Developers

Public API

Send SMS, email and WhatsApp, run campaigns, verify OTPs and read your balance over a simple HTTP API. Every error is machine-readable with a stable code — the full reference is below.

Open the test console Interactive reference (Swagger)

Getting started

All endpoints are served under:

https://api-s1.textdigo.com/api/v0

Requests and responses are JSON (except multipart file uploads). Send the header x-locale: fr or en to localize error messages.

Authentication

Authenticate every request with HTTP Basic using your apiLogin as the username and your apiKey as the password (found in Settings → Organization → API).

curl -u "apiLogin:apiKey" \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber":"+237670000000","message":"Hello"}' \
  https://api-s1.textdigo.com/api/v0/sms/message

Responses & errors

Errors share one shape. statusCode is the HTTP status, errorCode is a stable machine-readable string (see the reference), message is human-readable, and details[] lists per-field problems for validation errors.

{
  "statusCode": 422,
  "errorCode": "PUBLIC_API_INVALID_PHONE_NUMBER",
  "message": "The phone number 0670 is not a valid international number",
  "details": [],
  "timestamp": "2026-06-10T10:00:00.000Z",
  "path": "/api/v0/sms/message"
}

Send messages

POST/sms/messagetest send

Send an SMS to one number.

Field	Type	In	Description
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.
`message`*	string (≤2000)	body	Message body.
`senderName`	string (≤50)	body	Approved sender ID.
`smsType`	enum TRANSACTIONAL\|MARKETING	body	Billing tier (default TRANSACTIONAL).
`externalId`	string	body	Your reference, echoed in webhooks.

Possible errors: PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_UNSUPPORTED_PHONE_NUMBER (422)

GET/sms/messagetest send

Send an SMS (query-param variant).

Field	Type	In	Description
`phoneNumber`*	string (E.164)	query	Recipient number in international format, e.g. +237670000000.
`message`*	string	query	Message body.

Possible errors: PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_UNSUPPORTED_PHONE_NUMBER (422)

POST/email/messagebillable

Send an email.

Field	Type	In	Description
`email`*	string (email)	body	Recipient email address.
`subject`*	string (≤998)	body	Email subject.
`htmlMessage`	string	body	HTML body.
`textMessage`	string	body	Plain-text body.

Possible errors: PUBLIC_API_INVALID_EMAIL (422)

POST/email/template/messagebillable

Send a templated email.

Field	Type	In	Description
`email`*	string (email)	body	Recipient email address.
`subject`*	string	body	Email subject.
`templateId`*	string	body	Template identifier.
`parameters`	object<string,string>	body	Template variable values.

Possible errors: PUBLIC_API_INVALID_EMAIL (422), PUBLIC_API_TEMPLATE_NOT_FOUND (404)

POST/whatsapp-business/messagebillable

Send a WhatsApp Business message.

Field	Type	In	Description
`whatsappBusinessPhoneNumberId`*	string	body	Your WhatsApp sender id.
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.
`message`	string (≤4096)	body	Text body (within the 24h window).
`mediaUrl`	string (url)	body	Public URL of an attachment.

Possible errors: PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_WAB_ACCOUNT_NOT_FOUND (404)

POST/whatsapp-business/otp/messagebillable

Send a WhatsApp OTP message.

Field	Type	In	Description
`whatsappBusinessPhoneNumberId`*	string	body	Your WhatsApp sender id.
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.

Possible errors: PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_WAB_ACCOUNT_NOT_FOUND (404)

POST/whatsapp-business/template/messagebillable

Send a WhatsApp template message.

Field	Type	In	Description
`whatsappBusinessPhoneNumberId`*	string	body	Your WhatsApp sender id.
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.
`templateId`*	string	body	Approved template id.
`bodyParameters`	object<string,string>	body	Body variable values.

Possible errors: PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_TEMPLATE_NOT_FOUND (404), PUBLIC_API_WAB_ACCOUNT_NOT_FOUND (404)

POST/api-campaign/send-smsbillable

Send one SMS to many contacts (bulk).

Field	Type	In	Description
`message`*	string	body	Message body.
`contacts`*	string[] (≤1000)	body	Recipient numbers; invalid ones are skipped and reported.
`senderName`	string	body	Approved sender ID.

Possible errors: PUBLIC_API_INVALID_RECIPIENTS (422)

GET/api-campaign/send-smsbillable

Bulk SMS (query-param variant).

Field	Type	In	Description
`message`*	string	query	Message body.
`contacts`*	string (comma-separated)	query	Comma-separated numbers.

Possible errors: PUBLIC_API_INVALID_RECIPIENTS (422)

Delivery status

GET/message/{channel}/status/{msgId}read-only

Get a message delivery status.

Field	Type	In	Description
`channel`*	enum sms\|email\|whatsapp	path	Channel of the message.
`msgId`*	string	path	The msgId returned at send time.

Possible errors: PUBLIC_API_MESSAGE_NOT_FOUND (404)

GET/message/sms/{msgId}read-only

Get full SMS details.

Field	Type	In	Description
`msgId`*	string	path	The msgId returned at send time.

Possible errors: PUBLIC_API_MESSAGE_NOT_FOUND (404)

Account & usage

GET/integration/usageread-only

Usage & quota snapshot.

GET/integration/walletread-only

Wallet balance & recent transactions.

GET/integration/canalsread-only

List your channels.

Field	Type	In	Description
`type`	enum CanalType	query	Filter by channel type.
`limit`	number	query	Page size (default 50).

Resources

POST/integration/campaignsbillable

Create and launch a campaign.

Field	Type	In	Description
`campaignSpecId`*	uuid	body	Message template id.
`profileIds`*	uuid[]	body	Contact list ids.
`frequency`*	enum CampaignFrequency	body	Send cadence.

POST/integration/campaign-specsbillable

Create a message template.

Field	Type	In	Description
`name`*	string (≤200)	body	Template name.
`type`*	enum CampaignSpecType	body	Channel type (SMS, EMAIL…).
`config`	object	body	Channel-specific config.

POST/integration/campaign-profilesbillable

Create a contact list.

Field	Type	In	Description
`name`*	string (≤200)	body	List name.
`type`*	enum CampaignProfileType	body	List source type.
`campaignSpecType`*	enum CampaignSpecType	body	Channel the list targets.

POST/integration/campaign-profiles/{id}/contacts/importbillable

Import contacts into a list.

Field	Type	In	Description
`id`*	uuid	path	Contact list id.
`contacts`*	object[] (≤10000)	body	Array of { phoneNumber?, email?, parameters? }.

POST/integration/ticketsbillable

Create a ticket.

Field	Type	In	Description
`canalType`*	enum TicketCanalType	body	Channel of the ticket.
`description`	string (≤2000)	body	Ticket description.

POST/integration/customersbillable

Create a contact.

Field	Type	In	Description
`name`	string	body	Contact name.
`phoneNumbers`	string[]	body	Phone numbers.
`emails`	string[] (email)	body	Email addresses.

POST/integration/groupsbillable

Create a contact group.

Field	Type	In	Description
`name`*	string	body	Group name.

One-time passwords

POST/otp/smsbillable

Send an SMS OTP.

Field	Type	In	Description
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.
`numberOfDigits`	int 4–8	body	Code length (default service value).

Possible errors: PUBLIC_API_INVALID_PHONE_NUMBER (422)

POST/otp/sms/verifyread-only

Verify an SMS OTP.

Field	Type	In	Description
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.
`otpCode`*	string (3–10)	body	The code the user received.

Possible errors: PUBLIC_API_OTP_CONTACT_NOT_FOUND (404)

POST/otp/whatsappbillable

Send a WhatsApp OTP.

Field	Type	In	Description
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.

Possible errors: PUBLIC_API_INVALID_PHONE_NUMBER (422)

POST/otp/whatsapp/verifyread-only

Verify a WhatsApp OTP.

Field	Type	In	Description
`phoneNumber`*	string (E.164)	body	Recipient number in international format, e.g. +237670000000.
`otpCode`*	string (3–10)	body	The code the user received.

Possible errors: PUBLIC_API_OTP_CONTACT_NOT_FOUND (404)

POST/otp/emailbillable

Send an email OTP.

Field	Type	In	Description
`email`*	string (email)	body	Recipient email address.

Possible errors: PUBLIC_API_INVALID_EMAIL (422)

POST/otp/email/verifyread-only

Verify an email OTP.

Field	Type	In	Description
`email`*	string (email)	body	Recipient email address.
`otpCode`*	string (3–10)	body	The code the user received.

Possible errors: PUBLIC_API_OTP_CONTACT_NOT_FOUND (404)

Files & tickets

POST/file/uploadread-only

Upload a media file (multipart).

Field	Type	In	Description
`file`*	binary	multipart	The file to upload.

Possible errors: PUBLIC_API_FILE_REQUIRED (422), PUBLIC_API_FILE_TOO_LARGE (413)

POST/issuebillable

Create a support ticket (multipart).

Field	Type	In	Description
`email`*	string (email)	multipart	Recipient email address.
`issueCanalType`*	enum SMS\|WHATSAPP\|EMAIL	multipart	Reply channel.
`issueMessage`	string	multipart	The issue text.
`file`	binary	multipart	Optional attachment.

Possible errors: PUBLIC_API_INVALID_EMAIL (422), PUBLIC_API_FILE_TOO_LARGE (413)

Webhooks

Configure per-channel callback URLs in Settings → Organization → API. Every call is a POST signed with X-TextDigo-Signature: sha256=HMAC_SHA256(webhookSecret, rawBody) — verify it against your webhookSecret.

Delivery reports

{ "msgId": "...", "from": "...", "status": "DELIVERED",
  "partCount": 1, "amount": 0.02, "operator": "...",
  "externalId": "...", "currency": "XAF", "subject": "dlr", "type": "sms" }

status ∈ DELIVERED | UNDELIVERED | SENT | FAILED

Inbound messages

{ "event": "inbound-message", "type": "sms", "lineId": "...",
  "phoneNumber": "...", "chatId": "...", "message": "...", "medias": [] }

Error codes

Branch on errorCode, not on the human message (which is localized). Codes migrating from the legacy Meteor API show their old numeric code.

Authentication

Code	HTTP	Meaning	How to fix
`API_KEY_MISSING_CREDENTIALS`	401	Missing API credentials.No Authorization header (or token) was supplied.	Send Authorization: Basic base64(apiLogin:apiKey).
`API_KEY_INVALID_CREDENTIALS`	401	Invalid API credentials.The apiLogin/apiKey pair does not match any account.	Copy the keys from Settings → Organization → API.
`API_KEY_ORG_NOT_ACTIVE`	403	Organization is not active.The account is suspended or cancelled.	Reactivate the account or contact support.

Validation

Code	HTTP	Meaning	How to fix
`VALIDATION_FAILED`	422	One or more fields are invalid.A field is missing, the wrong type, too long, or unknown.	Read the per-field details[] array in the response.
`PUBLIC_API_INVALID_PHONE_NUMBER`was #3001	422	The phone number is not a valid international number.The number is not parseable in E.164.	Use the full international form, e.g. +237670000000.
`PUBLIC_API_UNSUPPORTED_PHONE_NUMBER`was #3002	422	No active operator serves this number.The destination country/operator is not enabled on your account.	Check your enabled coverage or contact support.
`PUBLIC_API_INVALID_EMAIL`was #3003	422	The email address is not valid.The address failed format validation.	Provide a syntactically valid address.
`PUBLIC_API_INVALID_RECIPIENTS`	422	None of the supplied recipients are valid.Every number in a bulk request failed validation.	Send at least one valid E.164 number.
`PUBLIC_API_FILE_REQUIRED`was #101	422	A file is required.The multipart request carried no file part.	Attach the file under the "file" field.
`PUBLIC_API_FILE_TOO_LARGE`	413	The file exceeds the maximum size.The upload is over the per-file limit.	Compress or split the file under the limit.

Resources

Code	HTTP	Meaning	How to fix
`PUBLIC_API_MESSAGE_NOT_FOUND`	404	Message not found.The msgId does not belong to your account.	Use the msgId returned by the send call.
`PUBLIC_API_OTP_CONTACT_NOT_FOUND`	404	No pending OTP for this contact.No OTP was sent, or it expired.	Send a new OTP before verifying.
`PUBLIC_API_WAB_ACCOUNT_NOT_FOUND`	404	No WhatsApp Business sender matches the id.whatsappBusinessPhoneNumberId is wrong or not connected.	Use an id from your connected WhatsApp channels.
`PUBLIC_API_TEMPLATE_NOT_FOUND`	404	Template not found.The templateId is unknown in your account.	List your templates and use a valid id.
`PUBLIC_API_CANAL_NOT_ACTIVE`was #501	422	The target channel is not active.The channel exists but is disabled.	Activate the channel in the dashboard.

Rate limiting

Code	HTTP	Meaning	How to fix
`RATE_LIMITED`	429	Too many requests.You exceeded the per-key request budget.	Back off and retry after a short delay.

Server

Code	HTTP	Meaning	How to fix
`INTERNAL_ERROR`was #100	500	Unexpected server error.Something failed on our side.	Retry later; contact support if it persists.

Limits & quotas

Rate limiting: requests are throttled per API key — back off on 429 (RATE_LIMITED).
Bulk SMS: up to 1000 contacts per /api-campaign/send-sms call.
Contact import: up to 10 000 contacts per import call.
File uploads are capped by the per-file size limit (PUBLIC_API_FILE_TOO_LARGE otherwise).