Skip to content

Task Query

Fresh

Query Task

URL: https://openapi.geelark.com/open/v1/task/queryMethod: POST

ParameterRequiredTypeDescription
idsYesarray[string]Task IDs (max 100)

Response Fields

FieldTypeDescription
idstringTask ID
planNamestringTask plan name
taskTypeintegerTask type code
serialNamestringCloud phone name
envIdstringCloud phone ID
scheduleAtintegerScheduled time
statusinteger1=Waiting, 2=In progress, 3=Completed, 4=Failed, 7=Cancelled
failCodeintegerFailure code
failDescstringFailure description
costintegerDuration in seconds
shareLinkstringShare link (if requested)

Response Example

json
{
  "traceId": "123456ABCDEF",
  "code": 0,
  "msg": "success",
  "data": {
    "total": 1,
    "items": [
      {
        "id": "123456ABCDEF",
        "planName": "testAdd",
        "taskType": 1,
        "serialName": "myPhone",
        "envId": "123456654321",
        "scheduleAt": 1718744459,
        "status": 3,
        "cost": 120,
        "shareLink": "https://www.tiktok.com/@user/video/123"
      }
    ]
  }
}

Batch Query Tasks

URL: https://openapi.geelark.com/open/v1/task/batchQueryMethod: POST

ParameterRequiredTypeDescription
pageYesintegerPage number
pageSizeYesintegerPage size (max 100)
planNameNostringFilter by plan name
envIdNostringFilter by cloud phone ID
statusNointegerFilter by status
taskIdsNoarray[string]Filter by task IDs

Cancel Task

URL: https://openapi.geelark.com/open/v1/task/cancelMethod: POST

ParameterRequiredTypeDescription
idsYesarray[string]Task IDs to cancel

INFO

Running tasks can be cancelled. Completed or failed tasks cannot be cancelled.


Retry Task

URL: https://openapi.geelark.com/open/v1/task/retryMethod: POST

ParameterRequiredTypeDescription
idsYesarray[string]Task IDs to retry

Task Detail

URL: https://openapi.geelark.com/open/v1/task/detailMethod: POST

ParameterRequiredTypeDescription
idYesstringTask ID

Returns detailed task information including failure codes and reasons.

GEELark API Documentation - Built with VitePress