Message Status Table
Status code |
Callbacks; Query Message Response (description presented to clients) |
Short Description |
Details |
Successful flow of messages | |||
1 |
UNKNOWN |
Message not found |
The specified message was not found in the account. Please check the account details and message ID to ensure these are correct. |
2 |
QUEUED |
Queued |
The message has been queued for delivery. This is a temporary status – please check again in a few hours. |
3 |
SCHEDULED |
Scheduled for later delivery |
The message is scheduled for later delivery. Review the message in a few hours to check on delivery. |
4 |
SENT_TO_SUPPLIER |
Sent to supplier |
This message has been submitted to an external supplier. (For WhatsApp messages, this means Meta.) |
5 |
DEVICE_ACK |
Device acknowledged delivery |
Two gray checkmarks on WhatsApp. The message was delivered successfully to the customer’s device. (WhatsApp-specific behavior) |
6 |
READ |
Read receipt |
Two blue checkmarks on WhatsApp. The customer has read or opened the message. (WhatsApp-specific behavior) |
Generic errors (shared by all channels) | |||
20 |
EXPIRED |
Message has expired |
Validity period or internal validity period-related. |
21 |
STOPPED_BY_USER |
Message stopped by the user |
|
22 |
STOPPED_BY_ADMIN |
Message stopped by admin |
|
23 |
DELIVERY_FAILURE |
Error delivering message |
Generic upstream supplier returned a permanent error. Could also be an internal error. |
24 |
EMULATED |
Emulated |
Used for sandbox messaging when the number being sent to has not been added as a test phone. |
25 |
INSUFFICIENT_ACCOUNT_BALANCE |
Insufficient account balance |
Review your account balance and ensure you have enough funds available. |
26 |
VOLUME_LIMIT |
Volume limit exceeded |
|
27 |
VOLUME_LIMIT_DAILY |
Daily volume limit exceeded |
Applies to the sandbox environment. |
28 |
VOLUME_LIMIT_MONTHLY |
Monthly volume limit exceeded |
Applies to the sandbox environment. |
29 |
RECIPIENT_DOES_NOT_EXIST |
Recipient does not exist on the channel |
|
Encryption-related | |||
60 |
ENCRYPTION_ACCESS_DENIED |
Security access denied |
Credentials are invalid or have expired. |
61 |
ENCRYPTION_CONTENT_ERROR |
Content decryption failed |
|
62 |
ENCRYPTION_VALIDATION_ERROR |
Encryption validation error |
Possible causes:
|
Media-related | |||
80 |
MEDIA_NOT_FOUND |
Media not found |
Ensure that media is present in your upload environment and that it adheres to supported media types and sizes. |
81 |
MEDIA_SIZE_ERROR |
Media size error |
Your media size is too large. Reference this page for guidelines. |
82 |
MEDIA_CHECKSUM_FAILURE |
Media checksum failure |
|
83 |
MEDIA_REJECTED_BY_SUPPLIER |
Channel supplier rejected media file |
Ensure that media is present in your upload environment and that it adheres to supported media types and sizes. |
84 |
MEDIA_METADATA_ERROR |
Metadata for the media file was not found or does not match the message request |
Please reference the One API documentation to ensure that all required metadata is present. |
85 |
MEDIA_ACCESS_ERROR |
An access/permissions-related error occurred when handling the media file |
Ensure that the media file is present and can be accessed by your system. |
86 |
MEDIA_TYPE_NOT_SUPPORTED |
The media type is not supported on the channel. |
This specific media format is not supported on the channel. See here for guidelines. |
SMS-specific | |||
100 |
ROUTING_ERROR |
Routing error |
This SMS message did not route correctly. |
WhatsApp-specific | |||
130 |
WHATSAPP_ACCOUNT_PAYMENT_ISSUE |
WhatsApp account payment issue |
There is a payment issue related to this account. |
131 |
WHATSAPP_RE_ENGAGEMENT_REQUIRED |
Re-engagement required |
The business must engage the client with an approved message template to initiate a new conversation. |
132 |
WHATSAPP_SPAM_RATE_LIMIT_REACHED |
Spam rate limit reached |
Relates to Whatsapp Rate Limit and message quality. |
133 |
WHATSAPP_SERVER_RATE_LIMIT |
WhatsApp server rate limit |
Your environment’s rate limit has been reached. Speak to your Technical Account Manager (TAM) about how to address this. |
139 |
WHATSAPP_EXPERIMENTAL_NUMBER |
Non-delivery due to WhatsApp experimental number feature |
Meta has initiated an experiment on this number. |
140 |
WHATSAPP_TEMPLATE_TEXT_TOO_LONG |
Length of the parameters and the template text exceeds the maximum allowed length |
|
141 |
WHATSAPP_TEMPLATE_FORMAT_MISMATCH |
Specified template header is not in the expected format |
There is a problem with the template header. See here for guidelines. See here for guidelines on setting up message templates. |
142 |
WHATSAPP_TEMPLATE_FORMATTING_POLICY_VIOLATED |
Template header parameter formatting is not allowed (bold, italic, etc.) |
There is a problem with the template header. See here for guidelines on setting up message templates. |
143 |
WHATSAPP_TEMPLATE_MEDIA_FORMAT_UNSUPPORTED |
Correct media type is used in the template, but the mime type is unsupported |
|
144 |
WHATSAPP_PARAMETER_MISSING |
Required parameter is missing for this message |
|
145 |
WHATSAPP_PARAMETER_INVALID |
A message parameter contains an invalid value |
|
146 |
WHATSAPP_PARAMETER_NOT_REQUIRED |
A parameter was specified for the message that is not required |
|
147 |
WHATSAPP_TEMPLATE_INVALID_URL |
Invalid hydrated URL received in the message template |
Ensure that the URL used in the message template is valid. |
148 |
WHATSAPP_TEMPLATE_INVALID_PHONE_NUMBER |
Phone number in the template message is missing |
Ensure that a valid telephone number is present in the message template. |
149 |
WHATSAPP_TEMPLATE_RECEIVER_NO_BUTTON_SUPPORT |
End-user device does not support buttons |
|
150 |
WHATSAPP_TEMPLATE_DOES_NOT_EXIST |
The template does not exist in the specified language or has not been approved. |
There is a problem with the template status. Review these guidelines. |
151 |
WHATSAPP_TEMPLATE_PARAM_COUNT_MISMATCH |
WhatsApp’s API indicated that the number of parameters provided does not match the expected number. |
There is a problem with the template. Review these guidelines. |
152 |
WHATSAPP_TEMPLATE_PAUSED |
The template is in a paused status in the Meta account |
The template has been paused due to negative feedback from customers. Edit the template to improve template quality. |
153 |
WHATSAPP_TEMPLATE_DISABLED |
The template is in a disabled status in the Meta account |
The template has been disabled due to continuous poor feedback from customers. Please create a new template and follow these recommendations. |
160 |
WHATSAPP_COMPLIANCE_INFO_MISSING |
The business has not provided any compliance information |
Relevant to WhatsApp commerce messaging. Currently only applies to businesses in India. |
161 |
WHATSAPP_PRODUCT_CATALOG_NOT_FOUND |
The catalog ID you provided either does not exist, does not belong to your WhatsApp Business Account, or is not connected to the phone number you are using to send the message |
Relevant to WhatsApp commerce messaging. Review your catalog ID in Facebook Business Manager. See here for guidelines. |
162 |
WHATSAPP_PRODUCT_NOT_FOUND_IN_CATALOG |
The product provided in a single-product message or all of the products provided in a multi-product message was not found in the catalog ID provided |
Relevant to WhatsApp commerce messaging. Review your catalog ID in Facebook Business Manager. See here for guidelines. |
163 |
WHATSAPP_PRODUCT_COMPLIANCE_ERROR |
The product provided in a single-product message or all of the products provided in a multi-product message are missing or have incomplete e-commerce compliance information |
Relevant to WhatsApp commerce messaging. Currently only applies to businesses in India. Review your catalog ID in Facebook Business Manager. See here for guidelines. |
170 |
WHATSAPP_MESSAGE_UNDELIVERABLE |
Message undeliverable |
Your message has not been delivered. For WhatsApp, ensure:
|
171 |
WHATSAPP_CHOSE_NOT_TO_DELIVER |
Meta chose not to deliver the message to maintain healthy ecosystem engagement |
Too many marketing messages are being sent to this number without engagement from the client. |
Generic status codes (Payment-related) | |||
283 |
PAYMENT_COMPLETED |
Payment completed |
Payment was completed successfully. |
284 |
PAYMENT_DECLINED |
Payment declined |
Payment was not completed successfully. |
285 |
PAYMENT_FAILED |
Payment failed |
A failure was encountered in the payment (not completed and not declined). |
286 |
PAYMENT_INVALID_MERCHANT_SESSION |
Invalid merchant session |
A valid merchant session was not provided. |
287 |
PAYMENT_INVALID_WEBHOOK_ENDPOINTS |
Invalid webhook endpoints |
Valid webhook endpoints were not provided. |
Channels
Find the most up-to-date information about the channels available to communicate with your clients.

SMS
Enable any application, website or system to facilitate local or international one- or two-way SMS communication via an easy one-step integration with our HTTP API.
Documentation

One API
Communicate with your mobile customers via multiple communication channels with a single integration. You can send and receive messages on both WhatsApp and SMS without the overhead of programming individual channels.
Documentation

As an authorized WhatsApp Business Solution Provider, we assist you in applying for a WhatsApp Business account and number. Integrate with other powerful features available on our platform via our One API.
Documentation
Products
Find the most up-to-date information about the products we offer and how to elevate your engagement with customers.

Chat 2 Pay
Send payment requests to customers via chat for secure, contactless payment experiences.
Documentation

Chat Desk
An easy-to-use web-based application that enables real-time communication with your customers via a single web interface.
Documentation

Chat Flow
A web-based application that allows you to quickly and collaboratively design and deploy conversational experiences across multiple chat applications and connect it to your organization's core functional APIs.
Documentation

Campaign Manager
An online tool that allows you to create a custom SMS campaign within minutes - no coding or developers required.
Documentation
Marketplace
Find the most up-to-date information about Clickatell's Marketplace and how you can utilize it for the distribution and payment acceptance of digital products.
Bank Interfaces API
An explanation of the way Clickatell and banks interact with one another when dealing with purchases.
Documentation
Transact Result API
Initiates the delivery of the transaction result for a purchase that was made through Clickatell after Clickatell facilitated the dispensing of the product.
Documentation
Reserve and Transact API
Initiates a purchase and fund reservation request to Clickatell.
Documentation
Security Service API
Request authentication tokens to use in all other Clickatell API calls.
Documentation
Transact
A cloud-based platform that allows for the distribution and payment acceptance of multiple digital products.
Documentation
In-Flight Transaction Check API
Used prior to a purchase instruction to confirm that no similar transaction is in progress.
Documentation
User Transaction Lookup API
Identify if a new transaction is similar to one of the user's recent transactions so the response details can be used to pre-emptively complete the current transaction details.
Documentation
Customer Account Validation API
Validate a customer's bill payment account number prior to submitting the bill payment purchase request to the vendor.
Documentation
MNO Lookup API
Derive the specific mobile network operator (MNO) for the specified MSISDN.
Documentation
Token Lookup API
Look up tokens/vouchers to present back to the buyer/customer who purchased token-related products via Clickatell's platform.
Documentation
Notifications API
Send notifications to buyer/recipient using different channels.
Documentation
Transaction Lookup API
Used after a purchase to confirm the transaction status.
Documentation
Financial Terms Lookup API
Display the correct fee and settlement amounts as per the contractual agreement for the SKU being purchased.
Documentation
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have