Close Call Center Room
- Print
- DarkLight
- PDF
Close Call Center Room
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/voip/room.close
Permission required: inbound-voip-calls
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
{
"rid": "c9YW3rejo7HeL6ZDW",
"token": "yHoawq4s9bDn4dM5H"
}object
rid
string Required
The ID of the open room.
token
string Required
The visitor token.
Responses
200
OK
Success Example
{
"rid": "c9YW3rejo7HeL6ZDW"
}object
rid
string
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
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?