Integre sin problemas nuestra API de mensajería HTTP WhatsApp


Introducción

Este documento proporciona una referencia de todas las funciones disponibles en nuestra interfaz HTTP para envío de mensajes de texto a través de WhatsApp.

La API HTTP le permite integrar su aplicación (cliente) utilizando el protocolo HTTP para enviar mensajes. HTTPS también es compatible para transacciones seguras mediante cifrado SSL. Recomendamos utilizar esta funcionalidad.

Para usar el servicio necesitará contar con una cuenta de usuario y una clave API. Llenando el siguiente formulario Mob Army los generará por usted.

La API HTTP se utiliza solo para mensajería unidireccional. Por lo tanto, debe proporcionar un MSISDN válido como número de destino.


Funcionalidades de la API HTTP

  • Envío de mensajes de texto sin límite de caracteres.
  • Envío de archivos multimedia.
  • Envío y verificación de códigos de seguridad tipo OTP.
  • Configuración de URL de confirmación (ACK) para confirmación de “entrega” y “lectura” de mensajes enviados.

Como enviar un mensaje de WhatsApp

API URL: https://api.mobarmy.dev/send-whatsapp/

Parámetros HTTP

A continuación se muestra una lista de parámetros al emitir una solicitud HTTP.

ParámetroDescripciónPresencia
msisdnMSIDSN del destinatario al que se enviará el mensaje. Por ejemplo: 59172083143 (No use + antes del código de país)Obligatorio
messageMensaje a enviar. Nota importante: debe tener una codificación URL.Obligatorio
usernameNombre de usuario asignado al cliente.Obligatorio
apikeyEl API Key que Mob Army genera para ti. Puede enviarse en el header o en la URL como parámetro.Obligatorio

Respuesta HTTP

Si el mensaje se ha enviado correctamente, el código de estado devolverá:

 {
    "id": "true_59170749005@c.us_3EB0089192FFBC3ADCC1",
    "response": "Sent to 59170749005@c.us",
    "sent": true
 }

Si el mensaje no se pudo entregar, devolverá un  mensaje de ERROR en el campo de respuesta.

A continuación se muestran ejemplos de solicitudes al utilizar la interfaz HTTP:

Solicitud de ejemplo:

username  : user1

apikey  : ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs

msisdn  : 59172083143

message  : Hello world

Request:

https://api.mobarmy.dev/send-whatsapp?username=user1&api-key=ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs&msisdn=59172083143&message=Hello%20world

Como enviar un archivo por WhatsApp

API URL: https://api.mobarmy.dev/send-file/

Parámetros HTTP

A continuación se muestra una lista de parámetros al emitir una solicitud HTTP.

ParámetroDescripciónPresencia
msisdnMSIDSN del destinatario al que se enviará el mensaje. Por ejemplo: 59172083143 (No use + antes del código de país)Obligatorio
fileLink HTTP. Ejemplo:

https://mobarmy.dev/wp-content/uploads/2021/02/logotipo_cuadrado.jpg

O un archivo codificado en base64 con mime data, Por ejemplo:

data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ…

File in form-data input field
Obligatorio
filenameNombre del archivo a ser enviado. Ejemplo: 1.jpg o archivo.pdfObligatorio
usernameNombre de usuario asignado al cliente.Obligatorio
apikeyEl API Key que Mob Army genera para ti. Puede enviarse en el header o en la URL como parámetro.Obligatorio

Respuesta HTTP

Si el mensaje se ha enviado correctamente, el código de estado devolverá:

 {
    "id": "true_59178455115@c.us_3EB0A4563FD2E5AF863A",
    "response": "Sent to 59178455115@c.us",
    "sent": true
}

Si el mensaje no se pudo entregar, devolverá un mensaje de ERROR en el campo de respuesta.

A continuación se muestran ejemplos de solicitudes al utilizar la interfaz HTTP:

Solicitud de ejemplo:

username  : user1

apikey  : ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs

msisdn  : 59172083143

file  : https%3A%2F%2Fmobarmy.dev%2Fwp-content%2Fuploads%2F2021%2F02%2Flogotipo_cuadrado.jpg

filename : logotipo_cuadrado.jpg

Request:

https://api.mobarmy.dev/send-file/?file=https%3A%2F%2Fmobarmy.dev%2Fwp-content%2Fuploads%2F2021%2F02%2Flogotipo_cuadrado.jpg&msisdn=59172083143&apikey=ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs&filename=logotipo_cuadrado.jpg&username=user1

Enviar un código OTP

API URL: https://api.mobarmy.dev/send-otp/

Parámetros HTTP

A continuación se muestra una lista de parámetros al emitir una solicitud HTTP.

ParámetroDescripciónPresencia
msisdnMSIDSN del destinatario al que se enviará el mensaje. Por ejemplo: 59172083143 (No use + antes del código de país)Obligatorio
messageMensaje de texto a enviar. 

Nota importante:

1. La plantilla de mensaje debe contener un marcador de posición (placeholder o comodín) para el código OTP, es decir, {*código*}. El sistema generará un PIN aleatorio de 4 dígitos y lo sustituirá por el placeholder de la plantilla.

Ejemplo: Este es tu PIN: {*code*}

2. Debe tener una codificación URL.

Este%20es%20tu%20PIN%3A%20%7B%2Acode%2A%7D
Obligatorio
usernameNombre de usuario asignado al cliente.Obligatorio
apikeyEl API Key que Mob Army genera para ti.Obligatorio

Respuesta HTTP

Si el mensaje se ha enviado correctamente, el código de estado devolverá:

 {
    "id": "true_59178455115@c.us_3EB0A4563FD2E5AF863A",
    "response": "Sent to 59178455115@c.us",
    "sent": true
}

Si el mensaje no se pudo entregar, devolverá un mensaje de ERROR en el campo de respuesta.

A continuación se muestran ejemplos de solicitudes al utilizar la interfaz HTTP:

Solicitud de ejemplo:

username  : user1

apikey  : ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs

msisdn  : 59172083143

message  : Este%20es%20tu%20PIN%3A%20%7B%2Acode%2A%7D

Request:

https://api.mobarmy.dev/send-otp/?message=Este%20es%20tu%20PIN%3A%20%7B%2Acode%2A%7D&msisdn=59172083143&username=user1&apikey=ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs

Verificar un código OTP

API URL: https://api.mobarmy.dev/verify-otp/

Parámetros HTTP

A continuación se muestra una lista de parámetros al emitir una solicitud HTTP.

ParámetroDescripciónPresencia
messageidId recibido al enviar una OTP.Obligatorio
otp2verifyCódigo OTP a verificar. Este es el código ingresado por el usuario de la aplicación.Obligatorio
usernameNombre de usuario asignado al cliente.Obligatorio
apikeyEl API Key que Mob Army genera para ti.Obligatorio

Respuesta HTTP

Si el mensaje se ha enviado correctamente, el código de estado devolverá:

{
   "status": "Verified"
}

Si el código OTP ingresado no es igual al registrado, devolverá el campo status como “Not verified”.

A continuación se muestran ejemplos de solicitudes al utilizar la interfaz HTTP:

Solicitud de ejemplo:

username  : user1

apikey  : ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs

messageid  : true_59178455115@c.us_3EB0A4563FD2E5AF863A

otp2verify  : 1234

Request:

https://api.mobarmy.dev/verify-otp/?messageid=true_59178455115@c.us_3EB0A4563FD2E5AF863A&username=user1&apikey=ooq5tOIxcGdMlsLHpJLL3UMUdlbmQWxs&otp2verify=1234