Search Specific Paging Groups

Search specific paging groups from the list.

Request URL

GET {base_url}/{api_path}/paging/search?access_token={access_token}

Request parameters

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

Valid value:

  • name: Paging group name.
  • number: Paging group number.
order_by No String Define the display order.

Valid value:

  • asc: Ascending order.
  • desc: Descending order.
search_value No String Search keyword.

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 paging groups matching the search criteria.
data Array<Paging_Basicinfo> The basic information of the paging group.
Paging_Basicinfo
Parameter Type Description
id Integer Paging group ID.
number String Paging group number.
name String Paging group name.
type String Paging group type.
  • 1_way_paging
  • 1_way_multicast_paging
  • 2_way_intercom
member_list Array<Member_List> Members for One-way Paging group or Two-way Intercom group.
broadcast Array<Broadcast> Broadcasters who initiate the paging.
Member_List
Parameter Type Description
type String Member type.
  • extension
  • ext_group
name String Name of extension or extension group.
number String Extension number.
id Integer ID of extension or extension group.
Broadcast
Parameter Type Description
type String Member type.
  • extension
  • ext_group
name String Name of extension or extension group.
number String Extension number.
id Integer ID of extension or extension group.

Examples

Request example

Search for paging group 6600 from the list.

GET /openapi/v1.0/paging/search?page=1&page_size=3&search_value=6600&access_token=mNFzdIZWSAeeNfU2s3NIzTmtUdCDQOM8 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "data": [
        {
            "id": 1,
            "number": "6600",
            "name": "6600",
            "type": "1_way_paging",
            "member_list": [
                {
                    "type": "extension",
                    "name": "Leo Ball",
                    "number": "1001",
                    "id": "83"
                },
                {
                    "type": "extension",
                    "name": "Phillip Huff",
                    "number": "1002",
                    "id": "84"
                },
                {
                    "type": "extension",
                    "name": "Terrell Smith",
                    "number": "1003",
                    "id": "82"
                }
            ],
            "broadcast": [
                {
                    "type": "extension",
                    "name": "Troy Daniel",
                    "number": "1000",
                    "id": "80"
                }
            ]
        }
    ]
}