Skip to contentSkip to navigationSkip to topbar
Twilio Docs
On this page

Job Resource

The Job resource allows you to view and delete the requests for exports of arbitrary date ranges, submitted through the ExportCustom Job.

Job Properties

job-properties page anchor
Property nameTypeRequiredDescriptionChild properties
resourceTypestring

Optional

Not PII

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

friendlyNamestring

Optional

Not PII

The friendly name specified when creating the job

detailsobject

Optional

Not PII

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.

startDaystring

Optional

Not PII

The start time for the export specified when creating the job

endDaystring

Optional

Not PII

The end time for the export specified when creating the job

jobSidSID<JS>

Optional

Not PII

The job_sid returned when the export was created

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

Optional

Not PII

The optional webhook url called on completion

webhookMethodstring

Optional

Not PII

This is the method used to call the webhook

emailstring

Optional

Not PII

The optional email to send the completion notification to

urlstring<uri>

Optional

Not PII
jobQueuePositionstring

Optional

Not PII

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

Not PII

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
ErrorDuringRunThe Job was attempted, but an error prevented completion. This is not a final status, the job will be retried.
SubmittedThe Job has been successfully submitted and is in the queue to execute.
RunningThe 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.
CompletedEmptyRecordsThe Job has completed, however, no records for the requested resource have been found. An empty file will be available at the Day endpoint.
CompletedThe Job is successfully completed, and the result files are available at the Day endpoint.
FailedThe 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 problem continues to persist.
RunningToBeDeletedThe Job is currently running, but it has been marked for deletion, and will be deleted soon.

Fetch a Job resource

fetch-a-job-resource page anchor

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

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
jobSidSID<JS>
required
Not PII

The unique string that that we created to identify the Bulk Export job

Pattern: ^JS[0-9a-fA-F]{32}$Min length: 34Max length: 34
Fetch a JobLink to code sample: Fetch a Job
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function fetchJob() {

11
  const job = await client.bulkexports.v1.exports

12
    .jobs("JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .fetch();

14


15
  console.log(job.resourceType);

16
}

17


18
fetchJob();

Response

1
{

2
  "start_day": "start_day",

3
  "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "url": "https://bulkexports.twilio.com/v1/Exports/Jobs/JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "friendly_name": "friendly_name",

6
  "end_day": "end_day",

7
  "details": {},

8
  "webhook_url": "https://webhookexample.com",

9
  "webhook_method": "webhook_method",

10
  "email": "email",

11
  "resource_type": "resource_type",

12
  "job_queue_position": "1",

13
  "estimated_completion_time": "2021-03-15T20:20:14.547"

14
}

Delete a Job resource

delete-a-job-resource page anchor

DELETE https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
jobSidSID<JS>
required
Not PII

The unique string that that we created to identify the Bulk Export job

Pattern: ^JS[0-9a-fA-F]{32}$Min length: 34Max length: 34
Delete a JobLink to code sample: Delete a Job
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function deleteJob() {

11
  await client.bulkexports.v1.exports

12
    .jobs("JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .remove();

14
}

15


16
deleteJob();