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
|
The friendly name specified when creating the job |
resource_type
|
The type of communication – Messages, Calls, Conferences, and Participants |
start_day
|
The start day for the custom export specified when creating the job |
end_day
|
The end day for the export specified when creating the job |
webhook_url
|
The optional webhook url called on completion of the job. If this is supplied, |
webhook_method
|
This is the method used to call the webhook on completion of the job. If this is supplied, |
email
|
The optional email to send the completion notification to |
job_sid
|
The unique job_sid returned when the custom export was created |
details
|
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. |
Create an ExportCustomJob resource
https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Jobs
パラメーター
Parameters in REST API format | |
---|---|
resource_type
Path
|
The type of communication – Messages or Calls, Conferences, and Participants |
start_day
必須
|
The start day for the custom export specified as a string in the format of yyyy-mm-dd |
end_day
必須
|
The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day. |
friendly_name
必須
|
The friendly name specified when creating the job |
webhook_url
オプション
|
The optional webhook url called on completion of the job. If this is supplied, |
webhook_method
オプション
|
This is the method used to call the webhook on completion of the job. If this is supplied, |
email
オプション
|
The optional email to send the completion notification to. You can set both webhook, and email, or one or the other. If you set neither, the job will run but you will have to query to determine your job's status. |
例 1
Read multiple ExportCustomJob resources
https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Jobs
パラメーター
Parameters in REST API format | |
---|---|
resource_type
Path
|
The type of communication – Messages, Calls, Conferences, and Participants |
例 1
ヘルプが必要ですか?
誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。