Quick Start Guide πŸƒ

Watch Quick Video Intro

​

Quick Setup

Generate API Token -> Select Your Project -> Settings -> API Token

Setup Webhook -> Select Project - Settings -> Webhook

Webhook & API Supports only POST Method & Both make use of JSON Format , no header based authentication required, pass the api token token variable in body.

We have common structure of all supported channels so please go through the API documentation carefully for make use of the correct variables and values.

Receiving Messages

Webhook is responsible to handle the incoming messages to your application. When a new message arrives in your application then the message details will be pushed to your web server instantly.

  1. πŸ‘‰message-in variable holds the message contents and this is URL encoded , so you need to decode the same.

  2. πŸ‘‰ We use the POST method to push messages to your server and the payload format is JSON.

Instant Reply - if you would like to give an instant reply back to the user whenever you receive an incoming message then give your reply message in JSON Format as response to the webhoook (like giving acknowledgement ) This method is highly recommend for all those who want to give instant reply back without calling the Push API

Phone automation doesn't supports receiving incoming media files i.e you will get only text messages in your webhook but its possible to know what kind of media you have received. See Workaround Solution​

Sending Messages (PUSH API)

In order to send messages out you need to make use of PUSH API. Use our postman collection for quick testing. Get Postman Collection ​

  1. Recipient mobile number must be passed with country code without 0 or +

  2. Supports only POST method and the payload format should be in JSON

  3. Make use of dynamic API to send personalised messages in a single API call rather than calling API multiple times

  4. If you would like to send media files then please upload your media to a public URL and pass the link to download through media-url variable. Please note the URL should not redirect to another page / server.

Using WhatsApp Official Account

  1. For WhatsApp Official & Shared number make sure you have a valid session to the recipient mobile number before sending a message, if there is no valid session then you need to make use of approved template messages

  2. WhatsApp Official new numbers must go through warm up process i.e by default all new numbers are allowed to send messages only to 1000 users in 24 hours window this will gradually increase when you send messages to more users. This is not applicable for WhatsApp session messages. Read More​

  3. For Facebook messenger you need to make use of subscriber unique id to send a message.

Using Phone Automation

  1. Please make sure the bridge app is installed and configured in the device. (activated using your project license key)

  2. Make sure the device screen is unlocked "Screen Lock should set to "None" and no dual WhatsApp or any virtualisation app are installed in the device.

  3. Please make sure the application you pass is installed in your device i.e application=1 (personal) and application=2 (business)

  4. For Sending SMS using your SIM Card please make sure your have an active SMS plan.

  5. For initiating a call conference make sure your SIM Card is enabled with call conferencing service and have valid calling plan.

  6. Always keep in mind the message sending speed and limitations. Read More ​

Using WhatsApp Shared Number

  1. Please make sure you pass application=<your shared number> to route the message correctly.

  2. To use push api your project should have an active session with the recipient you would like to send message

  3. You can't use the template message if the recipient mobile number never sends you a message in your keyword.

Sending Templated Messages to WhatsApp

Templated messages are used only to send messages if no valid session is available against a recipient mobile number. Read More​