抖音开放平台Logo
控制台

查询视频发布结果

更新时间 2024-07-24 02:58:49
收藏
我的收藏

状态码排查​

接口说明

Scope: aweme.forward 不需要用户授权 该接口用获取 share_id;该接口适用于抖音。

share_id 可以用于:

  • 追踪分享的视频是否成功。
  • 获取分享视频的数据,如点赞数, 评论数等。

生成 share_id 时 need_callback 字段要传 true 才会有回调。share_id 有效期为一个小时。

接入步骤:

  1. 申请发布视频的能力。详情请参见抖音分享与发布
  2. 分享前获取标识单次分享的 share_id
  3. 调用分享 SDK 时传入 share_id
  4. 基于Webhooks 接收分享成功的回调信息

回调body信息参数

{
  "event": "create_video",
  "from_user_id": "", // 投稿用户的open_id
  "client_key": "", // 发起投稿的client_key
  "log_id": "", // 请求唯一标识,可用于oncall快速定位问题
  "content": {
    "share_id": "",
    "item_id": "", //加密视频ID
    "video_id": "", //真实视频ID
    "has_default_hashtag": true // true / false,标识用户最终的投稿是否携带了开发者设置的默认话题
  }
}

item_id 可用于查询视频数据

基本信息

名称描述
HTTP URL
https://open.douyin.com/share-id/
HTTP Method
GET
Scope
aweme.forward

请求头

名称字段类型是否必填示例描述
access-tokenStringclt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeStringapplication/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
default_hashtagString
追踪分享默认hashtag
link_paramString
分享来源url附加参数(暂未开放)
need_callbackBool
如果需要知道视频分享成功的结果,need_callback设置为true
source_style_idString

多来源样式id(暂未开放)

请求示例

curl --location --request GET 'https://open.douyin.com/share-id/?need_callback=&source_style_id=&default_hashtag=&link_param=' \
--header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ' \ 

响应参数

Body

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

响应示例

正常响应示例

{
  "extra": {
    "description": "",
    "sub_error_code": 0,
    "sub_description": "",
    "logid": "202008121419360101980821035705926A",
    "now": 1597213176393,
    "error_code": 0
  },
  "data": {
    "share_id": "15674132978",
    "error_code": 0,
    "description": ""
  }
}

异常响应示例

{
  "data": {
    "error_code": 2100005,
    "description": "Parameter error"
  },
  "extra": {
    "error_code": 2100005,
    "description": "Parameter error",
    "sub_error_code": 0,
    "sub_description": "",
    "now": 1594015876138,
    "log_id": "2020070614111601022506808001045D59"
  }
}

错误码

http状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001016
当前应用已被封禁或下线
clientKey被封禁或者下线
20028001006
网络调用错误,请重试
重试即可
20028001014
应用未授权任何能力
确认应用是否授权能力
20028001018
应用未获得该能力
开通相关能力
20028003017
quota已用完
联系平台处理
20028001019
应用该能力已被封禁
该能力被封禁,联系平台处理
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常