Canales — API v3 [Desarrolladores]
Gestiona canales de comunicación (WhatsApp, email, chat, etc.) con la API v3 de Adereso.
Canales — API v3
La API v3 permite gestionar los canales de comunicación conectados a Adereso (WhatsApp, Facebook, Instagram, email, chat, etc.). Puedes listar canales, crear nuevos, editar configuraciones y gestionar mensajes a nivel de canal.
¿Para qué sirve?
Los canales son los medios de comunicación conectados a Adereso: números de WhatsApp, cuentas de email, páginas de Facebook, cuentas de Instagram, widgets de chat, etc. Esta API te permite gestionar esos canales de forma programática.
Beneficios concretos
- Consultar qué canales tienes conectados y su configuración actual
- Conectar canales custom o de integración propia para recibir y enviar mensajes a través de Adereso
- Modificar configuraciones de canales (tiempos de respuesta, automatizaciones, webhooks) desde tu sistema
¿Quién lo usa? Administradores de la plataforma, equipos de tecnología y operaciones que gestionan múltiples canales.
Listar todos los canales
/v3/channels/ - GET
Obtiene todos los canales conectados a tu cuenta Adereso, de forma paginada.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
page | integer | No | Número de página (default: 1) |
Ejemplo de request
curl -H "Authorization: Key TU_TOKEN" \
"https://api-cluster.adere.so/v3/channels/?page=1"Ejemplo de respuesta exitosa:
{
"status": 200,
"channels": [
{
"uid": "56900000000",
"name": "WhatsApp Ventas",
"social_network": "whatsapp",
"img_url": "https://...",
"provider": "adereso_bsp"
},
{
"uid": "soporte@empresa.com",
"name": "Email Soporte",
"social_network": "email",
"provider": "smtp"
}
]
}Canales por red social
/v3/channels/{social_network}/ - GET
Filtra canales por tipo de red social.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Tipo: facebook, twitter, whatsapp, app_store, play_store, instagram, chat, email |
page | integer | No | Número de página |
Ejemplo de request
curl -H "Authorization: Key TU_TOKEN" \
"https://api-cluster.adere.so/v3/channels/whatsapp/"Obtener un canal específico
/v3/channels/{social_network}/{channel_uid}/ - GET
Obtiene la información de un canal específico usando su red social y UID.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Tipo de red social |
channel_uid | string | Sí | UID del canal (ej: número de teléfono, email, page ID) |
Ejemplo de request
curl -H "Authorization: Key TU_TOKEN" \
"https://api-cluster.adere.so/v3/channels/whatsapp/56900000000/"Editar información de un canal
/v3/channels/{social_network}/{channel_uid}/ - PATCH
Actualiza el nombre o imagen de un canal.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Tipo de red social |
channel_uid | string | Sí | UID del canal |
name | string | No | Nuevo nombre del canal |
img_url | string | No | Nueva URL de imagen |
Ejemplo de request
curl -X PATCH \
-H "Authorization: Key TU_TOKEN" \
-H "Content-Type: application/json" \
"https://api-cluster.adere.so/v3/channels/whatsapp/56900000000/" \
-d '{"name": "WhatsApp Soporte VIP"}'Crear un canal
/v3/channels/ - PUT
Registra un nuevo canal en Adereso. Útil para conectar canales custom o de integración propia.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
uid | string | Sí | Identificador único del canal en su red social |
name | string | Sí | Nombre visible del canal en Desk |
social_network | string | Sí | Tipo de red social |
img_url | string | No | URL de imagen del canal |
channel_owner | string | No | Propietario del canal |
webhook_config | object | No | Configuración del webhook para recibir mensajes |
Ejemplo de request
curl -X PUT \
-H "Authorization: Key TU_TOKEN" \
-H "Content-Type: application/json" \
"https://api-cluster.adere.so/v3/channels/" \
-d '{
"uid": "custom_channel_001",
"name": "Canal Custom",
"social_network": "chat",
"webhook_config": {"url": "https://mi-servidor.com/webhook"}
}'Ver configuración de un canal
/v3/channels/{social_network}/{channel_uid}/config/ - GET
Obtiene las configuraciones actuales de un canal: calidad de servicio, automatizaciones, config específica por red social, etc.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Tipo de red social |
channel_uid | string | Sí | UID del canal |
Ejemplo de request
curl -H "Authorization: Key TU_TOKEN" \
"https://api-cluster.adere.so/v3/channels/whatsapp/56900000000/config/"Editar configuración de un canal
/v3/channels/{social_network}/{channel_uid}/config/ - PATCH
Actualiza configuraciones de un canal. Puedes modificar calidad de servicio, automatizaciones y configuraciones específicas por red social.
Parámetros
Parámetro | Tipo | Requerido | Descripción |
social_network | string | Sí | Tipo de red social |
channel_uid | string | Sí | UID del canal |
service_quality | object | No | Configuración de calidad de servicio |
general | object | No | Configuración general |
automations | object | No | Configuración de automatizaciones |
whatsapp_config | object | No | Config específica de WhatsApp |
email_config | object | No | Config específica de email |
webhook_config | object | No | Config del webhook |
Ejemplo de request
curl -X PATCH \
-H "Authorization: Key TU_TOKEN" \
-H "Content-Type: application/json" \
"https://api-cluster.adere.so/v3/channels/whatsapp/56900000000/config/" \
-d '{"service_quality": {"max_response_time": 300}}'