Query IVR Settings
Query detailed information like IVR number, IVR name, keypress events, response timeout, etc. of one or more IVRs.
Endpoint
POST /api/v1.1.0/ivr/query?token={token}
Request Parameters
Name | Importance | Type | Description |
---|---|---|---|
ivrid
|
Optional | String | The IVR number.
|
Response Parameters
Name | Type | Description |
---|---|---|
ivrnumber |
String | The IVR number. |
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. |
digittimeout |
Int | Digit timeout in seconds. |
dialext |
String | Allow the caller to dial extension.
|
dialoutboundroutes |
String | Allow the caller to dial through outbound routes.
|
selectedrouters |
String | The selected route. |
dialtocheckvoicemail |
String | Allow to check voicemail.
|
Examples
Request ExampleQuery the settings of IVR
6500.
POST /api/v1.1.0/ivr/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1 Content-Type:application/json; charset=utf-8 Host: api.yeastarcloud.com { "ivrid": "6500" }
Query all IVRs.
POST /api/v1.1.0/ivr/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1 Content-Type:application/json; charset=utf-8 Host: api.yeastarcloud.com
HTTP/1.1 200 OK Access-control-allow-origin: * Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE { "status": "Success", "ivr": [ { "ivrnumber": "6500", "ivrname": "6500", "prompt": "[Default]", "promptrepeat": "3", "responsetimeout": "3", "digittimeout": "3", "dialext": "on", "dialoutboundroutes": "off", "dialtocheckvoicemail": "off" } ] }