Menu

Expand
Rate 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

Resource Properties in REST API format
resource_type
string Not PII

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

friendly_name
string Not PII

The friendly name specified when creating the job

details
object 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.

start_day
string Not PII

The start time for the export specified when creating the job

end_day
string Not PII

The end time for the export specified when creating the job

job_sid
sid<JS> Not PII

The job_sid returned when the export was created

webhook_url
string Not PII

The optional webhook url called on completion

webhook_method
string Not PII

This is the method used to call the webhook

email
string Not PII

The optional email to send the completion notification to

url
url Not PII

job_queue_position
string 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

estimated_completion_time
string 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

Fetch a Job resource

get
https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}
Parameters
Parameters in REST API format
job_sid
Path
get sid<JS> Not PII

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

        delete
        https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}
        Parameters
        Parameters in REST API format
        job_sid
        Path
        delete sid<JS> Not PII

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

        Example 1
              
              
              
              
              Rate this page:

              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.

                    
                    
                    

                    Thank you for your feedback!

                    We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    Refer us and get $10 in 3 simple steps!

                    Step 1

                    Get link

                    Get a free personal referral link here

                    Step 2

                    Give $10

                    Your user signs up and upgrade using link

                    Step 3

                    Get $10

                    1,250 free SMSes
                    OR 1,000 free voice mins
                    OR 12,000 chats
                    OR more