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, realize as seguintes tarefas:
- No seu projeto do Google Cloud, faça o seguinte:
- Conceder o papel do IAM roles/connectors.admin ao usuário e configurar 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.
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:
- No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
- Clique em + CRIAR NOVO para abrir a página Criar conexão.
- Na seção Local, escolha o local da conexão.
- Região: selecione um local na lista suspensa.
Para conferir a lista de todas as regiões com suporte, consulte Locais.
- Clique em PRÓXIMA.
- Região: selecione um local na lista suspensa.
- Na seção Detalhes da conexão, faça o seguinte:
- Conector: selecione e-mail na lista suspensa de conectores disponíveis.
- Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
- 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 exceder 63 caracteres.
- Como opção, insira uma Descrição para a instância de conexão.
- Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
- 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.
- 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.
- Clique em + Adicionar destino.
- 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.
- Endereço do host: especifique o nome do host ou o endereço IP do destino.
- Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
- Clique em PRÓXIMA.
-
Na seção Autenticação, insira os detalhes da autenticação.
- 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
- Clique em PRÓXIMA.
Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.
- Selecione um Tipo de autenticação e insira os detalhes relevantes.
- Revisão: revise os detalhes de conexão e autenticação.
- 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.
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.
- 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:
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 da entidade, como as operações não estã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,
. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista
Actions
estará vazia.
Limitações do sistema
O conector do Twilio pode processar 25 transações por segundo, por nó, e limita as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.
Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.
Exemplos
Esta seção descreve como executar algumas das operações de entidade neste conector.
Exemplo: listar todas as gravações
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione "Gravações" na lista de
Entity
. - Selecione a operação
List
e clique em Concluído.
Exemplo: receber uma gravação única
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione "Gravações" na lista de
Entity
. - Selecione a operação
Get
e clique em Concluído. - Defina o ID da entidade como "Get single Recording". Para definir o ID da entidade, em
Na seção Task Input da tarefa Connectors, clique em entityId e
e insira
RE2e915e78549694bd0a0742d2d39454e5
no campo Valor padrão.
Exemplo: excluir uma chamada
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione "Calls" na lista
Entity
. - Selecione a operação
Delete
e clique em Concluído. - Defina o ID da entidade como "Delete a Calls". Para definir o ID da entidade, em
Na seção Task Input da tarefa Connectors, clique em entityId e
e insira
CAaa4a99c300bd9d1bcc0d1ae9dcd248c6
no campo Valor padrão.
Exemplo: criar um feedback de chamada
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione "Feedback" na lista de
Entity
. - Selecione a operação
Create
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "Sid": "CAdefbf2b4caa7df11dc48106385e32345", "QualityScore": 5 }
A execução deste exemplo retorna uma resposta semelhante à seguinte no conector variável de saída
connectorOutputPayload
da tarefa:{ "Sid": "CAdefbf2b4caa7df11dc48106385e32345" }
Exemplo: criar um resumo do feedback da chamada
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione FeedbackSummary na lista de
Entity
. - Selecione a operação
Create
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "StartDate": "2014-06-01", "EndDate": "2014-06-04" }
A execução deste exemplo retorna uma resposta semelhante à seguinte no conector variável de saída
connectorOutputPayload
da tarefa:{ "Sid": "FS11f26a89d7260fb8cef070b768fcf5d1" }
Exemplo: criar uma mensagem
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione "Mensagens" na lista
Entity
. - Selecione a operação
Create
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "To": "whatsapp:+9178923*****", "Sender": "whatsapp:+14155238886", "Body": "Message is sent from Google Cloud" }
A execução deste exemplo retorna uma resposta semelhante à seguinte no conector variável de saída
connectorOutputPayload
da tarefa:{ "Sid": "SMdfde81ab903c0a9e67f932f9bef91090" }
Exemplo: atualizar uma mensagem
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione "Mensagens" na lista
Entity
. - Selecione a operação
Update
e clique em Concluído. - Defina o ID da entidade como Update a Message. Para definir o ID da entidade, em
Na seção Task Input da tarefa Connectors, clique em entityId e
e insira
SM3ad97d41e786c02bca47c8ce1745053b
no campo Valor padrão. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "Body": "" }
Como alternativa, em vez de especificar o entityId, você também pode definir o
filterClause como SM3ad97d41e786c02bca47c8ce1745053b
.
A execução deste exemplo retorna uma resposta semelhante à seguinte no conector
variável de saída connectorOutputPayload
da tarefa:
{}
Exemplo - Atualizar um ReceivedNumbers
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione InboundNumbers na lista
Entity
. - Selecione a operação
Update
e clique em Concluído. - Defina o ID da entidade para Atualizar um InboundNumbers. Para definir o ID da entidade, em
Na seção Task Input da tarefa Connectors, clique em entityId e
e insira
PN4047ac009a15885690a50a1d388b8411
no campo Valor padrão. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "Name": "name of IncomingPhoneNumber is getting updated" }
Como alternativa, em vez de especificar o entityId, você também pode definir o
filterClause como PN4047ac009a15885690a50a1d388b8411
.
A execução deste exemplo retorna uma resposta semelhante à seguinte no conector
variável de saída connectorOutputPayload
da tarefa:
{ "Sid": "PN4047ac009a15885690a50a1d388b8411" }
Exemplo: atualizar um OutboundCallerIds
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione OutputCallerIds na lista
Entity
. - Selecione a operação
Update
e clique em Concluído. - Defina o ID da entidade para atualizar um OutboundCallerIds. Para definir o ID da entidade, em
Na seção Task Input da tarefa Connectors, clique em entityId e
e insira
PN6f5f9bf39cb1801a6e21a5a80d274bdd
no campo Valor padrão. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "Name": "Name Updated for 99025*****" }
Como alternativa, em vez de especificar o entityId, você também pode definir o
filterClause como PN6f5f9bf39cb1801a6e21a5a80d274bdd
.
A execução deste exemplo retorna uma resposta semelhante à seguinte no conector
variável de saída connectorOutputPayload
da tarefa:
{ "Sid": "PN6f5f9bf39cb1801a6e21a5a80d274bdd" }
Usar o Terraform para criar conexões
É possível usar o Terraform recurso 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 a criação de conexões, consulte Exemplo de modelo.
Ao criar essa conexão usando o Terraform, você precisa definir 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 o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE |
proxy_user | STRING | Falso | Um nome de usuário a ser usado para autenticar o proxy do ProxyServer. |
proxy_password | SEGREDO | Falso | Uma senha a ser usada para autenticação no proxy ProxyServer. |
proxy_ssltype | ENUM | Falso | O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL |
Usar a conexão do Twilio em uma integração
Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa Conectores.
- Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
- Para entender como criar e usar a tarefa Conectores no 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.