Create Provisioned Route
POST
https://platform-api.convirza.com/v3/provisioned-routes
Provisioned Routes
Last modified:2026-08-14 11:01:44
active / inactive), organization unitnumber_pool object (pool-based session tracking with TTL)Note: Number pools can be used with ANY routing type (simple, IVR, geo, outbound, etc.). The phone_numbersandnumber_poolfields are mutually exclusive - use one or the other, not both.
Roles required: AdminorStandard. ReadOnly users cannot create routes.
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://platform-api.convirza.com/v3/provisioned-routes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"provisioned_route_name": "Complete IVR with All Route Types",
"provisioned_route_status": "active",
"campaign_id": 100,
"ad_source_id": 56,
"org_unit_id": 70035,
"webhook_id": 892,
"call_value": 150,
"repeat_interval": 34,
"caller_survey_id": 75,
"agent_survey_id": 206,
"custom_source_list": [
{
"custom_source_id": "1080",
"custom_source_type": "CS1"
}
],
"phone_numbers": [
{
"phone_number_id": 12345,
"phone_number": "8005551234"
}
],
"spam_enabled": true,
"sms_enabled": false,
"sms_settings": {
"assigned_users": [],
"sms_notifications": false,
"email_notifications": false,
"unclaimed_sms": false
},
"dni_settings": [
{
"org_unit_id": 70035,
"dni_setting_name": "IVR Route DNI - Google Ads",
"destination_url": "example.com",
"dni_type": "session",
"dni_element": ".phone-number",
"referrer": "google.com",
"referrer_type": "paid",
"custom_cookie": "utm_source,utm_medium,utm_campaign",
"identifier": "PHONE_NUMBER",
"dni_keywords": "google,ads,ppc",
"dni_number_format": "(xxx) xxx-xxxx",
"dni_ttl": 30
}
],
"routing_configuration": {
"routing_type": "ivr",
"config": {
"voice_prompt_id": 12345,
"prompt_enabled": true,
"record_call": true,
"dnis_as_cid": "phone_number",
"click_to_call_enabled": true,
"whisper_enabled": true,
"whisper_id": 67890,
"ftc_whisper_enabled": true,
"ftc_whisper_id": 78901,
"play_disclaimer": "before",
"play_on_hold_enabled": true,
"play_on_hold_id": 11111,
"accept_answer": true,
"activate_voicemail": true,
"voicemail_message_id": 99999,
"voicemail_rings_count": "5",
"is_ODN_enabled": true,
"ivr_options": [
{
"key_press": 1,
"destination": "Simple Route - Full Options",
"org_unit_id": 70035,
"action_order": 1,
"action": "simple",
"keywords": [
"sales",
"buy",
"purchase",
"pricing"
],
"repeat_interval": 5000,
"dnis_as_cid": true,
"record_enabled": true,
"play_disclaimer": "before",
"target_did": "1000000000",
"overflow_numbers": [
{
"overflow_number": "2000000000",
"overflow_order": 1,
"rings": 5
},
{
"overflow_number": "3000000000",
"overflow_order": 2,
"rings": 5
}
],
"voice_prompt_id": 23456,
"prompt_enabled": true,
"activate_voicemail": true,
"whisper_enabled": true,
"whisper_id": 34567,
"ftc_whisper_enabled": true,
"ftc_whisper_id": 45678,
"accept_answer": true,
"play_on_hold_enabled": true,
"play_on_hold_id": 56789,
"route_voice_agent_enabled": false
},
{
"key_press": 2,
"destination": "Round Robin",
"org_unit_id": 70035,
"action_order": 2,
"action": "roundrobin",
"keywords": [
"support",
"help",
"assistance"
],
"record_enabled": true,
"play_disclaimer": "before",
"overflow_numbers": [
{
"overflow_number": "1300000000",
"overflow_order": 1,
"rings": 3
},
{
"overflow_number": "1400000000",
"overflow_order": 2,
"rings": 3
}
],
"voice_prompt_id": 23456,
"prompt_enabled": true,
"activate_voicemail": true,
"whisper_enabled": true,
"whisper_id": 34567,
"ftc_whisper_enabled": true,
"ftc_whisper_id": 45678,
"accept_answer": true,
"play_on_hold_enabled": true,
"play_on_hold_id": 56789,
"route_voice_agent_enabled": false
},
{
"key_press": 3,
"destination": "Simultaneous Ring",
"org_unit_id": 70035,
"action_order": 3,
"action": "simultaneous",
"keywords": [
"urgent",
"emergency",
"immediate"
],
"record_enabled": true,
"play_disclaimer": "before",
"overflow_numbers": [
{
"overflow_number": "1400000000",
"overflow_order": 1,
"rings": 3
},
{
"overflow_number": "1500000000",
"overflow_order": 2,
"rings": 3
}
],
"voice_prompt_id": 23456,
"prompt_enabled": true,
"activate_voicemail": true,
"whisper_enabled": true,
"whisper_id": 34567,
"ftc_whisper_enabled": true,
"ftc_whisper_id": 45678,
"accept_answer": true,
"play_on_hold_enabled": true,
"play_on_hold_id": 56789,
"route_voice_agent_enabled": false
},
{
"key_press": 4,
"destination": "Voicemail",
"org_unit_id": 70035,
"action_order": 4,
"action": "voicemail",
"keywords": [
"voicemail",
"message",
"leave"
],
"record_enabled": false,
"play_disclaimer": "before",
"voicemail_message_id": 12345,
"voicemail_rings_count": "3",
"voice_prompt_id": 23456,
"prompt_enabled": true,
"activate_voicemail": true,
"route_voice_agent_enabled": false
},
{
"key_press": 5,
"destination": "Geo Route - Location Based",
"org_unit_id": 70035,
"action_order": 5,
"action": "geo",
"keywords": [
"location",
"nearby",
"local",
"store"
],
"record_enabled": true,
"play_disclaimer": "after",
"geo_data": {
"geo_opt": {
"default_ringto": "5000000000",
"location_ids": [
104,
105,
106
]
},
"geo_rt": {
"strategy": "claimedState",
"radius": 50
}
},
"voice_prompt_id": 23456,
"prompt_enabled": true,
"activate_voicemail": true,
"whisper_enabled": true,
"whisper_id": 34567,
"ftc_whisper_enabled": true,
"ftc_whisper_id": 45678,
"accept_answer": true,
"play_on_hold_enabled": true,
"play_on_hold_id": 56789,
"overflow_numbers": [],
"route_voice_agent_enabled": false
},
{
"key_press": 6,
"destination": "Percentage Route",
"org_unit_id": 70035,
"action_order": 6,
"action": "percentage",
"keywords": [
"random",
"any"
],
"record_enabled": true,
"play_disclaimer": "before",
"ringto_percentage": [
{
"percentage": 60,
"route_order": 1,
"ringto": "6000000000",
"activate_voicemail": true,
"simultaneous_rings": false,
"overflow_numbers": [
{
"overflow_number": "6100000000",
"overflow_order": 1,
"rings": "3",
"unmask_number": "6100000000"
}
],
"play_on_hold_enabled": false,
"route_voice_agent_enabled": false
},
{
"percentage": 40,
"route_order": 2,
"ringto": "7000000000",
"activate_voicemail": false,
"simultaneous_rings": false,
"overflow_numbers": [],
"play_on_hold_enabled": false,
"route_voice_agent_enabled": false
}
],
"voice_prompt_id": 23456,
"prompt_enabled": true,
"activate_voicemail": true,
"whisper_enabled": true,
"whisper_id": 34567,
"ftc_whisper_enabled": true,
"ftc_whisper_id": 45678,
"accept_answer": true,
"play_on_hold_enabled": true,
"play_on_hold_id": 56789,
"route_voice_agent_enabled": false
},
{
"key_press": 7,
"destination": "Schedule Route - Time Based",
"org_unit_id": 70035,
"action_order": 7,
"action": "schedule",
"keywords": [
"hours",
"schedule",
"time",
"availability"
],
"record_enabled": true,
"play_disclaimer": "before",
"schedule_route": {
"timezone": "America/New_York",
"default_ringto": "8000000000",
"activate_voicemail": true,
"route_voice_agent_enabled": false,
"schedules": [
{
"from_time": "09:00 AM",
"to_time": "05:00 PM",
"ring_to": "8100000000",
"days": [
{
"id": 1,
"name": "Monday"
},
{
"id": 2,
"name": "Tuesday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 4,
"name": "Thursday"
},
{
"id": 5,
"name": "Friday"
}
],
"overflow_numbers": [
{
"overflow_number": "8200000000",
"overflow_order": 1,
"rings": "3",
"unmask_number": "8200000000"
}
],
"simultaneous_rings": false,
"activate_voicemail": true,
"play_on_hold_enabled": false,
"route_voice_agent_enabled": false
},
{
"from_time": "05:00 PM",
"to_time": "End of Day",
"ring_to": "8300000000",
"days": [
{
"id": 1,
"name": "Monday"
},
{
"id": 2,
"name": "Tuesday"
},
{
"id": 3,
"name": "Wednesday"
},
{
"id": 4,
"name": "Thursday"
},
{
"id": 5,
"name": "Friday"
}
],
"overflow_numbers": [],
"simultaneous_rings": false,
"activate_voicemail": true,
"play_on_hold_enabled": false,
"route_voice_agent_enabled": false
}
]
},
"voice_prompt_id": 23456,
"prompt_enabled": true,
"activate_voicemail": true,
"whisper_enabled": true,
"whisper_id": 34567,
"ftc_whisper_enabled": true,
"ftc_whisper_id": 45678,
"accept_answer": true,
"play_on_hold_enabled": true,
"play_on_hold_id": 56789,
"route_voice_agent_enabled": false
},
{
"key_press": 0,
"destination": "Hangup",
"org_unit_id": 70035,
"action_order": 8,
"action": "hangup",
"keywords": [
"goodbye",
"exit",
"quit"
],
"record_enabled": false,
"play_disclaimer": "never",
"target_did": "hangup",
"voice_prompt_id": 23456,
"prompt_enabled": true
}
]
}
}
}'Response Response Example
201 - Example 1
{
"code": 201,
"message": "Success",
"data": {
"provisioned_route_id": 12345,
"message": "Route created successfully"
},
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2026-03-27T10:30:00.000Z"
}Modified at 2026-08-14 11:01:44