Inyección de Mensajes — API v3 [Desarrolladores]
Inyecta mensajes desde sistemas externos hacia Adereso y consulta estados de mensajes con la API v3.
Inyección de Mensajes — API v3
La API v3 permite inyectar mensajes directamente en Adereso desde sistemas externos. Esto es útil para integraciones custom donde tu sistema gestiona la comunicación con el cliente y necesita que las conversaciones se reflejen en Adereso.
¿Para qué sirve?
La inyección de mensajes permite que sistemas externos envíen mensajes directamente a Adereso, como si hubieran llegado por un canal real. Esto es fundamental para integraciones donde tu plataforma gestiona la comunicación y necesita reflejarla en Adereso.
Beneficios concretos
- Conectar canales de comunicación propios (app móvil, portal web, sistema interno) con Adereso
- Centralizar todas las conversaciones en Adereso, incluso las que ocurren fuera de los canales nativos
- Crear tickets automáticamente cuando llegan mensajes desde tu sistema
¿Quién lo usa? Equipos de desarrollo que necesitan integrar sistemas de comunicación propios con Adereso.
Inyectar mensajes
/v3/channels/{social_network}/{channel_uid}/messages - POST
Envía uno o más mensajes al helpdesk de Adereso. Los mensajes se procesan como si hubieran llegado (o salido) por el canal especificado, creando o actualizando tickets según corresponda.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Red social del canal |
channel_uid | string | Sí | UID del canal |
messages | array | Sí | Array de mensajes a inyectar |
Ejemplo de request
curl -X POST \
-H "Authorization: Key TU_TOKEN" \
-H "Content-Type: application/json" \
"https://api-cluster.adere.so/v3/channels/chat/custom_001/messages" \
-d '{
"messages": [
{
"body": {
"content": "Hola, necesito ayuda con mi pedido",
"type": "text",
"subtype": null,
"payload": {}
},
"status": "sent",
"thread_root": "conv_12345",
"private": true,
"sender": {"id": "user_789"},
"receiver": [{"id": "agent_001"}],
"type": "inbound",
"version": "3.0",
"options": {
"addressed": false,
"is_bot": false,
"auto_reply": false
}
}
]
}'Ejemplo de respuesta exitosa:
{
"messages": [
{
"mid": "msg_abc123",
"status": "sent",
"case_id": "ticket_456"
}
]
}Estructura de un mensaje
Campo | Tipo | Requerido | Descripción |
body.content | string | Sí | Contenido del mensaje |
body.type | string | Sí | Tipo: text, image, video, document, audio |
status | string | Sí | Estado: sent, delivered, read, failed |
thread_root | string | Sí | ID de conversación (agrupa mensajes en un ticket) |
sender.id | string | Sí | ID del remitente en tu sistema |
receiver[].id | string | Sí | ID(s) del destinatario |
type | string | Sí | Dirección: inbound o outbound |
version | string | Sí | Versión del formato: '3.0' |
private | boolean | No | Si es un mensaje privado (default: true) |
attachments | array | No | Archivos adjuntos [{url, file_name, type}] |
options.is_bot | boolean | No | Si el mensaje fue enviado por un bot |
options.auto_reply | boolean | No | Si es una respuesta automática |
Consultar un mensaje
/v3/channels/{social_network}/{channel_uid}/messages/{mid} - GET
Obtiene un mensaje específico por su identificador único.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Red social del canal |
channel_uid | string | Sí | UID del canal |
mid | string | Sí | ID del mensaje |
Ejemplo de request
curl -H "Authorization: Key TU_TOKEN" \
"https://api-cluster.adere.so/v3/channels/chat/custom_001/messages/msg_abc123"Actualizar estado de un mensaje
/v3/channels/{social_network}/{channel_uid}/messages/{mid}/status/{status} - PUT
Actualiza el estado de entrega de un mensaje. Útil para notificar a Adereso que un mensaje fue entregado o leído por el destinatario.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Red social del canal |
channel_uid | string | Sí | UID del canal |
mid | string | Sí | ID del mensaje |
status | string | Sí | Nuevo estado: sent, delivered, read, failed |
Ejemplo de request
curl -X PUT \
-H "Authorization: Key TU_TOKEN" \
"https://api-cluster.adere.so/v3/channels/chat/custom_001/messages/msg_abc123/status/delivered"