/
Twilio Read

Twilio Read

May 09, 2024

In this article

Overview

Use this Snap to retrieve data resources from Twilio's REST APIs.

Prerequisites

  • Valid Twilio Account SID.

  • Auth Token corresponding to the Account SID.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations and Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Parser

  • CSV Parser

  • JSON Generator

A document containing details of the entity or data object to read a Twilio entity.

Output

Document

 

  • Min: 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • Router Snap

  • JSON Formatter

A document containing the data retrieved as a Twilio entity.

Snap Settings

Parameter Name

Data Type

Description

Default Value

Example 

Parameter Name

Data Type

Description

Default Value

Example 

Label

String

Twilio Read

Twilio Read All Entities

API object

String/Expression

Required. Select the API that you want to access in Twilio instance. This drop-down contains APIs (set of business objects) defined by Twilio. 

Programmable SMS

Autopilot

Entity

String/Expression/Suggestion

Required. Select an entity that belongs to the corresponding API object chosen above. 
For example, Messages entity belongs to the Programmable SMS API object. In this field, the available entities are dynamically populated in the suggestion drop-down list based on the selected API object.
You can choose an entity from the suggestion list dynamically or enter a static value. 

Messages

Assistant

Entity SID

String/Expression

Specify a unique ID for the entity that determines one specific resource under the given entity type.
If this field is left blank, by default all resources under the given entity type are retrieved. 

  • Certain Twilio entities represent uncountable resources that do not support SID-specified reading, for example, the 'Feedback' entities under several API objects. While, few Twilio entities do not support retrieving records without a SID, such as 'Dialogue' entity under the 'Autopilot' object. In this case, you must provide an Entity SID in this field. 

  • We recommend referring to Twilio's documentation or API explorer whenever you encounter the "Resource is not found" warning while performing the batch reading.

None

SM191d7edflkj987enm236eee168

Required SIDs

Use this field set to define the parent entity String Identifiers (SIDs) necessary for accessing the requested resources, if any.

Twilio's API designs follow a hierarchical pattern to indicate relationships among entities. For example, you can build an autopilot assistant to answer incoming calls with a task model. In this case, the Task entity is considered as a parameter of Assistant entity. Each assistant has a unique SID, and one assistant can have multiple tasks associated with it. To retrieve the record for one of the tasks, you must provide the task's parent assistant SID in the Required SIDs table.

Click 

 to add a new row in this table and define the values accordingly. This field set contains the following fields:

  • SID name

  • SID value

SID name

String/Expression/Suggestion

Specify the name of the SID to call the API.  

None

ServiceSID

SID value

String

Specify the SID value for the corresponding SID name chosen above.

None

UG12ab345acdeg9jkm345jkm765x

Filter parameters

Use this field set to define the names and values of query parameters for filtering the API responses. Click 

 to add a new row in this table and define the values accordingly.

This field set comprises the following fields:

  • Field name

  • Operator

  • Field value

For certain entities, you can provide Language or Date as the filter parameters; the input value format for these parameters should follow these standards:

Field Name

String/Expression/Suggestion

Specify the parameter names to filter the results.

You must enter only allowed parameters in this field. Use the suggestion list to identify the allowed parameters.

The available options are:

  • From

  • To

  • DateSent

None

DateSent

Operator

String/Expression

Select the operator from the drop-down list. The available options are:

  • equal to(=)

  • greater than or equal to(>=)

  • less than or equal to(<=)

The operators ">=" and "<=" are applicable only for sequential properties, such as the date and time-related parameters. for example, DateSent, DateCreated, StartTime, and EndTime.

=

>=

Field Value

String/Expression

Specify the value for service operation fields. The data type of this field depends on the field name chosen which can be String, Integer, or DateTime.

None

2020-03-10T10:00-20:00

Output Fields Pagination Options

Use this field set to add advanced options to define the pagination parameters for API response.

This field set comprises the following fields:

  • Page size

  • NextURL

Page size

Integer

Specify the number of records the Snap must get in each page. See Pagination for more information.

200

500

Next URL

Expression/Drop-down list

Enter an expression that will be evaluated on the output document to a URL that the Snap must use to get the next page. This property is used for the pagination feature. The Next URL has two components, which are structured as follows:

("<endpoint_URL>" + $next_page_uri)

  • The first component comprises the URL of the endpoint . ("<endpoint_URL>").

  • The second component is a pointer to the parameter in the API response that contains the URL of the next page(s).

None

"https://api.twilio.com/2010-04-01" + $next_page_uri"

Connection details

Use this field set to configure the network connection parameters.

This field set comprises the following fields:

  • Connection timeout

  • Maximum request attempts

  • Retry request interval

Connection timeout

Integer

Required. Specify the connection timeout duration in seconds.

30

60

Maximum request attempts

Integer

Required. Specify the maximum number of connection attempts if the connection fails or is timed-out.

3

6

Retry request interval

Integer

Required. Specify the time in seconds to wait before retrying the connection request.

1

3

Snap Execution

Dropdown list

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Validate & Execute

Validate & Execute