Call Route Options
API endpoints for call route options
The call route option object
One entry in a call route's phone-tree menu: the digit a caller presses, the prompt we read out to offer it, and who we page when they choose it.
The keypad digit a caller presses to choose this option
Available options:
1, 2, 3, 4, 5, 6, 7, 8, 9 Example:
"1"
Unique identifier for this option
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
Who we page when a caller chooses this option
Show child attributes
Show child attributes
Example:
[
{
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"level": {
"targets": [
{
"id": "lawrencejones",
"schedule_mode": "currently_on_call",
"selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"type": "schedule",
"urgency": "high"
}
]
},
"type": "level",
"voicemail": {
"greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded."
}
}
]
What we read out to offer this option, via text-to-speech in the route's language, exactly as written
Maximum string length:
250Example:
"For an urgent production outage, press 1"
Was this page helpful?
{
"digit": "1",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"path": [
{
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"level": {
"targets": [
{
"id": "lawrencejones",
"schedule_mode": "currently_on_call",
"selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"type": "schedule",
"urgency": "high"
}
]
},
"type": "level",
"voicemail": {
"greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded."
}
}
],
"prompt": "For an urgent production outage, press 1"
}