Skip to content Skip to navigation Skip to topbar

On this page

Export Custom Job Resource

Custom Jobs allow you to create exports for any date range. If the date range spans multiple days, they will generate separate output days. Jobs can be deleted with the Job resource. When a Job is completed successfully, the results are visible as days in the Day resource.

Job Properties

Property nameTypeRequiredDescriptionChild properties

friendlyNamestring

Optional

The friendly name specified when creating the job

resourceTypestring

Optional

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

startDaystring

Optional

The start day for the custom export specified when creating the job

endDaystring

Optional

The end day for the export specified when creating the job

webhookUrlstring

Optional

The optional webhook url called on completion of the job. If this is supplied, WebhookMethod must also be supplied.

webhookMethodstring

Optional

This is the method used to call the webhook on completion of the job. If this is supplied, WebhookUrl must also be supplied.

emailstring

Optional

The optional email to send the completion notification to

jobSidSID<JS>

Optional

The unique job_sid returned when the custom export was created

Pattern: ^JS[0-9a-fA-F]{32}$Min length: 34Max length: 34

detailsarray

Optional

The details of a job which is an object that contains an array of status grouped by status state. Each status object has a status string, a count which is the number of days in that status, and list of days in that status. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a status object for SUBMITTED each with its own count and list of days.

jobQueuePositionstring

Optional

This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease

estimatedCompletionTimestring

Optional

this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position

ENUM:STATUS possible values
`ErrorDuringRun`	The Job was attempted, but an error prevented completion. This is not a final status, the job will be retried.
`Submitted`	The Job has been successfully submitted and is in the queue to execute.
`Running`	The job is currently running. The output should be available shortly. Multiple Jobs may run at the same time. You can use the 'estimated_completion_time' to get a sense of when your job will be complete.
`CompletedEmptyRecords`	The Job has been completed, however, no records for the requested resource have been found. An empty file will be available at the Day endpoint.
`Completed`	The Job has completed, and the result files are available at the Day endpoint.
`Failed`	The Job was attempted, but an error prevented completion. This is a final status, as the job has already been tried multiple times and has not been successful. Try submitting the job again, or reach out to your Twilio support team if the problem continues to persist.
`RunningToBeDeleted`	The Job is currently running, but it has been marked for deletion and will be deleted soon.
`DeletedByUserRequest`	The Job has been marked for deletion. So the system will not attempt to run it.

Create an ExportCustomJob resource

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

Path parameters

Property nameTypeRequiredPIIDescription

resourceTypestring

required

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

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

startDaystring

required

The start day for the custom export specified as a string in the format of yyyy-mm-dd

endDaystring

required

The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day.

friendlyNamestring

required

The friendly name specified when creating the job

webhookUrlstring

Optional

The optional webhook url called on completion of the job. If this is supplied, WebhookMethod must also be supplied. If you set neither webhook nor email, you will have to check your job's status manually.

webhookMethodstring

Optional

This is the method used to call the webhook on completion of the job. If this is supplied, WebhookUrl must also be supplied.

emailstring

Optional

The optional email to send the completion notification to. You can set both webhook, and email, or one or the other. If you set neither, the job will run but you will have to query to determine your job's status.

Create a new BulkExport custom job

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 createExportCustomJob() {
11  const exportCustomJob = await client.bulkexports.v1
12    .exports("Messages")
13    .exportCustomJobs.create({
14      email: "you@example.com",
15      endDay: "2019-11-30",
16      friendlyName: "Export1",
17      startDay: "2019-11-20",
18      webhookMethod: "POST",
19      webhookUrl: "https://www.example.com/bulkexporthook",
20    });
21
22  console.log(exportCustomJob.jobSid);
23}
24
25createExportCustomJob();

Response

1{
2  "start_day": "2019-11-20",
3  "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Export1",
5  "webhook_method": "POST",
6  "details": [
7    {}
8  ],
9  "end_day": "2019-11-30",
10  "webhook_url": "https://www.example.com/bulkexporthook",
11  "email": "you@example.com",
12  "resource_type": "Messages",
13  "job_queue_position": "1",
14  "estimated_completion_time": "2021-03-15T20:20:14.547"
15}

Read multiple ExportCustomJob resources

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

Path parameters

Property nameTypeRequiredPIIDescription

resourceTypestring

required

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

Query parameters

Property nameTypeRequiredPIIDescription

pageSizeinteger<int64>

Optional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

pageinteger

Optional

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

The page token. This is provided by the API.

Read the current list of export jobs for this resource type

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 listExportCustomJob() {
11  const exportCustomJobs = await client.bulkexports.v1
12    .exports("Messages")
13    .exportCustomJobs.list({ limit: 20 });
14
15  exportCustomJobs.forEach((e) => console.log(e.friendlyName));
16}
17
18listExportCustomJob();

Response

1{
2  "meta": {
3    "previous_page_url": null,
4    "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0",
5    "page_size": 50,
6    "key": "jobs",
7    "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0",
8    "next_page_url": null,
9    "page": 0
10  },
11  "jobs": []
12}