Add a Paging Group

Add and configure a paging group.

Endpoint

POST /api/v1.1.0/paginggroup/add?token={token}

Request Parameters

Name Importance Type Description
number Required String Paging group number.
name Required String Paging group name.
duplex Required String Paging group type.

Valid values:

  • paging: 1-Way Paging. Typical one way for announcement only.
  • intercom: 2-Way Intercom. Make the paging duplex, allowing all users in group to talk and be heard by all.
  • multicast: 1-Way Multicast Paging. Broadcast an 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.
1-Way Paging ("duplex": "paging")
allowexten Required String Set extensions as paging group members. Separate multiple extensions with ,.

Example: "allowexten": "1000,1001,1002".
allowextengroup Required String Set extension groups as paging group members. Separate multiple extension groups with ,.

Example: "allowextengroup": "sales,support".
enablekeyhanup Required String Weather to enable Dial * to Answer feature.

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

  • yes: Enable.
  • no: Disable.
2-Way Intercom ("duplex": "intercom")
allowexten Required String Set extensions as paging group members. Separate multiple extensions with ,.

Example: "allowexten": "1000,1001,1002".
allowextengroup Required String Set extension groups as paging group members. Separate multiple extension groups with ,.

Example: "allowextengroup": "sales,support".
enablekeyhanup Required String Weather to enable Dial * to Answer feature.

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

  • yes: Enable.
  • no: Disable.
1-Way Multicast Paging ("duplex": "multicast")
multicastip Required String If the paging group type is multicast, set the multicast IP address.
enablekeyhanup Required String Weather to enable Dial * to Answer feature.

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

  • yes: Enable.
  • no: Disable.

Examples

Request Example

POST /api/v1.1.0/paginggroup/add?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "number": "6300",
    "name": "6300",
    "duplex": "paging",
    "allowexten": "1000,1001",
    "allowextengroup": "",
    "enablekeyhanup": "no",
    "multicastip": ""
}

Response Example

HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success"
}