livechat-transcript-2.md

Delete Livechat Transcript

This endpoint is used to cancel any transcript requests for an open room, meaning that the chat transcript won't be sent after the chat is closed. You can not livechat-transcript-1.md twice at a time. You must delete the previous request with this endpoint before requesting again.

{% hint style="info" %}

• It requires the send-omnichannel-chat-transcript permission. {% endhint %}

HTTP Method	URL	Requires Auth
DELETE	/api/v1/livechat/transcript/:rid	yes

Path Variables

Key	Example Value	Description
rid*	tcbbSmWSLR5uo5PBW	The room ID.

Example Call

{% code overflow="wrap" %}

curl -L -X DELETE 'http://localhost:3000/api/v1/livechat/transcript/WrosEi8fKFedLbQMe' \
-H 'x-auth-token: 6gwMfYPDoQzMCAnwjP5iILveZINplU7V-1DYzkhhxsc' \
-H 'x-user-id: rmbMnnpqkuxEbrajt'

{% endcode %}

Example Response

Success

{
  "success": true
}

Error

Any of the following errors can occur on the endpoint.

• Authorization: Requires an authentication token for the request to be made.
• No Permission: Occurs when the authenticated user doesn't have send-omnichannel-chat-transcript permission.
• Transcript Not Requested: Occurs when there is no existing transcript request.

{% tabs %} {% tab title="Authorization" %}

{
    "status": "error",
    "message": "You must be logged in to do this."
}

{% endtab %}

{% tab title="No Permission" %}

{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}

{% endtab %}

{% tab title="Transcript Not Requested" %}

{
    "success": false,
    "error": "error-transcript-not-requested"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
6.4.0	Added