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

Automações e canais

Como programar tarefas da VI, ligar e desligar seus recursos e usá-la em canais de atendimento e de compra.

Esta seção reúne o que faz a VI trabalhar sem uma conversa aberta: as rotinas (tarefas escritas em linguagem natural que rodam em horário fixo), o SAC resolutivo (a VI respondendo mensagens de pós-venda dos clientes) e a loja pronta para agentes (abertura da loja para assistentes de compra externos). Também documenta as configurações que ligam ou desligam cada recurso da VI na loja.

Pontos-chave
  • Uma rotina nasce como rascunho (draft) e só roda sozinha depois de retomada (resume), que a deixa active. Editá-la a devolve a rascunho.
  • Rotinas agendadas executam com as permissões do administrador que as ativou, conferidas a cada passo.
  • Cada loja pode ter no máximo 20 rotinas ativas.
  • PUT /settings substitui o documento inteiro: mande sempre o objeto completo lido antes.
  • O SAC e a loja pronta para agentes nascem desligados.

Como funciona

Ciclo de vida de uma rotina

draft→active→paused→archived
statusSignificado
draftCriada ou editada; ainda não roda sozinha
activeRoda no horário agendado
pausedParada pelo administrador; pode ser retomada
archivedExcluída (a exclusão é lógica)
  1. Compile
    POST /routines/compile transforma o texto ("todo dia às 8h resuma os pedidos de ontem") em um plano de passos. Nada é salvo.
  2. Revise e salve
    Mostre o plano ao administrador e salve com POST /routines. Passos que escrevem na loja vêm com is_write: true.
  3. Ative
    POST /routines/{id}/resume coloca a rotina em active.
  4. Acompanhe
    GET /routines/{id}/runs lista as execuções. POST /routines/{id}/run roda uma vez, na hora.

Conceitos-chave

Aprovação

Com require_approval: true, a execução para no primeiro passo que escreve na loja e registra a execução como waiting_approval. Passos de leitura rodam normalmente. Esta API não tem rota para aprovar uma execução parada: para rotinas que precisam escrever sem intervenção, use require_approval: false, ciente de que a escrita acontece sozinha.

Regras de negócio

Antes de cada passo que escreve, a plataforma confere as memórias do tipo rule com conteúdo estruturado (Memórias). Se o valor do passo viola uma regra (por exemplo, um desconto acima do máximo), a execução falha naquele passo.

Interruptores

Cada recurso da VI tem uma chave em Configurações. As chaves enable_* valem ligadas quando ausentes; proactive_nudges_enabled, o SAC e a loja pronta para agentes valem desligadas.

Rotas

Todas exigem Authorization: Bearer $TOKEN de um administrador.

MétodoCaminho (após /api/v1/admin/intelligence)Para que servePágina
GET/routinesListar rotinasroutines
POST/routinesCriarroutines
GET/routines/{id}Lerroutines
PATCH/routines/{id}Alterarroutines
DELETE/routines/{id}Excluirroutines
POST/routines/compileCompilar texto em planoroutines-run
POST/routines/{id}/pausePausarroutines-run
POST/routines/{id}/resumeAtivar/retomarroutines-run
POST/routines/{id}/runRodar agoraroutines-run
GET/routines/{id}/runsListar execuçõesroutines-run
GET/settingsLer configuraçõessettings
PUT/settingsSubstituir configuraçõessettings
GET/sac/settingsLer o SACsac
PUT/sac/settingsAlterar o SACsac
GET/sac/actionsAções do SAC numa conversasac
PUT/sac/threads/{id}/agentControlar a VI numa conversasac
GET/agent-commerce/settingsLer a loja pronta para agentesagent-commerce
PUT/agent-commerce/settingsLigar ou desligaragent-commerce

Erros comuns

  • Salvar a rotina e esperar que ela rode. Ela nasce draft. Falta o resume.
  • Editar uma rotina ativa e achar que continua ativa. PATCH volta o status para draft e zera require_approval quando você não o reenvia.
  • Mandar um PUT /settings parcial. Tudo que você não enviar é apagado, inclusive as chaves do SAC e da loja pronta para agentes.
  • Mandar PUT /sac/settings só com enabled. Os outros dois campos viram false.
  • Esperar 404 em rotinas que não existem. Várias rotas respondem 400 ou 500 com a mensagem do banco; confira o id antes.
  • Passar de 20 rotinas ativas. resume responde 409.

Próximos passos

Rotinas
Criar, alterar e excluir tarefas agendadas.
Configurações
Todas as chaves e seus padrões.
SAC resolutivo
Pós-venda respondido pela VI.
Loja pronta para agentes
Abrir a loja a assistentes de compra.
Anterior
Métricas e execução
Próxima
Rotinas agendadas
Nesta página
  • Como funciona
  • Ciclo de vida de uma rotina
  • Conceitos-chave
  • Aprovação
  • Regras de negócio
  • Interruptores
  • Rotas
  • Erros comuns
  • Próximos passos