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

Agir nas sessões do assistente

Responde ao cliente do chat da mini-loja, marca como lida, assume a sessão e devolve ao assistente.

Estas ações trabalham sobre uma sessão do chat do assistente. Diferente do WhatsApp, nada sai pela Meta: a resposta do atendente é gravada e chega ao chat do cliente na próxima consulta periódica que a página dele faz, em poucos segundos. Responder também assume a sessão, como na caixa do WhatsApp.

Responder na sessão

POST/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}/replySeller

Envia uma resposta ao chat do cliente

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.
Content-Typestringobrigatório
application/json.

Parâmetros de caminho

iduuidobrigatório
Id da sessão do assistente (id de Sessões do assistente).

Corpo da requisição

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

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31/reply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Entregamos em Campinas, sim! O prazo é de 2 dias úteis."
}'

Resposta

200Resposta gravada
json
{
  "id": 8,
  "thread_id": "c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31",
  "wamid": "wamid.HBgNNTUxMTk4NzY1NDMyMRUCABIYFjNFQjA",
  "direction": "O",
  "origin": "A",
  "msg_type": "text",
  "body": "Entregamos em Campinas, sim! O prazo é de 2 dias úteis.",
  "status": "S",
  "meta_timestamp": "2026-10-10T14:35:00Z",
  "created_at": "2026-10-10T14:35:00Z"
}

Campos da resposta

(campos)object
A mensagem gravada, no formato de mensagem de Conversas e mensagens.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
400Texto vazio (depois de remover espaços) ou corpo que não é JSON.{"error":"body required"}
404Sessão inexistente ou de outro seller.{"error":"thread not found"}
500Falha interna ao ler ou gravar.{"error":"..."}

Marcar sessão como lida

POST/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}/readSeller

Zera as não lidas da sessão

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório
Id da sessão do assistente (id de Sessões do assistente).

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31/read" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito
json
{
  "success": true
}

Campos da resposta

successboolean
Sempre true.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
404Sessão inexistente ou de outro seller.{"error":"thread not found"}
500Falha interna ao ler ou gravar.{"error":"..."}

Assumir a sessão

POST/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}/take-overSeller

O assistente para de responder esta sessão

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório
Id da sessão do assistente (id de Sessões do assistente).

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31/take-over" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito
json
{
  "success": true
}

Campos da resposta

successboolean
Sempre true.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
404Sessão inexistente ou de outro seller.{"error":"thread not found"}
500Falha interna ao ler ou gravar.{"error":"..."}

Devolver ao assistente

POST/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}/end-serviceSeller

O assistente volta a responder a sessão

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório
Id da sessão do assistente (id de Sessões do assistente).

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31/end-service" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito
json
{
  "success": true
}

Campos da resposta

successboolean
Sempre true.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
404Sessão inexistente ou de outro seller.{"error":"thread not found"}
500Falha interna ao ler ou gravar.{"error":"..."}

Veja também

  • Sessões do assistente
  • Estado da conversa
  • Visão geral da seção
Anterior
Sessões do assistente
Próxima
Visão geral
Nesta página
  • Responder na sessão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Marcar 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