Skip to content Skip to navigation Skip to topbar

On this page

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 been 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.

Configuration Properties

Property nameTypeRequiredDescriptionChild properties

enabledbooleanOptional

Not PII

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

webhook_urlstring<uri>Optional

Not PII

Stores the URL destination for the method specified in webhook_method.

webhook_methodstringOptional

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_typestringOptional

Not PII

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

urlstring<uri>Optional

Not PII

The URL of this resource.

Fetch an ExportConfiguration resource

GET https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration

Path parameters

Property nameTypeRequiredPIIDescription

ResourceTypestringrequired

Not PII

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

Fetch an Export Configuration for Messages

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchExportConfiguration() {
11  const exportConfiguration = await client.bulkexports.v1
12    .exportConfiguration("Messages")
13    .fetch();
14
15  console.log(exportConfiguration.enabled);
16}
17
18fetchExportConfiguration();

Output

1{
2  "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration",
3  "enabled": true,
4  "webhook_url": "",
5  "webhook_method": "",
6  "resource_type": "Messages"
7}

Fetch a Export Configuration for Calls

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchExportConfiguration() {
11  const exportConfiguration = await client.bulkexports.v1
12    .exportConfiguration("Calls")
13    .fetch();
14
15  console.log(exportConfiguration.enabled);
16}
17
18fetchExportConfiguration();

Output

1{
2  "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration",
3  "enabled": true,
4  "webhook_url": "",
5  "webhook_method": "",
6  "resource_type": "Calls"
7}

Update an ExportConfiguration resource

POST https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration

Path parameters

Property nameTypeRequiredPIIDescription

ResourceTypestringrequired

Not PII

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

EnabledbooleanOptional

Not PII

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

WebhookUrlstring<uri>Optional

Not PII

Stores the URL destination for the method specified in webhook_method.

WebhookMethodstringOptional

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

Update Export Configuration

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateExportConfiguration() {
11  const exportConfiguration = await client.bulkexports.v1
12    .exportConfiguration("Messages")
13    .update({
14      webhookMethod: "GET",
15      webhookUrl: "https://api.your-infrastructure.com/receive-messages/",
16    });
17
18  console.log(exportConfiguration.enabled);
19}
20
21updateExportConfiguration();

Output

1{
2  "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration",
3  "enabled": true,
4  "webhook_url": "https://api.your-infrastructure.com/receive-messages/",
5  "resource_type": "Messages",
6  "webhook_method": "GET"
7}