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

POSTPlayground do assistente

Roda um turno do assistente sem enviar nada pelo WhatsApp, para testar persona, conhecimento e respostas.

Simula o cliente escrevendo message e devolve o que o assistente responderia. É um teste a seco: nada é enviado ao WhatsApp. Cada chamada é independente (não guarda histórico). Exige manage_settings.

POST/api/v1/admin/whatsapp-confluence/ai/playgroundAdmin

Testa uma mensagem no assistente

Corpo da requisição

messagestringobrigatório
Texto que o cliente "escreveria". Obrigatório.
phonestring
Telefone de teste. Com ele, o turno roda como aquele cliente (conta, carrinho, histórico de pedidos). Sem ele, só a conversa é exercitada.
resetboolean
Aceito por compatibilidade; não tem efeito, porque o playground não guarda histórico.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/ai/playground" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message": "Vocês têm camiseta azul?", "phone": "5511987654321"}'

Resposta

200Turno simulado
json
{
  "reply": "Temos camisetas azuis a partir de R$ 59,90. Quer ver as opções?",
  "tool_calls": [
    "search_products"
  ],
  "latency_ms": 3120,
  "cards": [
    {
      "name": "Camiseta Azul",
      "price_cents": 5990
    }
  ]
}

Campos da resposta

replystring
Resposta do assistente.
tool_callsarray
Ferramentas usadas (nomes internos).
latency_msinteger
Duração em milissegundos.
cardsarray
Cartões de produto que acompanhariam a resposta. Ausente se não houver.
actionsarray
Botões que acompanhariam a resposta (label, href, variant, intent). Ausente se não houver.
wa_previewobject
Como seria o carrossel no WhatsApp. Ausente se não houver.

Erros

StatusQuandoCorpo de exemplo
400message vazia ou JSON inválido.{"error":"message required"}
502O modelo de IA falhou ou ficou indisponível.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
403O administrador não tem o privilégio manage_settings.{"error":"insufficient privileges","required":"manage_settings"}
Gasta chamadas reais

Cada teste usa o modelo de IA de verdade e aparece no registro com kind playground. Use um telefone de teste, não o de um cliente real.

Respostas lentas

Um turno pode levar vários segundos. Configure o tempo limite do seu cliente HTTP para pelo menos 60 segundos.

Anterior
Registro de chamadas
Próxima
WhatsApp: conexão
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros