Twilio

O conector permite a conexão com uma instância do Twilio e o acesso aos dados do Twilio como um banco de dados tradicional.

Antes de começar

Antes de usar o conector do Twilio, faça o seguinte:

• No seu projeto do Google Cloud, faça o seguinte:
  • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
  • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
  • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

• Receba o SID da conta e o Token de autenticação do Twilio da instância do Twilio. Consulte SID da conta, Token de autenticação.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

   Acessar a página "Conexões"

2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
3. Na seção Local, escolha o local da conexão.
   1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

   2. Clique em PRÓXIMA.
4. Na seção Detalhes da conexão, faça o seguinte:
   1. Conector: selecione e-mail na lista suspensa de conectores disponíveis.
   2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
   3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
   4. Como opção, insira uma Descrição para a instância de conexão.
   5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
   7. Opcionalmente, defina as Configurações do nó de conexão:
      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   8. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Básico: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
   • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
   • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
     • Sempre: a conexão será sempre com SSL ativado.
     • Nunca: a conexão não está com SSL ativado.
     • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
   • Na seção Servidor proxy, insira os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do host: especifique o nome do host ou o endereço IP do destino.

          Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

          • Crie um anexo do serviço PSC.
          • Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
   9. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
   10. Clique em PRÓXIMA.
5. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação oferecem suporte à conexão do Twilio:

      • Nome de usuário e senha

   Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

   2. Clique em PRÓXIMA.
6. Revisão: revise os detalhes de conexão e autenticação.
7. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

• Nome de usuário e senha
  • SID da conta: o SID da conta do usuário autenticado no momento.
  • Auth Token: token de autenticação do usuário autenticado no momento.

Exemplos de configuração de conexão

Esta seção lista os valores de exemplo para os vários campos que você configura ao criar o conector do Twilio.

Servidor do Twilio: tipo de conexão da Web

Nome do campo	Detalhes
Local	us-east1
Conector	Twilio
Versão do conector	1
Nome da conexão	gcp-twilio-rest-conn
Conta de serviço	SERVICE_ACCOUNT_NAME@serviceaccount
Número mínimo de nós	2
Número máximo de nós	50
Account SID	ACCOUNT_SID
Auth Token	AUTH_TOKEN
Versão do secret	1

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Observação : todas as entidades e ações terão um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro, como: os nomes do parâmetro e tipos de dados correspondentes. O esquema (metadados) de entidades e ações é buscado pela conexão no ambiente de execução do back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas suas conexões. Faça isso manualmente. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

Limitações do sistema

O conector do Twilio pode processar 25 transações por segundo, por nó, e limita todas as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação:o número de nós de Integration Connectors vai ser escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você for um cliente de pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição de conexão.
• Se você for um cliente de assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para uma melhor taxa de transferência, recomendamos verificar se os sistemas de back-end estão configurados de maneira ideal para processar o tráfego necessário.

Exemplos

Esta seção descreve como realizar algumas das operações de entidade neste conector.

Exemplo: listar todas as gravações

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Gravações na lista Entity.
3. Selecione a operação List e clique em Concluído.

Exemplo: receber uma gravação

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Gravações na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Defina o ID da entidade como "Receber gravação única". Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira RE2e915e78549694bd0a0742d2d39454e5 no campo Valor padrão.

Exemplo: excluir uma chamada

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Chamadas na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Defina o ID da entidade como "Excluir uma ligação". Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira CAaa4a99c300bd9d1bcc0d1ae9dcd248c6 no campo Valor padrão.

Exemplo: criar um feedback de ligação

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "Feedback" na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
                       "Sid": "CAdefbf2b4caa7df11dc48106385e32345",
                       "QualityScore": 5
                     }

   A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

   {
                       "Sid": "CAdefbf2b4caa7df11dc48106385e32345"
                     }

Exemplo: criar um resumo de feedback de ligação

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "FeedbackSummary" na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
                       "StartDate": "2014-06-01",
                       "EndDate": "2014-06-04"
                     }

   A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

   {
                       "Sid": "FS11f26a89d7260fb8cef070b768fcf5d1"
                     }

Exemplo: criar uma mensagem

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "Mensagens" na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
                       "To": "whatsapp:[phone]*****",
                       "Sender": "whatsapp:[phone]",
                       "Body": "Message is sent from Google Cloud"
                     }

   A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

   {
                       "Sid": "SMdfde81ab903c0a9e67f932f9bef91090"
                     }

Exemplo: atualizar uma mensagem

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "Mensagens" na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar uma mensagem. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira SM3ad97d41e786c02bca47c8ce1745053b no campo Valor padrão.
5. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
                       "Body": ""
                     }

Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como SM3ad97d41e786c02bca47c8ce1745053b.

A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

{}

Exemplo: atualizar um IncomingPhoneNumbers

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione IncomingPhoneNumbers na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar um IncomingPhoneNumbers. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira PN4047ac009a15885690a50a1d388b8411 no campo Valor padrão.
5. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
                       "Name": "name of IncomingPhoneNumber is getting updated"
                     }

Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como PN4047ac009a15885690a50a1d388b8411.

A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

{
                    "Sid": "PN4047ac009a15885690a50a1d388b8411"
                  }

Exemplo: atualizar um OutgoingCallerId

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "OutgoingCallerIds" na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade como "Atualizar um OutgoingCallerIds". Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira PN6f5f9bf39cb1801a6e21a5a80d274bdd no campo Valor padrão.
5. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
                       "Name": "Name Updated for 99025*****"
                     }

Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como PN6f5f9bf39cb1801a6e21a5a80d274bdd.

A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

{
                    "Sid": "PN6f5f9bf39cb1801a6e21a5a80d274bdd"
                  }

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte exemplo de modelo.

Ao criar essa conexão usando o Terraform, defina as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
proxy_enabled	BOOLEAN	Falso	Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar no proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticar no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado ao se conectar ao proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do Twilio em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

• Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
• Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.