--- title: "List of call flows with location information belonging to the user group and all children" method: GET path: "/callflow/location" tags: ["callflow"] --- # List of call flows with location information belonging to the user group and all children `GET /callflow/location` 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. ## Query parameters - `limit` integer - `offset` integer - `filter` string[] ## Response `200` Call flows with geographic routing configurations and location data - CallflowLocationResponse[] - `call_flow_id` integer — Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id. - `call_flow_name` string, required — Human-readable name of the call flow/route. String. - `call_flow_created` string, 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_interval` integer — The amount of minutes before the route can be used again. Type: integer (int32). - `call_value` integer — Monetary value assigned to the call by scoring/analytics. Integer (cents or whole dollars depending on account config). - `channel_id` integer, required — Unique identifier for the marketing channel tagged on this call. Integer. See /misc/channel for available channels. - `dnis` string — The unique ID assigned to an group for use with DNI. Type: string. - `message_enabled` boolean — Indicates whether the message feature is enabled or not. Type: boolean. - `message` string — SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated). - `default_ringto` string — The default number to route to for a call flow should be 10 number. Type: string. - `group_id` integer, required — Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs. - `email_to_notify` string — 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_at` string, date-time — The date and time at which the call flow was created. Type: string (date-time). - `updated_at` string, date-time — The date and time at which the call flow was last updated. Type: string (date-time). - `voicemail_greeting` string — The greeting to play if voicemail feature is enabled. Type: string. - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature. Type: boolean. - `voicemail_rings` integer — The unique identifier for the rings for Voicemail (1-10). Filter will not apply for voicemail_rings. Type: integer (int32). - `routable_id` integer — 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_enabled` boolean — Indicates whether or not a call flow uses webhooks. Type: boolean. - `record_until` string, date-time — The date and time to record until. Type: string (date-time). - `whisper_enabled` boolean — Indicates whether or not whisper messaging is enabled. Type: boolean. - `whisper_message` string — The message that should be played for the whisper or unique reference id. Type: string. - `ring_delay` integer — The number of seconds to delay before ringing. Type: integer (int32). - `postcall_ivr_enabled` boolean — Indicates whether call flow has post call routing actions enabled. Type: boolean. - `postcall_ivr_id` integer — The unique identifier for the post call action to take. Type: integer (int32). - `spam_threshold` integer — The threshold level of tolerance to allow on spam (0-5). Type: integer (int32). - `spam_filter_enabled` boolean — Determines whether or not spam filtering is enabled. Type: boolean. - `referral_number` string — The referral number to route to for a call flow if call flow is in referral state. Type: string. - `referral_end_date` string, 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_enabled` boolean — Enable/disable record call feature, play_disclaimer and record_until takes precedence. Type: boolean. - `hunt_type` string — This is uniquely identified the hunt type for a call flow. Type: string. - `overflowNumbers` OverflowNumbers[] - `overflowNumber` integer, required — The unique identifier for the overflowNumber. Type: integer (int32). - `rings` integer, required — The unique identifier for the rings for overflowNumber. Type: integer (int32). - `location` Location[] - `location_id` integer — The unique identifier for the location record. Type: integer (int32). - `group_id` integer, required — Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs. - `location_name` string, required — User defined name for the location. Type: string. - `location_active` boolean — Whether or not the location is currently active. Type: boolean. - `location_created` string, date-time — The date and time when the location record was created. Type: string (date-time). - `location_modified` string, date-time — The date and time when the location record was last updated. Type: string (date-time). - `routes` object[] — routes. Type: array of object. - `location_route_id` integer — The unique identifier for the location route record. Type: integer (int32). - `location_id` integer — The unique identifier for the location record which the route belongs to. Type: integer (int32). - `route_location` string, required — The user given name for the location route. Type: string. - `route_address` string — The street address of the location route. Type: string. - `route_city` string — The city for the location route. Type: string. - `route_state` string — The state or province for the location route. Type: string. - `route_zip` string, required — The zipcode for the location route. Type: string. - `route_target` integer — A phone number that is the target for this route. Type: integer (int64). - `route_claimed_zip` string — Defined zip codes that location route is inclusive of. Type: string. - `route_latitude` number, float — The geospatial horizontal location of the route. Type: number (float). - `route_longitude` number, float — The geospatial vertical location of the route. Type: number (float). - `route_created` string, date-time — The date and time when the location route was created. Type: string (date-time). - `route_modified` string, date-time — The date and time when the location route was last updated. Type: string (date-time). - `route_active` boolean — Indicates whether or not the location route is active. Type: boolean. ## Other responses - `default` — Unexpected error --- [API](https://skmtc.net/convirza/apis/convirza-apis.md) · [All operations](https://skmtc.net/convirza/apis/convirza-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/convirza/convirza-apis/versions/ccf9bbe34f5a/schema)