Query Information of Multiple Paging Groups

Query the detailed information of multiple paging groups at the same time.

Request URL

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

Request parameters

Parameter Required Type Description
ids Yes String The unique ID(s) of paging group(s).
Note:

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.
data Array<Paging_Basicinfo> The detailed information of paging group.
Paging_Basicinfo
Parameter Type Description
id Integer Paging group ID.
number String Paging group number.
name String Paging group name.
broadcast_client String Clients to receive broadcast.
  • exten: Extension Endpoint
  • linkus: Linkus Mobile Client
  • pc: Linkus Desktop Client
  • web: Linkus Web Client
  • pad: Linkus Pad Client (SDK)
dial_star_to_answer Integer Whether members can dial * to talk to the broadcaster privately.
  • 0: Disabled
  • 1: Enabled
play_prompt_to_broadcaster Integer Whether prompt will be played to broadcaster.
  • 0: Disabled
  • 1: Enabled
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.
dial_hash_to_stop_prompt Integer Whether broadcaster can dial # during playback to stop playing prompt.
  • 0: Disabled
  • 1: Enabled
prompt_play_times Integer How many times the prompt will be played and repeated.
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

Query the detailed information of paging groups (ID: 1 & 2).

GET /openapi/v1.0/paging/query?ids=1,2&access_token=BprupH1V8Jtp1U7rdI9M29bY7H8l0TIx HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "id": 1,
            "number": "6600",
            "name": "6600",
            "broadcast_client": "exten&linkus&pc&web&pad",
            "dial_star_to_answer": 0,
            "play_prompt_to_broadcaster": 1,
            "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"
                }
            ],
            "dial_hash_to_stop_prompt": 1,
            "prompt_play_times": 1
        },
        {
            "id": 2,
            "number": "6601",
            "name": "6601",
            "broadcast_client": "exten&linkus&pc&web",
            "dial_star_to_answer": 0,
            "play_prompt_to_broadcaster": 1,
            "type": "2_way_intercom",
            "member_list": [
                {
                    "type": "extension",
                    "name": "Terrell Smith",
                    "number": "1003",
                    "id": "82"
                },
                {
                    "type": "extension",
                    "name": "Carmen Gordon",
                    "number": "1005",
                    "id": "87"
                },
                {
                    "type": "extension",
                    "name": "Kevin Connor",
                    "number": "1006",
                    "id": "78"
                }
            ],
            "broadcast": [
                {
                    "type": "extension",
                    "name": "Troy Daniel",
                    "number": "1000",
                    "id": "80"
                }
            ],
            "dial_hash_to_stop_prompt": 1,
            "prompt_play_times": 1
        }
    ]
}