The Job resource allows you to view and delete the requests for exports of arbitrary date ranges, submitted through the ExportCustom Job.
The type of communication – Messages, Calls, Conferences, and Participants
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.
The job_sid returned when the export was created
^JS[0-9a-fA-F]{32}$Min length: 34Max length: 34This 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
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 completed, however, no records for the requested resource have been found. An empty file will be available at the Day endpoint. |
Completed | The Job is successfully 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 problem continues to persist. |
RunningToBeDeleted | The Job is currently running, but it has been marked for deletion, and will be deleted soon. |
GET https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}The unique string that that we created to identify the Bulk Export job
^JS[0-9a-fA-F]{32}$Min length: 34Max length: 341// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function fetchJob() {11const job = await client.bulkexports.v1.exports12.jobs("JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.fetch();1415console.log(job.resourceType);16}1718fetchJob();
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 https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}The unique string that that we created to identify the Bulk Export job
^JS[0-9a-fA-F]{32}$Min length: 34Max length: 341// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function deleteJob() {11await client.bulkexports.v1.exports12.jobs("JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.remove();14}1516deleteJob();