Sending Media Attachments – Push

You can send media files using the below method;

Please pass your internet facing public URL of your media file through “globalmedia” please make sure the media file can be downloaded and accessible through internet. Those who are using standalone application or don't have a webserver for media files then can make use of "globalmedia_code" to pass the base64 code of the media files

Supported Media Files

Platform

Type

Extension

Max Size

Images

jpg, jpeg, gif, png, image

5 MB

Video

mp4, 3gpp

16 MB

Audio

mp3, wav, aac, m4a, amr, opus

16 MB

Document

Any valid MIME-type

100 MB

Only H.264 video codec and AAC audio codec is supported by WhatsApp

Optional Caption Message

For image & video you can pass caption text in the “globalmessage” or “message” variables, by passing a separate message in the “message” variable you have the capability to send dynamic caption message which is helpful for sending personalised messages with image & video. Please note caption message works only with “image & video” files

Sending Dynamic Media

Currently we don't support sending dynamic media files to each contacts through a single API for phone & WhatsApp Web automation, so if you need to send dynamic images then please trigger the API multiple times keeping 5 seconds intervals between each API request. Sending dynamic media file is supported for those who are using WhatsApp Official or WhatsApp Shared Numbers use "media" or "media_code" variable

Sending Media Attachments Messages

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

This API allows you to send Messages with media attachments

Request Body

Name

Type

Description

token

string

Your API token for authentication

media_name

string

Optional for PDF & Documents, pass the file name to be displayed, not supported in Phone Automation, a maximum of 20 characters

media_code

string

If you need to pass base64 of the media file then please pass through this variable

application

number

Specify through which application the message need to sent. 1 = Whatsapp Personal 2 = Whatsapp Business 3 = SMS 4 = Call Conference 8 = WhatsApp Official 10 = WhatsApp Web Automation

globalmessage

string

Pass Caption Message Here supports only for image and video.

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

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

message

string

Pass Caption message 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 for Sending Static Media Files

{
  "token": "PICKY_API_TOKEN",
  "priority ": "0",
  "application": "1",
  "media_file": "Name of the File",
  "globalmessage": "Media URL", 
  "globalmedia": "MEDIA FILE UNIQUE URL",
  "data": [
    {
      "number": "NUMBER 1", 
      "message": "Caption Message" 
    }
  ]
}

Sample Request Body JSON for sending Static Media Files using Base64

{
  "token": " PICKY_API_TOKEN  ",
  "priority ": "0",
  "application": "8",
  "globalmessage": "GLOBAL MESSAGE",
  "globalmedia_code": "Media Base64 Code",
  "data": [
    {
      "number": " NUMBER 1 ",
      "message": "Caption Message"
    }
  ]
}

Sample Request Body JSON for Sending Audio File as Voice Note

Please note this method works only WhatsApp Web Automation Channel

{
   "token":"248f02903a57ee0fed380bd500dd1293e6d",
   "application":"10",
   "globalmedia":"Audio URL",
   "voice":1,
   "data":[
      {
         "number":"1194407768",
         "message":""
      }
   ]
}

Sample Request Body JSON for Sending Dynamic Media

Sending dynamic media is supported only in WhatsApp Official & WhatsApp Shared Numbers

{
   "token":"PICKY_API_TOKEN",
   "priority ":"0",
   "application":"8",
   "globalmessage":"",
   "data":[
      {
         "number":"NUMBER 1",
         "message":"MESSAGE FOR NUMBER 1",
         "media":"media url for number 1"
      },
      {
         "number":"NUMBER 2",
         "message":"MESSAGE FOR NUMBER 2",
         "media":"media url for number "
      },
      {
         "number":"NUMBER 3",
         "message":"MESSAGE FOR NUMBER 3",
         "media":"media url for number 3"
      },
      {
         "number":"NUMBER 4",
         "message":"MESSAGE FOR NUMBER 4",
         "media":"media url for number 4"
      },
      {
         "number":"NUMBER 5",
         "message":"MESSAGE FOR NUMBER 5",
         "media":"media url for number 5"
      }
   ]
}

Sample Request Body JSON for Sending Dynamic Media through Base64

Sending dynamic media is supported only in WhatsApp Official & WhatsApp Shared Channels

{
   "token":"PICKY_API_TOKEN",
   "priority ":"0",
   "application":"8",
   "globalmessage":"",
   "data":[
      {
         "number":"NUMBER 1",
         "message":"MESSAGE FOR NUMBER 1",
         "media_code":"base64 code for number 1"
      },
      {
         "number":"NUMBER 2",
         "message":"MESSAGE FOR NUMBER 2",
         "media_code":"base64 code for number 2"
      },
      {
         "number":"NUMBER 3",
         "message":"MESSAGE FOR NUMBER 3",
         "media_code":"base64 code for number 3"
      },
      {
         "number":"NUMBER 4",
         "message":"MESSAGE FOR NUMBER 4",
         "media_code":"base64 code for number 4"
      },
      {
         "number":"NUMBER 5",
         "message":"MESSAGE FOR NUMBER 5",
         "media_code":"base64 code 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 sent to the user, it means your message has been accepted by our servers and pushed to your phone / docker /app for processing.

PreviousSending Dynamic Messages – Push NextSending Interactive List & Buttons

Last updated 1 year ago