Query Ring Group List

Query the list of ring groups.

Request URL

GET {base_url}/{api_path}/ringgroup/list?access_token={access_token}

Request parameters

Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.
sort_by No String Define the sorting field.

Valid value:

  • id
  • number
  • name
  • ring_strategy
order_by No String Define the display order.

Valid value:

  • asc: Ascending order
  • desc: Descending order

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of ring groups.
data Array <Ring_Group_Info> The basic information of each ring group.
Ring_Group_Info
Parameter Type Description
id Integer The unique ID of the ring group.
number String The ring group number.
name String The ring group name.
ring_strategy String The ring strategy of the ring group.
  • ring_all: Ring all available extensions simultaneously.
  • sequentially: Ring all available extensions sequentially.
  • memory_hunt: Ring the first available extension in the member list. If no answer within the ring time, progressively ring the next available extension, until all the available extensions in the list rang.
  • custom: Ring extensions according to their individual ring delays and stop ringing after their individual ring timeouts.
member_count Integer The number of members in the ring group.

Examples

Request example

GET /openapi/v1.0/ringgroup/list?access_token=Av4ZxfcjqeHAWvNK9IeISDC6TnmiTpra HTTP/1.1
Host: 192.168.5.150:8088
Response example
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "data": [
        {
            "id": 8007,
            "number": "8007",
            "name": "Sales",
            "ring_strategy": "sequentially",
            "member_count": 5
        },
        {
            "id": 8018,
            "number": "8018",
            "name": "Marketing",
            "ring_strategy": "ring_all",
            "member_count": 2
        },
        {
            "id": 8022,
            "number": "8022",
            "name": "Technical Support",
            "ring_strategy": "ring_all",
            "member_count": 10
        }
    ]
}