Edit an IVR

Edit IVR settings, such as IVR name, the frequency of playing prompts, etc.

Request URL

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

Request parameters

Parameter Required Type Description
number Yes String IVR number.
ivrname No String IVR name.
Note:
  • Space and the following characters are not allowed:

    ! $ ( ) / # ; , [ ] " = < > & ' ` ^ % @ { } |

  • The maximum length is 31.
promptrepeat No String How many times will the prompt be played.

Valid values: 1-5.
responsetimeout No Integer Response timeout in seconds.

Valid values: 1-10.
digittimeout No Integer Digit timeout in seconds.

Valid values: 1-10
dialext No String Whether to allow the caller to dial extensions directly or not.

Valid values:

  • on: enable
  • off: disable
dialoutboundroutes No String Whether to allow the caller to dial through outbound routes or not.

Valid values:

  • on: enable
  • off: disable
dialtocheckvoicemail No String Whether to allow the caller to check voicemails or not.

Valid values:

  • on: enable
  • off: disable

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

Set the IVR name to “Welcome” for the IVR 6500.
POST /api/v2.0.0/ivr/update?token=1e3b3ebb6a974cb42ed31de5413df52d 
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6500",
	"ivrname": "Welcome"
}
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"
}