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.

Path Variables

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": true


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.

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

Change Log

Last updated

Rocket.Chat versions receive support for six months after release.