livechat-transcript.md

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.

{% hint style="info" %} The room must be closed before you can send a transcript. {% endhint %}

HTTP Method	URL	Requires Auth
POST	/api/v1/livechat/transcript	no

Body Parameters

Key	Example Value	Description
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

{% code overflow="wrap" %}

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

{% endcode %}

Example Response

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

Change Log

Version	Description
0.70.0	Added