Links

Get Call Center Queue Membership Information

Retrieves the Queue Membership Information
URL
Requires Authentication
HTTP Method
api/v1/voip/queues.getQueuedCallsForThisExtension
Yes
GET

Request Headers

Header
Example
Description
X-Auth-Token
myauth-token
Your token (returned after you log in through the API)
X-User-Id
myuser-name
Your username hash (returned after you log in through the API)

Payload

Argument
Data Type
Required
Description
extension
string
Required
The phone extension for VoIP

Example Call

curl --location --request GET 'localhost:3000/api/v1/voip/queues.getQueuedCallsForThisExtension' \
--header 'X-Auth-Token: xS8jnLS2YzVy-_w8T_S0WnQm5SnADjACa7gbXmcOcLY' \
--header 'X-User-Id: 6vHSSqdBHdm2R4gfi' \
--header 'Content-Type: application/json' \
--data-raw '{
"extension": "12234"
}'

Example Response

{
"extension": "12234",
"queueCount": "1",
"callWaitingCount": "2"
}

Error Response

401 Unauthorized
Last modified 1yr ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.