Sign in

v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Send a Whatsapp campaign

Send Whatsapp messages to a single recipient. This is a paid service.

post/campaign

Headers

Authorizationstring required

Bearer {access_token}

Content-Typestring required

application/json

Request body

fromstring required

The phone provided by the customer during the WABA account setup. It is the phone that receives the verification pin.

tostring required

The recipient of the message. Could be one of - phone number in international format. In this it should follow the guidelines of E.164 but leading 00 is as well accepted - group id

textstring required

The text to be sent. 4069 chars, UTF-8 support

imageURLstring

the url of the location where the image is stored. http or https, ASCII char set, supported formats are png, jpeg. Post-Processing Media Size 5MB.

videoURLstring

the url of the location where the video file is stored. http or https, ASCII char set, supported formats video/mp4, video/3gpp. Post-Processing media size 16MB.

documentURLstring

the url of the location where the document is stored. Any valid MIME-type is supported, post-Processing Media Size 100 MB.

filenamestring

File name of the document to be shown. It is shown on the uploaded document when the channel supports this. Max 512 chars, UTF-8.

captionstring

Additional caption for the image / document / video. It is shown on the uploaded image / document / video when the Whatsapp supports this. Max 512 chars, UTF-8

audioURLstring

the url of the location where the audio file is stored. Supported content is audio/aac, audio/mp4, audio/amr, audio/mpeg, audio/ogg; codecs=opus Note: The base audio/ogg type is not supported. Post-Processing Media Size 16MB

stickerURLstring

the url of the location where the sticker is stored. http or https, ASCII char set. Supported formats image/webp, post processing media size 100KB.

longitudenumber double

Longitude part of the coordinate. +/-180

latitudenumber double

Latitude part of the coordinate. +/-180

locationNamestring

Optional name of location. 256 chars.

locationAddressstring

Optional address, will only be rendered if name is set. 256 chars.

Response

200

trackingIdstring
createdAtstring

Example response

{
  "trackingId": "77185196-664a-43ec-b14a-fe97036c697f",
  "createdAt": "2020-08-10T14:54:49Z"
}