创建任务

收藏
我的收藏
该接口用于创建拍抖音互动任务​

使用限制​

    无​

接口说明​

注意事项​

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

基本信息​

HTTP URL​
HTTP Method​
Post​
Scope​
apps.douyin.interact_task​
权限要求​
    需要申请能力。开发者需要至控制台-小程序页面下,进入“能力-能力实验室-小程序能力-拍抖音任务”。​

请求头​

名称​
类型​
是否必填​
描述​
access-token​
string​
是​
接口调用凭证,client_token
Content-Type​
string​
是​
固定值:application/json​

请求参数​

名称​
类型​
是否必填​
描述​
示例​
app_id​
string​
是​
小程序id​
task_type​
int32​
是​
任务类型 ​
3:拍抖音互动任务​
3​
max_count​
int64​
是​
单用户可重复参与该任务的次数,发布一个视频视作参与一次,参与上限20次。​
10​
start_time​
int64​
是​
开始时间戳,秒级​
1690875969​
end_time​
int64​
是​
结束时间戳,秒级,任务持续时间最长一年​
1692517569​
mount_link​
string​
是​
挂载链接​
publish_type​
list<int>​
是​
要求发布类型,1:视频,2:图文,为空表明不做要求​
[1]​
tags​
list<string>​
是​
话题标签,用户发布时需要带上的标签内容,可以设置多个,最多支持10个,每个长度上限20​
interact_rules​
map<string,InteractRule>​
是​
互动任务目标配置,key代表互动数据类型,key代表目标值。key的取值如下:​
"like": 点赞数​
"share": 分享数​
"download": 下载数​
"play": 播放数​
"comment":评论数​
{​
"like": {​
"target_count": 5​
},​
"share": {​
"stage_count": 6,​
"target_count": 20​
}​
}​
    InteractRule信息​
字段​
类型​
是否必填​
说明​
示例​
target_count​
int​
是​
目标值,上限为500​
200​
stage_count​
int​
否​
单个阶段的数值,下限为5,上限为100​
20​

请求示例​

curl --location 'https://open.douyin.com/api/apps/v1/douyin/create_interact_task/' \ --header 'access-token: clt.*******' \ --header 'Content-Type: application/json' \ --data '{ "task_type": 3, "app_id": "ttabc*******", "start_time": 1690938443, "end_time": 1702365299, "max_count": 10, "mount_link": "path", "interact_rules": { "like": { "stage_count": 6, "target_count": 1 } } }'

响应参数​

名称​
类型​
是否必填​
描述​
示例​
err_no​
int64​
是​
错误码​
0​
err_msg​
string​
是​
错误信息​
""​
log_id​
string​
是​
用于问题快速定位​
20230803111429010225127084533203​
data​
object​
是​
任务信息​
task_id​
string​
是​
任务id​
task_7263******7724​

响应示例​

    正常示例​
{ "data": { "task_id": "task_7263******7724" }, "err_no": 0, "err_msg": "", "log_id": "2023080317282901022512708409145B" }
    异常示例​
{ "err_no": 28001008, "err_msg": "access_token过期,请刷新或重新授权", "log_id": "20230803111429010225127084533203" }

错误码​

HTTP 状态码
错误码
描述
排查建议
200​
28005002​
内部错误​
内部错误​
200​
28005001​
参数解析失败​
参数解析失败​
200​
28001003​
accesstoken无效​
accesstoken无效​
200​
28005078​
到期时间不在范围内​
到期时间不在范围内​
200​
28005073​
任务类型错误​
任务类型错误​
200​
28001018​
应用未获得该能力​
前往控制台开通能力​
200​
28005081​
max count 参数不合法​
max_count 需要控制在1-20的范围内​
200​
28005083​
mount link 参数不合法​
mount link 需要不为空,长度控制在200以内​
200​
28005084​
tags 参数不合法​
tags 个数不得超过10个,单tag字节长度不得超过20​
200​
28005085​
publish type 参数不合法​
需要传递在规定枚举类型内的​
200​
28005098​
interact rule 参数为空​
interact_rule 参数为空​
200​
28005098​
interact rule key 参数不合法​
interact_rule 的key需要在规定枚举类型内​
200​
28005098​
interact rule target count 参数不合法​
interact_rule 的target_count需要控制在1-500的范围内​
200​
28005098​
interact rule stage count 参数不合法​
interact_rule 的stage_count需要控制在10-100的范围内​