Create export custom job

POST /v1/Exports/{ResourceType}/Jobs

TODO: Resource-level docs

Path parameters

  • ResourceType string Required

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

Body

  • Email string

    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.

  • EndDay string Required

    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.

  • FriendlyName string Required

    The friendly name specified when creating the job

  • StartDay string Required

    The start day for the custom export specified as a string in the format of yyyy-mm-dd

  • WebhookMethod string

    This is the method used to call the webhook on completion of the job. If this is supplied, WebhookUrl must also be supplied.

  • WebhookUrl string

    The optional webhook url called on completion of the job. If this is supplied, WebhookMethod must also be supplied. If you set neither webhook nor email, you will have to check your job's status manually.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • details

      The details of a job state which is an object that contains a status string, a day count integer, and list of days in the job

    • email string | null

      The optional email to send the completion notification to

    • end_day string | null

      The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday.

    • estimated_completion_time string | null

      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

    • friendly_name string | null

      The friendly name specified when creating the job

    • job_queue_position string | null

      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

    • job_sid string | null

      The unique job_sid returned when the custom export was created. This can be used to look up the status of the job.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^JS[0-9a-fA-F]{32}$.

    • resource_type string | null

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

    • start_day string | null

      The start day for the custom export specified as a string in the format of yyyy-MM-dd

    • webhook_method string | null

      This is the method used to call the webhook

    • webhook_url string | null

      The optional webhook url called on completion
POST /v1/Exports/{ResourceType}/Jobs 
curl \
 -X POST https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Jobs \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Email=string&EndDay=string&FriendlyName=string&StartDay=string&WebhookMethod=string&WebhookUrl=string'
Request example 
{
  "Email": "string",
  "EndDay": "string",
  "FriendlyName": "string",
  "StartDay": "string",
  "WebhookMethod": "string",
  "WebhookUrl": "string"
}
Request examples 
{
  "Email": "string",
  "EndDay": "string",
  "FriendlyName": "string",
  "StartDay": "string",
  "WebhookMethod": "string",
  "WebhookUrl": "string"
}
Response examples (201) 
{
  "email": "string",
  "end_day": "string",
  "estimated_completion_time": "string",
  "friendly_name": "string",
  "job_queue_position": "string",
  "job_sid": "string",
  "resource_type": "string",
  "start_day": "string",
  "webhook_method": "string",
  "webhook_url": "string"
}
Response examples (201) 
{
  "email": "string",
  "end_day": "string",
  "estimated_completion_time": "string",
  "friendly_name": "string",
  "job_queue_position": "string",
  "job_sid": "string",
  "resource_type": "string",
  "start_day": "string",
  "webhook_method": "string",
  "webhook_url": "string"
}