> For the complete documentation index, see [llms.txt](https://help.smartico.ai/welcome/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.smartico.ai/welcome/technical-guides/communication-gateways/supported-whatsapp-gateways.md).

# Supported WhatsApp gateways

Smartico sends WhatsApp messages to players through WhatsApp Business API providers. Messages go 1-to-1 to the phone number in the player profile.

WhatsApp gateways are configured in the Back-Office under **Label Settings → Gateways → Instant messages**. Each gateway holds the provider credentials, the delivery status settings and the sender value. For the WhatsApp asset itself, see [SMS, Viber, and WhatsApp](https://help.smartico.ai/welcome/products/crm-automation/communication-channels/sms-viber-and-whatsapp).

***

## How WhatsApp Gateway Configuration Works

WhatsApp gateways are added in the Back-Office under **Label Settings → Gateways → Instant messages**. Adding a gateway opens a wizard:

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fgit-blob-1d90333a0ca429bba6d86394eaa09171307fb824%2F0aad308677-wa-type-975491cf-e57eeb.png?alt=media" alt=""><figcaption><p>Label → Gateways → Instant messages → Create: 1 — Instant messages, 2 — Type: WhatsApp, 3 — the WhatsApp providers</p></figcaption></figure></div>

1. **Add IM gateway**: Select **Type: WhatsApp**, then select the provider from the list. The list shows only the providers of the selected type.
2. **Conditions**:
   * **Name**: A name for internal identification.
   * **Brand**: On multi-brand labels, restrict the gateway to one brand, or leave **Any**.
   * **Set as default gateway**: Only one gateway can be the default at a time. Turn off the current default first.
   * **Gateway selection properties**: If gateway selection properties are set up for your label, the screen shows one field per property, named after the property (such as country or language). Pick the values for which this gateway is used during automatic selection. Ask your Smartico Success Manager to set the properties up.
3. **Authentication & Configuration**: Enter the credentials and settings the provider needs. The fields depend on the provider (see the catalog below).
   * **Additional parameters**: A key-value editor to pass extra settings that the form does not show. Use it only for keys your Smartico contact names for the provider.
   * **Callback URL**: For providers that report delivery statuses to Smartico, the full Callback URL for your environment is shown on this screen. Copy it into the provider account (or into the callback field of the form, when there is one).
4. **"From" config**: Enter the sender value shown to players, as registered with the provider. **WATide** skips this screen.

If you change "From" values that existing campaigns use, a **'From' changes** screen asks you to confirm how those campaigns are updated before saving.

***

## Supported WhatsApp Gateways Catalog

Below is the list of WhatsApp providers supported by Smartico, with the fields the Back-Office asks for (names as in the wizard) and the provider-side setup.

***

### 1. Botto

* **Provider links**: [Website](https://botto.ai)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: The Bottoo API endpoint for sending messages.
  * `token` *(Required)*
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 2. Clickatell WhatsApp

* **Provider links**: [Website](https://www.clickatell.com) · [One API reference (send message, client callbacks for message status)](https://help.clickatell.com/developers-api-reference/reference/one-api) · [Quick start guide (WhatsApp)](https://guides.clickatell.com/whatsapp-channel/getting-started/quick-start-guide-whatsapp) · [Send WhatsApp message templates](https://guides.clickatell.com/whatsapp-channel/channel-capabilities/whatsapp-message-templates/send-message-templates) · [View & edit API integrations (My Workspace > API Integrations)](https://help.clickatell.com/clickatell-user-portal/user-portal/view-and-edit-api-integrations)
* **Back-Office Configuration Fields**:
  * `API Key` *(Required)*: Enter your Clickatell WhatsApp API key.
* **Provider-Side Setup**:
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 3. CommsHub WhatsApp v2

* **Provider links**: [Website](https://commshub.com)
* **Back-Office Configuration Fields**:
  * `URL` *(Required)*: URL of the CommsHub API.
  * `TOKEN` *(Required)*: Authentication token for the CommsHub API.
* **What this gateway supports**:
  * Uses the CommsHub messenger API with `whatsapp` as the messenger.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 4. MailerWeb WhatsApp

* **Provider links**: [Website](https://www.mailerweb.com.br) · [MailerWeb API documentation (Redoc; campaigns, templates; used by the v1 integration)](https://app.mailerweb.com.br/api/docs/) · [Transactional API docs (WhatsApp send, X-API-KEY header; used by the v2 integration)](https://api.mailerweb.com/transactional/docs)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: Enter the URL for the Mailerweb API WhatsApp endpoint where the WhatsApp message request will be sent.
  * `Username` *(Required)*: Enter the username for authentication to Mailerweb API.
  * `Password` *(Required)*: Enter the password for authentication to Mailerweb API.
  * `Mailerweb Campaign name` *(Required)*: Enter the campaign name for Mailerweb.
  * `Mailerweb Whatsapp template name` *(Required)*: Enter the Whatsapp template name for Mailerweb.
  * `Disable Click Tracking` *(Optional)*: Default false. Set to true to disable click tracking and shorten links.
  * `Recipient Lists` *(Required)*: Enter recipient lists in the format /api/v1/contacts/{list\_type}/{list\_id}/ separated by commas WITHOUT spaces.
  * `Exclude Lists` *(Optional)*: Enter excluded recipient lists in the format /api/v1/contacts/{list\_type}/{list\_id}/ separated by commas WITHOUT spaces.
  * `Open Lists` *(Optional)*: MailerWeb open lists, separated by commas WITHOUT spaces.
  * `Click Lists` *(Optional)*: Enter lists to which the contact will be added if they click the campaign link. Separated by commas WITHOUT spaces.
  * `Use My Number` *(Optional)*: Set to true to have the messages sent from your own number.
  * `MailerWeb Reply Mobile Number` *(Optional)*: Ignored if using own number. Phone number replies will be sent to.
  * `Reply Call to Action` *(Optional)*: Ignored if using own number. Combined with the "reply\_mobile\_number" value, will create a link with text in the message, prompting the contact to click on the WhatsApp number.
  * `Reply Contact Text` *(Optional)*: Ignored if using own number. You can define a text that will be displayed within the contact's WhatsApp Web application, so that the receiving contact does not need to type any message to you, simply having to send the message.
  * `Reply To` *(Optional)*: email address to reply to.
  * `Scheduled Date` *(Optional)*: Date and time when the campaign is scheduled to be sent. format example: 2021-02-21 23:47.
* **What this gateway supports**:
  * Campaign-based sending: the message goes out through the Mailerweb campaign and WhatsApp template named in the gateway settings.
  * Click tracking and link shortening are on by default; turn on `Disable Click Tracking` to switch them off.
* **Provider-Side Setup**:
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 5. MailerWeb WhatsApp v2

* **Provider links**: [Website](https://www.mailerweb.com.br) · [MailerWeb API documentation (Redoc; campaigns, templates; used by the v1 integration)](https://app.mailerweb.com.br/api/docs/) · [Transactional API docs (WhatsApp send, X-API-KEY header; used by the v2 integration)](https://api.mailerweb.com/transactional/docs)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: Enter the URL for the MailerwebV2 API WhatsApp endpoint where the WhatsApp message request will be sent.
  * `Username` *(Required)*: Enter the username for authentication to MailerwebV2 API.
  * `Api Key` *(Required)*: Enter the api key for authentication to MailerwebV2 API.
* **What this gateway supports**:
  * The asset can carry a media URL and one button (`media_url`, `button_text`, `button_url` extra fields).
* **Provider-Side Setup**:
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 6. Messaggio WhatsApp

* **Provider links**: [Website](https://messaggio.com) · [How to get the secret API key (project > Set up API messaging)](https://messaggio.com/guides/how-to-get-the-secret-api-key/) · [How to specify webhook for message statuses (callback URL)](https://messaggio.com/guides/how-to-specify-webhook-for-message-statuses/) · [WhatsApp Sender ID requirements](https://messaggio.com/guides/whatsapp-sender-id-requirements/) · [API documentation](https://messaggio.com/api-docs/)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: Enter the URL for Messagio Whatsapp endpoint where the SMS request will be sent.
  * `Project Login` *(Required)*: Enter your Messagio Whatsapp project login.
  * `Time to Live (TTL)` *(Required)*: Enter the expiration time for the message in seconds.
  * `Callback URL` *(Required)*: Enter the URL for receiving delivery status updates.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 7. Mudigital WhatsApp

* **Provider links**: [Website](https://mudigital.com.br)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: The URL for the Mudigital WhatsApp.
  * `API Key` *(Required)*: The API Key for Mudigital WhatsApp.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 8. Nefex

* **Provider links**: [Website](https://www.nefex.io)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: Enter the URL for the Nefex API WhatsApp endpoint where the WhatsApp message request will be sent.
  * `Username` *(Required)*: Enter the username for login request to Nefex API.
  * `Password` *(Required)*: Enter the password for login request to Nefex API.
  * `Pool ID` *(Required)*: Enter the pool ID to send WhatsApp message request to Nefex API.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 9. Pushfy WhatsApp

* **Provider links**: [Website](https://pushfy.com) · [Pushfy API documentation (OpenAPI + Postman, PT/EN/ES)](https://portal.pushfy.com/docs/) · [OpenAPI spec (webapi, getstatus, reportbydate, campaign id fields)](https://portal.pushfy.com/docs/openapi.yaml)
* **Back-Office Configuration Fields**:
  * `URL` *(Required)*: URL of Pushfy API.
  * `AUTHORIZATION` *(Required)*: Full Authorization value for the Pushfy API (with the prefix).
  * `CAMPAIGN_ID` *(Required)*: Full Authorization value for the Pushfy API (with the prefix).
* **What this gateway supports**:
  * `CAMPAIGN_ID` identifies the Pushfy campaign used for the messages.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 10. Send-box WhatsApp

* **Provider links**: [Website](https://send-box.com) · [API documentation (JSON API sendsmsjson.php; Authorization: Bearer token from the personal account; message types incl. whatsapp)](https://send-box.com/en/docs/api-docs.html)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Optional)*: Send-box send API url. Leave empty to use <https://login.send-box.com/sendsmsjson.php>.
  * `API Token` *(Required)*: Bearer token issued by Send-box.
* **What this gateway supports**:
  * Plain text only: the Send-box API has no templates, media or buttons.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 11. SMS Retail

* **Provider links**: [Website](https://sms-retail.io)
* **Back-Office Configuration Fields**:
  * `URL` *(Required)*: SMS-Retail API base URL (e.g. <https://sms-retail.io/ext/api/v1/messages/send>).
  * `X-API-KEY` *(Required)*: API key sent as X-API-Key header.
  * `Channel` *(Optional, Default: `whatsapp`, Options: `WhatsApp` / `Telegram` / `Viber` / `Imo`)*
* **What this gateway supports**:
  * The `Channel` option lets the same gateway send through WhatsApp, Telegram, Viber or Imo (default: WhatsApp).
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 12. TSM

* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: Enter the URL for the TSM WhatsApp endpoint where the message request will be sent.
  * `Bearer Token` *(Required)*: Enter the Bearer Token.
  * `Secret Key` *(Required)*: Enter your Secret Key.
  * `Super Admin Token` *(Required)*: Enter your Super Admin Token.
* **Provider-Side Setup**:
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 13. WATide

* **Provider links**: [Website](https://watide.hilllightproduction.com)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: Enter the URL for Wati endpoint where the Message request will be sent.
  * `App Key` *(Required)*: Enter the Application key.
  * `Authorization Key` *(Required)*: Enter the Authorization key.
* **What this gateway supports**:
  * Text messages only. This gateway has no "From" config screen.
* **Provider-Side Setup**:
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

## WhatsApp Gateways Listed Under Custom IM

The following WhatsApp providers are selected with **Type: Custom IM** in the wizard. Their message content (for example the template name and its variables) comes from extra fields in the asset, which Smartico enables for your label on request.

***

### 14. Infobip WhatsApp

Listed in the wizard under **Type: Custom IM** (not under WhatsApp).

* **Provider links**: [Website](https://www.infobip.com) · [API authentication (API key and the App Authorization header)](https://www.infobip.com/docs/essentials/api-essentials/api-authentication) · [WhatsApp over API (sending, templates, delivery reports / webhooks)](https://www.infobip.com/docs/whatsapp/whatsapp-over-api) · [WhatsApp message templates (create and register)](https://www.infobip.com/docs/whatsapp/message-types-and-templates/message-templates) · [WhatsApp get started (sender / trial setup)](https://www.infobip.com/docs/whatsapp/get-started)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required, Default: `https://xxxxx.api.infobip.com/whatsapp/1/message/template`)*: Enter the URL for Infobip WhatsApp endpoint (e.g. <https://xxxxx.api.infobip.com/whatsapp/1/message/template>).
  * `API Key` *(Required, Default: `App` and a space)*: Your Infobip API key, with the `App` prefix and a space before the key.
* **What this gateway supports**:
  * Sends a pre-approved WhatsApp **template**. The asset gives the template name, the template language and up to 3 placeholder values.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 15. Auronix

Listed in the wizard under **Type: Custom IM** (not under WhatsApp).

* **Provider links**: [Website](https://www.auronix.com)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required, Default: `https://api.auronix.com/template-whatsapp/transactions-tpl-wa/api/v2/transactions`)*: Enter the URL of the Auronix v2 transactions API.
  * `API Key` *(Required)*: Enter the apikey issued by Auronix for the account.
* **What this gateway supports**:
  * Template-only gateway: Auronix sends no free text, only a pre-approved template and its variables. The asset gives the template ID (`<uuid>:<name>:<locale>`) and the variables.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

### 16. P1SMS WhatsApp

Listed in the wizard under **Type: Custom IM** (not under WhatsApp).

* **Provider links**: [Website](https://p1sms.ru) · [P1SMS API documentation (apiKey, webhookUrl for status, sender, channels)](https://p1sms.ru/api-dokumentaciya-p1sms) · [Sending SMS through the P1SMS API](https://p1sms.ru/otpravka-sms-soobscheniy-po-api) · [WhatsApp messaging (product page)](https://p1sms.ru/rassylka-v-whatsapp)
* **Back-Office Configuration Fields**:
  * `API Endpoint URL` *(Required)*: Enter the URL for P1SMS WhatsApp.
  * `API Key` *(Required)*: API Key for the P1SMS WhatsApp.
  * `Sender` *(Required)*: Sender value.
* **What this gateway supports**:
  * P1SMS WhatsApp channel; `Sender` is the sender value registered with P1SMS.
* **Provider-Side Setup**:
  * Set the **Callback URL** from the gateway configuration screen in the Back-Office as the delivery status URL in your provider account (or paste it into the callback field of the form, when there is one).
  * Register your WhatsApp Business sender with the provider. Business-initiated WhatsApp messages need templates approved by WhatsApp.

***

***

## WhatsApp Templates

Business-initiated WhatsApp messages need templates approved by WhatsApp. Create and approve the templates in your provider account first. Gateways that send templates (for example **Infobip WhatsApp** and **Auronix**) take the template name or ID and its variables from the asset.

***

## Frequently Asked Questions (FAQ)

### Where do I find the Callback URL for delivery reports?

Open the gateway in **Label Settings → Gateways → Instant messages** and go to the **Authentication & Configuration** screen. The Callback URL is generated for your environment and shown there for every provider that reports statuses. Do not build it by hand.

### How does automatic gateway selection work when several WhatsApp gateways are configured?

When a campaign uses automatic selection, Smartico picks the gateway at send time from the gateways whose **Brand** and gateway selection property values match the player. Use **Set as default gateway** on the gateway that should be used by default.

### What should I do if our preferred WhatsApp provider is not listed?

1. **Your secured gateway**: Connect your own sending service through the [Secured Messaging Gateways (Email/SMS/IM)](https://help.smartico.ai/welcome/technical-guides/communication-gateways/secured-messaging-gateways-email-sms-im.md) API.
2. **Request a new integration**: Contact your Smartico Customer Success Manager or Integration Manager with the provider's API documentation.

### Where are the general instructions for instant message gateways?

See the [Instant Messages Gateway guide](https://help.smartico.ai/welcome/technical-guides/communication-gateways/instant-messages-gateway-guide.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.smartico.ai/welcome/technical-guides/communication-gateways/supported-whatsapp-gateways.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
