Listar agentes
Lista os agentes que o chamador alcança: todos para um master, os dos clientes da carteira para uma revenda, e os do próprio cliente para um usuário de cliente. type, tenant_id, lifecycle_state, purpose e q (nome) estreitam dentro do alcance; por padrão só ativos. tenant_id inexistente ou fora do alcance responde 404 TENANT_NOT_FOUND.
Autorização
bearer agents: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: agents:read
Parâmetros de consulta
text ou voice.
Valor em
- "text"
- "voice"
Estreita para um cliente (dentro do alcance).
int64RASCUNHO, EM_PRODUCAO, INATIVO ou ARQUIVADO.
Valor em
- "RASCUNHO"
- "EM_PRODUCAO"
- "INATIVO"
- "ARQUIVADO"
true inclui os inativos (por padrão a lista só traz ativos).
Filtra por propósito.
Busca por nome.
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/agents"{ "data": [ { "active_template_name": "string", "agent_mode": "string", "blocked_by": null, "created_at": "2019-08-24T14:15:22Z", "current_version_id": "158beffb-f9de-457f-bbee-873740e72504", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_active": true, "lifecycle_state": null, "name": "string", "production_ended_at": "2019-08-24T14:15:22Z", "production_started_at": "2019-08-24T14:15:22Z", "purpose": "string", "telephony_provider": "string", "tenant_id": 0, "type": "string", "updated_at": "2019-08-24T14:15:22Z", "voice_mode": "string" } ], "page": { "has_more": true, "next_cursor": "string" }}