Get Provisioned Route Details

GET

https://platform-api.convirza.com/v3/provisioned-routes/{provisioned_route_id}

Provisioned Routes

Last modified:2026-04-03 14:27:57

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

Response Includes

Route identity — name, status, organization unit

Routing configuration — forwarding number, routing type (simple, IVR, geo, round-robin), 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

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

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

Complete provisioned route configuration retrieved successfully

Body

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/provisioned-routes/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "provisioned_route_id": "12345",
        "provisioned_route_name": "Spring Campaign - Organic",
        "provisioned_route_status": "active",
        "org_unit_id": 70035,
        "repeat_interval": 30,
        "conversion_value": 150,
        "routing_configuration": {
            "routing_type": "simple",
            "config": {
                "default_ringto": "2025551234",
                "activate_voice_prompt": true,
                "voice_prompt": "Thank you for calling. Please wait while we connect your call.",
                "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"
            }
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-03-27T10:30:00.000Z"
}

Modified at 2026-04-03 14:27:57

Create Provisioned Route

Delete Provisioned Route