IVR and auto-attendant
List IVR menus, read one menu and update supported menu settings when the key has write access.
GET/v1/ivrs
Lists IVR and auto-attendant menus available to the authorised customer.
GET/v1/ivrs/{ivr_id}
Returns one menu with its supported settings and prompt state.
Example response
{
"success": true,
"data": {
"ivr_id": "ivr_2d95ca46199f3b231b4e",
"telephone_number": "+442012345678",
"name": "ROOT",
"is_root": true,
"schedule": "always",
"schedule_description": "All hours",
"replay_count": 2,
"first_digit_timeout_seconds": 8,
"next_digit_timeout_seconds": 5,
"direct_dial_enabled": false,
"prompts": {
"intro": {"type": "custom", "custom_prompt_set": true},
"menu": {"type": "custom", "custom_prompt_set": true}
}
}
}Update a menu
PATCH/v1/ivrs/{ivr_id}
Updates only the supported menu settings included in the request.
Request body
{
"schedule": "always",
"schedule_description": "All hours",
"replay_count": 3,
"first_digit_timeout_seconds": 10,
"next_digit_timeout_seconds": 5,
"direct_dial_enabled": true
}Current write limits
Audio prompt upload and menu transitions are not exposed in v0.4.0. The
ROOT menu name cannot be changed.Use the returned IVR ID
Copy the exact
ivr_id returned by Voyced. Do not build an ID from a menu name or telephone number.1
Get a token
Request a temporary Sandbox bearer token.
2
Prepare the request
Select the endpoint and add a number when required.
3
Run and check
Review the HTTP status, response time and JSON.
Use a bearer token onlyThe page sends the token through the protected documentation proxy to Voyced Sandbox for this request. It is not saved. Reset or leave the page to clear the field.
The documentation proxy accepts approved Sandbox GET requests only. It cannot call Live. It does not place credentials in cookies, browser storage or URLs.