Edit a Paging Group

Edit settings of a paging group.

Request URL

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

Request parameters

Send different request parameters according to different types of paging group.
Paging
Parameter Required Type Description
number Yes String Paging group number.
name No String Paging group name.
type No String Paging group type.

Valid value:

  • paging: 1-Way Paging. Typical one way for announcement only.
member No String Paging group members.

Valid value:

Set extensions to paging group members. Separate multiple extensions with ,.

Example: "member":"1000,1001,1002"

Note: Either member or membergroup is required.
membergroup No String Paging group members.

Valid value:

Set extension groups to paging group members. Separate multiple extension groups with ,.

Example: "membergroup":"sales,support"

Note: Either member or membergroup is required.
enabledialtoanswer No 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.

Valid values:

  • yes: enable
  • no: disable
Intercom
Parameter Required Type Description
number Yes String Paging group number.
name No String Paging group name.
type No String Paging group type.

Valid value:

  • intercom: 2-Way Intercom. Make the paging duplex, allowing all users in a group to talk and be heard by all.
member No String Paging group members.

Valid value:

Set extensions to paging group members. Separate multiple extensions with ,.

Example: "member":"1000,1001,1002"

Note: Either member or membergroup is required.
membergroup No String Paging group members.

Valid value:

Set extension groups to paging group members. Separate multiple extension groups with ,.

Example: "membergroup":"sales,support"

Note: Either member or membergroup is required.
enabledialtoanswer No 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.

Valid values:

  • yes: enable
  • no: disable
Multicast
Parameter Required Type Description
number Yes String Paging group number.
name No String Paging group name.
type No String Paging group type.

Valid value:

  • multicast: 1-Way Multicast Paging. Broadcast a one-way announcement to users whose phones are programmed to listen to a broadcast address.
Note: Make sure your IP phone supports multicast paging and the broadcast address has been configured on the phone.
multicastip No String Range of IP address that will receive announcement.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

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

{
	"number": "6303",
	"name": "6303",
	"type": "paging",
	"member": "4001,4003,",
	"membergroup": "sales,",
	"enabledialtoanswer": "yes"
}

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"
}