Search Ring Groups

Search ring groups in a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/ring-groups/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 ring groups, which fuzzy matches the ring group fields.
extension No String The extension number used to filter ring groups.
name No String The name used to search for ring groups, which fuzzy matches the name.
member No String The member used to search for ring groups, which fuzzy matches the extension or name of the member user.
ringStrategies No Array<String> The ringing strategies to filter by: - RING_ALL - SEQUENTIALLY - MEMORY_HUNT
sorts No Array<Sort_Condition> The sort conditions.
Sort_Condition
Parameter Required Type Description
property No String The name of the field to sort by.
direction No String The sort order: - 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 ring groups.
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 ring groups that can be created.
results Array<Ring_Group_Item> The list of matching ring groups.
Ring_Group_Item
Parameter Type Description
id String The ID of the ring group.
extension String The extension number of the ring group.
name String The name of the ring group.
ringStrategy String The ringing strategy: - RING_ALL: Ring all the members at the same time. - SEQUENTIALLY: Ring the members one by one in order. - MEMORY_HUNT: Ring from the member who answered the last call first.
members Array<Member> The list of ring group members.
Member
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/ring-groups/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: jint
{
  "pageNumber": 1,
  "pageSize": 5
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "76d58c3dc9c895152c91e8eb83c0c783",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "count": "1",
    "limit": 32,
    "results": [
      {
        "id": "363588204383244288",
        "extension": "6300",
        "name": "zz-test-rg-upd",
        "ringStrategy": "RING_ALL",
        "members": [
          {
            "userId": "355536619424391168",
            "extension": "1000",
            "name": "3 1"
          }
        ]
      }
    ]
  }
}