Forward Livechat Room
    • Dark
      Light
    • PDF

    Forward Livechat Room

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/livechat/room.forward

    The chatbot agent forwards the chat to a human agent.

    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Body parameters
    Example 1
    {
      "roomId": "XFzMqgn33DcsQkpJp",
      "userId": "iNKE8a6k6cjbqWhWd"
    }
    object
    roomId
    string Required

    The room ID.

    userId
    string

    The new agent ID.

    departmentId
    string

    The new department ID.

    Responses
    200

    OK

    Example 1
    {
      "success": true
    }
    object
    success
    boolean
    400

    Bad Request

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

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    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.