Query IVR Settings
Query detailed information like IVR number, IVR name, keypress events, response timeout, etc. of one or more IVRs.
Endpoint
POST /api/v0.0.1/ivr/query?token={token}&type={type}
Request Parameters
| Name | Importance | Type | Description |
| name | Optional | String | The IVR number.
Example: “ivrid”:”6500″
Example: “ivrid”: “6500,6501”
|
Response Parameters
| Name | Type | Description |
| ivrname | String | The IVR name. |
| prompt | String | The IVR prompt. |
| promptrepeat | String | How many times will the prompt be repeated. |
| responsetimeout | Int | Response timeout in seconds. |
Examples
Request Example
Query the settings of IVR test_ivr.
POST /api/v0.0.1/ivr/query?token=813b621cfe8eecf445a2ce1f4a079ffe&type=json HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
{
“name”: “test_ivr”
}
POST /api/v0.0.1/ivr/query?token=813b621cfe8eecf445a2ce1f4a079ffe&type=xml HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
<?xml version=”1.0″ encoding=”UTF-8″ ?>
<xml>
<name>test_ivr</name>
</xml>
Query all IVRs.
POST /api/v0.0.1/ivr/query?token=813b621cfe8eecf445a2ce1f4a079ffe HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
“status”: “Success”,
“ivr”: [
{
“ivrid”: “4”,
“promptrepeat”: “3”,
“responsetimeout”: “5”,
“ivrname”: “test_ivr”,
“prompt”: “haruhi3″
}
]
}
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
<?xml version=”1.0″ encoding=”utf-8″?>
<xml>
<status>Success</status>
<ivr>
<item id=”0”>
<ivrid>4</ivrid>
<promptrepeat>3</promptrepeat>
<responsetimeout>5</responsetimeout>
<ivrname>test_ivr</ivrname>
<prompt>haruhi3</prompt>
</item>
</ivr>
</xml>