创建任务

收藏
我的收藏

接口说明

该接口用于创建分享任务​

创建任务后,需要将task_id通过ShareParam传递给发布器,用户完成分享后会在success回调内返回当前用户的对应任务完成信息。

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/apps/v1/share/create_task/
HTTP Method
POST
Scope
ma.share.task
权限要求
  • 需要申请能力。开发者需要至控制台-小程序页面下,进入“能力-能力实验室-小程序能力-分享任务

请求参数

请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body
end_time必填Int64
示例:1692517569

结束时间戳,秒级,任务持续时间最长一年

start_time必填Int64
示例:1690875969

开始时间戳,秒级

target_count必填Int64
示例:3

目标分享次数,分享给非重复用户算作成功分享

task_type必填Int32
示例:1

任务类型

1:分享任务

请求示例
curl --location 'http://open.douyin.com.boe-gateway.byted.org/api/apps/v1/share/create_task/' \ --header 'access-token: clt.******' \ --header 'Content-Type: application/json' \ --data '{ "task_type":1, "target_count":10, "start_time":1691377225, "end_time":1693357643 }'

响应参数

Body展开全部子属性
data必填Struct

任务信息

展开子属性
err_msg必填String

错误信息

err_no必填Int32

错误码

log_id必填String

字节内部log_id,用于问题快速定位

响应示例
正常响应示例异常响应示例
{ "data": { "task_id": "task_7263******7724" }, "err_no": 0, "err_msg": "", "log_id": "2023080317282901022512708409145B" }

错误码

HTTP 状态码错误码错误码描述排查建议
20028005002

内部错误

内部错误

20028005001

参数解析失败

参数解析失败

20028001003

access-token错误

access-token错误

20028005022

到期时间不在范围内

到期时间不在范围内

20028005073

任务类型错误

任务类型错误

20028005071

任务参数错误

任务参数错误

20028001018

应用未获得该能力

前控制台开通能力