抖音开放平台Logo
控制台

查询用户任务进度

收藏
我的收藏
​该接口用户查询某个用户的拍抖音互动任务进度​

​使用限制​

​无​

​接口说明​

    •​如果任务无效、视频失败、视频非公开，互动数据将不再更新，返回最后一次有效查询的数据。​

​基本信息​

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

​请求头​

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

​请求参数​

名称​
类型​
是否必填​
描述​
示例​
open_id​
string​
是​
开启任务的用户openid​
​
task_id​
list<string>​
是​
任务id​
task_*****​

​请求示例​

​​
JSON
复制
curl --location 'https://open.douyin.com/api/apps/v1/douyin/query_user_interact_task/' \
--header 'access-token: clt.******' \
--header 'Content-Type: application/json' \
--data '{"task_id":["task_7302***07"],
"open_id":"yH******7w",
"app_id":"ttabc*****"
}'

​响应参数​

名称​
类型​
是否必填​
描述​
示例​
err_no​
int64​
是​
错误码​
​
err_msg​
string​
是​
错误信息​
​
log_id​
string​
是​
用于快速定位问题，可在社区反馈时提供​
​
data​
TaskInfoMap​
是​
任务信息​
​
    •​ TaskInfoMap​
名称 ​
类型 ​
是否必填 ​
描述 ​
示例​
task_info_list ​
map<string, InteractTaskInfo> ​
是 ​
任务信息映射 ​
​
    •​ InteractTaskInfo​
名称 ​
类型 ​
是否必填 ​
描述 ​
示例​
video_info ​
list<InteractVideoInfo> ​
是 ​
视频信息 ​
​
task_id ​
string ​
是 ​
任务id ​
task_7301****20​
is_valid ​
bool ​
是 ​
任务是否有效 ​
true​
success_count ​
int64​
是 ​
已成功次数​
5​
max_count ​
int64​
是 ​
任务最多参与次数​
20​
err_no​
int64​
是​
错误码​
​
err_msg​
string​
是​
错误信息​
​
    •​ InteractVideoInfo​
名称 ​
类型 ​
是否必填 ​
描述 ​
示例​
video_id ​
string​
是 ​
视频id ​
1310******20e79​
video_status ​
bool ​
是 ​
任务状态：1:成功 2:失败 3:非公开​
1​
completed ​
int ​
是 ​
任务是否完成​
true​
interact_info ​
map<string, InteractInfo> ​
是 ​
互动数据​
​
    •​ InteractInfo​
名称 ​
类型 ​
是否必填 ​
描述 ​
示例​
completed ​
bool ​
是​
互动数据是否达到目标值​
true​
stage ​
int​
否​
代表当前阶段值。互动数值为x，阶段数为stage_count，阶段值的计算方式为：x除以stage_count，并向下取整。​
eg：视频有51个点赞，stage_count为10，stage为5​
2​

​响应示例​

    •​正常示例​
​​
JSON
复制
{
"err_no": 0,
"err_msg": "",
"log_id": "20231116111433010225127084047533",
"data": {
"task_info_list": {
"task_7301597285245279020": {
"task_id": "task_7301597285245279020",
"video_info": [
{
"video_status": 3,
"completed": false,
"video_id": "131****087e",
"interact_info": {
"like": {
"completed": false
},
"play": {
"stage": 0,
"completed": false
}
}
},
{
"interact_info": {
"like": {
"completed": false
},
"play": {
"stage": 0,
"completed": false
}
},
"video_status": 1,
"completed": false,
"video_id": "1310******20e79"
}
],
"is_valid": true,
"success_count": 0,
"max_count": 10，
"err_msg": "",
"err_no": 0
}
}
}
}
    •​异常示例​
JSON
复制
{
"err_no": 28001008,
"err_msg": "access_token过期,请刷新或重新授权",
"log_id": "20230803111429010225127084533203"
}

​错误码​

HTTP 状态码​
错误码​
描述​
排查建议​
200​
28005002​
内部错误​
内部错误​
200​
28005001​
参数解析失败​
参数解析失败​
200​
28001003​
accesstoken错误​
accesstoken错误​
200​
28005009​
openid无效​
openid无效​
200​
28005074​
任务id无效​
任务id无效​
200​
28001018​
应用未获得该能力​
前往控制台开通能力​
200​
28005074​
taskid超出限制长度​
taskid最多传递10个​
​