List DNI Settings

GET

https://platform-api.convirza.com/v3/dni

DNI

Last modified:2026-07-24 13:10:44

Returns a list of Dynamic Number Insertion (DNI) settings.

Access Control

Requires valid JWT authentication

Returns DNI settings within user's organizational scope

Only returns active DNI settings with provisioned routes

Filtering

provisioned_route_id — Filter by specific provisioned route ID

dni_type — Filter by DNI type (e.g., SWAP, POOL)

destination_url — Filter by destination URL (partial match)

org_unit_id — Filter by org unit ID

Pagination

limit — Records per page (max 1000, default 100)

offset — Number of records to skip (default 0)

Sorting

sort_by — Field to sort by (call_flow_name, dni_type, destination_url) - default: call_flow_name

sort_order — Sort direction (asc, desc) - default: asc

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200

application/json

DNI settings retrieved successfully

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/dni?limit=&offset=&provisioned_route_id=&dni_type=&destination_url=&org_unit_id=&sort_by=&sort_order=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "success",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-04-22T10:30:00.000Z",
    "data": {
        "dni_settings": [
            {
                "dni_setting_id": 456,
                "dni_setting_name": "Google Paid Campaign",
                "provisioned_route_id": 123,
                "org_unit_id": 70035,
                "destination_url": "https://example.com/landing",
                "dni_type": "SWAP",
                "dni_element": ".phone-number",
                "referrer": "google",
                "referrer_type": "organic",
                "dni_active": true,
                "last_verified": "2023-06-15T08:00:00.000Z",
                "dni_setting_created": "2023-01-15T10:35:00.000Z",
                "dni_setting_modified": "2023-06-15T08:00:00.000Z",
                "identifier": "PHONE_NUMBER",
                "dni_keywords": "google:paid:campaign",
                "dni_number_format": "(xxx) xxx-xxxx",
                "dni_code": "ABC123",
                "custom_params": "utm_source,utm_campaign",
                "dni_ttl": 30
            }
        ],
        "total_count": 1,
        "offset": 0,
        "limit": 100
    }
}

Modified at 2026-07-24 13:10:44

Delete Custom Sources (Single or Multiple)

Update DNI Setting