JSON API » queues » queues/callbacks/list
Gets the fields of queued callback requests, either for a specific queue, or for all queues in a given customer.
Input parameters
Requires authentication and the user role privilege if a queue is specified, else the administrator role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
customer | Integer | ID of customer to get queued calls for. Not used if queue is specified. | No | Customer of authentication user. |
descending | Integer | 1 to sort descending, 0 not to. | No | 0 |
queue | Integer | ID of queue to get queued for. 0 for all in given customer. | No | 0 |
sort | String | Field to sort by. "time" (of callback request), "queue_name", "queue_start" | No | "time" |
Responses
Code | Description |
---|---|
200 | Success. |
400 | The customer is invalid. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The queue does not exist, or you do not have permission to view it. |
Data returned
An array of fields, one row for each call leg.
Example: With queue
http://enswitch.example.com/api/json/queues/callbacks/list/?auth_username=user;auth_password=password;queue=123{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "queue_name":"Sales queue", "ctype 1":"", "cnumber1":"1004", ... }, { "queue_name":"Sales queue", "ctype 1":"", "cnumber1":"5551234567", ... }, ] }
Change history
Version | Changes |
---|---|
4.0 | Function added. |