v1

latestSwagger 2.02026-08-06114161439.7 KB

callflow

List of call flows with location information belonging to the user group and all children

Retrieves call flows with geographic location and geo-routing information. Returns call flow configurations along with location-based routing rules that direct calls based on caller geography. Supports pagination and filtering.

get/callflow/location

Query parameters

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

URL-encoded comma-separated list of filter conditions in the form '<field> <op> <value>' where op is one of =, !=, <=, >=, >, <, like (spaces required around 'like'). Example: 'call_started > 2024-01-01'. Max 10 conditions. Filterable fields vary by endpoint.

Response

Call flows with geographic routing configurations and location data

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

hunt_typestring

This is uniquely identified the hunt type for a call flow. Type: string.