Join Livechat Room
- Print
- DarkLight
- PDF
Join Livechat Room
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/room.join
Call this endpoint to join a Livechat room. Permission required: view-l-room
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
roomId
stringRequired
The room ID that you want to join.
ExamplegMMeBpWyLeowCrzBv
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"
}Example 2
{
"success": false,
"error": "error-invalid-room"
}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
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?