List export custom job

GET /v1/Exports/{ResourceType}/Jobs

TODO: Resource-level docs

Path parameters

  • ResourceType string Required

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

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • jobs array[object]
      Hide jobs attributes Show jobs attributes
      • 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

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Exports/{ResourceType}/Jobs 
curl \
 -X GET https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Jobs \
 --user "username:password"
Response examples (200) 
{
  "jobs": [
    {
      "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"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}