API atual/Referência completa/WhatsApp: caixa de entrada

Chat do Assistente: leitura

Lista e lê as sessões do chat do Assistente da mini-loja, que não passam pelo WhatsApp.

Listar sessões do Assistente

O chat do Assistente é o assistente de vendas dentro da mini-loja (no navegador do cliente). Cada visitante ou cliente identificado tem uma sessão. Esta rota lista as sessões com o mesmo formato de conversa da caixa de WhatsApp, para a equipe acompanhar e, se quiser, interferir. Sessões de visitante não têm telefone (customer_phone vazio).

GET/api/v1/admin/whatsapp-confluence/assistant/threadsAdmin

Lista sessões do chat do Assistente

Parâmetros de consulta

filterstring

unreadhumanunansweredmine

unread só não lidas; human só com pessoa; unanswered cuja última mensagem é do cliente; mine assumidas por você.

qstring

Busca por trecho no nome e no telefone.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 50

Itens por página (até 200).

Exemplo de requisição

bash

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

Resposta

200Sessões

json

{
  "page": 1,
  "threads": [
    {
      "id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "account_id": "",
      "customer_phone": "",
      "contact_name": "Visitante",
      "unread_count": 2,
      "last_message_at": "2026-10-10T18:42:10Z",
      "last_message_preview": "Vocês têm tênis 42?",
      "last_message_origin": "C",
      "csw_expires_at": "2026-10-11T18:42:10Z",
      "status": "A",
      "bot_mode": "A",
      "created_at": "2026-10-01T12:00:00Z",
      "updated_at": "2026-10-10T18:42:10Z"
    }
  ]
}

Campos da resposta

pageinteger

Página devolvida.

threadsarray

Sessões, com os campos de uma conversa (ver Conversas e mensagens).

Erros

Status	Quando	Corpo de exemplo
500	Falha ao consultar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Consultar uma sessão

Devolve uma sessão pelo id.

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

Consulta uma sessão do Assistente

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Exemplo de requisição

bash

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

Resposta

200Sessão

json

{
  "id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
  "account_id": "",
  "customer_phone": "",
  "contact_name": "Visitante",
  "unread_count": 2,
  "last_message_at": "2026-10-10T18:42:10Z",
  "last_message_preview": "Vocês têm tênis 42?",
  "last_message_origin": "C",
  "csw_expires_at": "2026-10-11T18:42:10Z",
  "status": "A",
  "bot_mode": "A",
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-10T18:42:10Z"
}

Campos da resposta

(corpo)object

Uma conversa, como em Conversas e mensagens.

Erros

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

Listar as mensagens da sessão

Mesmo formato e paginação de Listar as mensagens da caixa de WhatsApp: da mais nova para a mais antiga, com before e next_before. Mensagens do assistente têm origin B; as da equipe, A.

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

Lista as mensagens de uma sessão

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Parâmetros de consulta

beforeinteger

Só mensagens com id menor que este.

limitintegerpadrão: 50

Mensagens por página (até 200).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/assistant/threads/7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d/messages?limit=50" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Mensagens

json

{
  "messages": [
    {
      "id": 41,
      "thread_id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "wamid": "wamid.HBgLNTUxMTk4NzY1NDMyMRUCABIYFjNFQjA",
      "direction": "I",
      "origin": "C",
      "msg_type": "text",
      "body": "Vocês têm tênis 42?",
      "status": "S",
      "meta_timestamp": "2026-10-10T18:42:10Z",
      "created_at": "2026-10-10T18:42:10Z"
    }
  ],
  "next_before": 41,
  "thread": {
    "id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "account_id": "",
    "customer_phone": "",
    "contact_name": "Visitante",
    "unread_count": 2,
    "last_message_at": "2026-10-10T18:42:10Z",
    "last_message_preview": "Vocês têm tênis 42?",
    "last_message_origin": "C",
    "csw_expires_at": "2026-10-11T18:42:10Z",
    "status": "A",
    "bot_mode": "A",
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-10T18:42:10Z"
  }
}

Campos da resposta

messagesarray

Mensagens da sessão.

next_beforeinteger

Id da mais antiga da página.

threadobject

Retrato da sessão.

Erros

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

Consultar o modo do assistente

Diz se o assistente ainda responde nesta sessão (A) ou se uma pessoa assumiu (H).

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

Modo do assistente na sessão

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Exemplo de requisição

bash

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

Resposta

200Modo

json

{
  "thread_id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
  "mode": "A"
}

Campos da resposta

thread_iduuid

Sessão.

modestring

AH

Modo.

Erros

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

Ver o carrinho e os pedidos da sessão

Painel do cliente da sessão. Para sessão com telefone, igual a Ver o carrinho e os pedidos do cliente. Para visitante, devolve o carrinho do visitante e, se ele entrou numa conta, os pedidos dela.

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

Carrinho e pedidos da sessão

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Exemplo de requisição

bash

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

Resposta

200Painel

json

{
  "phone": "",
  "cart": null,
  "orders": []
}

Campos da resposta

phonestring

Telefone, vazio para visitante.

cartobject

Carrinho ou null.

ordersarray

Pedidos (até 30).

userobject

Cliente identificado, quando existir.

Erros

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

Veja também

Chat do Assistente: ações

API atual/Referência completa/WhatsApp: caixa de entrada

Chat do Assistente: leitura

Lista e lê as sessões do chat do Assistente da mini-loja, que não passam pelo WhatsApp.

Listar sessões do Assistente

GET/api/v1/admin/whatsapp-confluence/assistant/threadsAdmin

Lista sessões do chat do Assistente

Parâmetros de consulta

filterstring

unreadhumanunansweredmine

unread só não lidas; human só com pessoa; unanswered cuja última mensagem é do cliente; mine assumidas por você.

qstring

Busca por trecho no nome e no telefone.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 50

Itens por página (até 200).

Exemplo de requisição

bash

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

Resposta

200Sessões

json

{
  "page": 1,
  "threads": [
    {
      "id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "account_id": "",
      "customer_phone": "",
      "contact_name": "Visitante",
      "unread_count": 2,
      "last_message_at": "2026-10-10T18:42:10Z",
      "last_message_preview": "Vocês têm tênis 42?",
      "last_message_origin": "C",
      "csw_expires_at": "2026-10-11T18:42:10Z",
      "status": "A",
      "bot_mode": "A",
      "created_at": "2026-10-01T12:00:00Z",
      "updated_at": "2026-10-10T18:42:10Z"
    }
  ]
}

Campos da resposta

pageinteger

Página devolvida.

threadsarray

Sessões, com os campos de uma conversa (ver Conversas e mensagens).

Erros

Status	Quando	Corpo de exemplo
500	Falha ao consultar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Consultar uma sessão

Devolve uma sessão pelo id.

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

Consulta uma sessão do Assistente

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Exemplo de requisição

bash

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

Resposta

200Sessão

json

{
  "id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
  "account_id": "",
  "customer_phone": "",
  "contact_name": "Visitante",
  "unread_count": 2,
  "last_message_at": "2026-10-10T18:42:10Z",
  "last_message_preview": "Vocês têm tênis 42?",
  "last_message_origin": "C",
  "csw_expires_at": "2026-10-11T18:42:10Z",
  "status": "A",
  "bot_mode": "A",
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-10T18:42:10Z"
}

Campos da resposta

(corpo)object

Uma conversa, como em Conversas e mensagens.

Erros

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

Listar as mensagens da sessão

Mesmo formato e paginação de Listar as mensagens da caixa de WhatsApp: da mais nova para a mais antiga, com before e next_before. Mensagens do assistente têm origin B; as da equipe, A.

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

Lista as mensagens de uma sessão

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Parâmetros de consulta

beforeinteger

Só mensagens com id menor que este.

limitintegerpadrão: 50

Mensagens por página (até 200).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/assistant/threads/7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d/messages?limit=50" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Mensagens

json

{
  "messages": [
    {
      "id": 41,
      "thread_id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "wamid": "wamid.HBgLNTUxMTk4NzY1NDMyMRUCABIYFjNFQjA",
      "direction": "I",
      "origin": "C",
      "msg_type": "text",
      "body": "Vocês têm tênis 42?",
      "status": "S",
      "meta_timestamp": "2026-10-10T18:42:10Z",
      "created_at": "2026-10-10T18:42:10Z"
    }
  ],
  "next_before": 41,
  "thread": {
    "id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "account_id": "",
    "customer_phone": "",
    "contact_name": "Visitante",
    "unread_count": 2,
    "last_message_at": "2026-10-10T18:42:10Z",
    "last_message_preview": "Vocês têm tênis 42?",
    "last_message_origin": "C",
    "csw_expires_at": "2026-10-11T18:42:10Z",
    "status": "A",
    "bot_mode": "A",
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-10T18:42:10Z"
  }
}

Campos da resposta

messagesarray

Mensagens da sessão.

next_beforeinteger

Id da mais antiga da página.

threadobject

Retrato da sessão.

Erros

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

Consultar o modo do assistente

Diz se o assistente ainda responde nesta sessão (A) ou se uma pessoa assumiu (H).

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

Modo do assistente na sessão

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Exemplo de requisição

bash

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

Resposta

200Modo

json

{
  "thread_id": "7c1d2a3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
  "mode": "A"
}

Campos da resposta

thread_iduuid

Sessão.

modestring

AH

Modo.

Erros

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

Ver o carrinho e os pedidos da sessão

Painel do cliente da sessão. Para sessão com telefone, igual a Ver o carrinho e os pedidos do cliente. Para visitante, devolve o carrinho do visitante e, se ele entrou numa conta, os pedidos dela.

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

Carrinho e pedidos da sessão

Parâmetros de caminho

iduuidobrigatório

Id da sessão do chat do Assistente.

Exemplo de requisição

bash

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

Resposta

200Painel

json

{
  "phone": "",
  "cart": null,
  "orders": []
}

Campos da resposta

phonestring

Telefone, vazio para visitante.

cartobject

Carrinho ou null.

ordersarray

Pedidos (até 30).

userobject

Cliente identificado, quando existir.

Erros

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

Veja também

Chat do Assistente: ações