Create DNI Setting

Creates a new Dynamic Number Insertion (DNI) setting for a provisioned route.

Access Control

Requires valid JWT authentication

User must have access to the specified group and provisioned route

Provisioned route must be active

Behavior

Automatically creates dni_org_unit entry if it doesn't exist

Deletes any existing DNI settings for the provisioned route before creating new one

Updates custom_params in dni_org_unit if custom_cookie is provided

For number pools with TTL, updates phone_pool keep_alive_mins

DNI Types

session: Typically used for number pools

source: Typically used for tracking numbers

url: Typically used for tracking numbers with lmc_track element

Required Fields

org_unit_id — Org unit ID

provisioned_route_id — Tracking number or number pool ID

destination_url — Host domain (e.g., example.com)

dni_element — CSS selector/HTML class (e.g., .phone-number)

referrer — Referring website (e.g., google.com)

Optional Fields

dni_setting_name — Display name for this DNI configuration

dni_type — Defaults to 'session'

referrer_type — paid/organic (only for Google/Yahoo)

custom_cookie — Custom tracking parameters

identifier — Text placeholder to replace with tracking number

dni_keywords — Keywords for categorization

dni_number_format — Phone number display format

dni_ttl — Time to live in minutes (only for number pools)

Validation Rules

destination_url and referrer must be valid domain format

dni_element for 'url' type must be 'lmc_track'

dni_element for 'session'/'source' cannot be 'lmc_track' or empty

referrer_type (paid/organic) only applies to Google or Yahoo referrers

TTL must be between 1 and 525600 minutes (optional field)

Referrer-element-destination combination must be unique

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://platform-api.convirza.com/v3/dni/create' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "dni_setting": { "destination_url": "mycompany.com", "dni_setting_name": "Google Ads - Q1 Campaign", "referrer": "*.google.*", "referrer_type": "paid", "dni_element": ".contact-phone", "dni_type": "source", "dni_number_format": "(xxx) xxx-xxxx", "dni_keywords": "google,ppc,adwords", "custom_cookie": "utm_source,utm_campaign,utm_medium", "org_unit_id": 70035, "identifier": "", "provisioned_route_id": "12345" } }'

Create DNI Setting

Request

Responses