Query Paging Group Settings

Query settings of a paging group, multiple paging groups, or all paging groups.

Request URL

{base_url}/{api_path}/paginggroup/query?token={token}

Request parameters

Parameter Required Type Description
number Yes String Paging group number.

Valid values:

  • A paging group number: Query settings of the specified paging group.

    Example: "number":"6300"

  • Multiple paging group numbers: Query settings of multiple paging groups. Separate multiple numbers with ,.

    Example: "number":"6300,6301"

  • all: Query settings of all paging groups.

    Example: "number":"all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
paginggroup Array <PaginggroupInfo> Paging group information.
PaginggroupInfo
Yeastar S-Series VoIP PBX supports three types of paginggroup: Paging, Intercom, and Multicast.
Table 1. Paging
Parameter Type Description
number String Paging group number.
name String Paging group name.
type String Paging group type.
  • paging: 1-Way Paging. Typical one way for announcement only.
member String Paging group members, here refers to extension numbers.
membergroup String Paging group members, here refers to names of extension groups.
enabledialtoanswer String Whether to enable Dial * to Answer feature or not.

If enabled, paging group members can dial * to answer an announcement. After answered, the group announcement will terminate, and the extension user who dials * can have a private call with the initiator.

  • yes: enable
  • no: disable
Table 2. Intercom
Parameter Type Description
number String Paging group number.
name String Paging group name.
type String Paging group type.
  • intercom: 2-Way Intercom. Make the paging duplex, allowing all users in a group to talk and be heard by all.
member String Paging group members, here refers to extension numbers.
membergroup String Paging group members, here refers to names of extension groups.
enabledialtoanswer String Whether to enable Dial * to Answer feature or not.

If enabled, paging group members can dial * to answer an announcement. After answered, the group announcement will terminate, and the extension user who dials * can have a private call with the initiator.

  • yes: enable
  • no: disable
Table 3. Multicast
Parameter Type Description
number String Paging group number.
name String Paging group name.
type String Paging group type.
  • multicast: 1-Way Multicast Paging. Broadcast a one-way announcement to users whose phones are programmed to listen to a broadcast address.
multicastip String Range of IP address that will receive announcement.

Examples

Request example

Query the settings of paging group 6300.

POST /api/v2.0.0/paginggroup/query?token=277ac400357b509b4a587ff2157f7ad5
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6300"
}

Response example

HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"paginggroup": [
		{
			"number": "6300",
			"name": "6300",
			"type": "paging",
			"member": "4000,",
			"membergroup": "",
			"enabledialtoanswer": "no"
		}
	]
}