Template Status API

This API enables you to Fetch WhatsApp Templates & it's Status

To use this API your project must be enabled with WhatsApp Business Account.

Template Status API

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

This API allows you to get the status of WhatsApp template

Request Body

Name
Type
Description

token

string

Your API Token

template_id

string

Pass the template Id you have to query the status, if you pass blank then it will fetch all templates in your project

{ 
   "template_id":"YG7203",
   "template_name":"welcome_message",
   "template_status":"1",
   "message_type":"2",
   "category":"10",
   "footer":"test footer",
   "template_message":[ 
      { 
         "message":"Hello {{1}}, Welcome to Pickyassist",
         "language":"en"
      }
   ],
   "status":100,
   "message":"Success"
}

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)

Sample Request - With Template ID

{ 
   "token":"782a357a2c87654b83fd1a017f05eb6794",
   "template_id":"YG7203"
}

Sample Response

{ 
   "template_id":"YG7203",
   "template_name":"welcome_message",
   "template_status":"1",
   "message_type":"2",
   "category":"10",
   "footer":"test footer",
   "template_message":[ 
      { 
         "message":"Hello {{1}}, Welcome to Pickyassist",
         "language":"en"
      }
   ],
   "status":100,
   "message":"Success"
}

Sample Request - Listing All Templates

{ 
   "token":"782a357a2c876874b83fd1a017f05eb6794"
}

Sample Response

{ 
   "status":100,
   "message":"Success",
   "templates":[ 
      { 
         "template_id":"WY5408",
         "template_name":"order_delivery",
         "template_status":"2",
         "message_type":"3",
         "category":"2",
         "header":"Order_Summary",
         "footer":"test footer",
         "template_message":[ 
            { 
               "message":"Your order {{1}} for a total of {{2}} is confirmed. The expected delivery is {{3}}.",
               "language":"en"
            }
         ]
      },
      { 
         "template_id":"PG6840",
         "template_name":"welcome",
         "template_status":"1",
         "message_type":"2",
         "category":"10",
         "footer":"test footer",
         "template_message":[ 
            { 
               "message":"Hello {{1}}, Welcome to Pickyassist",
               "language":"en"
            },
            { 
               "message":"Bonjour {{1}}, Bienvenue chez Pickyassist",
               "language":"fr"
            }
         ]
      }
   ]
}

Last updated