Call an External Number via IVR

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

After the external user answers the call:

  • The IVR prompt will be played to the external user.
  • The external user can press a key to reach a pre-configured destination according to the IVR prompt.
Note: You need to dial from an extension with route permission and the outbound dial pattern should be matched.


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

Request Parameters

Name Importance Type Description
ivrid Required Int The IVR number.
outto Required String The dialed external number (the outbound dial pattern should be matched).
fromext Required String Which extension's call permission will be applied.

Response Parameters

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


Request Example
POST /api/v1.1.0/ivr/dial_outbound?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
    "ivrid": "6500",
    "outto": "18383992993",
    "fromext": "1000"
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"