Send Whatsapp Text Message

Sends a plain text message to a customer or WhatsApp group.

Before you call

  • Send to as the customer's phone number with country code (e.g. +919999999999), or customerId for a customer without a phone number.
  • from is optional: your connected WhatsApp number with country code. If omitted, a connected number of your organisation is used.
  • To send to a WhatsApp group, pass its groupId instead, and leave out from and to.
  • content.text is required and cannot be blank.
  • messageId is optional. If you send it, it must be a UUID v4. If you don't, DoubleTick generates one.
  • customData (optional, string values only) is stored with the message and added to its status and reply webhooks.

How it works

  • The message is queued for sending. The response contains recipient, status (SENT or FAILED, with errorMessage) and messageId.
  • Use the messageId with Get Message Status to check delivery and read status.
  • If no customer exists for to, DoubleTick creates one and opens a chat for them.
  • If your organisation's content policy blocks the text (e.g. private information), the request is rejected.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length between 10 and 15

The phone number from which the message is sent, with the country code.

string
length between 10 and 15

The phone number to which the message is sent, with the country code. Required when not using groupId.

string

The unique identifier of the WhatsApp group to send the message to. Mutually exclusive with "to".

string
length between 36 and 36

Message ID (UUID v4) to be used for the message. If not provided, a random UUID v4 will be generated

content
object
required

Text message to be sent

Responses
201

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json