Saltar al contenido

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ámetroTipoRequeridoDescripción
client_idnumberNoFiltra por cliente.
wa_idstringNoFiltra por número de WhatsApp (wa_id).
waba_idstringNoFiltra por WABA.
statusstringNoFiltra por estado.
business_idstringNoFiltra por ID de negocio asociado (coincidencia exacta).
business_namestringNoFiltra por nombre de negocio (coincidencia parcial, insensible a mayúsculas).
qstringNoBúsqueda libre (insensible a mayúsculas) sobre client_name, waba_name, wa_id y waba_id.
deletedbooleanNoFiltro de eliminados. Ausente o false: excluye eliminados (default). true: solo eliminados.
pagenumberNoNúmero de página (default 1).
sizenumberNoTamaño de página (default 20, máximo 100).
fieldsstringNoCampos 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.

CampoDescripción
wa_id, client_id, client_name, waba_id, waba_name, statusIdentificadores y estado del recurso
business_id, business_nameNegocio asociado
current_limit, quality_rating, phone_id, phone_number_idLímites, calidad y números
is_on_biz_appFlag de configuración
phone_code, phone_numberDatos del número
create_at, create_by, register_atAuditoría
external_webhookConfiguració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ódigoCaso
400Parámetro inválido (client_id, deleted, page, size no numéricos/booleanos válidos)
403Se solicitó un client_id de otro cliente sin permiso BSP_CN