Query IVR Settings

Query detailed settings of an IVR, multiple IVRs, or all IVRs.

Request URL

{base_url}/{api_path}/ivr/query?token={token}

Request parameters

Parameter Required Type Description
number Yes String The IVR number.

Valid values:

  • An IVR number: Query settings of the specified IVR.

    Example: "number":"6500"

  • Multiple IVR numbers: Query settings of multiple IVRs. Separate multiple IVR numbers with ,.

    Example: "number":"6500,6501,6502"

  • all: Query settings of all IVRs.

    Example: "number":"all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
ivr Array <IVRInfo> IVR information.
IVRInfo
Parameter Type Description
number String IVR number.
ivrname String IVR name.
prompt String IVR prompt.
promptrepeat String How many times will the prompt be played.
responsetimeout Integer Response timeout in seconds.
digittimeout Integer Digit timeout in seconds.
dialext String Whether to allow the caller to dial extensions directly or not.
  • on: enable
  • off: disable
dialoutboundroutes String Whether to allow the caller to dial through outbound routes or not.
  • on: enable
  • off: disable
dialtocheckvoicemail String Whether to allow the caller to check voicemails or not.
  • on: enable
  • off: disable

Examples

Request example

Query the detailed settings of IVR 6500.

POST /api/v2.0.0/ivr/query?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6500"
}
Response example
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"ivr": [
		{
			"number": "6500",
			"ivrname": "6500",
			"prompt": "[Default]",
			"promptrepeat": "3",
			"responsetimeout": "3",
			"digittimeout": "3",
			"dialext": "on",
			"dialoutboundroutes": "off",
			"dialtocheckvoicemail": "off"
		}
	]
}