Get Call Center Queue Membership Information

Prev Next
Get
/api/v1/voip/queues.getQueuedCallsForThisExtension

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
Query parameters
extension
stringRequired

The phone extension for VoIP.

Example1293
Responses
200

OK

Success Example
{
  "extension": "12234",
  "queueCount": "1",
  "callWaitingCount": "2"
}
object
extension
string
queueCount
string
callWaitingCount
string
400

Bad Request

Example 1
{
  "success": false,
  "error": "Match error: Missing key 'extension'"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string