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

Sessões do assistente

Lista e abre as conversas do chat do assistente da mini-loja, lê as mensagens, o modo e o painel do cliente.

Além do WhatsApp, a mini-loja tem um chat com o assistente na página. Cada visita com conversa vira uma sessão, lida aqui com o mesmo desenho da caixa do WhatsApp: as sessões voltam no formato de conversa e as mensagens no formato de mensagem. A sessão pode ser de um visitante (customer_phone vazio) ou de um cliente identificado pelo telefone. O seller só vê as sessões das contas dele.

Listar sessões

GET/api/v1/vendor/whatsapp-confluence/assistant/threadsSeller

Lista as sessões do chat do assistente

Cabeçalhos

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

Parâmetros de consulta

filterstring
unreadhumanunansweredmine
unread só com mensagens não lidas; human só com atendimento humano; unanswered cuja última mensagem é do cliente; mine assumidas por você.
qstring
Busca por texto no nome ou no telefone.
pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 50
1 a 200. Fora disso vale 50.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads?filter=unread" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Sessões
json
{
  "page": 1,
  "threads": [
    {
      "id": "c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31",
      "account_id": "3b9d8c52-1f0a-4e7b-8a21-6d5c4b3a2f10",
      "customer_phone": "",
      "contact_name": "Visitante",
      "unread_count": 1,
      "last_message_at": "2026-10-10T13:10:00Z",
      "last_message_preview": "Vocês entregam em Campinas?",
      "last_message_origin": "C",
      "status": "A",
      "bot_mode": "A",
      "created_at": "2026-10-10T13:08:00Z",
      "updated_at": "2026-10-10T13:10:00Z"
    }
  ]
}

Campos da resposta

pageinteger
Página devolvida.
threadsarray
Sessões, as mais recentes primeiro, nos campos de conversa 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"}
500Falha interna ao ler ou gravar.{"error":"..."}

Consultar sessão

GET/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}Seller

Retorna uma 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 "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Sessão
json
{
  "id": "c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31",
  "account_id": "3b9d8c52-1f0a-4e7b-8a21-6d5c4b3a2f10",
  "customer_phone": "",
  "contact_name": "Visitante",
  "unread_count": 1,
  "last_message_at": "2026-10-10T13:10:00Z",
  "last_message_preview": "Vocês entregam em Campinas?",
  "last_message_origin": "C",
  "status": "A",
  "bot_mode": "A",
  "created_at": "2026-10-10T13:08:00Z",
  "updated_at": "2026-10-10T13:10:00Z"
}

Campos da resposta

(campos)object
Os mesmos campos de conversa 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"}
404Sessão inexistente, id que não é UUID, ou de outro seller.{"error":"thread not found"}

Mensagens da sessão

GET/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}/messagesSeller

Pagina as mensagens de uma 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).

Parâmetros de consulta

beforeinteger
Só mensagens com id menor. Omitido traz as mais recentes.
limitintegerpadrão: 50
1 a 200. Fora disso vale 50.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31/messages?limit=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Mensagens
json
{
  "messages": [
    {
      "id": 7,
      "thread_id": "c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31",
      "wamid": "wamid.HBgNNTUxMTk4NzY1NDMyMRUCABIYFjNFQjA",
      "direction": "I",
      "origin": "C",
      "msg_type": "text",
      "body": "Vocês entregam em Campinas?",
      "status": "S",
      "meta_timestamp": "2026-10-10T14:35:00Z",
      "created_at": "2026-10-10T14:35:00Z"
    }
  ],
  "next_before": 7,
  "thread": {
    "id": "c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31",
    "account_id": "3b9d8c52-1f0a-4e7b-8a21-6d5c4b3a2f10",
    "customer_phone": "",
    "contact_name": "Visitante",
    "unread_count": 1,
    "last_message_at": "2026-10-10T13:10:00Z",
    "last_message_preview": "Vocês entregam em Campinas?",
    "last_message_origin": "C",
    "status": "A",
    "bot_mode": "A",
    "created_at": "2026-10-10T13:08:00Z",
    "updated_at": "2026-10-10T13:10:00Z"
  }
}

Campos da resposta

messagesarray
Mensagens da mais nova para a mais antiga, no formato de mensagem de Conversas e mensagens.
next_beforeinteger
id da mais antiga da página, o before da próxima.
threadobject
A sessão, com handoff_timeout quando a sessão voltou ao assistente por tempo.

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":"..."}

Modo da sessão

GET/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}/botSeller

Retorna quem atende 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 "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31/bot" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Modo
json
{
  "thread_id": "c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31",
  "mode": "A"
}

Campos da resposta

thread_iduuid
A sessão.
modestring
AH
A assistente, H pessoa.

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"}

Painel do cliente da sessão

Mesmo formato de Painel do cliente. Numa sessão de visitante, o carrinho é o do visitante e os pedidos são os da conta em que ele entrou no chat, se houver.

GET/api/v1/vendor/whatsapp-confluence/assistant/threads/{id}/commerceSeller

Mostra carrinho e pedidos do cliente 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 "$BASE_URL/api/v1/vendor/whatsapp-confluence/assistant/threads/c5a1e0d2-84b7-4f3a-9c16-2e7d8b9a0f31/commerce" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Painel
json
{
  "phone": "",
  "cart": null,
  "orders": []
}

Campos da resposta

phonestring
Telefone da sessão. Vazio para visitante.
cartobject
Carrinho com itens e totais, ou null.
ordersarray
Pedidos.
userobject
Cliente ligado, quando existe.

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"}

Veja também

  • Agir nas sessões
  • Conversas e mensagens
  • Visão geral da seção
Anterior
Cobrança por PIX e painel do cliente
Próxima
Agir nas sessões do assistente
Nesta página
  • Listar sessões
  • Exemplo de requisição
  • Resposta
  • Erros
  • Consultar sessão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Mensagens da sessão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Modo da sessão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Painel do cliente da sessão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também