Request Livechat Transcript
    • Dark
      Light
    • PDF

    Request Livechat Transcript

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/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.

    Changelog

    VersionDescription
    0.70.0Added
    Body parameters
    Example 1
    {
      "rid": "XFzMqgn33DcsQkpJp",
      "token": "iNKE8a6k6cjbqWhWd",
      "email": "[email protected]"
    }
    object
    rid
    string Required

    The room ID.

    token
    string Required

    The visitor token.

    email
    string Required

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

    Responses
    200

    OK

    Success Example
    {
      "message": "Livechat transcript sent",
      "success": true
    }
    object
    message
    string
    success
    boolean
    400

    Bad Request

    Example 1
    {
      "success": false,
      "error": "must have required property 'rid' [invalid-params]",
      "errorType": "invalid-params"
    }
    Example 2
    {
      "success": false,
      "error": "must have required property 'token' [invalid-params]",
      "errorType": "invalid-params"
    }
    object
    success
    boolean
    error
    string
    errorType
    string

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.