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
| Resource Properties in REST API format | |
|---|---|
resource_type
|
The type of communication – Messages, Calls, Conferences, and Participants |
friendly_name
|
The friendly name specified when creating the job |
details
|
The details of a job which is an object that contains an array of status grouped by |
start_day
|
The start time for the export specified when creating the job |
end_day
|
The end time for the export specified when creating the job |
job_sid
|
The job_sid returned when the export was created |
webhook_url
|
The optional webhook url called on completion |
webhook_method
|
This is the method used to call the webhook |
email
|
The optional email to send the completion notification to |
url
|
|
job_queue_position
|
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 |
estimated_completion_time
|
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 in REST API format | |
|---|---|
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. |
DeletedByUserRequest
|
The Job has been marked for deletion. So system will not attempt to run it. |
Fetch a Job resource
https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}
Parameters
| Parameters in REST API format | |
|---|---|
job_sid
Path
|
The unique string that that we created to identify the Bulk Export job |
Example 1
Delete a Job resource
https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}
Parameters
| Parameters in REST API format | |
|---|---|
job_sid
Path
|
The unique string that that we created to identify the Bulk Export job |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
