Get task status

GET 
/wiki/convert/tasks/:taskID/info

History

Version	Changes
v6.15.0	Added in v6.15.0

Get the task status.

Request

Path Parameters

taskID stringrequired

Task ID

Query Parameters

teamID stringrequired

The team ID

requestUserID string

User ID, this parameter can only be passed when calling as an Oauth bot. It is used to perform operations as the specified user

Responses

200

Get successfully

application/json

Schema

Schema

status string

Possible values: [Pending, Processing, Success, Failed]

Task status

message stringnullable

Task text information

file

object

nullable

Task result file

name string

File name

size int64

File size

expireAt int64

File expiration time

data objectnullable

Task extra information

Example (from schema)

{
  "status": "Pending",
  "message": "string",
  "file": {
    "name": "string",
    "size": 0,
    "expireAt": 0
  },
  "data": {}
}

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...