The Job resource allows you to view and delete the requests for exports of arbitrary date ranges, submitted through the ExportCustom Job.
resource_type
type: stringThe type of communication – Messages, Calls, Conferences, and Participants
details
type: objectThe 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.
job_sid
type: SID<JS>The job_sid returned when the export was created
^JS[0-9a-fA-F]{32}$
34
34
job_queue_position
type: stringThis 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
estimated_completion_time
type: stringthis 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}
JobSid
type: SID<JS>The unique string that that we created to identify the Bulk Export job
^JS[0-9a-fA-F]{32}$
34
34
DELETE https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}
JobSid
type: SID<JS>The unique string that that we created to identify the Bulk Export job
^JS[0-9a-fA-F]{32}$
34
34