Add a Paging Group

Add and configure a paging group.

Request URL

POST {base_url}/{api_path}/paging/create?access_token={access_token}

Request parameters

Parameter Required Type Description
number Yes String Paging group number.
name Yes String Paging group name.
type Yes String Paging group type.

Valid value:

  • 1_way_paging
  • 1_way_multicast_paging
  • 2_way_intercom
prompt No String The prompt to be played before making an announcement.
Note: You can query available custom prompts using the Get Menu Options interface.
prompt_play_times Yes Integer How many times the prompt will be played and repeated.

Valid value: 0-100, where 0 indicates playing the prompt in a loop.
broadcast No Array<Broadcast> Broadcasters who initiate the paging.
broadcast_client Yes String Clients to receive broadcast.

Valid value:

  • exten: Extension Endpoint
  • linkus: Linkus Mobile Client
  • pc: Linkus Desktop Client
  • web: Linkus Web Client
  • pad: Linkus Pad Client (SDK)
Note: Use & to separate multiple clients.
dial_star_to_answer No Integer Whether members can dial * to talk to the broadcaster privately.

Valid value:

  • 0: Disabled
  • 1: Enabled
dial_hash_to_stop_prompt No Integer Whether broadcaster can dial # during playback to stop playing prompt.

Valid value:

  • 0: Disabled
  • 1: Enabled
play_prompt_to_broadcaster No Integer Whether to play prompt to broadcaster.

Valid value:

  • 0: Disabled
  • 1: Enabled
member_list No Array<Member_List> Members for One-way Paging group or Two-way Intercom group.
Note: This parameter is required for One-way Paging group or Two-way Intercom group.
multicast_ip_list No Array<Multicast_IP_List> Multicast IPs for One-way Multicast Paging group.
Note: These parameters are required for One-way Multicast Paging group.
Broadcast
Parameter Required Type Description
id No Array The unique ID(s) of extension or extension group.
Note: You can query extension ID or extension group ID using the Get Menu Options interface.
Member_List
Parameter Required Type Description
id Yes Array The unique ID(s) of extension or extension group.
Note: You can query extension ID or extension group ID using the Get Menu Options interface.
Multicast_IP_List
Parameter Required Type Description
multicast_ip Yes String Multicast IP address.
multicast_port Yes Integer Multicast port.

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.
id Integer The unique ID of the paging group.

Examples

Request example

POST /openapi/v1.0/paging/create?access_token=iTtFoTQObinMGCpXzbtD8gnDaR2r8UJP HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "number": "6605",
    "name": "6605",
    "type": "1_way_paging",
    "prompt":"welcome.wav",
    "prompt_play_times": 1,
    "broadcast":["80"],
    "broadcast_client": "exten&linkus",
    "dial_star_to_answer": 0,
    "dial_hash_to_stop_prompt":1,
    "play_prompt_to_broadcaster": 1,
    "member_list":["83","84"]
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 233
}