Edit an IVR

Edit the IVR settings, such as number, name, etc.


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

Request Parameters

Name Importance Type Description
ivrid Required String A unique identifier of the configured IVR (IVR number).
ivrnumber Optional String Modified IVR number.
ivrname Optional String The IVR name.
promptrepeat Optional String How many times will the prompt be repeated.
responsetimeout Optional Int Response timeout in seconds.
digittimeout Optional Int Digit timeout in seconds.
dialext Optional String
Allow the caller to dial extension.
  • on: enable
  • off: disable
dialtocheckvoicemail Optional String

Allow to check voicemail.

  • on: enable
  • off: disable


Request Sample
Modify IVR number.
POST /api/v1.1.0/ivr/update?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
    "ivrid": "6500",
    "ivrnumber": "6501"
Response Sample
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
    "status": "Success"