Twilio

The Twilio connector lets you connect to a Twilio instance and access Twilio data as a traditional database.

Before you begin

Before using the Twilio connector, do the following tasks:

  • In your Google Cloud project:
    • Grant the roles/connectors.admin IAM role to the user configuring the connector.
    • Grant the following IAM roles to the service account that you want to use for the connector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.

    • Enable the following services:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      To understand how to enable services, see Enabling services.

    If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

  1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. In the Location section, choose the location for the connection.
    1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, see Locations.

    2. Click NEXT.
  4. In the Connection Details section, complete the following:
    1. Connector: Select Twilio from the drop down list of available Connectors.
    2. Connector version: Select the Connector version from the drop down list of available versions.
    3. In the Connection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 63 characters.
    4. Optionally, enter a Description for the connection instance.
    5. Service Account: Select a service account that has the required roles.
    6. Optionally, configure the Connection node settings:

      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

    7. Use proxy: Select this checkbox to configure a proxy server for the connection and configure the following values:
      • Proxy Auth Scheme: Select the authentication type to authenticate with the proxy server. The following authentication types are supported:
        • Basic: Basic HTTP authentication.
        • Digest: Digest HTTP authentication.
      • Proxy User: A user name to be used to authenticate with the proxy server.
      • Proxy Password: The Secret manager secret of the user's password.
      • Proxy SSL Type: The SSL type to use when connecting to the proxy server. The following authentication types are supported:
        • Auto: Default setting. If the URL is an HTTPS URL, then the Tunnel option is used. If the URL is an HTTP URL, then the NEVER option is used.
        • Always: The connection is always SSL enabled.
        • Never: The connection is not SSL enabled.
        • Tunnel: The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.
      • In the Proxy Server section, enter details of the proxy server.
        1. Click + Add destination.
        2. Select a Destination Type.
          • Host address: Specify the hostname or IP address of the destination.

            If you want to establish a private connection to your backend system, do the following:

    8. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
    9. Click NEXT.
  5. In the Authentication section, enter the authentication details.
    1. Select an Authentication type and enter the relevant details.

      The following authentication types are supported by the Twilio connection:

      • Username and password

      2. To understand how to configure these authentication types, see Configure authentication.

    2. Click NEXT.
  6. Review: Review your connection and authentication details.
  7. Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

  • Username and password
    • Account SID: Account SID of the currently authenticated user.
    • Auth Token: Auth token of the currently authenticated user.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

  • Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

    However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

  • Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:

    Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

  • Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

System limitations

The Twilio connector can process 25 transaction per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Examples

This section describes how to perform some of the entity operations in this connector.

Example - List all recordings

  1. In the Configure connector task dialog, click Entities.
  2. Select Recordings from the Entity list.
  3. Select the List operation, and then click Done.

Example - Get single recording

  1. In the Configure connector task dialog, click Entities.
  2. Select Recordings from the Entity list.
  3. Select the Get operation, and then click Done.
  4. Set the entity ID to Get single Recording. To set the entity ID, in the Task Input section of the Connectors task, click entityId and then enter RE2e915e78549694bd0a0742d2d39454e5 in the Default Value field.

Example - Delete a call

  1. In the Configure connector task dialog, click Entities.
  2. Select Calls from the Entity list.
  3. Select the Delete operation, and then click Done.
  4. Set the entity ID to Delete a Calls. To set the entity ID, in the Task Input section of the Connectors task, click entityId and then enter CAaa4a99c300bd9d1bcc0d1ae9dcd248c6 in the Default Value field.

Example - Create a call feedback

  1. In the Configure connector task dialog, click Entities.
  2. Select Feedback from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
                    "Sid": "CAdefbf2b4caa7df11dc48106385e32345",
                    "QualityScore": 5
                  }

    Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

    {
                    "Sid": "CAdefbf2b4caa7df11dc48106385e32345"
                  }

Example - Create a call feedback summary

  1. In the Configure connector task dialog, click Entities.
  2. Select FeedbackSummary from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
                    "StartDate": "2014-06-01",
                    "EndDate": "2014-06-04"
                  }

    Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

    {
                    "Sid": "FS11f26a89d7260fb8cef070b768fcf5d1"
                  }

Example - Create a Message

  1. In the Configure connector task dialog, click Entities.
  2. Select Messages from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
                    "To": "whatsapp:+9178923*****",
                    "Sender": "whatsapp:+14155238886",
                    "Body": "Message is sent from Google Cloud"
                  }

    Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

    {
                    "Sid": "SMdfde81ab903c0a9e67f932f9bef91090"
                  }

Example - Update a Message

  1. In the Configure connector task dialog, click Entities.
  2. Select Messages from the Entity list.
  3. Select the Update operation, and then click Done.
  4. Set the entity ID to Update a Message. To set the entity ID, in the Task Input section of the Connectors task, click entityId and then enter SM3ad97d41e786c02bca47c8ce1745053b in the Default Value field.
  5. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
                    "Body": ""
                  }

    6. Alternately, instead of specifying the entityId, you can also set the filterClause to SM3ad97d41e786c02bca47c8ce1745053b.

    Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

    {}

Example - Update a IncomingPhoneNumbers

  1. In the Configure connector task dialog, click Entities.
  2. Select IncomingPhoneNumbers from the Entity list.
  3. Select the Update operation, and then click Done.
  4. Set the entity ID to Update a IncomingPhoneNumbers. To set the entity ID, in the Task Input section of the Connectors task, click entityId and then enter PN4047ac009a15885690a50a1d388b8411 in the Default Value field.
  5. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
                    "Name": "name of IncomingPhoneNumber is getting updated"
                  }

    6. Alternately, instead of specifying the entityId, you can also set the filterClause to PN4047ac009a15885690a50a1d388b8411.

    Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

    {
                    "Sid": "PN4047ac009a15885690a50a1d388b8411"
                  }

Example - Update an OutgoingCallerIds

  1. In the Configure connector task dialog, click Entities.
  2. Select OutgoingCallerIds from the Entity list.
  3. Select the Update operation, and then click Done.
  4. Set the entity ID to Update an OutgoingCallerIds. To set the entity ID, in the Task Input section of the Connectors task, click entityId and then enter PN6f5f9bf39cb1801a6e21a5a80d274bdd in the Default Value field.
  5. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
                    "Name": "Name Updated for 99025*****"
                  }

    6. Alternately, instead of specifying the entityId, you can also set the filterClause to PN6f5f9bf39cb1801a6e21a5a80d274bdd.

    Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

    {
                    "Sid": "PN6f5f9bf39cb1801a6e21a5a80d274bdd"
                  }

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name Data type Required Description
proxy_enabled BOOLEAN False Select this checkbox to configure a proxy server for the connection.
proxy_auth_scheme ENUM False The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user STRING False A user name to be used to authenticate to the ProxyServer proxy.
proxy_password SECRET False A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype ENUM False The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Use the Twilio connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

  • To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
  • To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next