Search Queues

Request URL

POST {base_url}/uc-cconfig/api/v1/queues/search-page

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	Yes	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Body parameters


Parameter	Required	Type	Description
pageNumber	Yes	Integer	The page number to retrieve.
pageSize	Yes	Integer	The number of records to retrieve per page.
keyword	No	String	The keyword used to search for queues, which fuzzy matches the queue fields.
sorts	No	Array<Sort_Condition>	The sort conditions.
extension	No	String	The extension number used to filter queues.
name	No	String	The name used to search for queues, which fuzzy matches the name.
queueManager	No	String	The queue manager used to search for queues, which fuzzy matches the extension or name of the queue manager user.
staticAgent	No	String	The static agent used to search for queues, which fuzzy matches the extension or name of the agent user.
dynamicAgent	No	String	The dynamic agent used to search for queues, which fuzzy matches the extension or name of the agent user.
ringStrategies	No	Array<String>	The ringing strategies used to filter queues. Valid value: `RING_ALL` `LONGEST_IDLE_AGENT` `FEWEST_CALLS` `RANDOM` `ROUND_ROBIN` `LINEAR`

Sort_Condition


Parameter	Required	Type	Description
property	No	String	The name of the field to sort by.
direction	No	String	The sort order. Valid value: `asc`: Sort in ascending order. `desc`: Sort in descending order.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Search_Result>	The search result of queues.

Search_Result


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
count	String	The total number of matching records.
limit	Integer	The maximum number of queues that can be created.
results	Array<Queue_Item>	The list of matching queues.

Queue_Item


Parameter	Type	Description
id	String	The ID of the queue.
extension	String	The extension number of the queue.
name	String	The name of the queue.
ringStrategy	String	The ringing strategy for distributing calls to agents: `RING_ALL`: Ring all the agents at the same time. `LONGEST_IDLE_AGENT`: Ring the agent who has been idle for the longest time first. `FEWEST_CALLS`: Ring the agent who has answered the fewest calls first. `RANDOM`: Ring the agents in random order. `ROUND_ROBIN`: Ring the agents one by one in rotation. `LINEAR`: Ring the agents in the fixed order of the agent list.
staticAgents	Array<Member_Info>	The list of static agents.
dynamicAgents	Array<Member_Info>	The list of dynamic agents.
managers	Array<Member_Info>	The list of queue managers.

Member_Info


Parameter	Type	Description
userId	String	The ID of the user.
extension	String	The extension number of the user.
name	String	The name of the member.

Example

Request example

POST /uc-cconfig/api/v1/queues/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTkxMzkwNiwiaWF0IjoxNzkxODkyMzA2LCJqdGkiOiIyNjQzMzg4MC04OGI2LTQ1YjItYmMzZC1lMWFlM2MyZWM2NGIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.AMBnRYQuBmBxX5qZGethRuAqTm9JzAHAQJgq0rBW9kZo_B7ZJHYZOOt7hMyQRMG_fYfnJoU-LmZCM99e20jwQZ2vSipaTtIa7BGhpr7KK-EBunjLU2lAuv2FDEE6B9yGu-ZVg56tNXQRgv1xfTN-bQgN-qx9dcJc2j4wQX9Rqxd6NhjWO1eGUQlWOcVd-gpveaRCU-q6BwNlZL8JAS7rkFrf1uHYnKxUbDh_X-7Cx7f7DtR3R3VsywDXOeNmHQ-DqiKmaOtxOYFgKh9hyeQR9QSJ2V5rM3VILn4Ffb21hbrPARxNml9zhtTU4653e4Ir4J5WEJB50YSIRJX71o48qQ
Content-Type: application/json
x-tenant-code: jint
{
  "pageNumber": 1,
  "pageSize": 10
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "443f7abb60496b000879f0741d5f837b",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "count": "4",
    "limit": 32,
    "results": [
      {
        "id": "368362814601641984",
        "extension": "9003",
        "name": "test-queue-api-3",
        "ringStrategy": "RING_ALL",
        "staticAgents": [],
        "dynamicAgents": [],
        "managers": []
      },
      {
        "id": "368362814043799552",
        "extension": "9002",
        "name": "test-queue-api-2",
        "ringStrategy": "RING_ALL",
        "staticAgents": [],
        "dynamicAgents": [],
        "managers": []
      },
      {
        "id": "368362813322379264",
        "extension": "9001",
        "name": "test-queue-api-1-upd",
        "ringStrategy": "ROUND_ROBIN",
        "staticAgents": [
          {
            "userId": "366488799060709376",
            "extension": "1001",
            "name": "qq Hu"
          }
        ],
        "dynamicAgents": [],
        "managers": []
      },
      {
        "id": "361032822537973760",
        "extension": "6400",
        "name": "6400",
        "ringStrategy": "RING_ALL",
        "staticAgents": [],
        "dynamicAgents": [],
        "managers": []
      }
    ]
  }
}