Create Provisioned Route

POST

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

Provisioned Routes

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

Creates a new call-routing tracking number with a complete, production-ready configuration.

Configurable on Creation

Identity — route name, status (active / inactive), organization unit

Call Routing — forwarding number, ring strategy (simple, round-robin, simultaneous)

Call Handling — voice prompt, whisper message, first-time-caller whisper, voicemail greeting

Spam Protection — spam protection enable/disable, FTC whisper messages

SMS — enable SMS forwarding with assigned users and notification preferences

AI Voice Agent — attach an AI voice agent with configurable ring count

Analytics — conversion value, repeat interval, webhook integration

Phone Numbers — assign one or more tracking numbers at creation time

Roles required: Admin or Standard. ReadOnly users cannot create routes.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Route created successfully — returns the new route ID and a confirmation message

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://platform-api.convirza.com/v3/provisioned-routes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "provisioned_route_name": "Route 1",
    "provisioned_route_status": "active",
    "call_value": 100,
    "repeat_interval": 30,
    "org_unit_id": 70035,
    "webhook_id": 1,
    "sms_enabled": true,
    "spam_enabled": true,
    "sms_settings": {
        "assigned_users": [
            84784,
            7849,
            849,
            849
        ],
        "sms_notifications": true,
        "email_notifications": true,
        "unclaimed_sms": true
    },
    "customSourceList": [
        {
            "custom_source_id": "1080",
            "custom_source_type": "CS1"
        },
        {
            "custom_source_id": "1228",
            "custom_source_type": "CS2"
        }
    ],
    "routing_configuration": {
        "routing_type": "simple",
        "config": {
            "ringto": "1111111111",
            "isSimultaneousRing": false,
            "click_to_call_enabled": false,
            "dnis_as_cid": "phone_number",
            "voice_prompt": "Thank you for calling. Please wait while we connect your call.",
            "whisper_enabled": true,
            "whisper_type": "file",
            "whisper_message": "Whisper message 1",
            "ftc_whisper_enabled": "1",
            "ftc_whisper_type": "file",
            "ftc_whisper_message": "qLMcUEqb_1660813454043",
            "message_enabled": "1",
            "message_type": "file",
            "message": "fBiYF5MG_1674141425479",
            "activate_voicemail": false,
            "voicemail_greeting": "Please leave a message after the beep.",
            "activate_voiceagent": true,
            "is_ODN_enabled": false,
            "click_to_call": true,
            "play_disclaimer": "before",
            "play_on_hold_enabled": false,
            "play_on_hold_message": "",
            "play_on_hold_message_type": "",
            "record_call": true,
            "overflowNumbers": [
                {
                    "number": "(111)-111-1110",
                    "rings": "3",
                    "overflow_order": 1,
                    "unmaskNumber": "1111111110",
                    "overflowNumber": "1111111110"
                }
            ],
            "assigned_agent_id": null,
            "route_voice_agent_enabled": true,
            "voice_agent_rings_count": 3,
            "voice_agent_id": 683,
            "voicemail_rings_count": "3",
            "hunt_options": {
                "type": "round_robin",
                "options": [
                    {
                        "destination": "1234567890",
                        "order": 1
                    },
                    {
                        "destination": "0987654321",
                        "order": 2
                    }
                ]
            }
        }
    },
    "phone_numbers": [
        {
            "phone_number_id": 12345,
            "phone_number": "1234567890"
        }
    ]
}'

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-04-03 14:27:57

List Provisioned Routes

Get Provisioned Route Details