Get Agents assigned to Queue

Resource

https://api.infobip.com/ccaas/1/queues/{queueId}/agents

Query Params

Use this method to get a list of agents assigned to queue with pagination and filtering option. Using a filter is optional. The result can be filtered by one or many optional filters described in parameters.

Property name Type Description
limit integer Size of the 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, the 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.
status string Optional filter. Match any of status with the result. Possible values: ACTIVE, BUSY, OFFLINE, AWAY.
role string
Optional filter. Match any of role with result. Possible values: AGENT, SUPERVISOR.
displayName string Optional filter. Agent displayName to match result. This is case insensitive and will search for substring anywhere within string, 255 characters max.
enabled boolean Optional filter. Match any of enabled with the result. Possible values: TRUE, FALSE

Request Example

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

Response

					{
    "agents": [
        {
            "id": "E83E787CF2613450157ADA3476171E3F",
            "displayName": "Bon Scott",
            "status": "OFFLINE",
            "role": "AGENT",
            "enabled": true,
    				"createdAt": "2019-05-10T07:45:23.777+0000",
    				"updatedAt": "2019-05-10T09:53:58.463+0000"
        },
        {
            "id": "F66D67327326FCCB027BEAA916B94542",
            "displayName": "Phil Rudd",
            "status": "AVAILABLE",
            "role": "AGENT",
            "enabled": true,
    				"createdAt": "2019-05-10T07:45:23.777+0000",
    				"updatedAt": "2019-05-10T09:53:58.463+0000"
        }
    ],
    "pagination": {
        "totalItems": 2,
        "page": 0,
        "limit": 10,
        "orderBy": "id:ASC"
    }
}
					
				
					{
  "statusCode": "ERROR",
  "message": "Invalid id '1E54701F74BD86A070B43DB49478D82C' given! No such entity exists."
}
					
				
					{
    "statusCode": "ERROR",
    "message": "Page size must not be less than one!"
}