customer-engagement
conversations
conversation-queues

Get queues

Use this method to get a list of queues with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters. <a href="https://www.infobip.com/docs/conversations/supervisor-guide#queues-and-routing" target="_blank">More info</a>

get/ccaas/1/queues

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Query parameters

queueIdsstring[]

Optional filter. List of queue Ids.

agentIdstring

Optional filter. Agent Id.

workingHoursIdstring

Optional filter. Working Hours Id.

limitinteger

Size of the result page.

pageinteger

Number of the current page.

orderBystring

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.

namestring

Optional. Queue name.

Response

OK

Example response

{
  "queues": [
    {
      "id": "a126beb1-f43b-422c-b298-295f65d31e82",
      "name": "Queue 1",
      "enabledAgentsCount": 3,
      "enabledRoutesCount": 2,
      "isAutoAssignmentEnabled": false,
      "stickyAgentTimeoutDays": 10,
      "isStickyAutoAssignmentEnabled": true,
      "workingHoursId": null,
      "isPrivate": false,
      "createdAt": "2024-01-01T00:00:00.000+00:00",
      "updatedAt": "2024-01-01T00:00:00.000+00:00",
      "deletedAt": null
    },
    {
      "id": "75af6f92-75a6-4364-b293-450281bd21be",
      "name": "Queue 2",
      "enabledAgentsCount": 1,
      "enabledRoutesCount": 4,
      "isAutoAssignmentEnabled": false,
      "stickyAgentTimeoutDays": null,
      "isStickyAutoAssignmentEnabled": false,
      "workingHoursId": null,
      "isPrivate": false,
      "createdAt": "2024-01-01T00:00:00.000+00:00",
      "updatedAt": "2024-01-01T00:00:00.000+00:00",
      "deletedAt": null
    }
  ],
  "pagination": {
    "totalItems": 2,
    "page": 0,
    "limit": 10,
    "orderBy": "id:ASC"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.