Get Call Flow by ID
GET
https://apicfa.convirza.com/v2/callflow
Call Flow
Last modified:2026-04-03 12:54:09
Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apicfa.convirza.com/v2/callflow?id' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Example 1
{
"0": {
"geo_route": {
"play_branding": false,
"radius": 1,
"strategy": "Npa",
"allow_manual_entry": true,
"options": [
{
"geo_target_did": 0,
"latitude": 0,
"longitude": 0,
"address": "string",
"city": "string",
"geo_created_at": "2019-08-24T14:15:22.123Z",
"geo_updated_at": "2019-08-24T14:15:22.123Z"
}
]
},
"ivr_route": {
"repeat_greeting": true,
"options": [
{
"ivr_option_id": 0,
"value": 0,
"ivr_target_did": 0,
"ivr_email_to_notify": "string",
"ivr_play_disclaimer": true,
"ivr_record_enabled": true,
"ivr_voicemail_enabled": true,
"ivr_webhook_enabled": true,
"ivr_message_enabled": true,
"ivr_message": "string",
"ivr_whisper_enabled": true,
"ivr_whisper_message": "string",
"ivr_created_at": "2019-08-24T14:15:22.123Z",
"ivr_updated_at": "2019-08-24T14:15:22.123Z"
}
]
},
"percentage_route": [
{
"percentage": 0,
"per_target_did": 0
}
],
"schedule_route": {
"timezone": 0,
"options": [
{
"sch_target_did": 0,
"day": 0,
"from_time": 0,
"to_time": 0,
"sch_created_at": "2019-08-24T14:15:22.123Z",
"sch_updated_at": "2019-08-24T14:15:22.123Z"
}
]
},
"outbound": {
"set_caller_id": "string",
"pin": "string"
}
},
"call_flow_id": 0,
"call_flow_name": "string",
"call_flow_created": "2019-08-24T14:15:22.123Z",
"call_flow_status": "active",
"repeat_interval": 72,
"call_value": 0,
"channel_id": 7,
"channel_category": "string",
"channel_sub_category": "string",
"channel": "string",
"dnis": "string",
"message_enabled": false,
"message": "string",
"default_ringto": "stringstri",
"group_id": 0,
"email_to_notify": "string",
"play_disclaimer": "before",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"voicemail_greeting": "string",
"voicemail_enabled": false,
"voicemail_rings": 1,
"routable_id": 0,
"routable_type": "IvrRoute2",
"webhook_enabled": false,
"record_until": "2019-08-24T14:15:22.123Z",
"whisper_enabled": false,
"whisper_message": "string",
"ring_delay": 0,
"postcall_ivr_enabled": false,
"postcall_ivr_id": 0,
"spam_threshold": 0,
"spam_filter_enabled": false,
"referral_number": "string",
"referral_end_date": "2019-08-24T14:15:22.123Z",
"record_call_enabled": true,
"hunt_type": "string",
"overflowNumbers": [
{
"overflowNumber": 1000000000,
"rings": 1
}
],
"campaign_id": 0,
"campaign_ext_id": "string",
"campaign_name": "string",
"outbound": {
"set_caller_id": "string",
"pin": "string"
},
"location": [
{
"location_id": 0,
"group_id": 1,
"location_name": "string",
"location_active": true,
"location_created": "2019-08-24T14:15:22.123Z",
"location_modified": "2019-08-24T14:15:22.123Z",
"routes": [
{
"location_route_id": 0,
"location_id": 0,
"route_location": "string",
"route_address": "string",
"route_city": "string",
"route_state": "st",
"route_zip": "strin",
"route_target": 0,
"route_claimed_zip": "string",
"route_latitude": 0,
"route_longitude": 0,
"route_created": "2019-08-24T14:15:22.123Z",
"route_modified": "2019-08-24T14:15:22.123Z",
"route_active": true
}
]
}
],
"number": {
"phone_number_id": 0,
"phone_number": 0,
"rate_center": "string",
"npa": 0,
"nxx": 0,
"ocn": 0
},
"number_pool": {
"pool_id": 0,
"pool_name": "string",
"keep_alive_minutes": 60,
"pool_created": "2019-08-24T14:15:22.123Z",
"pool_updated": "2019-08-24T14:15:22.123Z",
"phone_numbers": [
{
"last_used": "2019-08-24T14:15:22.123Z",
"number": "stringstri"
}
]
},
"call_flow_recording_id": 0,
"call_flow_recording_filename": "string",
"call_flow_recording_name": "string",
"call_flow_recording_type": "prompt",
"call_flow_recording_created": "2019-08-24T14:15:22.123Z",
"call_flow_recording_modified": "string",
"recording_active": true,
"call_action": {
"action_id": 0,
"name": "string",
"action": "email_alert",
"action_target": "string",
"call_flow_id": 0,
"action_created": "2019-08-24T14:15:22.123Z",
"action_updated": "2019-08-24T14:15:22.123Z",
"action_order": 0,
"post_process": true,
"rules": [
{
"rule_id": 0,
"data_field": "string",
"indicator_id": 0,
"operator": ">",
"comparator": "string",
"join_type": "AND",
"rule_order": 0,
"grouping": 0,
"rule_created": "2019-08-24T14:15:22.123Z"
}
]
},
"ivrs": [
{
"ivr_option_id": 0,
"key": 0,
"action": "simple",
"destination": "string",
"message": "string",
"ivrData": [
{
"ivr_option_id": 0,
"key": 0,
"action": "simple",
"destination": "string",
"message": "string",
"ivrData": [
{
"ivr_option_id": 0,
"key": 0,
"action": "simple",
"destination": "string",
"message": "string",
"geoData": {
"route_by": "Claimed State",
"proximity_limit": 1,
"location_id": 0,
"target_did": 1000000000
},
"scheduleRoute": {
"timezone": "Atlantic",
"default_ringto": 1000000000,
"voicemail_enabled": false,
"schedules": [
{
"schedule_days": [
{
"id": "AllDays"
}
],
"schedule_start_time": "string",
"schedule_end_time": "string",
"ring_to": 1000000000,
"overflowNumbers": [
{
"overflowNumber": 1000000000,
"rings": 1
}
],
"isSimultaneous": false,
"voicemail_enabled": false
}
]
},
"target_did": 1000000000,
"isSimultaneous": false,
"overflowNumbers": [
{
"overflowNumber": 1000000000,
"rings": 1
}
],
"record_enabled": false,
"play_disclaimer": "never",
"whisper_enabled": false,
"whisper_message": "string",
"voicemail_enabled": false,
"go_back_key": 0
}
],
"geoData": {
"route_by": "Claimed State",
"proximity_limit": 1,
"location_id": 0,
"target_did": 1000000000
},
"scheduleRoute": {
"timezone": "Atlantic",
"default_ringto": 1000000000,
"voicemail_enabled": false,
"schedules": [
{
"schedule_days": [
{
"id": "AllDays"
}
],
"schedule_start_time": "string",
"schedule_end_time": "string",
"ring_to": 1000000000,
"overflowNumbers": [
{
"overflowNumber": 1000000000,
"rings": 1
}
],
"isSimultaneous": false,
"voicemail_enabled": false
}
]
},
"target_did": 1000000000,
"isSimultaneous": false,
"overflowNumbers": [
{
"overflowNumber": 1000000000,
"rings": 1
}
],
"record_enabled": false,
"play_disclaimer": "never",
"whisper_enabled": false,
"whisper_message": "string",
"voicemail_enabled": false,
"go_back_key": 0
}
],
"geoData": {
"route_by": "Claimed State",
"proximity_limit": 1,
"location_id": 0,
"target_did": 1000000000
},
"scheduleRoute": {
"timezone": "Atlantic",
"default_ringto": 1000000000,
"voicemail_enabled": false,
"schedules": [
{
"schedule_days": [
{
"id": "AllDays"
}
],
"schedule_start_time": "string",
"schedule_end_time": "string",
"ring_to": 1000000000,
"overflowNumbers": [
{
"overflowNumber": 1000000000,
"rings": 1
}
],
"isSimultaneous": false,
"voicemail_enabled": false
}
]
},
"target_did": "stringstri",
"isSimultaneous": false,
"overflowNumbers": [
{
"overflowNumber": 1000000000,
"rings": 1
}
],
"record_enabled": false,
"play_disclaimer": "never",
"whisper_enabled": false,
"whisper_message": "string",
"voicemail_enabled": false
}
]
}Modified at 2026-04-03 12:54:09