Send messages

Send one or more messages

On message send responses, error information can be in two possible locations: one at the global level (where the entire payload is rejected) and one where a message-level reject is applicable.

Also see:

• Status Codes & Errors Table

• Supported Content Types & Limitations

Send one or more messages

post

Note that on message send responses, there are two possible locations for error information: one for global level (where entire payload is rejected) and one where a message level reject is applicable. Errors Table Message Status Table Supported content types and limitations

Authorizations

api-key

AuthorizationstringRequired

Body

application/json

One api send message request

Responses

202

Success

application/json

207

Returned on a message when more than one message was submitted, but they have a different status (example: one message was accepted, and one was rejected

application/json

400

Bad Request. Note that the global error object is not used because this is a message-level error

application/json

401

Unauthorized

application/json

402

Payment Required. User is out of funds/credits/currency/balance

404

Request was sent to a resource that does not exist

503

Service Unavailable

post

/v1/message

HTTPcURLJavaScriptPython

POST /v1/message HTTP/1.1
Host: platform.clickatell.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "messages": [
    {
      "channel": "sms",
      "to": "2799900001",
      "content": "Here is my message"
    }
  ]
}

SMS: One MessageSMS: Two-way MessageSMS: Message with aes-256-gcm encryptionSMS: Two unique message texts sent to two handsetsWhatsApp Text MessageWhatsApp Media Inline MessageWhatsApp Media By Reference Message (With Caption)WhatsApp Media By Reference Message (Without Caption)WhatsApp Contacts MessageWhatsApp Location MessageWhatsApp Text TemplateWhatsApp Interactive Text Template with Dynamic URLWhatsApp Interactive Media Template with Suggested Response ButtonsWhatsApp Media TemplateWhatsApp Interactive Text Template with Mixed ButtonsWhatsApp Interactive ListPicker MessageWhatsApp Interactive Button MessageWhatsApp Interactive Button Message: MediaWhatsApp Location Template (cloud-hosted only)WhatsApp Interactive Location RequestWhatsApp and SMS message in one requestWhatsApp Interactive URL Button MessageWhatsApp OTP via Authentication template

{
  "messages": [
    {
      "apiMessageId": "77fb29998253415fa5d66971d519d362",
      "accepted": true,
      "to": "2799900001",
      "error": null
    }
  ],
  "error": null
}