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
  • Introduction
  • Quick Replies
  • Call 2 Action
  • Payload
  • API Variables
  • Sample API Request for Sending Quick Reply along with a Text Template
  • Sample for Dynamic Payload Passing for Each Number
  • Passing Static Payload for all numbers in the Push
  • Sample API Request for Sending Call to Action URL along with an Image Template
  • Sample API Request for Sending Call To Action URL & Website in a Text Template
  • Sending Dynamic Message with each Mobile Number for Call to Action URL
  • Sending Static Payload for all numbers in a push.
  • Sample Response JSON
  • Frequently Asked Questions
  • Is it possible to generate the quick replies button dynamically as per the situation?
  • Is it possible to change the Call to Action URL dynamically?
  • Can I use the existing approved templates by adding only buttons?
  • Are WhatsApp Buttons supports in all template types?
  • Is there any extra cost for sending WhatsApp Interactive Templates?
  • How can I request the WhatsApp Interactive Templates?
  • Can I send the WhatsApp Interaction buttons through Session Messages?
  • How do know which user and which button is clicked?
  • Can I change the buttons order/position while sending messages?
  • Is it possible to track the clicks on the Call to Action buttons?
  • Is it possible to change the phone number in the Call to Action Phone Number?
  • Is it possible to send Quick Replies & Call to Action Button together in a message?
  • How many buttons are available in Quick replies?
  • How many buttons are available in Call to Action?
  • Is it possible to request a template with 2 URL buttons?
  • What happens when the user clicks on the Phone Number Button?
  • I have a template approved with 3 quick replies, can I dynamically hide 1 button based on my situation?
  • Are all languages supported as button text?
  • If a user clicks twice on a button what will happen?
  • Will the user able to forward the interaction button messages?
  • Are the buttons displays on WhatsApp Web / Desktop App as well?

Was this helpful?

  1. API Documentation V2
  2. Push API
  3. Sending WhatsApp Template Messages

Sending WhatsApp Interactive Buttons

PreviousSending WhatsApp Template DocumentNextSending WhatsApp Limited Time Offer Templates

Last updated 4 years ago

Was this helpful?

Currently this feature is available only through API.

Introduction

WhatsApp recently introduced interactive buttons for WhatsApp Templates (HSM) and this allows businesses to send up to 3 quick replies and 1 Website & 1 Phone number as Call to Action along with the Text, Image, Document & Video Templates

Below examples show the different type of interactive buttons available with WhatsApp Templates;

Quick Replies

Quick replies can have up to 3 buttons and can be used with text, image, document, video templates

Call 2 Action

With the help of Call to Action businesses can redirect the user to a URL or Dial a Phone Number and it has two types of buttons as shown below;

  1. URL

  2. Phone Number

URL

URL allows you to dynamically pass a variable at the end of the URL like https://pickyassist.com/app/buttons/{{1}} and this helps you to redirect the users to a website or order tracking page appending the order reference number or any other values.

Phone Number

This helps users to take action by clicking the button and it will dial the phone number.

Please note except the URL Dynamic variable you are not allowed to change the button text once the template is approved, i.e you need to provide all the button text and call to action URL & Contact number while requesting the templates.

Maximum 20 characters are allowed in the button name and no emoji support, you need to request the button name while requesting the template and it’s not possible to change while sending the messages

Payload

Please note passing payload is only supported for sending WhatsApp templates with Quick Replies

Payload needs to be passed as per the position of the approved quick replies buttons.

API Variables

Variable Name

Type

Description

payload

array

You can pass a custom payload like a reference number for each button in the quick replies, this is an array and optional

It's possible to pass dynamic payload for each number separately while sending messages, refer the example below

interactive_globalbuttons

array

This is applicable only for the Call to Action URL and used for sending dynamic variables that should be replaced in the dynamic URL button. Mandatory if button type is url and interactive_buttons is empty.

If the URL variable is dynamic in nature (personalise for each number) then you need to pass the dynamic value against each number through interactive_buttons

interactive_buttons

array

This is applicable only for the Call to Action URL and used for sending dynamic variables that should be replaced in the dynamic URL button. This is used to pass personalised variable for each number dynamically and this is optional if interactive_globalbuttons is not empty

Sample API Request for Sending Quick Reply along with a Text Template

You can use the quick reply along with Text, Image, Document & Video Templates, need to request the template accordingly

Please mind the payload value position in the array as it should be in the same order as how your buttons appears in the messages. You can pass payload dynamically for each number or can pass static payload for all messages in the push. To pass dynamically include the *payload* inside the data array, to globally use pass the payload outside the data array

Sample for Dynamic Payload Passing for Each Number

{
	"token": "{{token}}",
	"application": "8",
	"template_id": "PQ112360",
	"data": [
    	{
        	"number": "91940055074",
            "payload": 
                [
            	"confirmbtn",
            	"cancelbtn",
            	"notsurebtn"
            	],
        	"template_message": [
            	"*James*",
            	"*Consulatation*",
            	"*Dr Daniel*",
            	"*Confirmed*",
            	"*27, Feb 2021 @ 2 PM*",
            	"Picky Assist"
        	],
        	"language": "en"
    	}
	]
}

Passing Static Payload for all numbers in the Push

{
	"token": "#TOKEN#",
	"application": "8",
	"template_id": "PQ112360",
	"payload": [
            	"confirmbtn",
            	"cancelbtn",
            	"notsurebtn"
            	],
	"data": [
    	{
        	"number": "91940055074",
        	"template_message": [
            	"11",
            	"22",
            	"33",
            	"44",
            	"55",
            	"66"
        	],
        	"language": "en"
    	}
	]
}

Sample API Request for Sending Call to Action URL along with an Image Template

It's possible to pass dynamic variable for the Call to Action URL for each number. For Dynamic use "interactive_buttons" array inside the data and for global use "interactive_globalbuttons"

{
	"token": "token",
	"application": 8,
	"template_id": "PB18600",
	"template_globalmessage": [
    	"abc",
    	"111",
    	"222",
    	"333",
    	"444",
    	"Picky"
	],
	"language": "en",
	"globalmedia": "https://pickyassist.com/img/social-messaging.png",
            "interactive_globalbuttons": [
            	"123"
            ],
	"data": [
    	{
        	"number": "91940055074",
        	"message": "",
        	"interactive_buttons": [
            	"123"
            ]
    	}
	]
}

Sample API Request for Sending Call To Action URL & Website in a Text Template

It's possible to pass a dynamic variable for the Call to Action URL for each number or can pass a static value for all numbers in a push. For Dynamic use "interactive_buttons" array inside the data and for global use "interactive_globalbuttons"

Sending Dynamic Message with each Mobile Number for Call to Action URL

{
	"token": "{{token}}",
	"application": 8,
	"template_id": "GQ113728",
	"language": "en",
	"data": [
    	{
        	"number": "91940055074",
        	"template_message":[ 
            "*Daniel*",
            "*Iphone 12 Pro Max*"
         ],
        	"interactive_buttons": 
            [
            	"123"
            ]
    	}
	]
}

Sending Static Payload for all numbers in a push.

{
	"token": "{{token}}",
	"application": 8,
	"template_id": "GQ113728",
	"language": "en",
  "interactive_globalbuttons": 
            [
            	"123"
            ],
	"data": [
    	{
        	"number": "91940055074",
        	"template_message":[ 
            "*Daniel*",
            "*Iphone 12 Pro Max*"
         ]
        	
    	}
	]
}

Sample Response JSON

{
    "status": 100,
    "push_id": "26296089",
    "message": "Success",
    "data": [
        {
            "msg_id": "30793156",
            "number": "91940055074",
            "credit": 0.0044688
        }
    ]
}

Frequently Asked Questions

Is it possible to generate the quick replies button dynamically as per the situation?

Is it possible to change the Call to Action URL dynamically?

The base url can't be changed once its approved however you will have an option to dynamically pass the value through variable like https://pickyassist.com/t/{{1}} can be replaced with https://pickyassist.com/t/order-id12334565

Can I use the existing approved templates by adding only buttons?

No, you can't use the existing templates with buttons however you can request a new template with the same message body along with the quick replies or call to action button as per your business requirements.

Are WhatsApp Buttons supports in all template types?

Yes, Buttons can be used with all type of template types i.e Text, Image, Video & Document (PDF)

Is there any extra cost for sending WhatsApp Interactive Templates?

No, the cost is the same for the template messages as per the designation country.

How can I request the WhatsApp Interactive Templates?

Can I send the WhatsApp Interaction buttons through Session Messages?

Yes, if the 24 hours session window is active against the user then you will able to send the WhatsApp Interaction button and it won't be billed as per the destination country charges still counted as session messages and billed as per your plan.

How do know which user and which button is clicked?

Can I change the buttons order/position while sending messages?

No, button order can't be changed while sending messages, so please make sure that you have passed the correct position while requesting a template.

Is it possible to track the clicks on the Call to Action buttons?

No, when a user clicks on the call to action button it redirects the user either into a webpage or dials a number as per the button type they clicked, so it's not possible to get the click reports for Call to Action button type.

Is it possible to change the phone number in the Call to Action Phone Number?

No, once the button is approved it's not possible to change the value in the Call to Action Phone number button, so please request a new template with a new number.

Is it possible to send Quick Replies & Call to Action Button together in a message?

No, only one button type can be passed through a single message.

How many buttons are available in Quick replies?

You can request upto 3 buttons and each button name can have upto 20 characters with no emoji support.

How many buttons are available in Call to Action?

In the Call to Action you can pass upto 2 buttons i.e URL & Phone number.

Is it possible to request a template with 2 URL buttons?

No, only one URL button is allowed in a template however if you use you can add a phone number button as well.

What happens when the user clicks on the Phone Number Button?

The number which you set for the button will be dialed from the user phone.

I have a template approved with 3 quick replies, can I dynamically hide 1 button based on my situation?

No, it's not possible to dynamically hide buttons.

Are all languages supported as button text?

Yes, you can pass button name in any language WhatsApp supports in templates, make sure your select the correct language while requesting the templates.

If a user clicks twice on a button what will happen?

When a user is interacting with a quick reply once the user clicked the clicked button becomes inactive which preventing users from clicking it again however for Call to Actions URL & Phone Number buttons can be clicked anytime and buttons won't get disabled.

Will the user able to forward the interaction button messages?

Yes, they can forward but the buttons will not be sent when forwarding i.e only body text will be sent.

Are the buttons displays on WhatsApp Web / Desktop App as well?

Yes, buttons will display in WhatsApp Web / Desktop App as well.

Still, Questions feel free to send an email to support@pickyassist.com

This is a new variable “payload” available in the Push API & Webhook in order track the quick reply button clicks, i.e when you send a message with interactive buttons and when the user clicked the button you will get the payload passed by you in the , you can pass separate payload for each button to make the user reply tracking easier.

Below are the API Variables related only to the interactive templates, for a complete list of API Variables please

This payload will return in the when the user click on the button

You can use the *msg_id* to get the message context in the if the user replies to your messages using quoted reply;

No, you are allowed to use only approved templates on your WhatsApp Official Number, once the quick reply buttons are approved by WhatsApp it's not possible to change the button name or its position, however while sending the message you will have the option to pass your own custom payload for each button and the same will be pushed back to your server when the user clicks on the buttons.

You can request new templates using the WhatsApp Template Request API, currently it's not possible to request the template from our platform, you can also use our to ease this process.

While sending a message you will have the option to pass a custom payload for each button and when the user clicked on the button you will get the payload you passed along with the message context id.

webhook
refer here
webhook
Postman Collection
Read More
Read More
Webhook