Get Queues

Resource

https://api.infobip.com/ccaas/1/queues

Query Params

Use this method to get a list of queues with pagination and filtering option. Using filter is optional. Result can be filtered by one or many optional filter described in parameters.

Property name Type Description
limit integer Size of result page. If a limit count is given, no more than that many rows will be returned (but possibly less, if the query itself yields fewer rows). The default value is 10, max value is 999.
page integer This parameter says to skip that many rows before beginning to return rows. If both page and limit appear, then page rows are skipped before starting to count the limit rows that are returned. The default value is 0
orderBy string This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.
queueIds array_string Optional filter array of queueIds in string
agentId string
Optional filter by agentId

Request Example 

					GET /ccaas/1/queues HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Response 

					{
    "queues": [
        {
            "id": "3BD35AB01DFD27E5AB48D57DC9DD02AB",
            "name": "Croatian Support",
            "createdAt": "2019-05-15T07:51:15.187+0000",
            "updatedAt": "2019-05-15T07:51:15.187+0000"
        },
        {
            "id": "5B7C4A0F8CC7D707908722AD8919E202",
            "name": "Spanish Support",
            "createdAt": "2019-05-15T07:51:01.446+0000",
            "updatedAt": "2019-05-15T07:51:01.446+0000"
        },
        {
            "id": "92C44D4D77DA67EABBD1EF9098A70754",
            "name": "Keyword STOP",
            "createdAt": "2019-05-15T07:51:39.652+0000",
            "updatedAt": "2019-05-15T07:51:39.652+0000"
        },
        {
            "id": "C685C19A7954C3A17C7F1002FED32C74",
            "name": "English Support",
            "createdAt": "2019-05-15T07:50:45.155+0000",
            "updatedAt": "2019-05-15T07:50:45.155+0000"
        }
    ],
    "pagination": {
        "totalItems": 4,
        "page": 0,
        "limit": 10,
        "orderBy": "id:ASC"
    }
}
					
				
					{
    "statusCode": "ERROR",
    "message": "Page size must not be less than one!"
}

Additional example:

Request example:
Searching for queues matching provided queueId list. Result must be sorted by date of queue creation in ascending order.

  • JSON
GET /ccaas/1/queues?queueId=[3BD35AB01DFD27E5AB48D57DC9DD02AB,5B7C4A0F8CC7D707908722AD8919E202]&orderBy=createdAt:asc HTTP/1.1
Host: {base_url}
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Response:

  • JSON
{
    "queues": [
      	{
            "id": "5B7C4A0F8CC7D707908722AD8919E202",
            "name": "Spanish Support",
            "createdAt": "2019-05-15T07:51:01.446+0000",
            "updatedAt": "2019-05-15T07:51:01.446+0000"
        },
        {
            "id": "3BD35AB01DFD27E5AB48D57DC9DD02AB",
            "name": "Croatian Support",
            "createdAt": "2019-05-15T07:51:15.187+0000",
            "updatedAt": "2019-05-15T07:51:15.187+0000"
        }        
    ],
    "pagination": {
        "totalItems": 2,
        "page": 0,
        "limit": 10,
        "orderBy": "createdAt:ASC"
    }
}

Request example:
Searching for queues specific agent with Id=E2025B7C4A0F8CC7D707908722AD8919 is assigned on.

  • JSON
GET /ccaas/1/queues?agentId=E2025B7C4A0F8CC7D707908722AD8919 HTTP/1.1
Host: {base_url}
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Response:

  • JSON
{
    "queues": [
        {
            "id": "3BD35AB01DFD27E5AB48D57DC9DD02AB",
            "name": "Croatian Support",
            "createdAt": "2019-05-15T07:51:15.187+0000",
            "updatedAt": "2019-05-15T07:51:15.187+0000"
        },
        {
            "id": "5B7C4A0F8CC7D707908722AD8919E202",
            "name": "Spanish Support",
            "createdAt": "2019-05-15T07:51:01.446+0000",
            "updatedAt": "2019-05-15T07:51:01.446+0000"
        },
        {
            "id": "92C44D4D77DA67EABBD1EF9098A70754",
            "name": "Keyword STOP",
            "createdAt": "2019-05-15T07:51:39.652+0000",
            "updatedAt": "2019-05-15T07:51:39.652+0000"
        }
    ],
    "pagination": {
        "totalItems": 3,
        "page": 0,
        "limit": 10,
        "orderBy": "id:ASC"
    }
}