Introduction

Welcome to the WhatsApp API documentation. This guide provides developers with information on two key APIs: Get WhatsApp Variables and Send WhatsApp Message. These APIs are designed to enable you to send WhatsApp messages with ease, ensuring that you follow WhatsApp template guidelines.

​

To Send Messages, Generate the API Key

1. Go to Developers under Admin settings at Zixflow Platform - https://app.zixflow.com/settings/workspace/developer
2. Now assign the respective permissions to the channel which you want to give specific or all channels (all channels recommended so you don’t have to change the API in the future if you want to use other channels)

​

Get WhatsApp Variables API

The Get WhatsApp Variables API provides essential information about the WhatsApp template you intend to use. This API allows you to understand the template’s structure, including the variable names and value types required for successful message delivery. This will return a JSON response with information about the template variables, such as their names and data types. If the template does not require any variables, the API response will indicate that. In this case, you can proceed to send the WhatsApp message without including any variables.

​

Send WhatsApp Message API

The Send WhatsApp Message API is used to send WhatsApp messages to end-users based on approved templates. This API allows you to craft and deliver messages in compliance with WhatsApp’s policies. It’s essential to provide valid variables when sending WhatsApp messages. If the variables do not match the template requirements or are not correctly formatted, the message will not be sent to the end-user. Always ensure that the variable data provided in your API request is accurate and adheres to the template’s structure.