Docs/API Reference/Simulador
DashboardGitHub

O simulador permite testar o agente de cobrança em ambiente sandbox, com pagamentos Pix reais de R$ 0,01 via Mercado Pago. Ideal para validar tom de mensagem, fluxos de negociação e comportamento do agente antes de lançar campanhas em produção.

Endpoints

#
MétodoEndpointDescrição
POST/api/simulator/startCriar sessão de simulação
POST/api/simulator/:id/messageEnviar mensagem ao agente
GET/api/simulator/:idDados da sessão atual
GET/api/simulator/:id/paymentPolling de pagamento simulado
GET/api/simulatorListar sessões
DELETE/api/simulator/:idDeletar sessão
PATCH/api/simulator/:id/configAtualizar configuração do agente
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN).


Criar sessão

POST/api/simulator/start

Cria uma nova sessão de simulação com dados de dívida fictícios. A sessão inclui um devedor, uma dívida e configurações do agente (tom, limites de desconto, parcelamento).


Enviar mensagem

POST/api/simulator/:id/message

Envia uma mensagem ao agente IA como se fosse o devedor. O agente responde em tempo real usando as mesmas regras e prompts da produção.


Dados da sessão

GET/api/simulator/:id

Retorna os dados completos da sessão: histórico de mensagens, status da dívida, configuração do agente e informações de pagamento.


Polling de pagamento

GET/api/simulator/:id/payment

Verifica o status do pagamento Pix na sessão. Usado para polling a cada 3 segundos até a confirmação.


Listar sessões

GET/api/simulator

Retorna todas as sessões de simulação do usuário autenticado, com status e data de criação.


Deletar sessão

DELETE/api/simulator/:id

Remove uma sessão de simulação e seus dados associados.


Atualizar configuração

PATCH/api/simulator/:id/config

Altera as configurações do agente na sessão: tom da mensagem, limites de desconto, número máximo de parcelas e composição da dívida.