# Channels

> Channel status, web chat widgets, WhatsApp onboarding, email inboxes and domains, SMS numbers.

Channel status, web chat widgets, WhatsApp onboarding, email inboxes and domains, SMS numbers.

## `admin_link`

**Get a link to an admin screen** · Read only · Listed to the agent from the start

Returns the exact link to a Dakso admin screen, for something a person must do (connect an account, grant a permission, approve, pay). `destino`: a catalog route such as "/agentflows", "/admin/mcp-credentials", "/admin/channels/whatsapp". Routes with parameters: "/agentflows/builder/:clientId/:flowId" (client_id, flow_id), "/tools/:toolId" (tool_id; optional tab), "/admin/screen-pops/:id" (screen_pop_id), "/admin/datatables/:name" (table_name), "/admin/queue-settings/:tab" (tab), "/admin/campaigns/outbound/:campaignId" (campaign_id). Fails without permission.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `destino` | string | Yes |  |
| `campaign_id` | string | No |  |
| `client_id` | string | No |  |
| `flow_id` | string | No |  |
| `screen_pop_id` | string | No |  |
| `tab` | string | No |  |
| `table_name` | string | No |  |
| `tool_id` | string | No |  |

## `channels_status`

**Get status of all channels** · Read only · Listed to the agent from the start

Status of every channel in one call: whatsapp, whatsapp_voice, email, sms, webchat, telegram, voice (calls), meta (Facebook and Instagram) and genesys. Per channel: `status` (connected; partial = something exists but is incomplete, e.g. an unverified email domain; not_connected = nothing; unknown = could not be determined, due to a failure or missing permission, and must never be read as not connected), `missing` and `adminUrl` (admin screen where a person finishes it; null for meta).

No arguments.

## `sms_number_enable`

**Enable SMS on a number** · Changes data · can overwrite or remove · Listed to the agent from the start

Enables SMS on a number (or changes its flow or environment): incoming SMS are served by the flow `flow_id` (must have an active version) in `environment` prod (default) or testing. Voice is unchanged. Every inbound and outbound SMS is charged per segment, so get the user's OK. In the US and Canada the number stays pending_registration until support completes the registration.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `flow_id` | string | Yes |  |
| `number_id` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |
| `environment` | string | No | Default: `"prod"`. |

## `email_domain_add`

**Add an email domain** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Adds an own domain to send email from (for example acme.com). It stays pending until the DNS records (`email_domain_records`) are copied and verified. Free email domains are not allowed.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `domain` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |

## `email_domain_check`

**Verify an email domain** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Re-verifies the DNS records of `domain` now (after the user copied them) and returns the status and `checks`. It changes nothing else.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `domain` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |

## `email_domain_records`

**Get DNS records of an email domain** · Read only · Reached with `dakso_explore`

DNS records to copy at the provider of `domain` (3 signing CNAMEs, MX and TXT of the bounce subdomain and, if missing, the DMARC TXT) and the state of each verification (`checks`). Use it to guide the user step by step.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `domain` | string | Yes |  |

## `email_domains_list`

**List email domains** · Read only · Reached with `dakso_explore`

Own domains of the organization for sending email: `status` (pending | verified | failed | temporary_failure), `checks` {dkim, mailFrom, spf, dmarc} (pass | pending | fail) and `note` with the next step. The DNS records to copy are in `email_domain_records`.

No arguments.

## `email_inbox_create`

**Create an email inbox** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Creates an email inbox served by the flow `flow_id` (must have an active version) in `environment` prod (default) or testing. `kind`: dakso (address `{alias}.{org}@dakso.app`; `alias` lowercase) or domain (`address` on the organization's own domain; the customer forwards mail to the returned `ingressAddress`). Gmail or Microsoft mailboxes (kind google/microsoft) are connected by a person in the admin: the link is returned. Every email is charged.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `display_name` | string | Yes |  |
| `flow_id` | string | Yes |  |
| `kind` | string | Yes |  |
| `address` | string | No | Default: `""`. |
| `alias` | string | No | Default: `""`. |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |
| `environment` | string | No | Default: `"prod"`. |

## `email_inbox_update`

**Update an email inbox** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Changes an email inbox: `flow_id` and `environment` (prod | testing) serving it, auto-acknowledgement (`ack_enabled`, `ack_text` up to 500 chars), `inbound_filter` ({"mode": "all"} or {"mode": "aliases", "aliases": [addresses]}) and `display_name`. Only what you pass is sent.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `inbox_id` | string | Yes |  |
| `ack_enabled` | boolean | No |  |
| `ack_text` | string | No |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |
| `display_name` | string | No | Default: `""`. |
| `environment` | string | No | Default: `""`. |
| `flow_id` | string | No | Default: `""`. |
| `inbound_filter` | object | No |  |

## `email_inboxes_list`

**List email inboxes** · Read only · Reached with `dakso_explore`

Email inboxes of the organization: `kind` (dakso = Dakso address, domain = own domain with forwarding, google/microsoft = connected mailbox), `address`, `ingressAddress` (where to forward own-domain mail), `reserveAddress`, `flowId` and `environment` (the serving flow), `status` (active | pending | paused | reauth_required | disabled), auto-acknowledgement and inbound filter. `note` says what to do if the inbox is not active. `providers` says whether Gmail or Microsoft mailboxes can be connected (false = coming soon); `slug` is the organization's Dakso address slug (null if none yet).

No arguments.

## `email_rates_get`

**Get email rates** · Read only · Reached with `dakso_explore`

Email rates currently charged to the organization, in credits: per email sent and received, and the surcharge for large attachments. They already include the organization's override if any.

No arguments.

## `email_suppressions_list`

**List suppressed email addresses** · Read only · Reached with `dakso_explore`

Addresses the organization can no longer email (permanent bounce, complaint or unsubscribe), with reason, date and origin, newest first. Returns up to `limit` (default 50, max 200), `total` and `truncated`. With `address` it says whether that address (without +tag) is suppressed. Only support can lift a suppression.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `address` | string | No | Default: `""`. |
| `limit` | integer | No | Default: `50`. |

## `sms_number_disable`

**Disable SMS on a number** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Disables SMS on a number: it stops receiving SMS (voice is unchanged). Its flow and environment are kept so it can be enabled again.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `number_id` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |

## `sms_numbers_list`

**List SMS numbers** · Read only · Reached with `dakso_explore`

The organization's phone numbers seen per channel: `voice` (bool) and `sms` with `capable` (the number supports SMS in its country; null = not known yet), `enabled`, `status` (active | pending_registration | unsupported | not_capable), `flowId` (the flow serving SMS; may differ from voice) and `environment` (prod | testing). `smsNote` explains in one line why a number cannot hold SMS conversations yet. Use it before `sms_number_enable`.

No arguments.

## `sms_rates_get`

**Get SMS rates** · Read only · Reached with `dakso_explore`

SMS rates currently charged to the organization, in credits: per country (`rows`) and `rest` (rest of the world, for countries without a row). SMS is charged per segment (inbound and outbound); MMS per message. They include the organization's override if any. `country` (2-letter ISO, e.g. US) returns only that country.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `country` | string | No | Default: `""`. |

## `webchat_create`

**Create a web chat** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Creates a web chat connected to a flow and makes it live at once: nothing is left to publish. `name` is the internal name; `flow_id` and `client_id` come from `flows_list` and must be of the same flow. `config` must include `allowedDomains` (where it will be installed; no wildcards on public suffixes like *.com) and accepts widgetTitle, welcomeMessage, inputPlaceholder, colors ({primary, background} hex), logo, position (bottom-right | bottom-left), mode and status. Returns the widget with its `widgetId`. If the organization has no card or plan, it returns a link to complete it.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `client_id` | string | Yes |  |
| `flow_id` | string | Yes |  |
| `name` | string | Yes |  |
| `config` | object | No |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |

## `webchat_get`

**Get a web chat** · Read only · Reached with `dakso_explore`

Detail of one web chat (`widget_id` = `widgetId` from `webchat_list`): appearance, flow and allowed domains, with `borrarEn`.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `widget_id` | string | Yes |  |

## `webchat_list`

**List web chats** · Read only · Reached with `dakso_explore`

Lists the organization's web chats: `items` with `widgetId`, `label`, `status`, `flowId`, `allowedDomains` and appearance, `total`, and `borrarEn` (the admin link to delete a web chat).

No arguments.

## `webchat_publish`

**Publish a web chat** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Publishes a web chat draft, making the changes from `webchat_update` live. Returns `version` and `published` (false if there were no changes). If the organization has no card or plan, it returns a link to complete it.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `widget_id` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |

## `webchat_snippet`

**Get the web chat install code** · Read only · Reached with `dakso_explore`

Returns the install code of a web chat: `snippet` (one line of HTML with the `widgetId`) and `installHint` (where to paste it and which domains it accepts).

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `widget_id` | string | Yes |  |

## `webchat_update`

**Update a web chat draft** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Edits the draft of a web chat: only what you pass in `config` is sent (label, widgetTitle, welcomeMessage, inputPlaceholder, colors, logo, position, mode, allowedDomains, status). It does not change the flow. Changes stay in the draft and are not live until `webchat_publish`. To delete a web chat, `borrarEn` from `webchat_list` and `webchat_get` gives the admin link.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `config` | object | Yes |  |
| `widget_id` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |

## `whatsapp_onboarding_check`

**Re-check WhatsApp onboarding** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Queries the state of a sign-up again (`app_id` = `appId` from `whatsapp_status`), for example when the customer finished Meta's registration. It completes the connection if Meta already registered the number and returns the view with `onboardingStatus`, `health`, `problems` and `next`. It only finishes a sign-up already started; do not poll it in a loop.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `app_id` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |

## `whatsapp_onboarding_link`

**Regenerate the WhatsApp onboarding link** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Generates the link to Meta's registration again for a sign-up (`app_id` = `appId` from `whatsapp_status`), for example when it expired (`next` = regenerar_enlace). Returns the view with `link` and `linkExpiresAt` (admin role only). Give the link to the user as is.

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `app_id` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |
| `lang` | string | No | Default: `"es"`. |

## `whatsapp_onboarding_start`

**Start WhatsApp onboarding** · Changes data · can overwrite or remove · Reached with `dakso_explore`

Starts the sign-up of a WhatsApp number: reserves it and prepares the link to Meta's registration, which the customer completes with their own data. `flow_id` is the flow (virtual agent) that will serve the number and must have an active version; `label` is an optional internal name and `lang` the registration language (es by default). Returns the sign-up view with `link` (admin role only).

| Argument | Type | Required | Description |
| --- | --- | --- | --- |
| `flow_id` | string | Yes |  |
| `descripcion` | string | No | One short sentence: what this call changes and why (10-200 chars, no personal data). |
| `label` | string | No | Default: `""`. |
| `lang` | string | No | Default: `"es"`. |

## `whatsapp_status`

**Get WhatsApp onboarding status** · Read only · Reached with `dakso_explore`

Status of the organization's WhatsApp number sign-ups: `selfOnboarding` (false = guided sign-up not enabled) and `apps`, one view per number with `appId`, `label`, `onboardingStatus` (creada | enlace_generado | activa | conectada | con_problemas | manual), `pendingDays`, `link` and `linkExpiresAt` (null below admin role or without WhatsApp write permission), `phone`, `health`, `problems` and `checkedAt`. `next` is the next step: abrir_enlace, regenerar_enlace, esperar_meta, revisar_problemas or ninguno. Common errors: NO_CREDITS, SELF_ONBOARDING_DISABLED, QUOTA_EXCEEDED, ALREADY_LIVE, IN_PROGRESS (retry in seconds) and PROVIDER_UNAVAILABLE (retry in minutes).

No arguments.
