Configurar o spoke do Vonage

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 6 min. de leitura

    • Integre sua instância ServiceNow com a instância Vonage para habilitar a comunicação entre elas. Com esta integração, sua instância ServiceNow pode automatizar ações na instância Vonage, enquanto a instância Vonage pode enviar cargas para sua instância ServiceNow.

    Antes de Iniciar

    • Solicitar uma assinatura de Integration Hub.
    • Ative o plug-in Spoke do Vonage em sua instância ServiceNow.
    • Função necessária: administrador
    • Conta de instância de desenvolvedor do Vonage.

    Configurar a instância de desenvolvedor do Vonage

    Gere credenciais essenciais, como chaves de API, segredos e segredos de assinatura, para configurar sua instância de desenvolvedor Vonage. Sua instância ServiceNow usa essas credenciais no registro de conexão para se conectar à instância de desenvolvedor Vonage.

    Antes de Iniciar

    Função necessária: administrador

    Acesso a uma Vonage conta de desenvolvedor.

    Procedimento

    1. Faça login no https://developer.vonage.com/en/home.
    2. Na página Vonage da Central do desenvolvedor, selecione Meu painel.Minha página do painel.
    3. Na página Vonage do Painel de API, use a chave de API padrão e o segredo de API ou crie sua chave de API e segredo de API personalizados.
      1. Para usar a chave de API padrão e o segredo de API, copie a chave de API padrão e os valores de segredo de API.Botão Copiar para chave de API e segredo de API.
      2. Para gerar uma chave de API personalizada e um segredo de API, no painel esquerdo, selecione Configurações de API.Link de configurações de API.
      3. Selecione Solicitar mais chaves de API.
      4. Preencha e envie o formulário.
      5. Selecione Criar novo segredo.
      6. Na janela Adicionar um novo segredo, insira seu segredo personalizado.
      7. Selecione Salvar.
    4. No campo Segredo da assinatura, copie o segredo da assinatura.

    Configurar registro de conexão para alias de conexão e credencial do Vonage

    Configure um registro de conexão que permite que sua instância ServiceNow se conecte com a instância Vonage e automatize várias ações na instância Vonage. Por exemplo, crie um fluxo em Workflow Studio que obtém o saldo da sua conta Vonage.

    Antes de Iniciar

    Função necessária: administrador
    Nota:
    Verifique se você está no escopo do spoke do Vonage.

    Procedimento

    1. Navegar até Todos > Automação de Processo > Flow Designer.
    2. Selecione Conexões.
    3. No campo Pesquisar todas as conexões, insira Vonage.Campo Pesquisar todas as conexões.
    4. No cartão Vonage, selecione Exibir detalhes.
    5. Selecione Configurar.
    6. Preencha o formulário.
      Tabela 1. Criar Conexão
      Campo Descrição
      Nome da conexão O nome padrão e somente leitura do registro de conexão. Para fornecer um nome personalizado ao registro de conexão, crie um registro de conexão selecionando Adicionar conexão.
      URL de Conexão O URL para se conectar à API do Vonage.
      Versão da API de mensagens A versão das APIs que o registro de conexão solicita usando o recurso SMS na instância do Vonage.
      Versão da API de voz A versão das APIs para as quais o registro de conexão solicita usando o recurso de voz na instância do Vonage.
      Nome da Credencial Nome do registro da credencial. O nome padrão da credencial do Vonage que você pode atualizar.
      Nome da aplicação Nome da conta que você inseriu na página Configurações da conta de desenvolvedores do Vonage.Campo de nome da conta na instância do Vonage.
      Chave de API Chave de API que você adquiriu na instância de desenvolvedor do Vonage.
      Segredo de API Segredo de API que você adquiriu na instância de desenvolvedor do Vonage.
      Segredo da assinatura Chave secreta de assinatura que você adquiriu na instância de desenvolvedor do Vonage.
    7. Selecione Criar conexão.

    Configurar registro de conexão para alias primário do Vonage

    Configure um registro de conexão que permite que sua instância ServiceNow se conecte com a instância Vonage e automatize várias ações na instância Vonage. Por exemplo, crie um fluxo em Workflow Studio que obtém o saldo da sua conta Vonage.

    Antes de Iniciar

    Função necessária: administrador
    Nota:
    Verifique se você está no escopo do spoke do Vonage.

    Procedimento

    1. Navegar até Todos > Automação de Processo > Flow Designer.
    2. Selecione Conexões.
    3. No campo Pesquisar todas as conexões, insira Vonage.Campo Pesquisar todas as conexões.
    4. No cartão VonagePrimary, selecione Exibir detalhes.
    5. Selecione Configurar.
    6. Preencha o formulário.
      Tabela 2. Criar Conexão
      Campo Descrição
      Nome da conexão O nome padrão e somente leitura do registro de conexão. Para fornecer um nome personalizado ao registro de conexão, crie um registro de conexão selecionando Adicionar conexão.
      URL de Conexão O URL para se conectar à API do Vonage. Insira https://rest.nexmo.com.
      Chave de API Chave de API que você adquiriu na instância de desenvolvedor do Vonage.
      Segredo de API Segredo de API que você adquiriu na instância de desenvolvedor do Vonage.
    7. Selecione Criar conexão.

    Criar um webhook para receber dados do Vonage

    Configure webhooks para SMS para permitir que a plataforma de API do Vonage envie dados para sua instância da ServiceNow. Por exemplo, se um fluxo em sua instância da ServiceNow enviar uma solicitação de API de detalhes da chamada para a API do Vonage, mas a solicitação falhar inicialmente, o webhook garantirá que a API do Vonage envie os dados posteriormente.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Spoke do Vonage > Registros de webhook do Vonage.
    2. Selecione Novo.
    3. No formulário, preencha os seguintes campos.
      Tabela 3. Formulário de registro do Webhook do Vonage
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro do webhook.
      Descrição Descrição do registro do webhook.
      Tipo de evento Tipo de evento para o qual o webhook está configurado. Selecione SMS.
      Chave Secreta Chave secreta para autenticar as solicitações de webhook. Insira sua chave secreta personalizada.
    4. Clique com o botão direito no cabeçalho do formulário e selecione Salvar.
    5. Selecione o URL de retorno de chamada.
      O sistema exibe o URL de retorno de chamada do webhook.
    6. Copie e registre a URL de retorno de chamada do webhook.
    7. Faça login no https://developer.vonage.com/en/home.
    8. No painel esquerdo, em Criar e gerenciar, selecione Aplicações.Link de aplicações em Criar e gerenciar.
    9. Na página Suas aplicações, selecione o ícone de menu ( Ícone de menu.) para sua aplicação.Minha aplicação.
    10. Selecione Editar.
    11. No título Mensagens, insira a URL de retorno de chamada nos campos URL de entrada e URL de status.Configurações de mensagens.
    12. No painel esquerdo, selecione Configurações de API.
    13. Na página Configurações, no título Configurações de SMS, verifique se você selecionou API de SMS.
    14. Preencha os valores.
      Campo Valor
      Webhooks de recibos de entrega (DLR) URL de retorno de chamada do Webhook
      Webhooks de SMS de entrada URL de retorno de chamada do Webhook
    15. Selecione Salvar mudanças.
      As configurações de SMS da aplicação são salvas.

    Personalizar webhooks e políticas de roteamento

    Personalize a política de roteamento do webhook e o subfluxo de acordo com seus requisitos.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Flow Designer > Designer.
    2. Clique em Subfluxos.
    3. Crie uma cópia do subfluxo padrão necessário.
    4. Personalize o subfluxo de acordo com seus requisitos e publique-o.
      Consulte Criação de subfluxos para obter mais informações sobre como criar e usar subfluxos e Vonage Spoke para obter informações sobre os campos compatíveis com a política de roteamento padrão e os subfluxos.
    5. Navegar até Vonage Spoke > Política de roteamento do WebHook do Vonage.
    6. Clique em Nova.
    7. No formulário, preencha os campos.
      Tabela 4. Formulário de decisão
      Campo Descrição
      Rótulo Rótulo exclusivo para identificar a política de roteamento.
      Resposta padrão Opção para especificar se esta é a resposta padrão. A resposta padrão é aplicável quando as condições não são atendidas.
      1. Clique no ícone de pesquisa ( ícone de pesquisa).
      2. Selecione o subfluxo necessário na lista Documento.
        Nota:
        Certifique-se de que o nome da tabela seja Fluxo [sys_hub_flow].
      Condição Condições a serem atendidas quando os eventos necessários ocorrerem em Vonage. Os campos Vonage compatíveis são:
      • Palavras-chave
      • Direção da chamada
      • Status da chamada
      • Tipo de evento
      • De
      • Status do SMS
      • Mensagem SMS
      • Para
      • do WhatsApp Status da mensagem
      • do WhatsApp Texto
      • Mostrar campos relacionados
      Resposta Subfluxo que deve ser acionado quando as condições especificadas são atendidas.
    8. Clique em Enviar.
      Nota:
      Essas políticas de roteamento são salvas nas tabelas de decisão. Os usuários são alertados para não atualizar ou modificar diretamente os dados dessas tabelas.