Get a Task

Retrieve the details and execution status of an asynchronous task for importing, clearing, and exporting contacts, as well as Bloom filter rebuild tasks (scheduled automatically by the system each day).

Request URL

GET {base_url}/uc-ccontact/api/v1/tasks/{id}

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The task ID.
Note: You can obtain the ID using the Query Task List interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Task> The details of the task.
Task
Parameter Type Description
taskId String The ID of the task.
taskType String

The type of the task.

  • TASK_TYPE_COMPANY_CONTACTS_IMPORT: Company contact import.
  • TASK_TYPE_PERSONAL_CONTACTS_IMPORT: Personal contact import.
  • TASK_TYPE_CLEAR_COMPANY_CONTACTS: Company contact clear.
  • TASK_TYPE_CLEAR_PERSONAL_CONTACTS: Personal contact clear.
  • TASK_TYPE_COMPANY_CONTACTS_EXPORT: Company contact export.
  • TASK_TYPE_PERSONAL_CONTACTS_EXPORT: Personal contact export.
  • TASK_TYPE_BLOOM_REBUILD: Bloom filter rebuild (internal scheduled task).
updatedAt String The time when the task was last updated, in Unix timestamp format (milliseconds).
content String The task content in JSON format.
status String

The status of the task.

  • PENDING
  • PARSING
  • PARSE_FAILED
  • PROCESSING
  • SUCCESS
  • FAILED
message String The result message of the task.

Example

Request example

GET /uc-ccontact/api/v1/tasks/366860302581911552 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTc5ODcyMSwiaWF0IjoxNzkxNzc3MTIxLCJqdGkiOiI3YjRmNDQ3MC1jZmI0LTQ3NTAtYTg4Zi01ZjIxNjY5ZDI3NzUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.Vb9Xw8-vvI689EzR9bl9jrH3BWBDrYPl9c10AzyTv-LjTxxbNdYiz-9k_FBhe3HSqSeLdDXb0py1fzUhJ-e2wIn9Sq2ZeOz4IQAJQwjmyG9-Kk0jy43iyLkcBO7LQxfVQksnKs7hB0cG9FIhoil-FiQL_mUwNHCVN-BnfoN4Dyiyp7BE8nHiehlng4SUQ5zxgQf_JlqALzcP6bNlvp4k1AfjoY2KKQ7H7g9nGSZZZ2fv_j65-j_XJKpLR4ujC7iDH6MezGg8RgOKwHE2HSgtxfiIrHF8wQVhrlKFgCGu1dvszp5mvXPXLy3WnMjuCCidLYI2NvRhfVHd1VzB13XteA
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "e795e0d5796d7cae96fa7189a20ed44e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "taskId": "366860302581911552",
    "taskType": "TASK_TYPE_CLEAR_COMPANY_CONTACTS",
    "updatedAt": "1791533512083",
    "content": "{\"task_created_at\":1791533512070,\"start_time\":0,\"end_time\":1791533512070,\"query\":\"zz\",\"exclude_ids\":null}",
    "status": "SUCCESS",
    "message": "success"
  }
}