ExportConfiguration Resource
The Export Configuration for a resource has two uses:
- setting automatic generation of files by setting "enabled" to true (in the case of Editions customers)
- setting the callback method for when the automatic generation of the file has completed
You can send this via:
- webhook
The webhook_method must be either GET or POST, and webhook_url should be the URL of the service you want to call when the file is available. For email, the email parameter should be an email address.
ExportConfiguration properties
Resource Properties in REST API format | |
---|---|
enabled
|
If true, Twilio will automatically generate every day's file when the day is over. |
webhook_url
|
Stores the URL destination for the method specified in webhook_method. |
webhook_method
|
Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url |
resource_type
|
The type of communication – Messages, Calls, Conferences, and Participants |
url
|
The URL of this resource. |
Fetch an ExportConfiguration resource
https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration
Parameters
Parameters in REST API format | |
---|---|
resource_type
Path
|
The type of communication – Messages, Calls, Conferences, and Participants |
Example 1
Example 2
Update an ExportConfiguration resource
https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration
Parameters
Parameters in REST API format | |
---|---|
resource_type
Path
|
The type of communication – Messages, Calls, Conferences, and Participants |
enabled
Optional
|
If true, Twilio will automatically generate every day's file when the day is over. |
webhook_url
Optional
|
Stores the URL destination for the method specified in webhook_method. |
webhook_method
Optional
|
Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.