Skip to content

Each tool lists the inputs your assistant can send. You do not type these yourself: ask in plain language and the assistant fills them in.

Tool name: teleflows_list_routing_plans

Lists routing plans your API key can access (name and routing mode).

Use it to find a plan by name and get its ID. For a plan’s routes use teleflows_get_routing_plan; for the campaigns that use a plan use teleflows_find_usages or teleflows_list_campaigns with routing_plan_id.

Inputs

Input Details Description
search string; up to 200 characters Text to match; partial matches of 3 or more characters work.
sort string; newest_first, oldest_first; default newest_first Order by creation time.
page integer; 1 to 100000; default 1 Page number, from 1.
page_size integer; 1 to 100; default 20 Records per page, 1-100.

Tool name: teleflows_get_routing_plan

Gets one routing plan by ID, optionally with its routes (include).

Each route has a type, priority, weight, concurrency cap and duplicate settings (dedup_seconds, on_duplicate). Teleflows does not return where a route sends calls: routes carry settings only. To see which routes use a target, ring tree or target group, use teleflows_find_usages on that target, ring tree or group. How priority and weight are applied is not documented by Teleflows.

Inputs

Input Details Description
plan_id string; required; 36 characters The routing plan ID (UUID).
include array; routes Related data to add; each part is fetched only when listed.
routes_page integer; 1 to 100000; default 1 Page number, from 1.

Tool name: teleflows_list_targets

Lists targets (call destinations) your API key can access: name, destination (a phone number or SIP address), type, active flag, timezone, connection timeout and caps.

Use it to find a target by name, list active SIP targets, or those with a health check. A target record has no buyer field; buyer_id and has_buyer filters are the only link to buyers. Only the has_health_check flag exists: live health results for targets are not available. Caps may be null or -1; their meaning is not documented for targets.

Inputs

Input Details Description
is_active boolean Only active or only inactive targets.
destination_type string; number, sip Destination kind.
has_health_check boolean Only targets with or without a health check.
has_buyer boolean Only targets with or without a buyer.
buyer_id string; 36 characters The buyer ID (UUID).
created_after string; up to 40 characters Only records created at or after this moment (inclusive): date-time with timezone, e.g. 2026-10-01T00:00:00Z.
created_before string; up to 40 characters Only records created at or before this moment (inclusive): date-time with timezone, e.g. 2026-10-31T23:59:59Z.
search string; up to 200 characters Text to match; partial matches of 3 or more characters work.
sort string; newest_first, oldest_first; default newest_first Order by creation time.
page integer; 1 to 100000; default 1 Page number, from 1.
page_size integer; 1 to 100; default 20 Records per page, 1-100.

Tool name: teleflows_list_target_groups

Lists target groups your API key can access (name, active flag, simultaneous-dial flag, timezone, caps).

Use it to find a group by name. For a group’s members use teleflows_get_record with record_type target_group; for where it is used use teleflows_find_usages.

Inputs

Input Details Description
search string; up to 200 characters Text to match; partial matches of 3 or more characters work.
sort string; newest_first, oldest_first; default newest_first Order by creation time.
page integer; 1 to 100000; default 1 Page number, from 1.
page_size integer; 1 to 100; default 20 Records per page, 1-100.

Tool name: teleflows_list_ring_trees

Lists ring trees your API key can access (name, timezone, dial timeout, ping timeout).

Use it to find a ring tree by name. For its members use teleflows_get_record with record_type ring_tree; for where it is used use teleflows_find_usages.

Inputs

Input Details Description
search string; up to 200 characters Text to match; partial matches of 3 or more characters work.
sort string; newest_first, oldest_first; default newest_first Order by creation time.
page integer; 1 to 100000; default 1 Page number, from 1.
page_size integer; 1 to 100; default 20 Records per page, 1-100.

Tool name: teleflows_list_ring_tree_targets

Lists ring tree targets your API key can access (name, display ID, status).

Use it to find one by name before checking its health with teleflows_get_ring_tree_target. The buyer and revenue-trigger filters refer to data not shown in the results, so their effect cannot be checked from the list.

Inputs

Input Details Description
buyer_id string; 36 characters The buyer ID (UUID).
has_buyer boolean Only with or without a buyer.
revenue_trigger string; CONNECTED, CALL_LENGTH, DIALED, POSTBACK_WEBHOOK Revenue trigger.
search string; up to 200 characters Text to match; partial matches of 3 or more characters work.
sort string; newest_first, oldest_first; default newest_first Order by creation time.
page integer; 1 to 100000; default 1 Page number, from 1.
page_size integer; 1 to 100; default 20 Records per page, 1-100.

Tool name: teleflows_get_ring_tree_target

Gets one ring tree target by ID with its health: cap usage (used vs maximum per concurrency, hour, day and month; a maximum of -1 means unlimited), ping latency (median and 95th percentile) and saved ping results in a time window (default the last 24 hours, at most 31 days).

Use it for “is this target near its cap / slow / failing pings”. It reads saved results only and never sends a ping. Raw ping request and response bodies are not available. Which ring trees use this target: teleflows_find_usages.

Inputs

Input Details Description
ring_tree_target_id string; required; 36 characters The ring tree target ID (UUID).
include array; cap_usage, latency, pings Parts to return; default: all.
since string; up to 40 characters Start of the window (inclusive): date-time with timezone, or YYYY-MM-DD meaning 00:00 UTC that day. Default: 24 hours before until.
until string; up to 40 characters End of the window (exclusive): date-time with timezone, or YYYY-MM-DD meaning 00:00 UTC that day, not included. Example: yesterday on 2026-10-01 is since 2026-09-30, until 2026-10-01. Default: now. At most 31 days after since; longer windows are rejected.
pings_page integer; 1 to 100000; default 1 Page number, from 1.
ping_id string; 36 characters Fetch one saved ping by ID; include and the time window are not needed with it.