DOCUMENTO PARA INICIAR COVERSACION WHATSAPP DESDE
OTROS SISTEMA
A UN SERVICIO MULTIAGENTE/DESIGNER.
METODO POST
1) Parámetros Básicos de envió
|
login |
Usuario de plataforma |
|
token |
Token para realizar conexiones api. No es el mismo password de logueo. |
|
id_template |
Id de la plantilla a enviar. Cuando se crea la
plantilla se identifica este número. |
|
template_variables |
(opcional) Si la plantilla creada tiene variables, las variables se envían dentro
de [] sin importar la cantidad ejemplo: |
|
mobile |
Prefijo del país y el Número telefónico del
destinatario. Ejemplo 573102111111 |
|
media |
(opcional) puede
utilizar una de estas 2 opciones: 1)
Dirección web del archivo multimedia
donde esta almacenado. 2)
Cadena con el archivo codificado en base64 |
|
media_name |
(opcional) El nombre del archivo cuando se envía en base64 debe tener
entre 10 y 60 caracteres. El sistema agregará inicialmente 3 dígitos
numéricos aleatorios. Si no cumple con esta condición o si la variable está
vacía, el sistema asignará automáticamente un nombre con la extensión .pdf. |
|
custom_field |
(opcional) Campo auxiliar que se envía en el primer mensaje (no llega al cliente) y se retorna cuando
usuario responde. Máximo 1.000 caracteres. |
Retorno
|
Concepto |
Valor |
Descripción |
|
Message sent |
1 |
Mensajes enviado |
|
authentication error |
2 |
Invalido
usuario y/o password |
|
user without multiagent/chatbot |
3 |
Usuario
no tiene asignado un chatbot o multiagente.
Consultar con soporte |
|
error in the cell phone number to send |
4 |
Error en
el format del celular, debe ser de Colombia, debe
iniciar con el 57 y debe tener 12 dígitos. |
|
no balance or inactive chatbot/multiagent |
5 |
No tiene saldo
en la cuenta para realizar el envió |
|
empty message |
6 |
El campo message llega sin ninguna información. |
|
id_template does not correspond to the project |
7 |
El id_template no corresponde al proyecto |
|
the number of variables received does not correspond
to the number of variables created in the template |
8 |
la
cantidad de variables recibidas no corresponde a la cantidad de
variables creadas en la plantilla |
|
messages repeated 60 seconds |
9 |
Error en
el envio, No se puede enviar el mismo mensaje al
mismo celular antes de 60 segundos. |
|
Error: The maximum number of sends to this mobile
number in the marketing category has been exceeded. |
10 |
Error: Se
ha superado el límite máximo de envíos a este número de celular en la
categoría de marketing. |
Formatos
A través de este api puede enviar texto con emojis y multimedia, solo enviando la dirección web donde se encuentra la parte multimedia.
Ejemplo,
https://servercliente.com/jemplo-de-Archivo-PDF-508.pdf
Puede enviar los siguientes archivos:
Pdf, jpg, mp3, txt, docx, xlsx, zip, mp4, pptx, png, jpeg
Endpoint: https://contacto-multichat.com/bot/chat_wa/ws/send/
|
Pantalla en postman |
|
|
|
Pantalla en postman,
cuando se envía un PDF en base64 |
|
|
Al momento de realizar el envío hacia whatsapp, puede retornar un error que queda almacenado en el campo status con el siguiente mensaje “sending error, return balance”
|
Descripción |
|
|
|
|
|
402 |
error por parte de whatsapp |
|
471 – 131048 |
error mensaje spam |
|
470 - 131047 |
mensaje paso mas de 24 horas |
|
1002 |
Número no active para enviar mensajes a whatsapp |
|
1003 |
No se puede enviar el mensaje | Verifique el saldo de su billetera |
|
1004 |
El envío del mensaje falló porque el usuario está inactivo para el mensaje
de sesión y la mensajería de plantilla está deshabilitada |
|
1005 |
El envío del mensaje fallo poque plantilla no coincidió |
|
1006 |
El envío del mensaje falló porque el usuario está inactivo para el
mensaje de sesión y no ha optado por el mensaje de plantilla |
|
1007 |
El envío del mensaje falló porque el usuario está inactivo para el
mensaje de sesión, no ha optado por el mensaje de plantilla y la plantilla no
coincide |
|
1008 |
falta parametros obligatorio en la plantilla |
|
1010 |
URL de medios no válida |
|
1011 |
Tamaño de mensaje no válido |
|
131021 |
Numero Origen y destinatario es el mismo |
|
132005 |
Mensaje muy largo |
|
132007 |
La plantilla infringe la política de meta |
|
132015 |
La plantilla pausada por meta |
|
132016 |
La plantilla desactivada por meta |
|
131031 |
Numero Origen bloqueado por meta |
Webhook (POST)
Puede entregarnos un web services donde enviaremos todos los eventos en relaciona a cada uno de los mensajes enviados.
Estructura json cuando falla el mensaje messageId
{
"type": “message-event”,
"type2": "failed",
"code": "xxxx",
"reason": "xxxxx",
"messageId": "xxxx"
}
Estructura json para saber en que momento whatsapp realizo el envió y el id de envio entregado por parte de whatsapp.
{
"type": “message-event”,
"type2": " sent",
"messageId_whatsapp": "xxxx",
"fecha_envio_por_whatsapp": "xxxxx",
"&messageId": "xxxx"
}
Estructura json para saber en qué momento el usuario le llego el mensaje al celular
{
"type": “message-event”,
"type2": "
delivered",
"messageId_whatsapp": "xxxx",
"fecha_envio_por_whatsapp": "xxxxx",
"&messageId": "xxxx"
}
Estructura json cuando para saber en qué momento el usuario leyó el mensaje
{
"type": “message-event”,
"type2": " read",
"messageId_whatsapp": "xxxx",
"fecha_lectura_usuario": "xxxxx",
"&messageId": "xxxx"
}
Estructura json cuando el cliente responde desde el celular
{
"mobile": "573002222222",
"message": "Hola, respondiendo mensaje desde el whatsapp",
"custom_field": "1020-3040-5060-7089",
"official_number": "573005202020"
}
3) CONSULTA DE SALDO POR
PARAMETROS
Con este método, se podrá consultar el saldo del
usuario en tiempo real.
Endpoint: https://contacto-multichat.com/bot/chat_wa/ws/balance/
|
Autenticación |
login |
Usuario otorgado |
|
token |
Clave otorgado |
Retorno
|
Concepto |
Valor |
Descripción |
|
authentication error |
2 |
Invalido
usuario y/o password |
|
user without multiagent/chatbot |
3 |
Usuario
no tiene asignado un chatbot o multiagente.
Consultar con soporte |
|
Pantalla en Postman |
|
|
4)
CONSULTA
DE PLANTILLAS
Con este método, se podrá consultar las plantillas que
han sido aprobadas, pendientes o rechazadas por WhatsApp
Endpoint: https://contacto-multichat.com/bot/chat_wa/ws/template/
|
Autenticación |
login |
Usuario otorgado |
|
token |
Clave otorgado |
Retorno
|
Concepto |
Valor |
Descripción |
|
authentication error |
2 |
Invalido
usuario y/o password |
|
user without multiagent/chatbot |
3 |
Usuario
no tiene asignado un chatbot o multiagente.
Consultar con soporte |
|
without templates |
4 |
No tiene
plantillas aprobadas. |
|
Pantalla en Postman |
|
|
