Kanal

Money + engagement stats for a single campaign (attributed revenue, cost, cost_marketing, ROAS, orders, delivered/read/clicked) over a period, using the team attribution settings. cost = spend across ALL WhatsApp conversation categories, marketing AND utility (the ROAS denominator — marketing is routinely routed as utility for Meta pricing); cost_marketing = the marketing-only slice of that spend. Find campaign ids with list_campaigns.

get_campaign_stats

Lists the team's WhatsApp campaigns, most recent first: id, name, status (CREATED, SENDING, SCHEDULED, PAUSED, SENDED), scheduled date. Use the id with get_campaign_stats. Optional status filter and limit (default 25, max 100).

list_campaigns

Lists the team's WhatsApp message templates with their Meta approval status (DRAFT, PENDING, APPROVED, REJECTED) — a template must be APPROVED before it can be sent in a campaign. Also returns category (MARKETING, UTILITY, AUTHENTICATION) and language.

list_templates

Lists the team's audience building blocks with contact counts: segments (dynamic, condition-based) and groups (static lists). Both can be used as a campaign audience. Counts are WhatsApp-reachable contacts, exactly like the Kanal UI: a group can also hold Instagram-only profiles, which are not counted here and are skipped when a WhatsApp campaign is sent to that group.

list_segments_and_groups

Lists the team's automations (visual flows): id, name, trigger type (kanal_keyword, shopify_order_created, shopify_abandoned_checkout…), active status. Use the id with get_automation_stats. Optional is_active filter and limit (default 25, max 100).

list_automations

Lists the team's inbox conversations across channels, most recent first: contact id, name, the channels that conversation uses, phone number and/or Instagram username (shown in full — the merchant owns these conversations and the inbox permission was granted separately at connect time), the last message (preview, channel, direction in/out, date), an unread flag, and whether the conversation is flagged for a human. Read-only. Note: "all" is broader than the in-app inbox default — it includes closed conversations and ones the business has not replied to yet. Optional channel (all, whatsapp, instagram; default all), filter (all, unread, human_needed; default all) and limit (default 20, max 50). Unread means: manually marked unread, or the last WhatsApp message is an unanswered inbound one; on Instagram there is no inbound read receipt, so it means the last Instagram message is an inbound one (the business has not replied since). Pass a contact id to get_conversation to read the full thread.

list_conversations

Free-form stats query engine (the same one Kanal's built-in assistant uses). Call get_stats_capabilities first to discover available targets, metrics, filters and periods, then query e.g. target=attribution.global or attribution.top_campaigns. group_by day/week/month on attribution targets returns a revenue time series (data[] of {period, ...}); group_by=hour is rejected (attribution is daily) and top_* stays a ranked list. Results follow the team's attribution settings and match the Kanal dashboard.

query_stats

Returns the most recent messages of one conversation in chronological order (oldest first), with a contact header (name, phone number and/or Instagram username shown in full, channels, opt-in status). When the contact talks on both channels the two threads are merged into one timeline; each message carries its channel. Each message has: direction (in/out), type, a text body (media and interactive replies collapse to a bracketed placeholder like "[image]" or "[button: Yes]", a deleted Instagram message to "[deleted message]"), who sent it (human/ai/automation/integration on WhatsApp; on Instagram, kanal or instagram_app for messages the team sent from Meta's own apps), an Instagram reaction emoji when there is one, and the timestamp. Read-only — there is no way to send a message. Find contact ids with list_conversations. Args: contact_id (required), channel (all, whatsapp, instagram; default all), limit (default 50, max 100).

get_conversation

Removes contacts from a static group (the contacts themselves are kept). Idempotent: contacts not in the group are reported as not_in_group, ids that do not belong to the team as unknown_contact_ids. Returns the number actually removed.

remove_contacts_from_group

Finds contacts of the team whose name, phone number or Instagram username contains the query (min 2 characters), most recently active first: contact id, name, the channels the contact is reachable on, phone number (in full, null for an Instagram-only profile), Instagram username, opt-in status. Use the ids with add_contacts_to_group, remove_contacts_from_group and set_contact_variable. Limit default 20, max 50.

search_contacts