Fetch job

GET /v1/Exports/Jobs/{JobSid}

TODO: Resource-level docs

Path parameters

  • JobSid string Required

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

Responses

  • • 200

    OK

    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 time for the export specified when creating the job

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

    • resource_type string | null

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

    • start_day string | null

      The start time for the export specified when creating the job

    • url string(uri) | null
    • webhook_method string | null

      This is the method used to call the webhook

    • webhook_url string | null

      The optional webhook url called on completion
GET /v1/Exports/Jobs/{JobSid} 
curl \
 -X GET https://bulkexports.twilio.com/v1/Exports/Jobs/{JobSid} \
 --user "username:password"
Response examples (200) 
{
  "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",
  "url": "https://example.com",
  "webhook_method": "string",
  "webhook_url": "string"
}