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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
customerIntegerID of customer to get queued calls for. Not used if queue is specified.NoCustomer of authentication user.
descendingInteger1 to sort descending, 0 not to.No0
queueIntegerID of queue to get queued for. 0 for all in given customer.No0
sortStringField to sort by. "time" (of callback request), "queue_name", "queue_start"No"time"

Responses

CodeDescription
200Success.
400The customer is invalid.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
4.0Function added.