Twilio

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:
  • List
  • Get
  • Create
  • Update
  • Delete

  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. Normally, an action will have some input parameters, and an output parameter. 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": ""
                     }

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"
                     }

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*****"
                     }

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"
                  }