Twilio Read
Overview
Use this Snap to retrieve data resources from Twilio's REST APIs.
- This is a Read-type Snap.
Works in Ultra Tasks
Prerequisites
- Valid Twilio Account SID
- Auth Token corresponding to the Account SID
Snap views
| Type | Description | Examples of upstream and downstream Snaps |
|---|---|---|
| Input |
A document containing details of the entity or data object to read a Twilio entity. |
|
| Output |
A document containing the data retrieved as a Twilio entity. |
|
| Learn more about Error handling. | ||
Snap settings
| Field/Field set | Description |
|---|---|
|
Label String
|
Specify a unique name for the Snap. Modify this to
be more appropriate, especially if there are more than one of the same Snap in the
pipeline.
Default value: Twilio Read |
|
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.
Default value: Programmable SMS Example: Autopilot |
|
Entity String/Expression/ Suggestion
|
Required. Select an entity that belongs to the corresponding
API object chosen above. You can choose an entity from the suggestion list
dynamically or enter a static value. Default value: Messages Example: Assistant |
|
Entity SID String/Expression
|
Specify the unique identifier of a specific resource under the selected entity. Leave this blank to retrieve all resources for the entity. Default value: N/A Example:
|
| Required SIDs | Use this fieldset to specify any additional SIDs required by the selected entity. Click the + icon to add a row and provide the SID name and its value for each required parameter. |
|
SID name String/Expression
|
Specify the name of the required SID parameter for the selected entity. Default value: N/A Example: AccountSid |
|
SID value String/Expression
|
Specify the value for the corresponding SID name. Default value: N/A Example:
|
| Filter parameters | Use this fieldset to filter the records returned by the Snap. Click the + icon to add a row and provide the parameter name and value for each filter. |
|
Field Name String/Expression/ Suggestion
|
Specify the name of the filter parameter supported by the selected entity. Default value: N/A Example: Status |
OperatorString/Expression/ Suggestion |
|
|
Field value String/Expression
|
Specify the value to be used to filter results for the corresponding parameter name. Default value: N/A Example: delivered |
| Output Fields Pagination Options | Use this fieldset to configure pagination of the Snap's output. |
|
Page size Integer/Expression
|
Specify the maximum number of records to return in each page. Default value: 200 Example: 100 |
|
Next URL String/Expression
|
Specify the URL for the next page of results when paginating through a large result set. Leave this blank to start from the first page. Default value: N/A |
| Connection details | Use this fieldset to specify the connection details for the Snap. |
|
Connection timeout Integer/Expression
|
Required. Specify the connection timeout duration in seconds. Default value: 30 Example: 60 |
|
Maximum request attempts Integer/Expression
|
Required. Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response. Default value: 3 Example: 5 |
|
Retry request interval Integer/Expression
|
Required. Specify the time interval in seconds between successive retry attempts. A retry occurs only when the previous attempt resulted in an exception. Default value: 3 Example: 5 |
|
Snap execution Dropdown list
|
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Execute only |