Fetch job

GET /v1/Exports/Jobs/{JobSid}

Path parameters

  • JobSid string Required

    The unique string that that we created to identify the Bulk Export job

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

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
    • resource_type string | null

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

    • friendly_name string | null

      The friendly name specified when creating the job

    • 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.

    • start_day string | null

      The start time for the export specified when creating the job

    • end_day string | null

      The end time for the export specified when creating the job

    • job_sid string | null

      The job_sid returned when the export was created

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

    • webhook_url string | null

      The optional webhook url called on completion

    • webhook_method string | null

      This is the method used to call the webhook

    • email string | null

      The optional email to send the completion notification to

    • url string(uri) | null
    • 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

GET /v1/Exports/Jobs/{JobSid}
curl \
 --request GET 'https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid}' \
 --user "username:password"
Response examples (200)
{
  "url": "https://bulkexports.twilio.com/v1/Exports/Jobs/JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "email": "email",
  "details": [
    {}
  ],
  "end_day": "end_day",
  "job_sid": "JSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "start_day": "start_day",
  "webhook_url": "https://webhookexample.com",
  "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"
}