Listar conversas
Lista as conversas de texto do alcance do chamador, da mais ativa para a mais antiga. q busca em título, nome e telefone do contato e no conteúdo das mensagens. Os ensaios do estúdio ficam de fora por padrão — include_studio=true os traz. A ordem é por atividade, que muda enquanto se pagina: uma conversa que recebe mensagem sobe para o topo e não reaparece nas páginas seguintes. Conversas de ligação não estão aqui — elas vão por /calls.
Autorização
bearer conversations: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: conversations:read
Parâmetros de consulta
Estreita para um cliente (dentro do alcance).
int64Só as conversas deste agente de texto.
uuidBusca em título, nome e telefone do contato e no conteúdo das mensagens.
webhook ou platform.
Valor em
- "webhook"
- "platform"
Inclui os ensaios do estúdio, que ficam de fora por padrão.
Só as conversas com atividade a partir deste instante.
date-timeSó as conversas com atividade até este instante.
date-timeCursor 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/conversations"{ "data": [ { "agent": { "id": null, "name": "string" }, "channel": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "string" }, "closed_at": "2019-08-24T14:15:22Z", "contact": { "email": "string", "name": "string", "phone": "string" }, "created_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "last_message_at": "2019-08-24T14:15:22Z", "last_message_preview": "string", "matched_snippet": "string", "message_count": 0, "origin": "webhook", "result": null, "status": "string", "studio": true, "tenant_id": 0, "title": "string", "updated_at": "2019-08-24T14:15:22Z" } ], "page": { "has_more": true, "next_cursor": "string" }}