List export custom job

GET /v1/Exports/{ResourceType}/Jobs

Path parameters

  • ResourceType string Required

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

Query parameters

  • PageSize integer(int64)

    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.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • jobs array[object]
      Hide jobs attributes Show jobs attributes object
      • friendly_name string | null

        The friendly name specified when creating the job

      • 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 when creating the job

      • end_day string | null

        The end day for the export specified when creating the job

      • webhook_url string | null

        The optional webhook url called on completion of the job. If this is supplied, WebhookMethod must also be supplied.

      • webhook_method string | null

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

      • email string | null

        The optional email to send the completion notification to

      • job_sid string | null

        The unique job_sid returned when the custom export was created

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

      • details array | null

        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.

      • 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

      • 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

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Exports/{ResourceType}/Jobs
curl \
 --request GET 'https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Jobs' \
 --user "username:password"
Response examples (200)
{
  "jobs": [],
  "meta": {
    "key": "jobs",
    "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0",
    "previous_page_url": null
  }
}
{
  "jobs": [
    {
      "email": "email",
      "details": [
        {}
      ],
      "end_day": "end_day",
      "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "start_day": "start_day",
      "webhook_url": "webhook_url",
      "friendly_name": "friendly_name",
      "resource_type": "resource_type",
      "webhook_method": "webhook_method",
      "job_queue_position": "1",
      "estimated_completion_time": "2021-03-15T20:20:14.547"
    }
  ],
  "meta": {
    "key": "jobs",
    "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://bulkexports.twilio.com/v1/Exports/Messages/Jobs?PageSize=50&Page=0",
    "previous_page_url": null
  }
}