Query Paging Group Settings

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

Endpoint

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

Request Parameters

Name Importance Type Description
number Required String Paging group number.
  • A paging group: Set number to the paging group number.

    Example: "number":"6300"

  • Multiple paging groups: Set number to paging group number. Separate multiple paging groups with ,.

    Example: "number": "6300,6301"

  • All paging groups: Set number to all.

Response Parameters

Name Type Description
paginggroup Object Object parameter.
id Int Paging group ID.
number String Paging group number.
name String Paging group name.
duplex String Paging group type.
  • 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.
allowexten String Paging group members.

If extensions are set as paging group members, the extension numbers are displayed as allowexten.
allowextengroup String Paging group members.

If extension groups are set as paging group members, the extension groups are displayed as allowextengroup.
enablekeyhanup 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.
multicastip String multicastip displays the multicast IP address if the paging group type is multicast.

Examples

Request Example

POST /api/v1.1.0/paginggroup/query?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "number": "6300"
}

Response Example

HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "paginggroup": [
        {
            "id": "1",
            "number": "6300",
            "name": "6300",
            "duplex": "paging",
            "allowexten": "1001,",
            "allowextengroup": "",
            "enablekeyhanup": "no",
            "multicastip": ""
        }
    ]
}