On which channel you need to request the WhatsApp Template.
121 = WhatsApp Business API
If you have connected multiple channels or using WhatsApp Cloud api then please get the channel id from your project under Settings -> Channels
You need to pass the Channel ID here , which can take from your platform under Settings -> Channels
121= WhatsApp Business API
Specify the message type, in the document only PDF is supported
1 = Text
2 = Image (.jpg, .jpeg, .png)
3 = Document (.pdf)
4 = Video
| Mandatory | | category | numeric |Specify the the category which the message belongs to , please make sure you pass the correct category based on your nature of business.
12=TRANSACTIONAL
13=MARKETING
14=OTP
| Mandatory | | name | string |Template name. Can only contain lowercase alphanumeric characters and underscores ( \_ ). No other characters or white space are allowed.
Template name can't duplicate
This is an array in which you need to pass the message and language , you can pass multiple messages by specifying the language
| Mandatory | | message | string |Message content with dynamic variable starting from {{1}}
Text Template maximum character limit is 1024
For Media template maximum character limit is 160.
| Mandatory | | language | string | Object through which you can pass multiple number and its personalised message | Mandatory | | header | string |If you wish to add a header then please pass here, only 60 character allowed and supports one dynamic variable
Make sure the dynamic variable value not exceeds the 60 characters limit of the header when sending message
This is the type of button to be requested
1 = Quick Reply
2 = URL
3 = Phone Number
| Mandatory for buttons | | text | string |Button Text Name
1) Maximum 20 characters allowed
Not possible to change once its approved
| Mandatory for buttons | | url | url |Website URL should pass
Must have {{1}} at the end of the URL like
Only one dynamic variable is allowed and its should be at the end of the URL
Not possible to change once its approved
| Mandatory if type=2 | | phone\_number | string |Phone Number which needs to be dialed when clicking the Call to Action button
Not possible to change once its approved
| Mandatory if type=3 | #### ## Response Variables | Variable | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | template\_id | Alpha numeric unique template id , this template id need to pass when sending templated messages | | template\_status |Status of the Templates,
1 = Pending Review
2 = WA Pending Review
3 = Approved
4 = Rejected
| | category |Category of the template
1 = ACCOUNT\_UPDATE
2 = PAYMENT\_UPDATE
3 = PERSONAL\_FINANCE\_UPDATE
4 = SHIPPING\_UPDATE
5 = RESERVATION\_UPDATE
6 = ISSUE\_RESOLUTION
7 = APPOINTMENT\_UPDATE
8 = TRANSPORTATION\_UPDATE
9 = TICKET\_UPDATE
10 = ALERT\_UPDATE
11 = AUTO\_REPLY
| | message\_type |Message type
1 = Text
2 = Image (.jpg, .jpeg, .png)
3 = Document (.pdf)
4= Video
This is an array which gives template message and language
message = template message
language = language of the template
100=>’Success’,
401=>Authentication Failed
801=>Official WhatsApp Account Not Active
405=>API Is Not Active For This Plan
804=>Invalid Template ID
817=>No Templates Found
883 => Sample Message not matched with the Count of the Dynamic Variable
884 => Sample Values are Mandatory For All Dynamic Variables And Media
885 => Header Is Missing
886 => Footer Is Missing
887 => 'Only One Dynamic Variable Allowed In Header'
888 => 'Header Parameters Count Not Matching'
Refer Complete Status & Error Code Here
| | message | Detailed Status Message (description of any error message) | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://help.pickyassist.com/api-documentation-v2/whatsapp-template-api/api-variables.md?ask=