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
|
This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status |
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
|
|
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 |
There are 4 possible status values for a Job. You may get different status values for each day, across the range of days you requested in the job. For instance, if you have requested 100 days, and request the status, 10 may be submitted, 20 in running, 30 in completed, and 40 in completedemptyrecords.
- Submitted
- The Job has been successfully submitted and is in the queue to execute. Typically, executions should take less than one day.
- Running
- The job is currently running. The output should be available shortly. Multiple Jobs may run at the same time.
- Completed
- The Job is completed, and the result files are available at the Days endpoint.
- 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.
- Failed
- The Job was attempted, but an error prevented completion. This is a final status, and the job has already been tried multiple times before this status.
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 browsing the Twilio tag on Stack Overflow.