API Variables

Request Variables

You need to use below variables to request a new WhatsApp Template

Request URL

Method : POST

https://pickyassist.com/app/api/v2/template-request
https://pickyassist.com/app/api/v2/template-status

Variable

Date Type

Description

Required

token

string

Unique token for the project

Mandatory

message_type

numeric

Specify the message type, in the document only PDF is supported

​

1 = Text

2 = Image (.jpg, .jpeg, .png)

3 = Document (.pdf)

​

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.

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

Mandatory

name

string

Template name. Can only contain lowercase alphanumeric characters and underscores ( _ ). No other characters or white space are allowed.

Mandatory

header

string

Optional Only for Documents, 60 Character limit

Optional,

footer

string

Optional only for Document & Image, 60 character limit

Optional

messages

Array

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

buttons

array

Array contains of WhatsApp Interactive Buttons Values

Optional

type

numeric

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

2) No Emoji Support

​

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 https://pickyassist.com/t/{{1}}

​

Only one dynamic variable is allowed and its should be at the end of the URL

​

Not possbile 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 possbile 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)

header

Header text of the template only applicable for document templates

footer

Footer of the template only applicable for media templates

template_name

Name of the template you requested

templates

This is an array presents only if you are not passing the template id

template_message

This is an array which gives template message and language

message = template message language = language of the template

​

status

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

​

​Refer Complete Status & Error Code Here​

message

Detailed Status Message (description of any error message)