Sending Single Message - Push

Send Your First Message is easy

Below is the Sample Push API Request & Response for sending WhatsApp & SMS , please update variables with your own values ;

Sending Single Message

POST https://pickyassist.com/app/api/v2/push

This API allows you to send a Single Message

Request Body

NameTypeDescription

token

string

Your API Token for authentication

application

number

Specify through which application the message need to sent. 1 = WhatsApp Personal (Phone Automation) 2 = WhatsApp Business (Phone Automation) 3 = SMS (Phone Automation) 4 = Call (Phone Automation) 5 = Facebook Messenger 8 = WhatsApp Official Shared Number 919737001155 = Shared Number India 556140404433 - Shared Number Brazil

globalmessage

string

Global Message Text Message with emoji supported by whatsapp If you are sending image and video you can pass caption text here

globalmedia

string

URL from we need to fetch the media ,

priority

string

This gives priority in the message queue 0 = Low (Default) 1 = High

data

array

This is an array in which you need to pass the mobile number and message

number

number

Mobile Number with full country code without 0 or + +55 12345 6789 – Wrong Format 55123456789 – Correct Format

message

string

Text Message with emoji supported by whatsapp If you are sending image and video you can pass caption text also here. Caption text is not supported for PDF, Audio, Document

{
    "status": 100,
    "push_id": "7478630",
    "message": "Success",
    "data": [
        {
            "msg_id": "9844217",
            "number": "934343442290",
            "credit": "0.005"
        },
        {
            "msg_id": "9844218",
            "number": "35435304220",
            "credit": "0.005"
        }
    ]
}

Sample Request Body JSON POST Method

{
  "token": "YOUR_API_TOKEN",
  "priority ": "0",
  "application": "10",
  "globalmessage": "your global message ",
  "globalmedia": "MEDIA FILE UNIQUE URL",
  "data": [
    {
      "number": "NUMBER 1",
      "message": "MESSAGE FOR NUMBER 1",
      "reference_number": "Your Internal Reference Number"
      
    },
    {
      "number": "NUMBER 2",
      "message": "MESSAGE FOR NUMBER 2",
      "reference_number": "Your Internal Reference Number"
      
    }
  ]
}

Sample Request Normal POST Method

This is a normal post method and useful for those who would like to use the API as Webhook for various 3rd party applications like Zoho CRM, Zapier which don't directly support JSON POST method, you can post the message into a variable "data" as shown below

https://pickyassist.com/app/api/v2/push?data=JSON

{
  "token": "YOUR_API_TOKEN",
  "priority ": "0",
  "application": "1",
  "globalmessage": "your global message ",
  "globalmedia": "MEDIA FILE UNIQUE URL",
  "data": [
    {
      "number": "NUMBER 1",
      "message": "MESSAGE FOR NUMBER 1"
    },
    {
      "number": "NUMBER 2",
      "message": "MESSAGE FOR NUMBER 2"
    },
    {
      "number": "NUMBER 3",
      "message": "MESSAGE FOR NUMBER 3"
    },
    {
      "number": "NUMBER 4",
      "message": "MESSAGE FOR NUMBER 4"
    },
    {
      "number": "NUMBER 5",
      "message": "MESSAGE FOR NUMBER 5"
    }
  ]
}

Sample Response

{
    "status": 100,
    "push_id": "7478630",
    "message": "Success",
    "data": [
        {
            "msg_id": "9844217",
            "number": "934343442290",
            "credit": "0.005"
        },
        {
            "msg_id": "9844218",
            "number": "35435304220",
            "credit": "0.005"
        }
    ]
}

Please note “100 -> Sucess” response doesn’t means the message has been successfully send to the user, it means your message has been accepted by our servers and pushed to your phone / docker / app for processing.

Last updated