Las campañas transaccionales te permitirán el envío de comunicaciones o notificaciones a tus clientes en el momento en tiempo real donde ocurra un evento en tus procesos y sistemas.
Requisitos:
Tu X-Tenant.
https://help.convos.la/es/articles/8452332-x-tenant
Un token con la habilidad de "Campaigns".
El ID de una campaña transaccional, crea una si todavía no lo has hecho.
Configuración de la request:
Descripción | Envía un mensaje transaccional. |
HTTP Method | POST |
Headers | X-Tenant: {YourXTenant} |
URL | https://api.convos.la/consumer/transactional-campaigns/{CampaignId}/send |
JSON request (ejemplo) | { |
JSON request (ejemplo de adjunto) | { |
JSON response (ejemplo) | { |
Paginación y filtrado (ejemplo)
| none |
Parámetros adicionales | Campo: try_fix_cellphone: true|false
Este parámetro permite corregir automáticamente el número de teléfono cuando no está en formato internacional, de modo que el mensaje pueda enviarse correctamente.
{ |
El CampaignId lo puedes obtener desde:
Desde la API
Desde la plataforma
Lo encontrarás en el listado de campañas, cada una tiene su ID
El número de teléfono:
Para enviar un mensaje a través de WhatsApp necesitas un número de teléfono completo del cliente (con su código de país y prefijo).
Envió de adjuntos:
Para enviar un adjunto debes considerar que la campaña transaccional tenga un template configurado para enviar multimedia y luego en la llamada a la API necesitas agregar una key attachment con valores de type y content, para indicar el tipo de adjunto y el contenido del adjunto, el contenido del adjunto tiene que estar en base64.
Tipo de adjunto permitido: pdf, png, jgp, jpeg, doc, docx y mp4.
Ejemplo:
{
"attachment": {
"type": "<File type>",
"filename": "<File name>",
"content": "<File in base 64 encoded>"
}
}