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

Chat do Assistente: ações

Responde no chat do cliente, assume a sessão, devolve ao assistente e marca como lida.

Responder no chat

Grava uma mensagem da equipe (origin A) na sessão. O chat do cliente a recebe na próxima consulta. Responder também assume a sessão: o assistente para de falar naquela sessão.

POST/api/v1/admin/whatsapp-confluence/assistant/threads/{id}/replyAdmin

Responde no chat do Assistente

Parâmetros de caminho

iduuidobrigatório
Id da sessão do chat do Assistente.

Corpo da requisição

bodystringobrigatório
Texto. Obrigatório (ou text).
textstring
Apelido de body.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/assistant/threads/7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d/reply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body": "Olá! Aqui é a equipe da loja, posso ajudar?"}'

Resposta

200Mensagem gravada
json
{
  "id": 42,
  "thread_id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
  "wamid": "wamid.HBgLNTUxMTk4NzY1NDMyMRUCABEYEjQ1QTE",
  "direction": "O",
  "origin": "A",
  "msg_type": "text",
  "body": "Olá! Aqui é a equipe da loja, posso ajudar?",
  "status": "S",
  "meta_timestamp": "2026-10-10T18:43:02Z",
  "created_at": "2026-10-10T18:43:02Z"
}

Campos da resposta

(corpo)object
A mensagem criada, com os campos de uma mensagem.

Erros

StatusQuandoCorpo de exemplo
400Texto vazio ou JSON inválido.{"error":"body required"}
404A sessão não existe (ou está fora do escopo de quem chama).{"error":"thread not found"}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}

Marcar a sessão como lida

Zera o contador de não lidas da sessão.

POST/api/v1/admin/whatsapp-confluence/assistant/threads/{id}/readAdmin

Marca a sessão como lida

Parâmetros de caminho

iduuidobrigatório
Id da sessão do chat do Assistente.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/assistant/threads/7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d/read" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito
json
{
  "success": true
}

Campos da resposta

successboolean
Sempre true.

Erros

StatusQuandoCorpo de exemplo
404A sessão não existe (ou está fora do escopo de quem chama).{"error":"thread not found"}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}

Assumir a sessão

A IA para de responder esta sessão; a equipe passa a falar com o cliente.

POST/api/v1/admin/whatsapp-confluence/assistant/threads/{id}/take-overAdmin

Assume a sessão do Assistente

Parâmetros de caminho

iduuidobrigatório
Id da sessão do chat do Assistente.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/assistant/threads/7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d/take-over" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito
json
{
  "success": true
}

Campos da resposta

successboolean
Sempre true.

Erros

StatusQuandoCorpo de exemplo
404A sessão não existe (ou está fora do escopo de quem chama).{"error":"thread not found"}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}

Devolver ao assistente

A IA volta a responder a sessão.

POST/api/v1/admin/whatsapp-confluence/assistant/threads/{id}/end-serviceAdmin

Devolve a sessão ao Assistente

Parâmetros de caminho

iduuidobrigatório
Id da sessão do chat do Assistente.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/assistant/threads/7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d/end-service" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito
json
{
  "success": true
}

Campos da resposta

successboolean
Sempre true.

Erros

StatusQuandoCorpo de exemplo
404A sessão não existe (ou está fora do escopo de quem chama).{"error":"thread not found"}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Aviso por falta de resposta

Se a equipe assume e não responde a tempo, a plataforma devolve a sessão e deixa um aviso ao cliente (from assistant) no chat.

Veja também

  • Chat do Assistente: leitura
Anterior
Representantes e aprovação de desconto
Próxima
Chat do Assistente: leitura
Nesta página
  • Responder no chat
  • Exemplo de requisição
  • Resposta
  • Erros
  • Marcar a sessão como lida
  • Exemplo de requisição
  • Resposta
  • Erros
  • Assumir a sessão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Devolver ao assistente
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também