Un Webhook es un sistema de comunicación automático que funciona a través de solicitudes del protocolo HTTP y que permite el intercambio de datos entre aplicaciones web en tiempo real.
El Webhook recibirá los datos en formato JSON mediante el método POST del protocolo HTTP.
Cuando la respuesta de la API contenga el código de estado 4xx o 5xx se responderá con un JSON incluyendo el mensaje de error correspondiente.
Query String o "Cadena de consulta" son parámetros que se añaden en la URL los cuales indican variables al servidor.
Endpoints Abiertos
Endpoints abiertos que no requieren autenticación.
Login
POST/api/LoginEmite un token que dura 2 días
Parámetros
Parámetro
Requerido?
Tipo de Dato
Descripción
Email
Sí
string
Email del Usuario
Password
Sí
string
Password del Usuario
Respuesta JSON
Propiedad
Descripción
token
Token de autorización que se utilizará en cada solicitud HTTP que requiera autenticación
Endpoints que requieren Authenticación
Los Endpoints cerrados requieren que se incluya un TOKEN válido en el encabezado la solicitud HTTP mediante el header Authorization: Bearer TOKEN o mediante el Query String?token=TOKEN. Se puede adquirir un TOKEN desde el Endpoint anterior.
GET/api/NewSessionCrear una nueva sesión de WhatsApp
Respuesta JSON
Propiedad
Descripción
Tipo de Dato
idSession
Identificador único para cada sesión de WhatsApp
string
GET/api/MySessionsListar las sesiones
Respuesta JSON (Array)
Propiedad
Descripción
Tipo de Dato
idSession
Identificador único para cada sesión de WhatsApp
string
hasCredentials
Indica si la sesión tiene vinculado un dispositivo
boolean/null
Webhook
Webhook configurado para la sesión
string/null
DownloadMedia
Indica si la sesión descargará el contenido multimedia entrante (audio, fotos, video, stickers)
boolean
isRunning
Indica si la sesión se encuentra corriendo
boolean
qr
Valor del QR a escanear con la aplicación de WhatsApp para autenticar la sesión
string
isConnected
Identifica si la sesión se encuentra conectada y autenticada
boolean
GET/api/Session/{idSession}Obtener la información relativa a una sesión
Respuesta JSON
Propiedad
Descripción
Tipo de Dato
idSession
Identificador único para cada sesión de WhatsApp
string
hasCredentials
Indica si la sesión tiene vinculado un dispositivo
boolean/null
Webhook
Webhook configurado para la sesión
string/null
DownloadMedia
Indica si la sesión descargará el contenido multimedia entrante (audio, fotos, video, stickers)
boolean
isRunning
Indica si la sesión se encuentra corriendo
boolean
qr
Valor del QR a escanear con la aplicación de WhatsApp para autenticar la sesión
string
isConnected
Identifica si la sesión se encuentra conectada y autenticada
boolean
DELETE/api/Session/{idSession}Eliminar una sesión
Respuesta JSON
Propiedad
Descripción
Tipo de Dato
status
Estado de la eliminación
string
GET/api/Session/{idSession}/StartIniciar una sesión
Respuesta JSON
Propiedad
Descripción
Tipo de Dato
status
Estado de la inicialización
string
GET/api/Session/{idSession}/StopParar una sesión
Respuesta JSON
Propiedad
Descripción
Tipo de Dato
status
Estado de éxito
string
POST/api/Session/{idSession}/SendMessageEnviar un Mensaje
Parámetros
Parámetro
Requerido?
Tipo de Dato
Descripción
To
Sí
string
ID del grupo/usuario de WhatsApp, también puede ser el número de teléfono con el prefijo correspondiente al país
text
Sí
string
Mensaje que se enviará
Respuesta JSON
Propiedad
Descripción
Tipo de Dato
status
Estado de éxito
string
POST/api/Session/{idSession}/SendAttachmentEnviar un Adjunto
Parámetros
Parámetro
Requerido?
Tipo de Dato
Descripción
To
Sí
string
ID del grupo/usuario de WhatsApp, también puede ser el número de teléfono con el prefijo correspondiente al país
URL
Sí
string
Archivo que se enviará (MP3/PDF/JPEG/PNG)
caption
No
string
Mensaje que acompaña al adjunto
Respuesta JSON
Propiedad
Descripción
Tipo de Dato
status
Estado de éxito
string
POST/api/Session/{idSession}/SetWebhookConfigurar el Webhook para una sesión
Parámetros
Parámetro
Requerido?
Tipo de Dato
Descripción
Webhook
Sí
string
Webhook donde se haran las peticiones POST con los mensajes entrantes de la sesión