Picky Assist Help Desk
Main WebsiteBlogFacebook Community
Picky Assist Help Desk
Picky Assist Help Desk
  • Welcome To Picky Assist 🙏
  • Setting Up Guide
    • Sending First Message
    • Connecting Channels
      • WhatsApp Web Automation to Official API Migration Guide 2024
      • Connecting WhatsApp Web Automation
      • Connecting Facebook Messenger
        • Introduction
        • Getting Start
        • Guidelines & Compliances
        • Messenger Link
      • Connecting WhatsApp Official
        • Introduction
        • Dashboard
        • Profile
        • Templates
      • Connecting WhatsApp Cloud API
      • WhatsApp Official Managed Service
      • Connecting Instagram
      • Phone Bridge (Call Blaze)
      • Connecting SMTP
      • Connecting Amazon SES
      • Connecting Sendgrid
      • Connecting Additional WhatsApp Numbers
      • Porting WhatsApp Number to Picky Assist
      • WhatsApp Official Message Delivery Issues & Solutions
    • Working With Prebuilt CRM Modules
      • Introduction
      • Onboarding
      • Modules
        • Leads
        • Deals
        • Meetings
        • Company
        • Support Cases
        • System Modules
          • Contacts
          • Notes
          • Task
          • Call Logs
          • Tags
          • Activity Logs
      • Automations
        • Workflows
        • Chatbots
        • Funnels
        • Connectors
        • Scheduler
        • Other Prebuilt Features
      • Reports and Dashboard
      • Mandatory Preconditions for Using Prebuilt
      • Testing Prebuilt
    • Managing Organization
    • Setting Up Teambox
      • Introduction
      • Routing Rules
      • Teambox
      • Inbox View
      • Organization Hierarchy
      • Analytics
    • Setting Up Smart Replies
      • Introduction
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variations
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalising Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Testing the Bot
        • Publishing Bot
      • ChatGPT Integration
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Smart Reply V2
      • Introduction
      • ChatGPT Integration
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variation
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalizing Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Publishing Bot
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Setting Up Broadcaster
      • Introduction
      • Creating a Campagin
      • Sending Message to WhatsApp Groups
      • Reports
      • Broadcaster V2
        • Introduction
        • Creating Campaign
        • Reports
    • Setting Up Sequence
      • Introduction
      • Creating New Sequence
      • Sequence Stats
      • Subscribe & Unsubscribe
      • Disabling Sequence Message
    • Setting Up Reminder
    • Setting Up Mobile App
    • Setting Up Connector
      • Introduction
      • Getting Started
      • Steps
        • Introduction
        • Filters
        • Delay
        • Iterator
        • Stats
      • Actions
      • Formatter
        • Date & Time
        • Counter
        • Math Calculation
        • Data Parser
        • Convert File
        • Line Items
      • Building Mini App
      • Email Parser
      • Data Storage
      • Simulate Test
      • Connector Logs
    • Email Builder
    • Setting Up Flow Builder
      • Fundamentals (Must Read)
      • Basic Terminology (Must Read)
      • Guide to Building an Effective Chatbot (Must Read)
      • Create, Manage, Test & Publish Flows
      • Triggering a Chatbot Flow
      • Steps
        • Introduction (Must Read)
        • Send Message
        • Ask A Question
        • Filter
        • Save Data
        • Actions
        • Check WhatsApp Session
        • Delay
        • Smart Delay
        • Formatter
        • Splitter
        • Data Lookup
        • Trigger HTTP API
        • Webhook
        • Apps
        • Match Keywords
        • Route to Chatbot
        • End
      • Saving Data into CRM
      • Analytics
      • Integrations
      • Flow Builder logs and conversational logs
      • Chatbot Best Practices, Ideas & FAQ
    • Setting up Modular CRM
      • Fundamentals (Must Read)
      • Guide to Building and Implementing a Modular CRM (Must Read)
      • Create & Manage Data Modules
      • CRM Macro Buttons
      • Adding Records into CRM
      • Data View & Manage Records
      • Task
      • Workflows
      • Funnels
      • Data Import
      • Integrations
    • Setting Up Scheduler
    • Media Gallery
    • Quick Replies
    • Opt-out Settings
    • Blacklist
    • Global Variables
    • Setting Up Ad-On's
      • Setting Up WhatsMail
      • Setting Up Zendesk
      • Setting Up Zapier
      • Setting Up Zoho CRM
        • Getting Started
        • Working with Extension
        • Integrating with Zoho Workflow
        • Lead Assignment Rules
        • Integrating into Custom Modules
        • Connecting Multiple WhatsApp Numbers into Zoho CRM
        • Integrating WhatsApp with Zoho CRM Mobile App
        • Keyboard Shortcuts
      • Setting Up Facebook Lead Adform
      • Facebook Lead Ad form V2
      • Setting Up WhatsApp Web
      • Setting Up Pabbly Connect
      • Setting Up ChatGPT App
    • Google Chrome Extensions
      • Extension for Sending WhatsApp Messages from any Webpage
      • Chrome Extension V2
      • Extension for Zoho CRM & Teambox
    • Managing Profile
      • Two Factor Aunthentication
      • Login History
      • Delete Account
    • Quick Rollout Guide
      • WhatsApp Official Account
    • Developers & Partners Guide for Deep Integration of Picky Assist
  • API Documentation V2
    • Introduction
    • Quick Start Guide 🏃
    • Global Webhook
      • How Webhook Works
      • Webhook Variables
      • Configuring Webhook URL
      • Webhook Request & Response
      • Getting the Conversation Context
      • Testing Your Webhook
    • Event Webhook
      • How Event Webhook Works
      • Event Webhook Variables
      • Configuring Event Webhook URL
      • Event Webhook Sample Request & Response
    • Push API
      • Introduction
      • API Variables
      • Sending Single Message - Push
      • Sending Dynamic Messages – Push
      • Sending Media Attachments – Push
      • Sending Interactive List & Buttons
      • Sending Stickers
      • Sending Bulk Messages - Push
      • Sending Contacts
      • Sending Location
      • Sending WhatsApp Template Messages
        • Introduction
        • Sending WhatsApp Template Text Messages
        • Sending WhatsApp Template Image
        • Sending WhatsApp Template Document
        • Sending WhatsApp Interactive Buttons
        • Sending WhatsApp Limited Time Offer Templates
      • Sending Message to Groups
      • Sending SMS Using SIM Card
      • Sending Message to Facebook Messenger
      • Normal Post Method
      • Delivery Reports
      • Push API Must Read Instructions
      • Testing API Requests
    • WhatsApp Template API
      • Introduction
      • API Variables
      • Template Request API
      • Template Status API
      • Languages
      • Guidelines
    • WhatsApp Group API
      • Introduction
      • API Variables
      • Create Group
      • Set Group Permission
      • Add Group Admin
      • Add Group Members
      • Fetch Group Details
      • Update Group Info
      • Remove Group Members / Admin
      • Generate New Invite Link
      • Group Delete Actions
    • WhatsApp Settings API's
      • WhatsApp Profile API
      • 2 Step Verification
      • WhatsApp Status Update
      • WhatsApp Contact & Group Fetching
    • Device Manage API’s
      • Fetching Device Status API
      • Device Commands API’s
      • WhatsApp Automation Server Status API
    • Account API
      • Fetch Balance
    • Project Management API
      • Introduction
      • Create Project
      • Get Project Details
      • Set / Update Webhook
      • Create API Token
      • Manage API Token
      • Change Billing Plan
      • Fetch Account Balance
      • Country Code & Timezones
    • References
      • Status & Error Codes
      • Most Frequent Issues & Solutions
      • Formating & Sending Emojis 😊
      • Postman Collection for Picky Assist API's
      • High Volume Messaging Bots - WhatsApp
    • Sample Codes
      • PHP
      • Python
      • Node JS
      • Ruby
      • Java
      • ASP.NET Using C#
      • Javascript
      • Go
      • Swift
      • C
      • C#
      • Objective C
  • General Guidelines
    • Billing
    • Adding Money Into Account
    • Rate Limits
    • Character Limits WhatsApp
    • Best Practices for Media Handling
    • Roadmap
    • Features In the Early Beta Version
  • Changelog
    • 2021
      • February 2021
      • March 2021
      • April 2021
      • May 2021
      • June 2021
    • 2020
      • February 2020
      • March 2020
      • April 2020
      • May 2020
      • June 2020
      • September 2020
      • October 2020
    • 2019
      • November 2019
      • October 2019
      • August 2019
      • September 2019
Powered by GitBook
On this page
  • Supported Media Files
  • Optional Caption Message
  • Sending Media Attachments Messages
  • Sample Request Body JSON for Sending Static Media Files
  • Sample Request Body JSON for sending Static Media Files using Base64
  • Sample Request Body JSON for Sending Audio File as Voice Note
  • Sample Request Body JSON for Sending Dynamic Media
  • Sample Request Body JSON for Sending Dynamic Media through Base64
  • Sample Response

Was this helpful?

  1. API Documentation V2
  2. Push API

Sending Media Attachments – Push

PreviousSending Dynamic Messages – PushNextSending Interactive List & Buttons

Last updated 1 year ago

Was this helpful?

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

WhatsApp

Images

jpg, jpeg, gif, png, image

5 MB

WhatsApp

Video

mp4, 3gpp

16 MB

WhatsApp

Audio

mp3, wav, aac, m4a, amr, opus

16 MB

WhatsApp

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

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.

whatsapp-image-with-caption-message