Request Livechat Transcript

The endpoint is used by visitors to request a transcript of their chat to be sent to their email once the conversation ends.

The room must be closed before you can send a transcript.

HTTP MethodURLRequires Auth

POST

/api/v1/livechat/transcript

no

Body Parameters

KeyExample ValueDescription

rid*

XFzMqgn33DcsQkpJp

The room ID.

token*

iNKE8a6k6cjbqWhWd

The visitor token.

email*

visitor@rocket.chat

The visitor's email ID where the transcript should be sent.

Example Call

curl -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/livechat/transcript \
     -d '{"rid":"XFzMqgn33DcsQkpJp", 
          "token": "iNKE8a6k6cjbqWhWd", 
          "email": "visitor@rocket.chat"}'

Example Response

{
  "message": "Livechat transcript sent",
  "success": true
}

Change Log

VersionDescription

0.70.0

Added

Last updated

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