Help Center/ KooPhone/ API Reference/ APIs/ Instance Management/ Batch Task Query

Updated on 2024-07-22 GMT+08:00

View PDF

Batch Task Query

Function

This API is used to query tasks of an instance in batches. Before calling this API, ensure that the tenant has purchased a KooPhone cloud phone instance. This API must be used together with the API for executing an asynchronization command for an instance. The task_id returned by the API for executing an asynchronization command for an instance is used as the parameter in the path to obtain the asynchronous command execution result.

URI

GET /v1/instances/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Task ID returned for an asynchronization request.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
x-request-id	Yes	String	Unique ID of a request.
X-Auth-Token	Yes	String	Tenant-level token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Response code. The error code specification is KooPhone.API.1001, and the number increases in ascending order.
error_msg	String	Response description.
data	JobDetailWrapper object	List of tasks queried based on task_id.

**Table 4** JobDetailWrapper
Parameter	Type	Description
jobs	Array of JobDetail objects	List of tasks queried based on task_id.

**Table 5** JobDetail
Parameter	Type	Description
job_id	String	Unique ID of a task.
status	Integer	Task status. 1: Running. 2: Successful. -1: Failed.
error_code	String	Task error code.
error_msg	String	Task error code description.
execute_msg	String	Content returned after a task is executed. The value can contain up to 1,024 bytes. The command output is returned regardless of whether the command is successfully executed. Maximum: 1024

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Response code. The error code specification is KOOPHONE.API.0001, and the number increases in ascending order. If error_code is 0, the operation is successful.
error_msg	String	Response description.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Response code. The error code specification is KOOPHONE.API.0001, and the number increases in ascending order. If error_code is 0, the operation is successful.
error_msg	String	Response description.

Example Requests

/v1/instances/tasks/6837531fd3f54550927b930180a706bf

Example Responses

Status code: 200

{
  "data" : {
    "jobs" : [ {
      "job_id" : "1564567b8bab40f34711234cb80d0123",
      "status" : -1,
      "error_code" : "CPS0005",
      "error_msg" : "Phone not found.",
      "execute_msg" : null
    }, {
      "job_id" : "1564567b8bab40f34711234cb80d0456",
      "status" : 2,
      "error_code" : "",
      "error_msg" : "",
      "execute_msg" : "xxxxxx"
    } ]
  },
  "error_code" : "0",
  "error_msg" : "ok"
}