CAcallr
Tasks

Get task

Return the status of a task. Tasks are kept 48 hours.

get/tasks/{taskid}

Request

  • Base URL
    https://api.callr.com/v2.0
  • URL
    https://api.callr.com/v2.0/tasks/{taskid}
  • Auth
    • API key in header x-api-key
    • or HTTP basic

Path parameters

taskidstring required

Task ID

Example:sampleTaskID1234567890abcdef0000

Response

Task

idstring required

Task ID

status'pending' | 'running' | 'canceled' | 'done' required
percentnumber required

Progress of the task, from 0 to 100

endedstring date-time

RFC 3339, section 5.6

resultunknown
errorstring

The error, when the task failed

Example response

{
  "id": "sampleTaskID1234567890abcdef0000",
  "status": "pending",
  "percent": 42,
  "ended": "2024-04-24T17:42:28Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.