Introduction

The WapiFlow 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 WapiFlow 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://wapiflow.cloud/external-api

Authentication

All requests to the WapiFlow 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 WapiFlow Dashboard under Developer Tools.

In addition to credentials, WapiFlow 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 WapiFlow 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.

Respuesta Exitosa de Ejemplo

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

Respuesta de Error de Ejemplo

{
    "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://wapiflow.cloud/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 WapiFlow account.

GET

contact/list

Parámetros de Consulta

Parámetros de consulta que permiten personalizar la respuesta de la API.

Nombre	Descripción	Requerido	Por Defecto
`página`	Especifica el número de página a recuperar.	No	1
`paginar`	Define el número de elementos devueltos por página.	No	20
`búsqueda`	Busca contactos por nombre, apellido o número de móvil.	No	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Crear Nuevo Contacto

This endpoint allows you to add a new contact to your WapiFlow 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

Campos Requeridos

Los siguientes campos son necesarios para crear un nuevo contacto en el sistema.

Nombre	Requerido	Por Defecto
`nombre`	Sí	-
`apellido`	Sí	-
`código_móvil`	Sí	-
`móvil`	Sí	-
`ciudad`	No	-
`estado`	No	-
`código_postal`	No	-
`dirección`	No	-
`imagen_perfil`	No	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Actualizar Contacto

Este endpoint te permite actualizar un contacto existente. Solo necesitas enviar los campos que deseas modificar. Cualquier campo no incluido en la solicitud permanecerá sin cambios.

POST

/contact/update/{id}

Campos Requeridos

Los siguientes campos son necesarios para crear un nuevo contacto en el sistema.

Nombre	Requerido	Por Defecto
`nombre`	Sí	-
`apellido`	Sí	-
`código_móvil`	Sí	-
`móvil`	Sí	-
`ciudad`	No	-
`estado`	No	-
`código_postal`	No	-
`dirección`	No	-
`imagen_perfil`	No	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Eliminar Contacto

Este endpoint permite eliminar un contacto por su ID único. La eliminación puede estar restringida si el contacto tiene mensajes asociados o está bloqueado.

DELETE

/contact/delete/{id}


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Lista de Conversaciones

Recupera una lista paginada de las conversaciones del usuario autenticado, incluyendo la información del contacto y el estado de la conversación.

GET

/inbox/conversation-list

Parámetros de Consulta

Nombre	Descripción	Por Defecto
`status`	Filtra las conversaciones por estado. Utiliza los siguientes valores para filtrar las conversaciones. Done = 1; Pending = 2; Important = 3; Unread = 4;	Todo
`página`	Especifica el número de página a recuperar.	1
`paginar`	Define el número de elementos devueltos por página.	20


$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Cambiar Estado de la Conversación

Actualiza el estado de una conversación como pendiente, finalizada o importante. Aquí Finalizada = 1, Pendiente = 2 e Importante = 3, No Leída = 4

POST

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

Parámetros de la URL

Parámetro	Tipo	Descripción
`conversation_id`	integer	ID único de la conversación

Cuerpo de la Solicitud

Campo	Tipo	Requerido
`status`	integer	YEs


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Detalles de la Conversación

Recupera los detalles completos de una conversación, incluyendo la información del contacto, notas, etiquetas y asociaciones de listas.

GET

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

Parámetros de la URL

Parámetro	Tipo	Descripción
`conversation_id`	integer	ID único de la conversación


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Enviar Mensaje

Envía mensajes de WhatsApp a un número de móvil. Este endpoint soporta texto, multimedia, ubicación, listas interactivas, URLs CTA y mensajes de comercio electrónico. Si no se encuentra un contacto o conversación existente para el número, se creará uno nuevo automáticamente.

POST

/inbox/send-message

Cuerpo de la Solicitud

Campo	Tipo	Requerido	Descripción
`mobile_code`	string	yes	Código de país del móvil. Debe ser un código numérico válido sin el signo más (+).
`mobile`	string	yes	Un número de teléfono móvil válido asociado al código de país proporcionado.
`from_number`	string	conditional	Se requiere un número de WhatsApp Business válido registrado en su cuenta y en el panel de Meta. Si no se proporciona un ID, el mensaje se enviará usando su cuenta de WhatsApp registrada por defecto.
`message`	string	Conditional	Cuerpo del mensaje de texto. Requerido si no se proporcionan datos multimedia, ubicación o interactivos
`image`	file	No	Archivo de imagen (jpg, jpeg, png – máx 5MB)
`document`	file	No	Archivo de documento (pdf, doc, docx – máx 100MB)
`video`	file	No	Archivo de video (mp4 – máx 16MB)
`audio`	file	No	Archivo de audio – máx 16MB
`latitude`	decimal	Conditional	Latitud para el mensaje de ubicación
`longitude`	decimal	Conditional	Longitud para el mensaje de ubicación
`cta_url_id`	integer	No	ID de URL de CTA para mensajes de botón interactivo
`interactive_list_id`	integer	No	ID de la lista interactiva

Notas

Debe proporcionarse al menos un tipo de mensaje.

Los mensajes interactivos requieren un plan activo.

Los contactos bloqueados no pueden enviar o recibir mensajes.


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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('mobile_code' => '880','mobile' => 'xxxxxx','testmplate_id' => 'your template id'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Enviar Mensaje de Plantilla

Envía un mensaje de plantilla de WhatsApp aprobado a una conversación existente. Los mensajes de plantilla se usan comúnmente para notificaciones, alertas y comunicación iniciada por el negocio.

POST

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

Cuerpo de la Solicitud

Campo	Tipo	Requerido	Descripción
`mobile_code`	string	yes	Código de país del móvil. Debe ser un código numérico válido sin el signo más (+).
`mobile`	string	yes	Un número de teléfono móvil válido asociado al código de país proporcionado.
`from_number`	string	conditional	Se requiere un número de WhatsApp Business válido registrado en su cuenta y en el panel de Meta. Si no se proporciona un ID, el mensaje se enviará usando su cuenta de WhatsApp registrada por defecto.
`template_id`	integer	Yes	ID de la plantilla de WhatsApp aprobada

Notas

Solo se pueden enviar plantillas de WhatsApp aprobadas.

Los mensajes de plantilla se usan típicamente para conversaciones iniciadas por la empresa.

Los contactos bloqueados no pueden recibir mensajes de plantilla.

La cuenta de WhatsApp debe estar conectada antes de enviar mensajes.


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wapiflow.cloud/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;

Obtener Lista de Plantillas

Este endpoint te permite obtener todas las plantillas de WhatsApp asociadas a tu cuenta.

POST

/inbox/template-list