Get Provisioned Route Details

Retrieves the complete configuration for a single provisioned route by its unique identifier.

Response Includes

Route identity — name, status, organization unit

External identifiers — campaign_ext_id, org_unit_ext_id, ad_source_id for integration with external systems

Organization details — org_unit_id, org_unit_ext_id, org_unit_name (organization unit name)

Campaign association — campaign_id, campaign_ext_id, campaign_name (null if no campaign)

DNI settings — dni_data, dni_enabled (always included, empty arrays/false if no DNI configured)

Routing configuration — forwarding number, routing type (simple, ivr, georoute, percentage, outbound, voicemail, schedule, hangup), ring strategy

Call handling — voice prompt, whisper message, first-time-caller whisper, voicemail fallback

Advanced features — SMS forwarding, AI voice agent integration, ODN (Originally Dialed Number)

Overflow numbers and hunt group settings

All tracking phone numbers assigned to this route (including sms_feature per number)

Number pool details if the route uses a number pool (pool name, TTL, phone numbers)

Common Use Cases

Inspect or audit a specific route's settings before making changes

Export configuration for documentation or compliance

Troubleshoot unexpected call routing behavior

Integrate with external CRM or marketing platforms using external identifiers

Note: This endpoint always includes DNI data (unlike the list endpoint where it's optional via ?include=dni_data). Matches api2 /v1/cai/tndetail/:id format.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "code": 200, "message": "Success", "data": { "provisioned_route_id": "12345", "provisioned_route_name": "Spring Campaign - Organic", "provisioned_route_status": "active", "org_unit_id": 70035, "org_unit_ext_id": "ORG-12345", "org_unit_name": "Sales Department", "repeat_interval": 30, "conversion_value": 150, "campaign_id": 789, "campaign_name": "Spring 2026 Campaign", "campaign_ext_id": 456, "ad_source_id": 5, "routing_configuration": { "routing_type": "simple", "config": { "default_ringto": "2025551234", "activate_voice_prompt": true, "voice_prompt": "file", "activate_whisper_message": true, "whisper_message": "Inbound lead from Google Ads", "activate_voicemail": false, "voicemail_message": "Please leave your name and number after the tone." } }, "sms_enabled": true, "phone_numbers": [ { "phone_number": "4058737820", "number_id": "98765", "sms_feature": "enabled" } ], "dni_data": [ { "dni_org_unit": [ { "org_unit_id": 70035, "custom_params": "utm_source={{source}}&utm_medium={{medium}}", "dni_code": "dni_abc123" } ], "dni_settings": [ { "dni_setting_id": 123, "dni_setting_name": "Homepage DNI - Google Ads", "provisioned_route_id": 8790, "org_unit_id": 70035, "destination_url": "https://example.com/landing-page", "dni_type": "static", "referrer": "google.com", "referrer_type": "contains", "dni_element": "span#phone-number", "dni_keywords": "google ads, ppc", "dni_number_format": "(XXX) XXX-XXXX", "identifier": "dni_code_abc123", "number": "Sales Pool", "dni_ttl": 30, "pool_id": 456 } ] } ], "dni_enabled": true, "number_pool": { "pool_id": 456, "pool_name": "Sales Pool - March Campaign", "keep_alive_mins": 30, "number_count": 10, "status": "active", "phone_numbers": [ { "phone_number": "8001234567", "number_id": "8001234567", "number_type": "DID", "vendor_id": 1, "resporg_id": "RESPORG123" } ] } }, "request_id": "550e8400-e29b-41d4-a716-446655440000", "timestamp": "2026-03-27T10:30:00.000Z" }

Get Provisioned Route Details

Request

Responses