抖音开放平台Logo
控制台

更新任务状态-v2

收藏
我的收藏

接口说明

该接口用于小程序任务台任务状态编辑，当前仅支持下线任务。

使用限制

无。

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/match/v2/taskbox/update_status/
HTTP Method
POST
Scope
match_taskbox.default.plan_permission
权限要求
服务商代调用场景下，需商家授予小程序推广计划-任务管理权限。

请求头

名称字段类型是否必填示例描述
access-tokenString是
当非服务商时，调用https://open.douyin.com/oauth/client_token/生成的token
当服务商时，调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
task_idInt64是

任务ID，创建接口返回

该字段通过 /api/match/v2/taskbox/add_task/ 接口返回的 data.task_id 字段获取

task_statusInt64是4

任务状态，当前仅支持传4

请求示例

curl --location --request POST 'https://open.douyin.com/api/match/v2/taskbox/update_status/' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data '
  {
  "task_id": 12333,
  "task_status": 2
}
'

响应参数

Body

名称字段类型是否必填示例描述
err_msgString是success

错误信息

err_noInt32是0

错误码，0 是成功，其它为异常

log_idString是202008121419360101980821035705926A

标识请求的唯一id，在接口异常时用于问题排查

响应示例

正常响应示例

{
  "err_no": 0,
  "err_msg": "success",
  "log_id": "202008121419360101980821035705926A",
  "data": {
    "task_id": 7209926988888146000
  }
}

异常响应示例

{
  "err_msg": "ErrNo_CPSSettlement",
  "err_no": 5401,
  "log_id": "202008121419360101980821035705926A",
  "data": {}
}

错误码

http状态码错误码错误码描述排查建议
2000
请求操作成功
2005443
下线任务状态非审核中or已上线
2005444
该任务当前状态为已下线，请求失败
2005445
该任务当前状态为已驳回，请求失败
2005506
任务状态变更，仅支持传4
2005515
调用者无权限
请服务商前往「服务商平台-能力-代商家管理能力-小程序推广计划」完成协议签署
2005516
调用者无权限
请服务商前往「服务商平台-设置-权限设置」申请该小程序的「小程序推广计划-任务管理」权限
2005517
该小程序暂未完成撮合平台协议的签署
请开发者前往「开发者平台-运营-小程序推广计划」完成协议签署
20028001018
应用未获得该能力
请服务商前往「服务商平台-设置-权限设置」申请该小程序的「小程序推广计划-任务管理」权限