v1

latestSwagger 2.02026-08-06114161439.7 KB

callflow

Create a new call flow outbound record entry

Creates outbound call flow configurations for making outbound calls through the system. Configures routing rules, caller ID settings, and call handling for calls originated by your organization rather than received.

post/callflow/outbound

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'

channel_idinteger required

The unique identifier for the channel record

message_enabledboolean

Indicates whether the message feature is enabled or not

messagestring

The message to use if message is enabled or unique reference id

group_idinteger required

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

email_to_notifystring email

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

play_disclaimer'before' | 'after' | 'never'

Identifies whether to play the disclaimer message or not

record_untilstring date-time

The date and time to record until

campaign_idinteger required

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

Response

Created outbound call flow IDs with confirmation status

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).