Sign inGet Started

Iniciar uma Automação a partir de uma sequência de voz

Aviso: as sequências de voz estão em versão prévia. As etapas, os dados de entrada e o formato de definição de sequência podem mudar de formas que quebram sequências existentes e solicitações API.

Use Send Automation Event para iniciar uma Automação enquanto a chamada continua. Por exemplo, quando quem liga pressiona 1 para pedir um retorno de ligação, envie o número dessa pessoa para uma Automação que agenda o retorno. A chamada não espera a execução da Automação.

A etapa está em versão prévia. Automations está em acesso antecipado, e as permissões do seu espaço de trabalho determinam o que você pode configurar.

Preparar a automação

  1. Crie uma automação com Event from your application como gatilho.
  2. Defina Event name, por exemplo callback_requested.
  3. Defina Event fields para os valores que a chamada vai enviar, como campos de texto chamados caller e digits.
  4. Publique a automação.

Na automação, trigger.data é o envelope do evento e trigger.data.data são os dados que você mapeou, então o número de quem liga fica em trigger.data.data.caller. Conecte sua aplicação a uma automação explica o envelope, os nomes de eventos, os campos de evento e as execuções.

Adicionar a etapa

  1. Adicione Send Automation Event no caminho que deve iniciar a automação, como a opção do teclado para solicitar um retorno de ligação.
  2. Em Automation event, escolha a automação e depois o evento dela. A lista mostra os eventos que a versão publicada da automação pode iniciar.
  3. Em Data, preencha os campos do evento. Cada campo pode ser um valor fixo, um valor de dados anteriores da chamada ou, em campos de texto, um texto que combina os dois. Se o evento não tiver campos de evento, adicione seus próprios nomes e valores.
  4. Conecte os resultados Success e Failure.

Os dados que você mapeia são todos os dados do evento. Bird não adiciona nenhum campo, então mapeie todos os valores que a automação lê. O número de quem liga fica em execution.call.orig.address e pode estar ausente, então proteja-o. O ID da chamada fica em execution.call.id, e os dígitos do teclado ficam em steps.<gather step>.output.digits. O ID da sequência não está disponível nos dados da chamada; insira-o como valor fixo quando a automação precisar dele.

Para escolher uma automação, você precisa de permissão para ler Automations. Sem essa permissão, insira você mesmo o ID da automação, o nome do evento e os dados.

Trate os resultados

ResultadoSignificado e próxima ação
SuccessO evento entrou na fila da automação. Continue a chamada.
FailureNão foi possível enfileirar o evento em poucos segundos. Continue a chamada ou peça a quem liga que tente de outra forma.

Uma falha sem conexão encerra a execução como falha. Conecte-a, mesmo que à mesma etapa do sucesso, quando a chamada precisar continuar de qualquer forma.

Nenhum dos resultados informa o que a automação fez. O resultado é sucesso mesmo quando a automação está pausada, não publicada ou excluída, quando ela não usa o nome do evento ou quando os dados não correspondem aos campos do evento. Confira a aba Runs da automação para ver se uma execução foi iniciada.

Verifique antes de publicar

Ao publicar a sequência, você recebe um aviso, sem bloqueio, quando a automação escolhida não existe, está pausada ou não foi publicada, ou quando a versão publicada dela não pode iniciar uma execução a partir do evento escolhido. O aviso também aparece para uma automação pausada ou para um evento usado apenas por uma regra de espera ou de cancelamento, mesmo que o evento possa continuar ou cancelar execuções existentes. Se você não tiver permissão para ler Automations, o aviso informa que a etapa não foi verificada.

Entrega

  • A etapa só é executada depois que a chamada é atendida. Uma chamada não atendida ou abandonada não envia nada.
  • O evento normalmente chega à automação cerca de um segundo após a etapa.
  • Cada passagem pela etapa envia um evento, e as entregas repetidas desse evento são descartadas. A proteção contra duplicatas é limitada, então projete a automação para tolerar uma repetição ocasional.
  • Uma Transfer que retorna à etapa envia um novo evento.
  • Todos os eventos vão para a versão publicada da automação, inclusive os de chamadas de teste. Uma chamada de teste é uma chamada real, e a automação pode executar ações reais.
  • O Preview não envia nenhum evento. Escolha um exemplo de sucesso ou de falha para a etapa.

Usar a definição

Em uma definição de sequência, a etapa é um nó automation.send_event:

Exemplo de código
{
  "id": "notify",
  "type": "automation.send_event",
  "type_version": 1,
  "config": {},
  "input": {
    "automation_id": "atm_01jz8x3v4w5y6z7a8b9c0d1e2f",
    "event": "callback_requested",
    "data": {
      "caller": {
        "$expr": "execution.call.orig != null && has(execution.call.orig.address) ? execution.call.orig.address : ''"
      },
      "digits": { "$expr": "steps.menu.output.digits" }
    }
  },
  "connections": {
    "success": { "node_id": "confirm", "port": "input" },
    "failure": { "node_id": "confirm", "port": "input" }
  }
}
CampoValor
config{}.
input.automation_idObrigatório. ID de uma automação neste espaço de trabalho.
input.eventObrigatório. O nome do evento da automação: de 1 a 128 letras, dígitos, pontos, sublinhados ou hifens.
input.dataOpcional, padrão {}. Um objeto em que cada valor de nível superior é vinculado com $expr ou $template, ou um único $expr para o objeto inteiro. Valores aninhados em níveis mais profundos permanecem literais. No máximo 16 KiB junto com o restante da entrada.
Resultadossuccess e failure, cada um com a saída {}. Um failure não conectado faz a execução falhar.

Próximas etapas

Continue com a documentação, guias e exemplos sobre este tópico.