Links

Send Livechat Transcript

This endpoint is used by agents and managers to schedule an email transcript to be sent once the chat is closed.
  • It requires the send-omnichannel-chat-transcript permission.
  • The room must be opened.
HTTP Method
URL
Requires Auth
POST
/api/v1/livechat/transcript/:rid
yes

Path Variables

Key
Example Value
Description
rid*
tcbbSmWSLR5uo5PBW
The room ID.

Body Parameters

Key
Example Value
Description
email*
The email address where the transcript should be sent.
subject*
Test request Transcript
The subject of the email.

Example Call

curl -L -X POST 'http://localhost:3000/api/v1/livechat/transcript/AHsFiNLYWQK35jgtS" \
-H 'x-auth-token: qlHA60g5JQjJJG7C_8MgXoFnOiRQ8X9TWVVq4AcQeFb' \
-H 'x-user-id: rbAXPnMktTFbNpwtJ' \
-H 'Content-Type: application/json' \
--data-raw '{
"email":"[email protected]",
"subject":"Livechat Transcript"
}'

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 Requested: Occurs when a transcript has been requested for this room. See Delete Livechat Transcript and delete the current request before requesting the transcript again.
Authorization
No Permission
Transcript Requested
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}
{
"success": false,
"error": "Transcript already requested [error-transcript-already-requested]",
"errorType": "error-transcript-already-requested"
}

Change Log

Version
Description
6.4.0
Added
Last modified 2mo ago
Rocket.Chat versions receive support for six months after release.