Send a Whatsapp campaign

post

https://waapi.routee.net/campaign

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Account activated feature
Please note, the service is available for use after filling in Whatsapp Application Form

Key	Description
trackingId	The tracking id of the Whatsapp campaign.
createdAt	The time the campaign was created.

Body Params

from

string

required

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

string

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

text

string

required

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

imageURL

string

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.

videoURL

string

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.

documentURL

string

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

filename

string

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.

caption

string

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

audioURL

string

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

stickerURL

string

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.

longitude

double

Longitude part of the coordinate. +/-180

latitude

double

Latitude part of the coordinate. +/-180

locationName

string

Optional name of location. 256 chars.

locationAddress

string

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

template

object

The message template to be send.

Headers

Authorization

string

required

Defaults to Bearer {access_token}

Bearer {access_token}

Content-Type

string

required

Defaults to application/json

application/json

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘Account activated feature

200200

400400

403403

📘
Account activated feature