VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: caixa de entrada

Sessão do assistente

Consulta, pausa por um tempo e religa o assistente automático em uma conversa.

Consultar o assistente na conversa

Diz em que modo o assistente está nesta conversa e, se estiver pausado, até quando. Uma conversa nunca configurada responde A.

GET/api/v1/admin/whatsapp-confluence/threads/{id}/botAdmin

Estado do assistente na conversa

Parâmetros de caminho

iduuidobrigatório
Id da conversa.

Exemplo de requisição

Resposta

200Estado

Campos da resposta

thread_iduuid
Conversa consultada.
modestring
APH
Modo do assistente.
paused_untilstring
Fim da pausa (RFC 3339). Só aparece quando mode é P.

Erros

StatusQuandoCorpo de exemplo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Não valida o id

Um id de conversa inexistente também responde 200 com mode A.

Pausar o assistente

Silencia o assistente por alguns minutos nesta conversa, sem assumir como pessoa. Passado o prazo, ele volta sozinho.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/bot/pauseAdmin

Pausa o assistente

Parâmetros de caminho

iduuidobrigatório
Id da conversa.

Corpo da requisição

minutesinteger
Duração da pausa em minutos. Se ausente, zero ou negativo, vale o tempo padrão da loja para pausa depois de um eco do aplicativo.

Exemplo de requisição

Resposta

200Pausado

Campos da resposta

paused_untilstring
Instante em que a pausa termina (RFC 3339).

Erros

StatusQuandoCorpo de exemplo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Não vale em modo pessoa

Se a conversa já está em H, nada muda, mas a resposta ainda mostra um paused_until. Falhas ao gravar também não geram erro. Confirme com Consultar o assistente na conversa.

Religar o assistente

Volta o assistente para A (automático), desfazendo pausa ou modo pessoa.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/bot/resumeAdmin

Religa o assistente

Parâmetros de caminho

iduuidobrigatório
Id da conversa.

Exemplo de requisição

Resposta

200Religado

Campos da resposta

statusstring
Sempre ok.

Erros

StatusQuandoCorpo de exemplo
500Falha ao gravar.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Mesmo efeito de `end-service`

end-service faz o mesmo e é o nome usado pela tela de atendimento.

Veja também

  • Assumir e devolver
  • Assistente de IA
Anterior
Chat do Assistente: leitura
Próxima
Cobranças PIX
Nesta página
  • Consultar o assistente na conversa
  • Exemplo de requisição
  • Resposta
  • Erros
  • Pausar o assistente
  • Exemplo de requisição
  • Resposta
  • Erros
  • Religar o assistente
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/bot" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/bot/pause" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"minutes": 30}'
bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/bot/resume" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "thread_id": "e661b36c-fe1b-450f-b75b-49d10c1ead48",
  "mode": "P",
  "paused_until": "2026-10-10T20:00:00Z"
}
json
{
  "paused_until": "2026-10-10T19:15:00Z"
}
json
{
  "status": "ok"
}