v1

latestSwagger 2.02026-08-06114161439.7 KB

callflow

Create a new DNI settings record entry

Creates Dynamic Number Insertion settings for call flows to enable web visitor-level call tracking. Configures number pools and insertion parameters that dynamically display different tracking numbers to website visitors based on their session.

post/callflow/dni

Request body

dni_codestring

Unique randomly generated ID key. Type: string.

custom_cookiestring

Optional additional parameters. Type: string.

group_idinteger required

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

destination_urlstring required

The domain of the intended destination. Type: string.

Specifies the type of DNI being used for this configuration. Type: enum (string); Allowed values: session, single, URL, url, Source, source.

dni_elementstring required

The HTML element which is used for the DNI operation. Type: string.

call_flow_idinteger required

Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id.

referrerstring required

The domain from which the page was referred from. Type: string.

referrer_typestring

Specifies the type of referrer used. Type: string.

TTLinteger

Time to Live in minutes Max - 525,600 min. Type: integer (int32).

Response

Created DNI setting IDs with confirmation status for each configuration

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

datastring required

Response payload. Shape varies by endpoint.

entry_countinteger required

The sequential number of the entry in the submitted array. Type: integer (int32).