Call an Extension via IVR

The PBX will call to an extension via IVR to play the voice alarm.

After the extension answers the call:

  • The IVR prompt will be played to the extension.
  • The extension user can press a key to reach a pre-configured destination according to the IVR prompt.


POST /api/v1.1.0/ivr/dial_extension?token={token}

Request Parameters

Name Importance Type Description
ivrid Required Int The IVR number.
extid Required String The extension number.
autoanswer Required String Whether the extension will auto answer the call or not. (This parameter only works in SIP extensions and requires the SIP phone to support. )
  • Yes
  • No

Response Parameters

Name Type Description
callid String An unique identifier for the call.


Request Example
POST /api/v1.1.0/ivr/dial_extension?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
    "ivrid": "6500",
    "extid": "1002",
    "autoanswer": "no"
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
    "status": "Success",
    "callid": "1495698843.215"