Get Available Users for Ring Groups

Retrieves the users that can be selected as ring group members, with pagination.

Request URL

POST {base_url}/uc-cconfig/api/v1/ring-groups/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, which fuzzy matches the user fields.
pageNumber No Integer The page number to query. If pageSize is 0, all the matching users are returned.
pageSize No Integer The number of records per page. 0 means that pagination is disabled and all the matching users are 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<Search_Result> The search result of users.
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.
results Array<User_Option> The list of matching users.
User_Option
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/ring-groups/users/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc3NTMyMCwiaWF0IjoxNzkwNzUzNzIwLCJqdGkiOiI2ZDg1ZTg2NC1jOTk0LTRjZTItOGUzYi1mMTRiODE1Y2M4NDIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.o8tXb4Q9dImuGjtnui9LWTCukF9S5HKMkqYYWT7rjd1H7_2S40ZUjYuGonzGZR37q66kWBxrbHI0a9c7ICQO4MAq-0X0Ev6coK1Q8ud9yWFq1cf7H58pC0wYxE_bCjnDdKLxQk6lHCFbD_WiMTjuuK_Vtckuv6sI9-3ILspzK1WLJLktESKBV1qbsMJY-pO-pD8enoZq9I1Lo_kWIOHckg5Hq4kKjwq9iN1pecnSVQwKsL5Z8KDiJS8QXuoJrZtySacLbGB0-_GeljzDXk5JmsmOrpUr3UWDD7Lh4rcYq3Xwc6ya126GV5ETTZHAM4uX-OWev69cR29MHRxw5eNZIw
Content-Type: application/json
x-tenant-code: min
{
  "pageNumber": 0,
  "pageSize": 0
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "6491dfcdfd2db74bcd5d6d3506d7ee86",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 0,
    "pageNumber": 0,
    "count": "2",
    "results": [
      {
        "id": "355536619424391168",
        "extension": "1000",
        "name": "3 1"
      },
      {
        "id": "355545562435493888",
        "extension": "1001",
        "name": "newwwww"
      }
    ]
  }
}