声控__抖音开放平台

接口说明

Scope: data.external.billboard_cospa

需要申请权限。路径：抖音开放平台控制台 > 应用详情 > 能力管理 > 数据权限

不需要用户授权该接口用于获取声控榜数据。该接口适用于抖音。

注意：

抖音的 OAuth API 以https://open.douyin.com/开头。
该统计数据为离线数据；数据产出周期：每天 10 点前。

基本信息

名称	描述
HTTP URL	https://open.douyin.com/data/extern/billboard/cospa/voice_control/
HTTP Method	GET
Scope	data.external.billboard_cospa

请求头

名称	字段类型	是否必填	示例	描述
access-token	String	是	clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ	调用https://open.douyin.com/oauth/client_token/生成的token
content-type	String	是	application/json	固定值"application/json"

请求参数

请求示例

curl --location --request GET '/data/extern/billboard/cospa/voice_control/' \
--header 'access-token: 0801121846735352506a356a6' \
--header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ' \

响应参数

Body

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

响应示例

正常响应示例

{
  "data": {
    "description": "",
    "list": [
      {
        "follower_count": 200,
        "onbillbaord_times": 200,
        "effect_value": 10000,
        "video_list": [
          {
            "share_url": "https://www.iesdouyin.com/share/video/QDlWd0EzdWVMU2Q0aU5tKzVaOElvVU03ODBtRHFQUCtLUHBSMHFRT21MVkFYYi9UMDYwemRSbVlxaWczNTd6RUJRc3MrM2hvRGlqK2EwNnhBc1lGUkpRPT0=/?region=CN&mid=6753173704399670023&u_code=12h9je425&titleType=title",
            "title": "测试视频 #测试话题 @抖音小助手",
            "item_cover": "https://example.com/x.jpeg"
          }
        ],
        "rank": 1,
        "rank_change": "1",
        "nickname": "昵称",
        "avatar": "https://example.com/x.jpeg"
      }
    ],
    "error_code": 0
  },
  "extra": {
    "sub_error_code": 0,
    "sub_description": "",
    "logid": "202008121419360101980821035705926A",
    "now": 1597213176393,
    "error_code": 0,
    "description": ""
  }
}

异常响应示例

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

错误码

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

声控在线调试

接口说明

基本信息

请求头

请求参数

请求示例

响应参数

Body

响应示例

正常响应示例

异常响应示例

错误码

声控