v1
latestSwagger 2.02026-08-06114161439.7 KBCreate or update any number of call flow records
Creates or updates call flow routing configurations. Provisions phone numbers with routing rules including forwarding destinations, business hours, IVR menus, and call handling logic.
Request body
Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id.
Human-readable name of the call flow/route. String.
The date and time that the call flow was created. Type: string (date-time).
call_flow_status. Type: enum (string); Allowed values: active, inactive.
The amount of minutes before the route can be used again. Type: integer (int32).
Monetary value assigned to the call by scoring/analytics. Integer (cents or whole dollars depending on account config).
Unique identifier for the marketing channel tagged on this call. Integer. See /misc/channel for available channels.
The unique ID assigned to an group for use with DNI. Type: string.
Indicates whether the message feature is enabled or not. Type: boolean.
SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).
The default number to route to for a call flow should be 10 number. Type: string.
Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.
The e-mail address(es) to notify for call flow. Type: string.
Identifies whether to play the disclaimer message or not. Type: enum (string); Allowed values: before, after, never.
The date and time at which the call flow was created. Type: string (date-time).
The date and time at which the call flow was last updated. Type: string (date-time).
The greeting to play if voicemail feature is enabled. Type: string.
Indicates whether or not to use the voice mail feature. Type: boolean.
The unique identifier for the rings for Voicemail (1-10). Filter will not apply for voicemail_rings. Type: integer (int32).
The routable_id is used to get route info. Type: integer (int32).
routable_type. Type: enum (string); Allowed values: SimpleRoute, IvrRoute2, PercentageBasedRoute, ScheduleRoute, GeoRoute, OutboundRoute, HangupRoute.
Indicates whether or not a call flow uses webhooks. Type: boolean.
The date and time to record until. Type: string (date-time).
Indicates whether or not whisper messaging is enabled. Type: boolean.
The message that should be played for the whisper or unique reference id. Type: string.
The number of seconds to delay before ringing. Type: integer (int32).
Indicates whether call flow has post call routing actions enabled. Type: boolean.
The unique identifier for the post call action to take. Type: integer (int32).
The threshold level of tolerance to allow on spam (0-5). Type: integer (int32).
Determines whether or not spam filtering is enabled. Type: boolean.
The referral number to route to for a call flow if call flow is in referral state. Type: string.
The referral date to route to for a call flow if call flow is in referral state. Type: string (date-time).
Enable/disable record call feature, play_disclaimer and record_until takes precedence. Type: boolean.
The isSimultaneous is used to create hunt type for a call flow and its mandatory when you are adding overflowNumbers in call flow
The unique identifier for the campaign to attach the call flow to
Response
Created or updated call flow IDs with result status for each operation
Outcome of the request. String, typically 'success' or 'error'.
Response payload. Shape varies by endpoint.
The sequential number of the entry in the submitted array. Type: integer (int32).