Developer documentation
API documentation for WhatsApp, SMS and RCS.
UDO's API documentation for the WhatsApp Business API, SMS, OTP and RCS is in the developer
portal at developers.apikey
header, send JSON, and each endpoint has an example request.
REST over JSON · API-key authentication · Webhooks for SMS and WhatsApp delivery reports
Inside the portal
What does the UDO WhatsApp, SMS and RCS API documentation cover?
The UDO API documentation has five guides (introduction, quickstart, authentication, errors and webhooks), a reference for each channel (SMS, OTP, WhatsApp Business API and RCS) and setup guides for CleverTap and MoEngage.
SMS API
Single, bulk, OTP, Unicode, flash and template SMS, plus messages with short URLs. The route — transactional, promotional or OTP — is set on each request.
OTP API: generate and verify
Generate a one-time password, then verify the code your customer enters.
WhatsApp Business API
Send templates with text, image, video or document headers; create and list templates; and send interactive messages with reply buttons and lists.
RCS API
Plain and rich text, text with variables, standalone rich cards and carousels.
Guides
Quick start
How do you start sending with the UDO API?
Get an account, register what each channel requires, generate your API key, send a test request, then point webhooks at your system.
Open an account
Book a demo and we set up your UDO account and dashboard.
Register each channel
DLT headers and templates for SMS, Meta business verification for the WhatsApp Business API, Google brand verification for RCS business messaging.
Generate your API key
Find it in the API settings of your dashboard, and keep it on your server.
Send a test request
POST your first message with the key in the apikey header, using the quickstart's example request.
Add webhooks, go live
Point the SMS and WhatsApp webhooks at your URL, then move real traffic across.
Meta's business verification for WhatsApp and Google's brand verification for RCS are the slowest steps, because they wait on Meta and Google rather than on us. We start them first, so your integration work runs alongside.
Webhooks and delivery reports
How do you get delivery reports from the UDO API?
Through webhooks, which the portal documents for SMS and WhatsApp: UDO pushes the status of each message you send to a URL you choose, along with the messages your customers send back.
Three kinds of event
- Messages received from your customers
- Messages sent, template and session
- The status of each sent message: sent, delivered and, where the channel reports it, read
You add a webhook in the dashboard — for SMS under DLR push configuration, for WhatsApp in the WhatsApp webhook settings — by naming it, choosing its events and entering your URL.
Read the webhooks guide
Integrations
Do you need a developer to connect UDO to CleverTap or MoEngage?
No. An administrator adds UDO in the platform's own settings: CleverTap takes UDO as a generic SMS provider using your UDO API key, and MoEngage takes UDO as an RCS sender using a sender ID and a bearer token issued by the UDO team. A custom system connects through the REST API, which does need a developer. UDO also works with Salesforce, HubSpot, Zoho and Freshdesk.
CleverTap SMS
Add UDO as CleverTap's generic SMS provider, authenticated with your UDO API key.
MoEngage RCS
Configure UDO as an RCS sender in MoEngage, with a sender ID and a bearer token issued by UDO.
Questions
Frequently asked.
In the WhatsApp section of the UDO developer portal. It documents sending template messages with text, image, video or document headers, creating and listing templates, and sending interactive messages with reply buttons and lists.
In the API settings of your UDO dashboard. Keep it on your server, never in client-side code, and reset it if you think it has been exposed.
With your API key, sent in an apikey HTTP header on every request. Request bodies are JSON, so set the content type to application/json as well.
The authentication guide covers the apikey header.
The UDO REST API covers SMS, OTP generation and verification, the WhatsApp Business API and RCS, each with its own reference in the portal. The SMS API sends single, bulk, OTP, Unicode, flash and template SMS, with the route (transactional, promotional or OTP) set on each request.
For outbound voice, talk to us about connecting the outbound dialer to your systems.
A 400 status code for a problem with your request, or a 500 for a server error, with a JSON body that sets "error": true and gives a message such as "Api Key not found". A successful request returns 200.
The errors guide lists the error types behind them.
Yes. Campaigns can be sent from the UDO dashboard, and CleverTap and MoEngage connect from their own settings screens.
The API is for messages your own systems trigger, such as OTPs and order updates.
Get a walkthrough before you build.
Book a demo and we'll take your team through the API, the webhooks and the registration each channel needs for your use case.