Inbox
GET /v1/inbox/threads/{threadKey}
One conversation, oldest message first.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/inbox/threads/{threadKey} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
One thread with its messages in order. Reading a thread does not mark it read — that is a separate, explicit call.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
threadKey (path) | string | Sim | — |
org_id (query) | Uuid | Não | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
thread_key | string | Sim | — |
subject | string | Não | — |
kind | string<campaign, ticket, account> | Não | — |
messages | InboxMessage[] | Sim | — |
Erros que este endpoint pode retornar
401 · 403