Get Available Users for AI Routes

Retrieves the list of users that are available for the AI route configuration of a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/ai-routes/users/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
keyword No String The keyword used to search for users by extension number or name.
pageNumber No Integer The page number to retrieve.
pageSize No Integer The number of records to retrieve per page.
Note:

pageSize supports the following values: 0 returns all users without pagination, and the maximum value is 500. If pageNumber is omitted, the first page is returned.

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<User_Page> The search result of users.
User_Page
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.
results Array<User_Item> The list of users on the current page.
User_Item
Parameter Type Description
id String The ID of the user.
extension String The extension number of the user.
name String The name of the user.

Example

Request example

POST /uc-cconfig/api/v1/ai-routes/users/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM2NDgxOSwiaWF0IjoxNzkzMzQzMjE5LCJqdGkiOiI3YjhjNzQ0ZC1jNTFkLTRlZmYtOWM5ZS04YzE1MmQ3MWRjNzIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.Cqgp39PGgVcQXsVEkQfcIbviGKW6c4sX_wVA-q-mPb9YS3VSmYZ79VyzfXa3XR3iIdV7jdCQXNzRmXKt5ozM8MaLb69tFNcy_zDuLX5FkwNBuLxiZQUPGr3o7ZoNVX75KTpZDu6lmZvOM4kJXQAp66zQDm8bU56MU8D5TX7EwG0UjvmiFygRryhEZwfEaiOFPV4TyR_a3emovg-EQWrDLYx14bdw6PGRbrPTE1mkhjPhk4izceChiCjX0YbzfSkcIOiJLtp7vG-8dM1Oj2zsXgDPR94gO_34Ic3LakYyEnaCmX0g4wo63uGc0PJmfBLnFuQFu5laencELeMhTRRXWg
x-tenant-code: jint
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 3
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "f947275539311f30deedb00410e84fa5",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 3,
    "pageNumber": 1,
    "count": "6",
    "results": [
      {
        "id": "338136731335409664",
        "extension": "1000",
        "name": "Leo Ball"
      },
      {
        "id": "342552093490561024",
        "extension": "1001",
        "name": "Terrell Smith"
      },
      {
        "id": "338855950145581056",
        "extension": "1002",
        "name": "Philip Huff"
      }
    ]
  }
}