Twilio Delete
In this article
Overview
Use this Snap to delete existing data objects from Twilio.
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 | Document |
|
| A document containing details of the entity or data object to delete a Twilio entity. |
Output | Document Binary Binary or Document |
|
| A document containing details indicating whether the delete operation is successful or not. |
Snap Settings
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
Label | String | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | Twilio Delete | Twilio Delete |
API object | String/Expression | Required. Select the API that you want to delete in Twilio instance. This property provides a set of business objects defined by Twilio. | Programmable SMS | None |
Entity | String/Expression | Required. Select an entity that belongs to the corresponding API object chosen above. | Messages | Assistant |
Entity SID | String/Expression | Required. Specify a unique ID for the entity that determines one specific resource under the given entity type. | None | SMb5c5dcjklp475e863fj52f821u |
Required SIDs | Use this field set to add parent entity SID(s) necessary for accessing the requested resources, if there are any. Click to add a new row in this table and define the values accordingly.This field set comprises the following fields:
| |||
SID name | String/Expression/Suggestion | Specify the name of the parent SID of the input Entity. The available entities are dynamically populated in the suggestion list based on the specified Entity. You can choose an entity from the suggestion list or enter a static value. | None | AssistantSid |
SID value | String | Specify the value of the referred SID name. | None | UA12ab3656hjhd098ksvou946hgfd56 |
Connection details | Use this field set to configure the network connection parameters. This field set contains the following fields:
| |||
Connection timeout | Integer | Required. Specify the connection timeout duration in seconds. | 30 | 60 |
Maximum requests attempts | Integer | Required. Specify the maximum number of connection attempts in case of a failure or time-out. | 0 | 6 |
Retry request interval | Integer | Required. Specify the time in seconds to wait before retrying the connection request. | 0 | 3 |
Snap Execution | Drop-down list | Select one of the three following modes in which the Snap executes:
| Execute Only | Validate & Execute |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
The input entity does not exist. | An invalid entity has been entered. | Select a valid entity from the suggestion drop-down list. |
One or more Required SIDs are missing. | The Required SIDs are mandatory for this endpoint. | Check your settings under the Required SID table and enter valid entries if any of them are missing. |
You have an empty value in the SID name/value field for the Required SID. | The SID name/value field must not be empty for Required SIDs. | Enter a valid SID name/value for the Required SID. |
Examples
Deleting a message sent through Programmable SMS
In this example, we want to delete a message record sent through Programmable SMS using the Twilio Delete Snap.
To use this example, you must have a valid Twilio Account (see Twilo Account) and a Twilio phone number (including a trial phone number). You should also have sent at least one message with that Twilio phone number.
First, we configure the Twilio Delete Snap with the following settings:
- API object: Programmable SMS
- Entity: Messages
- Entity SID: $MessagesSid
In the Entity SID field you must provide the message SID retrieved from your own account. Here, we can use an expression to capture the message SID from the upstream document generated by the Mapper Snap.
Then, we configure the Mapper Snap as shown below
.
Subsequently, we edit the JSON text in the JSON Generator Snap and also edit the Target path and provide a $MessageSid expression in the Mapper snap.
You must provide a valid message SID retrieved from the Twilio account, else the Snap will not execute successfully.
A successful validation of this pipeline results in the following API response in the output view of the Twilio Delete Snap, which we later convert into XML format and stream to an XML Writer Snap. We should be able to see the XML file in the project workspace.
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Snap Pack History
See Also
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.