One API: Overview

Clickatell’s RESTful One API allows you to send and receive messages on multiple communication channels, at scale, with a single integration. One API currently supports SMS and WhatsApp for Business with more channels to be added soon. Easily scale your messaging and add more channels without the need to update your integration. You integrate once-off with the One API, and Clickatell will handle the interpretation of all the different channel requirements. Unified reporting allows for a single view of all your messaging activity regardless of the channel.

Message types available for each channel

Message Type SMS WhatsApp
Plain text Yes Yes
Rich text No Yes
Plain text with URL support No Yes
Templated Message No Yes
Media No Yes

How to get started with the One API

1. The first step is to register your Clickatell account.

2. Before configuring your One API integration, determine whether you need to apply for a number.

3. You can configure an integration in the sandbox environment by clicking on 'Create One API integration'from the dashboard or left-hand navigation in your account.

4. Add your test phone numbers to send and receive test messages from the sandbox environment. You can add up to three test phone numbers to your account here. You can also find more information in the FAQs to help with troubleshooting when sending test SMS messagesor sending test WhatsApp messages from the sandbox environment.

5. To configure a production-ready integration, or to publish your integration from the sandbox to the production environment, you need to complete your company billing details. You can read more about how to set up your billing details here.

Clickatell’s RESTful One API allows you to send and receive messages on multiple communication channels, at scale, with a single integration. One API currently supports SMS and WhatsApp for Business with more channels to be added soon. Easily scale your messaging and add more channels without the need to update your integration. You integrate once-off with the One API, and Clickatell will handle the interpretation of all the different channel requirements. Unified reporting allows for a single view of all your messaging activity regardless of the channel.

Message types available for each channel

Message Type SMS WhatsApp
Plain text Yes Yes
Rich text No Yes
Plain text with URL support No Yes
Templated Message No Yes
Media No Yes

How to get started with the One API

1. The first step is to register your Clickatell account. 2. Before configuring your One API integration, determine whether you need to apply for a number. 3. You can configure an integration in the sandbox environment by clicking on 'Create One API integration'from the dashboard or left-hand navigation in your account. 4. Add your test phone numbers to send and receive test messages from the sandbox environment. You can add up to three test phone numbers to your account here. You can also find more information in the FAQs to help with troubleshooting when sending test SMS messagesor sending test WhatsApp messages from the sandbox environment. 5. To configure a production-ready integration, or to publish your integration from the sandbox to the production environment, you need to complete your company billing details. You can read more about how to set up your billing details here.