---
title: "List of call flows with associated DNI settings"
method: GET
path: "/callflow/dni"
tags: ["callflow"]
---

# List of call flows with associated DNI settings

`GET /callflow/dni`

Retrieves call flows configured with Dynamic Number Insertion (DNI) for web visitor tracking. Returns call flow configurations along with DNI settings, number pools, and web integration parameters used for marketing attribution. Supports pagination and filtering.

## Query parameters

- `limit` integer
- `offset` integer
- `filter` string[]

## Response `200`

Call flows with DNI configuration, number pools, and web tracking settings

- CallflowDniResponse
  - `call_flow_id` integer — Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id.
  - `call_flow_name` string, required — Human-readable name of the call flow/route. String.
  - `call_flow_created` string, date-time — The date and time that the call flow was created. Type: string (date-time).
  - `call_flow_status` 'active' | 'inactive' — call_flow_status. Type: enum (string); Allowed values: active, inactive.
  - `repeat_interval` integer — The amount of minutes before the route can be used again. Type: integer (int32).
  - `call_value` integer — Monetary value assigned to the call by scoring/analytics. Integer (cents or whole dollars depending on account config).
  - `channel_id` integer, required — Unique identifier for the marketing channel tagged on this call. Integer. See /misc/channel for available channels.
  - `dnis` string — The unique ID assigned to an group for use with DNI. Type: string.
  - `message_enabled` boolean — Indicates whether the message feature is enabled or not. Type: boolean.
  - `message` string — SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).
  - `default_ringto` string — The default number to route to for a call flow should be 10 number. Type: string.
  - `group_id` integer, required — Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.
  - `email_to_notify` string — The e-mail address(es) to notify for call flow. Type: string.
  - `play_disclaimer` 'before' | 'after' | 'never' — Identifies whether to play the disclaimer message or not. Type: enum (string); Allowed values: before, after, never.
  - `created_at` string, date-time — The date and time at which the call flow was created. Type: string (date-time).
  - `updated_at` string, date-time — The date and time at which the call flow was last updated. Type: string (date-time).
  - `voicemail_greeting` string — The greeting to play if voicemail feature is enabled. Type: string.
  - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature. Type: boolean.
  - `voicemail_rings` integer — The unique identifier for the rings for Voicemail (1-10). Filter will not apply for voicemail_rings. Type: integer (int32).
  - `routable_id` integer — The routable_id is used to get route info. Type: integer (int32).
  - `routable_type` 'SimpleRoute' | 'IvrRoute2' | 'PercentageBasedRoute' | 'ScheduleRoute' | 'GeoRoute' | 'OutboundRoute' | 'HangupRoute', required — routable_type. Type: enum (string); Allowed values: SimpleRoute, IvrRoute2, PercentageBasedRoute, ScheduleRoute, GeoRoute, OutboundRoute, HangupRoute.
  - `webhook_enabled` boolean — Indicates whether or not a call flow uses webhooks. Type: boolean.
  - `record_until` string, date-time — The date and time to record until. Type: string (date-time).
  - `whisper_enabled` boolean — Indicates whether or not whisper messaging is enabled. Type: boolean.
  - `whisper_message` string — The message that should be played for the whisper or unique reference id. Type: string.
  - `ring_delay` integer — The number of seconds to delay before ringing. Type: integer (int32).
  - `postcall_ivr_enabled` boolean — Indicates whether call flow has post call routing actions enabled. Type: boolean.
  - `postcall_ivr_id` integer — The unique identifier for the post call action to take. Type: integer (int32).
  - `spam_threshold` integer — The threshold level of tolerance to allow on spam (0-5). Type: integer (int32).
  - `spam_filter_enabled` boolean — Determines whether or not spam filtering is enabled. Type: boolean.
  - `referral_number` string — The referral number to route to for a call flow if call flow is in referral state. Type: string.
  - `referral_end_date` string, date-time — The referral date to route to for a call flow if call flow is in referral state. Type: string (date-time).
  - `record_call_enabled` boolean — Enable/disable record call feature, play_disclaimer and record_until takes precedence. Type: boolean.
  - `hunt_type` string — This is uniquely identified the hunt type for a call flow. Type: string.
  - `overflowNumbers` OverflowNumbers[] — overflowNumbers. Type: array of object (overflowNumbers).
    - `overflowNumber` integer, required — The unique identifier for the overflowNumber. Type: integer (int32).
    - `rings` integer, required — The unique identifier for the rings for overflowNumber. Type: integer (int32).
  - `dni` DniSetting[] — dni. Type: array of object (DniSetting).
    - `dni_code` string — Unique randomly generated ID key. Type: string.
    - `custom_cookie` string — Optional additional parameters. Type: string.
    - `group_id` integer, required — Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.
    - `destination_url` string, required — The domain of the intended destination. Type: string.
    - `dni_type` 'session' | 'single' | 'URL' | 'url' | 'Source' | 'source', required — Specifies the type of DNI being used for this configuration. Type: enum (string); Allowed values: session, single, URL, url, Source, source.
    - `dni_element` string, required — The HTML element which is used for the DNI operation. Type: string.
    - `call_flow_id` integer, required — Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id.
    - `referrer` string, required — The domain from which the page was referred from. Type: string.
    - `referrer_type` string — Specifies the type of referrer used. Type: string.
    - `TTL` integer — Time to Live in minutes Max - 525,600 min. Type: integer (int32).

## Other responses

- `default` — Unexpected error

---

[API](https://skmtc.net/convirza/apis/convirza-apis.md) · [All operations](https://skmtc.net/convirza/apis/convirza-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/convirza/convirza-apis/versions/ccf9bbe34f5a/schema)