Resume Room On-Hold

Prev Next
Post
/api/v1/livechat/room.resumeOnHold
Premium tag

Use this endpoint to resume a room that was on-hold. 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
Body parameters
Example 1
{
  "roomId": "dCBiZX3XPWyPsa6pt"
}
object
roomId
string Required

Enter the Omnichannel room ID that you want to resume.

ExampledCBiZX3XPWyPsa6pt
Responses
200

OK

Success
{
  "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
Tags