ReferênciaConversations
Conversations
Inbox público. A mesma visibilidade do produto para o usuário que mintou a chave.
Liste threads, leia mensagens, responda texto, feche, snooze, priorize, anote, marque e convide staff.
| HTTP | Path | Scope |
|---|---|---|
| GET | /api/v1/conversations | rest.conversations.read |
| GET | /api/v1/conversations/{id} | rest.conversations.read |
| PATCH | /api/v1/conversations/{id} | rest.conversations.write |
| GET | /api/v1/conversations/{id}/messages | rest.conversations.messages.read |
| POST | /api/v1/conversations/{id}/messages | rest.conversations.write |
| POST | /api/v1/conversations/{id}/media | rest.conversations.write |
| GET | /api/v1/conversations/{id}/notes | rest.conversations.read |
| POST | /api/v1/conversations/{id}/notes | rest.conversations.write |
| GET | /api/v1/conversation-tags | rest.conversations.read |
| POST | /api/v1/conversations/{id}/tags | rest.conversations.write |
| DELETE | /api/v1/conversations/{id}/tags/{tag_id} | rest.conversations.write |
| GET | /api/v1/conversations/{id}/participants | rest.conversations.read |
| POST | /api/v1/conversations/{id}/participants | rest.conversations.write |
| DELETE | /api/v1/conversations/{id}/participants/{participant_id} | rest.conversations.write |
Lista com q, status (open / pending / closed / snoozed) e contact_id. PATCH status é open, closed ou snoozed — pending fica filtro. snoozed_until é obrigatório com status snoozed e precisa ser futuro. Já-snoozed recusa novo snooze: abra primeiro. priority: low | normal | high | urgent. Reply é texto; DNC, thread fechada e canal inativo falham fechados. Notas internas são staff-only, 1–5000 chars, distintas de /api/v1/notes. Tags do inbox são outro catálogo (GET /conversation-tags), máximo 10. Participantes staff: observer | collaborator; collaborator em canal exclusivo é 403.
Query
| Parâmetro | Tipo | Notas |
|---|---|---|
| q | string | Busca o thread. |
| status | open | pending | closed | snoozed | Filtro. pending não é PATCH. |
| contact_id | UUID | Threads daquele contato. |
| limit / cursor | number / string | Página de cursor. limit 1–100. |
Campos
| Campo | Tipo | Notas |
|---|---|---|
| id / display_id | UUID / string | Identidade pública do thread. |
| status | string | open, pending, closed, snoozed. |
| can_reply | boolean | WhatsApp false = janela 24h fechada. |
| owner_id | UUID | null | Membro. Unassign exclusivo falha fechado. |
| priority | low | normal | high | urgent | PATCH. |
| content | string | Reply texto. 201 { id, status: pending }. |