Listar canales WhatsApp del cliente
Lista los canales WhatsApp de los clientes conectados a la plataforma (número con su WABA, negocio asociado, límites, calidad y estado) con filtros, paginación y selección de campos. Cualquier supervisor autenticado puede listar: sin el permiso BSP_CN solo se devuelven los canales del cliente del token; con BSP_CN se puede filtrar por cualquier client_id u omitirlo para listar todos los clientes.
Endpoint: GET /v1/client-whatsapp-channels
Parámetros
Query
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
client_id | number | No | Filtra por cliente. |
wa_id | string | No | Filtra por número de WhatsApp (wa_id). |
waba_id | string | No | Filtra por WABA. |
status | string | No | Filtra por estado. |
business_id | string | No | Filtra por ID de negocio asociado (coincidencia exacta). |
business_name | string | No | Filtra por nombre de negocio (coincidencia parcial, insensible a mayúsculas). |
q | string | No | Búsqueda libre (insensible a mayúsculas) sobre client_name, waba_name, wa_id y waba_id. |
deleted | boolean | No | Filtro de eliminados. Ausente o false: excluye eliminados (default). true: solo eliminados. |
page | number | No | Número de página (default 1). |
size | number | No | Tamaño de página (default 20, máximo 100). |
fields | string | No | Campos a devolver separados por coma (ver Campos). |
Campos
Los campos desconocidos se descartan silenciosamente. Si fields está ausente o todos los campos son desconocidos, se devuelve el conjunto por defecto.
| Campo | Descripción |
|---|---|
wa_id, client_id, client_name, waba_id, waba_name, status | Identificadores y estado del recurso |
business_id, business_name | Negocio asociado |
current_limit, quality_rating, phone_id, phone_number_id | Límites, calidad y números |
is_on_biz_app | Flag de configuración |
phone_code, phone_number | Datos del número |
create_at, create_by, register_at | Auditoría |
external_webhook | Configuración adicional |
Campos por defecto: wa_id,client_id,client_name,waba_id,waba_name,status,business_id,business_name.
Request
curl --request GET \
--url 'https://api.chattigo.com/v1/client-whatsapp-channels?client_id=6&deleted=false&size=20&page=1&fields=wa_id,client_name,business_id,business_name,status' \
--header 'Authorization: Bearer <token>'Response
Éxito (200)
{
"data": [
{
"wa_id": "573012345678",
"client_name": "Cliente Demo",
"business_id": "biz-123",
"business_name": "Negocio Demo",
"status": "ACTIVE"
}
],
"total": 1,
"page": 1,
"page_size": 20,
"fields": "wa_id,client_name,business_id,business_name,status"
}Errores
| Código | Caso |
|---|---|
400 | Parámetro inválido (client_id, deleted, page, size no numéricos/booleanos válidos) |
403 | Se solicitó un client_id de otro cliente sin permiso BSP_CN |