Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 1.42 KB

livechat-transcript.md

File metadata and controls

57 lines (43 loc) · 1.42 KB
description
Request a Livechat transcript

Request a Livechat Transcript for the Visitor

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 %}

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

Payload

Argument Example Required Description
rid XFzMqgn33DcsQkpJp Required The room _id.
token iNKE8a6k6cjbqWhWd Required The visitor token.
email visitor@rocket.chat Required The visitor email.

Example payload

{
  "rid":"XFzMqgn33DcsQkpJp",
  "token": "iNKE8a6k6cjbqWhWd",
  "email": "visitor@rocket.chat"
}

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 Result

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

Change Log

Version Description
0.70.0 Added