Introduction

The WaFi - Whatsapp Business API Platform API follows RESTful architecture standards, offering clear and consistent resource-based endpoints. All requests and responses are transmitted in JSON format, leveraging standard HTTP verbs, status codes, and authentication protocols to enable secure, efficient, and scalable integrations.

API Base URL

Please note that WaFi - Whatsapp Business API Platform does not provide a sandbox or test environment. All API requests are processed in the live environment, so ensure that all request data and parameters are accurate before making any calls.

https://wa.fihd.in/external-api

Authentication

All requests to the WaFi - Whatsapp Business API Platform API require authentication. Each API request must include a valid client-id and client-secret to the request header, which can be obtained from your WaFi - Whatsapp Business API Platform Dashboard under Developer Tools.

In addition to credentials, WaFi - Whatsapp Business API Platform enforces IP-based security. You must register and enable your server’s public IP address in the IP Whitelist section of the dashboard. Requests originating from non-whitelisted IP addresses will be automatically rejected.

Both valid API credentials and an approved IP address are mandatory. Without completing these two steps, authentication will fail and API access will not be granted.

Response Format

All responses from the WaFi - Whatsapp Business API Platform API are returned in JSON format. Each response follows a consistent structure and includes a status indicator, message, and relevant data payload when applicable. Standard HTTP status codes are used to represent the outcome of each request.

Sample Success Response

{
"status": "success",
"remark": "contact_list",
"message":[
    "Contact list fetched successfully"
],
"data": {
   ...you get all data here
    }
}

Error Sample Response

{
    "remark": "Unauthorized",
    "status": "error",
    "message": [
        "The client secret is required"
    ]
}

 {
    "remark": "Unauthorized",
    "status": "error",
    "message": [
        "Access to this API endpoint is restricted to IP addresses that have been explicitly whitelisted.",
        "In order to access this API endpoint, please add your IP address (::1) to the white list from the user dashboard."
    ]
}


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/contact/list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Get Contact List

This endpoint allows you to retrieve a complete list of contacts associated with your WaFi - Whatsapp Business API Platform account.

GET

contact/list

Query Parameters

Query parameters that allow you to customize the API response.

Name	Description	Required	Default
`page`	Specifies the page number to retrieve.	No	1
`paginate`	Defines the number of items returned per page.	No	20
`search`	Searches for contacts by firstname, lastname or mobile number.	No	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/contact/store',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Create New Contact

This endpoint allows you to add a new contact to your WaFi - Whatsapp Business API Platform account. Provide the necessary contact details, and upon successful request, the API returns the created contact’s information in JSON format for easy integration.

POST

/contact/store

Required Fields

The following fields are required to create a new contact in the system.

Name	Required	Default
`firstname`	Yes	-
`lastname`	Yes	-
`mobile_code`	Yes	-
`mobile`	Yes	-
`city`	No	-
`state`	No	-
`post_code`	No	-
`address`	No	-
`profile_image`	No	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/contact/update/{contactId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Update Contact

This endpoint allows you to update an existing contact. You only need to send the fields you want to modify. Any field not included in the request will remain unchanged.

POST

/contact/update/{id}

Required Fields

The following fields are required to create a new contact in the system.

Name	Required	Default
`firstname`	Yes	-
`lastname`	Yes	-
`mobile_code`	Yes	-
`mobile`	Yes	-
`city`	No	-
`state`	No	-
`post_code`	No	-
`address`	No	-
`profile_image`	No	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/contact/delete/{contactId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Delete Contact

This endpoint allows you to delete a contact by its unique ID. Deletion may be restricted if the contact has associated messages or is blocked.

DELETE

/contact/delete/{id}


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/inbox/conversation-list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Conversation List

Retrieve a paginated list of conversations for the authenticated user, including contact info and conversation status.

GET

/inbox/conversation-list

Query Parameters

Name	Description	Default
`status`	Filter conversations by status. Use below value for the filter conversation via status. Done = 1; Pending = 2; Important = 3; Unread = 4;	All
`page`	Specifies the page number to retrieve.	1
`paginate`	Defines the number of items returned per page.	20


$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/inbox/change-conversation-status/2',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('status' => '1'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Change Conversation Status

Update the status of a conversation such as pending, done, or important. Here Done = 1, Pending = 2 and Important = 3,UnRead=4

POST

/inbox/change-conversation-status/{conversation_id}

URL Parameters

Parameter	Type	Description
`conversation_id`	integer	Unique ID of the conversation

Request Body

Field	Type	Required
`status`	integer	YEs


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/inbox/conversation-details/2',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS => array('status' => '1'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Conversation Details

Retrieve complete details of a conversation including contact information, notes, tags, and list associations.

GET

/external-api/inbox/conversation-details/{conversation_id}

URL Parameters

Parameter	Type	Description
`conversation_id`	integer	Unique ID of the conversation


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/inbox/send-message',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('mobile_code' => '880','mobile' => xxxxxxxxx','message' => 'Hello world'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Send Message

Send WhatsApp messages to a mobile number. This endpoint supports text, media, location, interactive lists, CTA URLs, and e-commerce messages. If no existing contact or conversation is found for the provided phone number, a new contact and conversation will be created automatically.

POST

/inbox/send-message

Request Body

Field	Type	Required	Description
`mobile_code`	string	yes	Mobile country code. Must be a valid numeric country code without the plus (+) sign.
`mobile`	string	yes	A valid mobile phone number associated with the provided country code.
`from_number`	string	conditional	A valid WhatsApp Business phone number registered on your account and in the Meta dashboard is required. If no ID is provided, the message will be sent using your default registered WhatsApp account.
`message`	string	Conditional	Text message body. Required if no media, location, or interactive data is provided
`image`	file	No	Image file (jpg, jpeg, png – max 5MB)
`document`	file	No	Document file (pdf, doc, docx – max 100MB)
`video`	file	No	Video file (mp4 – max 16MB)
`audio`	file	No	Audio file – max 16MB
`latitude`	decimal	Conditional	Latitude for location message
`longitude`	decimal	Conditional	Longitude for location message
`cta_url_id`	integer	No	CTA URL ID for interactive button messages
`interactive_list_id`	integer	No	Interactive list ID

Notes

At least one message type must be provided.

Interactive messages require an active plan.

Blocked contacts cannot send or receive messages.


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/inbox/send-template-message',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array(
    'conversation_id'  => '123',
    'template_id'      => '45',
    'body_variables[]' => 'John',
    // Add more body_variables[] for 2, 3 etc.
    // 'header_variables[]' => 'Header value',
    // 'button_variables[]' => 'dynamic-url-suffix',
  ),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Send Template Message

Send an approved WhatsApp template message into an existing conversation. Use this endpoint when you already have a conversation_id (i.e. the contact has previously messaged you). For sending to any mobile number without a conversation, use the Send Template Direct endpoint instead.

POST

/external-api/inbox/send-template-message

Request Body

Field	Type	Required	Description
`conversation_id`	integer	Yes	The ID of an existing conversation. Retrieve this from the Conversation List endpoint.
`template_id`	integer	Yes	The internal ID of an approved WhatsApp template. Retrieve this from the Get Template List endpoint.
`body_variables`	array	No	Array of values to fill in the template body variables , , etc. Pass values in order.
`header_variables`	array	No	Array of values to fill in the template header variable . Only applies to text-type headers with a variable.
`button_variables`	array	No	Array of values for URL button variables . Each entry corresponds to a URL button in the template by index order.

Notes

Only approved WhatsApp templates can be sent.

Blocked contacts cannot receive template messages.

The conversation must belong to your account.

To send to a mobile number directly without a conversation, use the Send Template Direct endpoint.


// Simple template (no variables)
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/api/templates/send',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode([
    'whatsapp_account_id' => 'YOUR-WABA-ID',
    'template_name'       => 'your_template_name',
    'mobile_number'       => '+919876543210',
  ]),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR-API-KEY',
    'Content-Type: application/json',
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;


// Template with body + button variables
$postData = [
  'whatsapp_account_id' => 'YOUR-WABA-ID',
  'template_name'       => 'order_confirmed',
  'mobile_number'       => '+919876543210',
  'body_variables'      => ['John', 'ORD-4521', '₹1,299'],
  'button_variables'    => ['ORD-4521'],
];

curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postData));

Send Template Direct

Send an approved WhatsApp template message directly to any mobile number using your API key — no conversation ID or login required. Ideal for external integrations, webhooks, CRMs, and automated workflows.

POST

/api/templates/send

Authentication: This endpoint uses your personal API key (not client-id/client-secret). Pass it as a Bearer token in the Authorization header.
Authorization: Bearer YOUR-API-KEY
Find your API key in your dashboard under Developer Credentials.

Request Body

Field	Type	Required	Description
`whatsapp_account_id`	string	Yes	Your WhatsApp Business Account ID (WABA ID) from Meta. Found in your WhatsApp Account settings.
`template_name`	string	Yes*	The exact template name as registered with Meta. Required if template_id is not provided.
`template_id`	integer	Yes*	The internal template ID from this platform. Required if template_name is not provided. Use the Get Template List endpoint to find IDs.
`mobile_number`	string	Yes	Recipient phone number in E.164 format including country code. Example: +919876543210
`body_variables`	array	No	Array of string values to fill template body placeholders , , etc. Values must be provided in order. Max 10 values.
`header_variables`	array	No	Array of string values to fill the template header placeholder . Only needed for text-type headers with a variable. Max 5 values.
`button_variables`	array	No	Array of values for URL button dynamic suffixes . Each entry maps to a URL button by index. Max 3 values.

Examples

Simple template (no variables):

{
  "whatsapp_account_id": "123456789012345",
  "template_name": "welcome_message",
  "mobile_number": "+919876543210"
}

Template with body variables:

{
  "whatsapp_account_id": "123456789012345",
  "template_name": "order_confirmed",
  "mobile_number": "+919876543210",
  "body_variables": ["John", "ORD-4521", "₹1,299"]
}

→ Fills = John, = ORD-4521, = ₹1,299 in the template body.

Template with header + body + button URL variable:

{
  "whatsapp_account_id": "123456789012345",
  "template_name": "track_order",
  "mobile_number": "+919876543210",
  "header_variables": ["John"],
  "body_variables": ["ORD-4521", "2 days"],
  "button_variables": ["ORD-4521"]
}

→ Button URL becomes https://yourdomain.com/track/ORD-4521

Success Response

{
  "status": "success",
  "message": "Template sent successfully",
  "whatsapp_message_id": "wamid.XXXXXXXXXXXXXX",
  "template_name": "order_confirmed"
}

Error Response

{
  "status": "error",
  "message": "The selected whatsapp_account_id is invalid."
}

Notes

Only approved WhatsApp templates can be sent. Pending or rejected templates will return an error.

template_name and template_id are mutually exclusive — provide one, not both.

The template must belong to the specified whatsapp_account_id.

If the recipient has an existing conversation, the sent message will appear in the inbox automatically.

For sending within an existing conversation by conversation ID, use the Send Template Message endpoint instead.


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wa.fihd.in/extern-api/inbox/template-list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Get Template List

This endpoint allows you to fetch all WhatsApp templates associated with your account.

POST

/inbox/template-list