Listar canais
Lista os canais do alcance do chamador — caixas do Chatwoot, números do WhatsApp oficial e conexões não oficiais — por tipo e nome, com o estado da conexão, o que o tipo pode fazer e se o canal está atendendo agora. O código de pareamento não vem aqui: está em /channels/{channel_id}/session.
Autorização
bearer channels:readCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: channels:read
Parâmetros de consulta
Estreita a um cliente do alcance.
int64Só os canais que este agente de texto atende.
uuidO tipo de um canal.
Valor em
- "chatwoot"
- "meta_cloud"
- "whatsapp_lite"
true só os ligados; false só os desligados.
O canal de um número (E.164 com +) ou de uma caixa do Chatwoot (o id),
na forma gravada.
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/channels"{ "data": [ { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "campaign_eligibility": { "eligible": true, "reason": "string" }, "capabilities": { "delivery": "none", "initiation": "never", "owner": "external", "requires_pairing": true, "session_window_seconds": 0 }, "created_at": "2019-08-24T14:15:22Z", "enabled": true, "external_identity": "string", "has_credential": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_serving": true, "last_status_at": "2019-08-24T14:15:22Z", "name": "string", "status": "disconnected", "status_detail": "string", "status_label": "string", "tenant_id": 0, "type_label": "string", "updated_at": "2019-08-24T14:15:22Z", "config": { "account_id": 0, "auto_respond": true, "base_url": "string", "transcribe_audio": true }, "type": "chatwoot" } ], "page": { "has_more": true, "next_cursor": "string" }}