Links
Comment on page

Request PDF Transcript

Request a PDF transcript for an Omnichannel conversation.
  • The conversation must be closed before it can be exported.
  • It requires the request-pdf-transcript permission. Omnichannel managers and agents have this permission by default.
HTTP Method
URL
Requires Auth
POST
/api/vi/omnichannel/:rid/request-transcript
yes

Path Variables

Key
Example Value
Description
rid*
gLanBL8wSfXG7AqBo
The room ID.

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/omnichannel/teSNo3QPv4ebudmab/request-transcript' \
--header 'x-auth-token: fjiPBhtyFAn5JO3RDdDvKjkXToV2pd4_lb-nkdgJ_Q4' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ'

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.
  • Invalid Room: This occurs when the rid does not exist in the workspace.
  • Room still open: This happens when the room you're requesting a transcript for is still open. Only closed conversations can be exported.
  • No Permission: This occurs when the authenticated user doesn't have the request-pdf-transcript permission.
  • Can't Access Room: Occurs when the authenticated user doesn't have access to the conversation room.
Authorization
Invalid Room
Room still open
No Permission
Can't Access Room
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "error-invalid-room"
}
{
"success": false,
"error": "room-still-open"
}
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}
{
"success": false,
"error": "error-not-allowed"
}

Change Log

Version
Description
6.0.0
Added
Last modified 7d ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.