Get Call Center Queue Membership Subscription Information
- Print
- DarkLight
- PDF
Get Call Center Queue Membership Subscription Information
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/voip/queues.getMembershipSubscription
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
{
"queues": {
"name": "event.queue",
"loggedin": "event.loggedin",
"available": "event.available",
"callers": "event.available",
"holdtime": "event.holdtime",
"talktime": "event.talktime",
"longestholdtime": "event.logestholdtime"
},
"extension": "1293"
}object
queues
object
name
string
loggedin
string
available
string
callers
string
holdtime
string
talktime
string
longestholdtime
string
extension
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
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?