callflow

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

Supports two methods for number pool creation:

  1. Pre-existing phone numbers (V3 compatible): Provide a phone_numbers array with phone_number_id and phone_number values. Numbers must exist in inventory with 'unprovisioned' or 'reserved' status.
  2. NPA/NXX provisioning (original APICFA): Provide npa, nxx, and number_quantity to automatically provision new numbers from the specified area code and exchange.

When creating a call flow, either number (for single number) or number_pool must be provided, but not both.

post/callflow

Request

  • Base URL
    https://apicfa.conviza.com/v2
  • URL
    https://apicfa.conviza.com/v2/callflow
  • Auth
    none declared

Request body

call_flow_idinteger

Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id.

call_flow_namestring required

Human-readable name of the call flow/route. String.

call_flow_createdstring date-time

The date and time that the call flow was created. Type: string (date-time).

call_flow_status'active' | 'inactive'

call_flow_status. Type: enum (string); Allowed values: active, inactive.

repeat_intervalinteger

The amount of minutes before the route can be used again. Type: integer (int32).

call_valueinteger

Monetary value assigned to the call by scoring/analytics. Integer (cents or whole dollars depending on account config).

channel_idinteger required

Unique identifier for the marketing channel tagged on this call. Integer. See /misc/channel for available channels.

dnisstring

The unique ID assigned to an group for use with DNI. Type: string.

message_enabledboolean

Indicates whether the message feature is enabled or not. Type: boolean.

messagestring

SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).

default_ringtostring

The default number to route to for a call flow should be 10 number. Type: string.

group_idinteger required

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

email_to_notifystring

The e-mail address(es) to notify for call flow. Type: string.

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

Identifies whether to play the disclaimer message or not. Type: enum (string); Allowed values: before, after, never.

created_atstring date-time

The date and time at which the call flow was created. Type: string (date-time).

updated_atstring date-time

The date and time at which the call flow was last updated. Type: string (date-time).

voicemail_greetingstring

The greeting to play if voicemail feature is enabled. Type: string.

voicemail_enabledboolean

Indicates whether or not to use the voice mail feature. Type: boolean.

voicemail_ringsinteger

The unique identifier for the rings for Voicemail (1-10). Filter will not apply for voicemail_rings. Type: integer (int32).

routable_idinteger

The routable_id is used to get route info. Type: integer (int32).

routable_type'SimpleRoute' | 'IvrRoute2' | 'PercentageBasedRoute' | 'ScheduleRoute' | 'GeoRoute' | 'OutboundRoute' | 'HangupRoute' required

routable_type. Type: enum (string); Allowed values: SimpleRoute, IvrRoute2, PercentageBasedRoute, ScheduleRoute, GeoRoute, OutboundRoute, HangupRoute.

webhook_enabledboolean

Indicates whether or not a call flow uses webhooks. Type: boolean.

record_untilstring date-time

The date and time to record until. Type: string (date-time).

whisper_enabledboolean

Indicates whether or not whisper messaging is enabled. Type: boolean.

whisper_messagestring

The message that should be played for the whisper or unique reference id. Type: string.

ring_delayinteger

The number of seconds to delay before ringing. Type: integer (int32).

postcall_ivr_enabledboolean

Indicates whether call flow has post call routing actions enabled. Type: boolean.

postcall_ivr_idinteger

The unique identifier for the post call action to take. Type: integer (int32).

spam_thresholdinteger

The threshold level of tolerance to allow on spam (0-5). Type: integer (int32).

spam_filter_enabledboolean

Determines whether or not spam filtering is enabled. Type: boolean.

referral_numberstring

The referral number to route to for a call flow if call flow is in referral state. Type: string.

referral_end_datestring date-time

The referral date to route to for a call flow if call flow is in referral state. Type: string (date-time).

record_call_enabledboolean

Enable/disable record call feature, play_disclaimer and record_until takes precedence. Type: boolean.

isSimultaneousboolean

The isSimultaneous is used to create hunt type for a call flow and its mandatory when you are adding overflowNumbers in call flow

campaign_idinteger required

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

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

Changes

No recorded changes to this operation across all 2 revisions of this API.