WhatsAPP Business API
Envíe / Reciba mensajes, imágenes, audio y video a través de WhatsAPP de forma automatizada por API
- HTTP API, Envíe Voz desde cualquier lenguaje de programación.
- API Oficial, Trabajamos con la API oficial de Facebook
- 99.9% SLA, Optimizamos el rendimiento de todos los servidores.
- Máxima Conectividad, Compatible con todos los países y operadoras.
Funcionalidades de la API de WhatsAPP Business
Enviar un mensaje por WhatsAPP
Parámetro | Descripción | Obligatorio / Opcional |
---|---|---|
class=whatsapp | Clase a la que se realiza la petición | Obligatorio |
method=sendmessage | Método de la clase al que se realiza la petición | Obligatorio |
user | El usuario / email de su cuenta de Afilnet | Obligatorio |
password | El password de su cuenta de Afilnet | Obligatorio |
platformid | Identificador de la plataforma | Obligatorio |
destination | whatsapp.sendmessage_destination | Obligatorio |
message | whatsapp.sendmessage_message | Obligatorio |
Respuesta:
- status
-
result (si status=success), recibirá los siguientes valores:
- No recibirá valores adicionales
- error (si status=error), aquí recibirá el código de error
Códigos de error:
Código | Descripción |
---|---|
MISSING_USER | Usuario / email no incluido |
MISSING_PASSWORD | Password no incluido |
MISSING_CLASS | Clase no incluida |
MISSING_METHOD | Método no incluido |
MISSING_COMPULSORY_PARAM | Parámetro obligatorio no incluido |
INCORRECT_USER_PASSWORD | Usuario o clave incorrectos |
INCORRECT_CLASS | Clase incorrecta |
INCORRECT_METHOD | Método incorrecto |
CHANNEL_NOT_FOUND | El canal indicado no existe |
Parámetros:
- class : whatsapp
- method : sendmessage
- user : user
- password : password
- platformid : 100
- destination : 3460000000
- message : test+message
Petición:
Enviar un archivo por WhatsAPP
Parámetro | Descripción | Obligatorio / Opcional |
---|---|---|
class=whatsapp | Clase a la que se realiza la petición | Obligatorio |
method=sendfile | Método de la clase al que se realiza la petición | Obligatorio |
user | El usuario / email de su cuenta de Afilnet | Obligatorio |
password | El password de su cuenta de Afilnet | Obligatorio |
platformid | Identificador de la plataforma | Obligatorio |
destination | whatsapp.sendfile_destination | Obligatorio |
type | whatsapp.sendfile_type | Obligatorio |
fileurl | whatsapp.sendfile_fileurl | Obligatorio |
thumburl | whatsapp.sendfile_thumburl | Opcional |
message | whatsapp.sendfile_message | Opcional |
Respuesta:
- status
-
result (si status=success), recibirá los siguientes valores:
- No recibirá valores adicionales
- error (si status=error), aquí recibirá el código de error
Códigos de error:
Código | Descripción |
---|---|
MISSING_USER | Usuario / email no incluido |
MISSING_PASSWORD | Password no incluido |
MISSING_CLASS | Clase no incluida |
MISSING_METHOD | Método no incluido |
MISSING_COMPULSORY_PARAM | Parámetro obligatorio no incluido |
INCORRECT_USER_PASSWORD | Usuario o clave incorrectos |
INCORRECT_CLASS | Clase incorrecta |
INCORRECT_METHOD | Método incorrecto |
CHANNEL_NOT_FOUND | El canal indicado no existe |
CHAT_NOT_FOUND | El chat indicado no existe |
INCORRECT_FILETYPE | El tipo de archivo es incorrecto, revise los valores posibles |
INCORRECT_FILEURL | La url del archivo no es válida |
INCORRECT_THUMBURL | La url de la miniatura no es válida |
Parámetros:
- class : whatsapp
- method : sendfile
- user : user
- password : password
- platformid : 100
- destination : 3460000000
- type : image
- fileurl : https://www.example.com/image.jpg
- thumburl : https://www.example.com/thumb.jpg
- message : test+message
Petición:
Enviar un mensaje con plantilla por WhatsAPP
Parámetro | Descripción | Obligatorio / Opcional |
---|---|---|
class=whatsapp | Clase a la que se realiza la petición | Obligatorio |
method=sendmessagefromtemplate | Método de la clase al que se realiza la petición | Obligatorio |
user | El usuario / email de su cuenta de Afilnet | Obligatorio |
password | El password de su cuenta de Afilnet | Obligatorio |
idtemplate | Identificador de la plantilla | Obligatorio |
platformid | Identificador de la plataforma | Obligatorio |
destination | Destinatario del mensaje (Número en formato internacional) | Obligatorio |
options | Las opciones permiten parametrizar y configurar el mensaje a enviar (Ver Anexo) | Opcional |
Respuesta:
- status
-
result (si status=success), recibirá los siguientes valores:
- No recibirá valores adicionales
- error (si status=error), aquí recibirá el código de error
Códigos de error:
Código | Descripción |
---|---|
MISSING_USER | Usuario / email no incluido |
MISSING_PASSWORD | Password no incluido |
MISSING_CLASS | Clase no incluida |
MISSING_METHOD | Método no incluido |
MISSING_COMPULSORY_PARAM | Parámetro obligatorio no incluido |
INCORRECT_USER_PASSWORD | Usuario o clave incorrectos |
INCORRECT_CLASS | Clase incorrecta |
INCORRECT_METHOD | Método incorrecto |
CHANNEL_NOT_FOUND | El canal indicado no existe |
Parámetros:
- class : whatsapp
- method : sendmessagefromtemplate
- user : user
- password : password
- idtemplate : 100
- platformid : 100
- destination : 3460000000
- options : {"header":{"file":"url"}}
Petición:
Obtener listado de conversaciones de WhatsAPP
Parámetro | Descripción | Obligatorio / Opcional |
---|---|---|
class=whatsapp | Clase a la que se realiza la petición | Obligatorio |
method=getchats | Método de la clase al que se realiza la petición | Obligatorio |
user | El usuario / email de su cuenta de Afilnet | Obligatorio |
password | El password de su cuenta de Afilnet | Obligatorio |
platformid | Identificador de la plataforma | Obligatorio |
Respuesta:
- status
-
result (si status=success), recibirá los siguientes valores:
-
list
- platformid
- message
- destination
- messageid
- sent
- status
- datetime
-
list
- error (si status=error), aquí recibirá el código de error
Códigos de error:
Código | Descripción |
---|---|
MISSING_USER | Usuario / email no incluido |
MISSING_PASSWORD | Password no incluido |
MISSING_CLASS | Clase no incluida |
MISSING_METHOD | Método no incluido |
MISSING_COMPULSORY_PARAM | Parámetro obligatorio no incluido |
INCORRECT_USER_PASSWORD | Usuario o clave incorrectos |
INCORRECT_CLASS | Clase incorrecta |
INCORRECT_METHOD | Método incorrecto |
CHANNEL_NOT_FOUND | El canal indicado no existe |
CHAT_NOT_FOUND | El chat indicado no existe |
Parámetros:
- class : whatsapp
- method : getchats
- user : user
- password : password
- platformid : 100
Petición:
Obtener listado de mensajes de un WhatsAPP
Parámetro | Descripción | Obligatorio / Opcional |
---|---|---|
class=whatsapp | Clase a la que se realiza la petición | Obligatorio |
method=getmessages | Método de la clase al que se realiza la petición | Obligatorio |
user | El usuario / email de su cuenta de Afilnet | Obligatorio |
password | El password de su cuenta de Afilnet | Obligatorio |
platformid | Identificador de la plataforma | Obligatorio |
destination | Destinatario del cual se quiere obtener los mensajes | Obligatorio |
Respuesta:
- status
-
result (si status=success), recibirá los siguientes valores:
-
list
- platformid
- message
- destination
- messageid
- sent
- status
- datetime
-
list
- error (si status=error), aquí recibirá el código de error
Códigos de error:
Código | Descripción |
---|---|
MISSING_USER | Usuario / email no incluido |
MISSING_PASSWORD | Password no incluido |
MISSING_CLASS | Clase no incluida |
MISSING_METHOD | Método no incluido |
MISSING_COMPULSORY_PARAM | Parámetro obligatorio no incluido |
INCORRECT_USER_PASSWORD | Usuario o clave incorrectos |
INCORRECT_CLASS | Clase incorrecta |
INCORRECT_METHOD | Método incorrecto |
CHANNEL_NOT_FOUND | El canal indicado no existe |
CHAT_NOT_FOUND | El chat indicado no existe |
Parámetros:
- class : whatsapp
- method : getmessages
- user : user
- password : password
- platformid : 100
- destination : 34600000000
Petición:
Obtener listado de mensajes no leídos de un chat de WhatsAPP
Parámetro | Descripción | Obligatorio / Opcional |
---|---|---|
class=whatsapp | Clase a la que se realiza la petición | Obligatorio |
method=getunreadmessages | Método de la clase al que se realiza la petición | Obligatorio |
user | El usuario / email de su cuenta de Afilnet | Obligatorio |
password | El password de su cuenta de Afilnet | Obligatorio |
platformid | Identificador de la plataforma | Obligatorio |
destination | Destinatario del cual se quiere obtener los mensajes | Obligatorio |
Respuesta:
- status
-
result (si status=success), recibirá los siguientes valores:
-
list
- platformid
- message
- destination
- messageid
- issent
- status
- datetime
-
list
- error (si status=error), aquí recibirá el código de error
Códigos de error:
Código | Descripción |
---|---|
MISSING_USER | Usuario / email no incluido |
MISSING_PASSWORD | Password no incluido |
MISSING_CLASS | Clase no incluida |
MISSING_METHOD | Método no incluido |
MISSING_COMPULSORY_PARAM | Parámetro obligatorio no incluido |
INCORRECT_USER_PASSWORD | Usuario o clave incorrectos |
INCORRECT_CLASS | Clase incorrecta |
INCORRECT_METHOD | Método incorrecto |
CHANNEL_NOT_FOUND | El canal indicado no existe |
CHAT_NOT_FOUND | El chat indicado no existe |
Parámetros:
- class : whatsapp
- method : getunreadmessages
- user : user
- password : password
- platformid : 100
- destination : 34600000000
Petición:
ANEXO: Opciones adicionales en Mensajes
En este anexo aprenderá a enviar mensajes desde sus plantillas. Las plantillas de WhatsAPP le permite enviar mensajes más elaborados que los mensajes de texto, permitiendo adjuntar archivos, así como incluir botones en sus mensajes.
Opciones
Las opciones permiten enviar mensajes interactivos, adjuntar imágenes, videos, documentos y compartir localizaciones por WhatsAPP. Para ello aquí aprenderá a personalizar el parámetro "options". El parámetro "options" debe ser una cadena en formato JSON siguiendo las siguientes especificaciones:
Parámetros principales
header | Detalles sobre la cabecera del mensaje (opcional) |
---|---|
params | Valores a los diferentes valores de la plantilla (opcional) |
Ejemplo
{"header":"", "params": ""} |
Definir la cabecera
Definir una cabecera le permitirá adjuntar diferentes archivos y servicios a sus mensajes de WhatsAPP
Enviar una Imagen
file | URL de la imagen (Formatos permitidos: JPG, PNG, WEBP) El archivo debe estar subida a internet y ser accesible a través de una URL
|
---|
Enviar un Video
file | URL del video (Formatos permitidos: MP4, MPEG, 3GP) El archivo debe estar subida a internet y ser accesible a través de una URL
|
---|
Enviar un Documento
file | URL del documento (Formatos permitidos: TXT, PDF, PPT, DOC, DOCX, XLS, PPTX, XLSX) El archivo debe estar subida a internet y ser accesible a través de una URL
|
---|
Enviar una Localización
file | Latitud y longitud con el formato: (0.0000, 0.0000) | ||||
---|---|---|---|---|---|
location |
|
Definir los parámetros
Utilizar parámetros le permitirá personalizar sus plantillas a cada destinatario, permitiendo incluir información relacionada con el destinatario al mensaje. Algunos ejemplos de esta información sería: Datos personales, Datos relacionados con su cuenta, Información de seguimiento, etc.
Ejemplo JSON: | {"params":{"name":"John", "orderid": "10"}} |
---|
Ejemplos de JSON válidos
Enviar un mensaje con parámetros personalizados
En este ejemplo vamos a enviar un mensaje parametrizado.
Mensaje de la plantilla con parámetros: | Estimado {{name}}, su pedido con ID: {{orderid}} ha salido de nuestros almacenes |
---|---|
Ejemplo JSON: | {"params":{"name":"John", "orderid": "10"}} |
Enviar una Imagen
En este ejemplo vamos a utilizar una plantilla que tiene cómo cabecera una imagen.
Ejemplo JSON: | {"header":{"file":"https:\/\/test.com\/test.jpg"}} |
---|
Enviar una Imagen y mensaje con parámetros personalizados
En este ejemplo vamos a utilizar una plantilla que tiene cómo cabecera una imagen. Adjuntamos una imagen con el número de seguimiento.
Mensaje de la plantilla con parámetros: | Estimado {{name}}, su pedido con ID: {{orderid}} ha salido de nuestros almacenes |
---|---|
Ejemplo JSON: | {"header":{"file":"https:\/\/test.com\/test.jpg"}, "params":{"name":"John", "orderid": "10"}} |
Enviar un Video
En este ejemplo vamos a utilizar una plantilla que tiene cómo cabecera un video.
Ejemplo JSON: | {"header":{"file":"https:\/\/test.com\/test.mp4"}} |
---|
Enviar un Documento
En este ejemplo vamos a utilizar una plantilla que tiene cómo cabecera un documento.
Ejemplo JSON: | {"header":{"file":"https:\/\/test.com\/test.mp4"}} |
---|
Enviar una Localización
En este ejemplo vamos a utilizar una plantilla que tiene cómo cabecera una localización.
Ejemplo JSON: | {"header":{"file":"(LATITUDE, LONGITUDE)","location":{"name":"NAME","address":"ADDRESS"}}} |
---|
Herramientas que potencian nuestra API de WhatsAPP Business
CONEXIÓN CON API DE FORMA SEGURA
Seguridad adaptada a su empresa
Configure sus conexiones por API, cree nuevos accesos y administre los existentes.
Filtre por IP todos los accesos a la API, añada o elimine IPs habilitadas para garantizar la seguridad de sus accesos.
Lleve un control de todas las conexiones realizadas, la API utilizada y las fechas / hora de conexión
MULTIPLES APIs
Conectividad adaptada a su empresa
Le ofrecemos multiples APIs para conectar con nosotros, disponemos de una API HTTP, BASIC AUTH, SOAP y Autenticación JWT para que conecte con nosotros de la forma que desee.
Conecte con cualquiera de las APIs de forma segura, sencilla y centralizada. Afilnet API es perfecta para su software.
API Logs
Conozca cada petición al detalle
Gracias a nuestros logs podrá revisar todas las peticiones realizadas y la correspondiente respuesta de nuestra API, lo que le permitirá consultar detalles cuando le necesite.
La información que puede consultar es la siguiente:
- IP origen de la petición
- Fecha & Hora de la petición
- API & Método al que se llama
- Parámetros enviados a la API
- Respuesta de la API
- Metadatos
Pasos para usar API de WhatsAPP Business
Siga los pasos para tener acceso a WhatsAPP Business API
Regístrese como cliente
Necesita estar registrado como cliente para poder obtener unas credenciales para utilizar la API de WhatsAPP Business. Una vez esté registrado podrá realizar las peticiones que necesite a nuestra API.
Verifique su negocio en Facebook
Para poder hacer uso de la API de WhatsAPP Business es imprescindible disponer de un perfil de negocio verificado en Facebook. Puede encontrar más información en Facebook Business
Adquiera WhatsAPP Business
Póngase con nosotros para que pongamos a su disposición de un número virtual para WhatsAPP Business, consulte las tarifas del servicio en nuestra página de tarifas.
Integre WhatsAPP Business
Utilice los métodos de la API que le ofrecemos y realice la integración con los servicios de Afilnet de WhatsAPP Business
Características del servicio de WhatsAPP Business API
Automatice WhatsAPP
Automatice las notificaciones por WhatsAPP a través de APIAudio, Imágenes, Videos y Documentos
Reciba y/o envíe los archivos que necesite a través de WhatsAPP Business API.Gestión de contactos y charlas
Gestione sus contactos y conversaciones por WhatsAPP con nuestra API.Envíe servicios cloud por WhatsAPP
Envíe archivos cloud a través de WhatsAPP, adjunte encuestas, contratos y mucho más.Seguridad por lista blanca
Habilite las listas blancas y permita conexiones sólo desde las IPs incluidas.Multiples accesos por cuenta
Puede crear tantos usuarios para conectar con la API con una misma cuenta como desee.Subcuentas
Cree subcuentas para otras empresas o departamentos con su propia conexión a la API y saldo.API gratuita
Puede hacer uso de la API sin limitaciones y de forma gratuita, sólo pagará por el uso de los servicios.Preguntas frecuentes sobre WhatsAPP Business API
Aquí encontrarás las preguntas más comunes que heemos recibido sobre el servicio de WhatsAPP Business API.
A través de WhatsAPP Business API podrá recibir todos los mensajes de WhatsAPP que envíen a su cuenta, responder a estos e iniciar conversaciones con mensajes basados en plantillas preautorizadas por WhatsAPP.
Sólo puede enviar WhatsAPP a usuarios que previamente hayan permitido ser contactado por este canal y sólo utilizando mensajes basados en plantillas previamente autorizadas.
Puede tener tantos Chats activos por WhatsAPP cómo necesite, siempre y cuando cumpla los requisitos establecidos por WhatsAPP.
En el servicio de WhatsAPP Business API usted paga por los canales activos para WhatsAPP, sólo pagará una cuota mensual por número de WhatsAPP Business activo y el precio por conversación (chats ilimitados con un destinatario durante 24 horas), puede consultar más información en nuestra página de tarifas.