Atendimento

Conversas

Encontre conversas, abra novas e organize o atendimento.

Nesta página

Toda conversa pertence a um número de WhatsApp da empresa (um canal). Comece listando os números em /channels: o id de cada um é o channel_id usado para abrir conversas e filtrar.

GET/channelsbash

curl "$NEXTCHAT_API/channels" -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Listar e buscar

GET /conversations traz as conversas da mais recente para a mais antiga, com responsável, setor e atendimento aberto. Filtros: q (nome, telefone ou texto), channel, unread=true, archived=true, kind, assignee=none|me|<id>, sector, label, limit e offset.

GET/conversationsbash

curl "$NEXTCHAT_API/conversations?unread=true&assignee=none&limit=20" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Iniciar conversa

POST /conversations abre (ou devolve, se já existir) a conversa com um telefone no número escolhido. Informe {channel_id, phone, name} ou {channel_id, contact_id}. Telefone com DDD; sem o código do país, vale o Brasil. Abrir não envia nada: depois use Mensagens.

POST/conversationsbash

curl -X POST "$NEXTCHAT_API/conversations" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel_id":"ID_DO_NUMERO","phone":"44999990000","name":"Maria Souza"}'

Organizar

Ação	Rota	Corpo
Transferir para um colega e/ou setor	`POST /conversations/{id}/transfer`	`{user_id?, sector_id?, reason?}`
Trocar o setor (ou tirar de todos)	`PUT /conversations/{id}/sector`	`{sector_id}` ou `{sector_id: null}`
Arquivar, fixar, silenciar, renomear, etiquetas	`PATCH /conversations/{id}`	`archived`, `pinned`, `muted`, `name`, `label_ids`
Marcar como lida	`POST /conversations/{id}/read`	—

Endpoints

Método	Caminho	Ação	Permissão
GET	`/channels`	Listar números de WhatsApp	`conversations:read`
GET	`/conversations`	Listar conversas	`conversations:read`
POST	`/conversations`	Abrir conversa com um telefone ou contato	`conversations:write`
GET	`/conversations/{id}`	Detalhar conversa	`conversations:read`
PATCH	`/conversations/{id}`	Alterar conversa (arquivar, fixar, silenciar, nome, etiquetas)	`conversations:write`
POST	`/conversations/{id}/read`	Marcar como lida	`conversations:write`
POST	`/conversations/{id}/transfer`	Transferir para pessoa e/ou setor	`conversations:write`
PUT	`/conversations/{id}/sector`	Definir o setor	`conversations:write`