Menu

Expand
Rate this page:

ExportConfiguration Resource

The Export Configuration for a resource has two uses:

  1. setting automatic generation of files by setting "enabled" to true (in the case of Editions customers)
  2. setting the callback method for when the automatic generation of the file has completed

You can send this via:

  • webhook
  • email

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
boolean Not PII

If true, Twilio will automatically generate every day's file when the day is over.

webhook_url
url Not PII

Stores the URL destination for the method specified in webhook_method.

webhook_method
string Not PII

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
string Not PII

The type of communication – Messages, Calls, Conferences, and Participants

url
url Not PII

The URL of this resource.

Fetch an ExportConfiguration resource

get
https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration
Parameters
Parameters in REST API format
resource_type
Path
get string Not PII

The type of communication – Messages, Calls, Conferences, and Participants

Example 1
Loading Code Sample...
        
        

        Fetch an Export Configuration for Messages

        Example 2
        Loading Code Sample...
              
              

              Fetch a Export Configuration for Calls

              Update an ExportConfiguration resource

              post
              https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration
              Parameters
              Parameters in REST API format
              resource_type
              Path
              post string Not PII

              The type of communication – Messages, Calls, Conferences, and Participants

              enabled
              Optional
              post boolean Not PII

              If true, Twilio will automatically generate every day's file when the day is over.

              webhook_url
              Optional
              post url Not PII

              Stores the URL destination for the method specified in webhook_method.

              webhook_method
              Optional
              post string Not PII

              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
              Loading Code Sample...
                    
                    

                    Update Export Configuration

                    Rate this page:

                    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.

                    Loading Code Sample...
                          
                          
                          

                          Thank you for your feedback!

                          Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                          Sending your feedback...
                          🎉 Thank you for your feedback!
                          Something went wrong. Please try again.

                          Thanks for your feedback!

                          thanks-feedback-gif