Post
/api/v1/livechat/transcript/{rid}
This endpoint is used by agents and managers to schedule an email transcript to be sent once the chat is closed.
Permission required: send-omnichannel-chat-transcript
The room must be opened.
Changelog
| Version | Description |
|---|---|
| 6.4.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
rid
stringRequired
The room ID.
Body parameters
Example 1
{
"email": "[email protected]",
"subject": "Livechat Transcript"
}object
email
string Required
The email address where the transcript should be sent.
subject
string Required
The subject of the email.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'email' [invalid-params]",
"errorType": "invalid-params"
}Example 2
{
"success": false,
"error": "must have required property 'subject' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Unauthorized
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string