抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • OpenAPI 简介
  • 通用参数
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 视频能力
  • 线索组件
  • 接口调用凭证
  • 登录
  • Web 化接入
  • 隐私协议
  • 流量主
  • 小程序码与小程序链接
  • 用户信息
  • 抖音号绑定
  • 小程序推广计划
  • 内容安全
  • 内容安全检测
  • 图片检测V2
  • 图片检测V3
  • 获取加密密钥
  • 任务能力
  • 分享
  • 反馈
  • 客服
  • 小程序券
  • 触达与营销
  • 支付
  • 运营
  • 生活服务
  • 垂直行业
  • 其它
  • 获取加密密钥

    收藏
    我的收藏

    接口说明

    该接口用于获取用户encrypt_key。 会获取用户最近3次的key,每个key的存活时间为3600s。

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/api/apps/v1/get_user_encrypt_key/
    HTTP Method
    POST
    Scope
    ma.openapi.user_encrypt_key
    权限要求

    请求参数

    请求头
    access-token必填String
    示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
    content-type必填String
    示例:application/json
    固定值"application/json"
    Body
    app_id必填String
    示例:tt5da*********7910
    小程序id
    open_id必填String
    示例:BLV**********oo

    用户openid

    sig_method必填String
    示例:sha1

    加密算法,只支持sha1

    signature必填String
    示例:5b94*******6235

    签名,用sha1算法对session_key加密得到的结果,session_key可通过code2Session接口获得

    请求示例
    curl --location --request POST '/api/apps/v1/get_user_encrypt_key' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"open_id":"BLV**********oo","signature":"5b94*******6235","sig_method":"sha1","app_id":"tt5da*********7910"}'

    响应参数

    Body展开全部子属性
    dataList
    展开子属性
    err_msgString

    错误信息

    err_noInt32
    示例:0

    错误码

    log_idString
    示例:202308031728290102251270840914XX
    响应示例
    正常响应示例异常响应示例
    { "log_id": "hxkfoJZxTp", "data": [ { "encrypt_key": "DpblXkpQM5", "version": 6798019902413553000, "expire_at": 6819603927973191000, "iv": "Lo1uhVVJbV", "create_time": 2414506891960108500 } ], "err_no": 4150812239899514400, "err_msg": "O4T9F83v4I" }
    切换单列布局

    错误码

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