Menu

Expand
Rate this page:

Thanks for rating this page!

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

Export Custom Job Resource

Custom Jobs allow you to create exports for any date range. If the date range spans multiple days, they will generate separate output days. Jobs can be deleted with the Job Resource. When a Job successfully completes, the results are visible as days in the Day Resource.

ExportCustomJob properties

Resource Properties in REST API format
friendly_name
string Not PII

The friendly name specified when creating the job

resource_type
string Not PII

The type of communication – Messages, Calls

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

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

job_sid
sid<JS> Not PII

The job_sid returned when the export was created

details
object Not PII

Create an ExportCustomJob resource

post
https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Jobs
Parameters
Parameters in REST API format
resource_type
Path
post string Not PII

The type of communication – Messages, Calls

friendly_name
Optional
post string Not PII

start_day
Optional
post string Not PII

end_day
Optional
post string Not PII

webhook_url
Optional
post string Not PII

webhook_method
Optional
post string Not PII

email
Optional
post string Not PII

Example 1
        
        
        
        

        Read multiple ExportCustomJob resources

        get
        https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Jobs
        Parameters
        Parameters in REST API format
        resource_type
        Path
        get string Not PII

        The type of communication – Messages, Calls

        next_token
        Optional
        get string Not PII

        The token for the next page of job results, and may be null if there are no more pages

        previous_token
        Optional
        get string Not PII

        The token for the previous page of results, and may be null if this is the first page

        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.