Make an Announcement

Through this interface, call to a paging group, and make a live announcement to the group members, or play a background music to the group members.

Live Announcements & Background Music

  • Live Announcements

    Make a live announcement to the paging group through an extension.

  • Background Music

    Play a background music to the paging group.

    Note: Playing background music is supported when paging group type is paging or intercom.

Endpoint

POST /api/v1.1.0/extension/dial_number?token={token}

Request Parameters

Name Importance Type Description
Live Announcement
caller Required String Which extension is used to make the announcement.
callee Required String Paging group number.
volume Optional String Volume adjustment.

Range: 0 - 20
Background Music
callee Required String Paging group number.
volume Optional String Volume adjustment.

Range: 0 - 20
prompt Required String Audio file name.
Note:
  • The file name must contain at least a letter, and cannot contain character +.
  • The audio file must be uploaded to the PBX's Custom Prompt page beforehand.

For multiple audio files, separate the file names with + .

Example: "prompt:music1+music2"
count Optional String How many times to play the audio files.

Response Parameters

Name Type Description
callid String The call ID.

Examples

Request Example

Make a live announcement through extension 1001.

POST /api/v1.1.0/extension/dial_number?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "caller": "1001",
    "callee": "6300"
}

Play background music.

POST /api/v1.1.0/extension/dial_number?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "callee": "6300",
    "volume": "",
    "prompt": "music1",
    "count": "3"
}

Response Example

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