v1

latestSwagger 2.02026-08-06114161439.7 KB

callflow

Create or update any number of call flow records with multilevel IVR

Creates call flows with multi-level IVR (Interactive Voice Response) menu systems. Configures hierarchical phone menus with multiple levels of options for advanced call routing and self-service workflows.

post/callflow/multilevelivr

Request body

call_flow_idinteger

The unique identifier for the call flow route

call_flow_namestring required

The user assigned name for the call flow route

call_flow_status'active' | 'inactive'

repeat_intervalinteger

The amount of minutes before the route can be used again

call_valueinteger

A numeric value for the call

channel_idinteger required

The unique identifier for the channel record

messagestring required

The message to play related to key presses

group_idinteger required

The unique identifier of the group that is associated with the call flow

campaign_idinteger required

The unique identifier for the campaign to attach the call flow to

email_to_notifystring email

The e-mail address(es) to notify for call flow

voicemail_ringsinteger

The unique identifier for the rings for Voicemail (1-10)

voicemail_greetingstring

The greeting to play if voicemail feature is enabled.

webhook_enabledboolean

Indicates whether or not a call flow uses webhooks

webhook_idinteger

Unique identifier representing the webhook

spam_thresholdinteger

The threshold level of tolerance to allow on spam (0-5)

spam_filter_enabledboolean

Determines whether or not spam filtering is enabled

referral_numberinteger

The referral number to route to for a call flow if call flow is in referral state

Response

Created call flow IDs with confirmation status for each IVR configuration

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

datastring required

Response payload. Shape varies by endpoint.

entry_countinteger required

The sequential number of the entry in the submitted array. Type: integer (int32).