抖音
  1. 角色系统
抖音
  • 简介
  • 签名算法
  • 接口调用凭证
    • 经营能力调用凭证
      • BusinessToken 生成
      • BusinessToken 刷新
      • 经营能力当前状态查询
    • 非用户授权调用凭证
      • 获取应用授权调用凭证
      • getAccessToken
    • 用户授权调用凭证
      • 获取用户授权调用凭证
      • 刷新用户授权调用凭证
      • 刷新授权调用凭证
  • 登录
    • code2Session
  • 小程序码与小程序链接
    • Schema 链接
      • 生成SchemaV2
      • 查询SchemaV2
      • 查询Schema配额V2
    • Link链接
      • 生成 Link V2
      • 查询 Link 配额V2
      • 查询 Link V2
    • 二维码
      • 生成QRCodeV2
  • 私域经营
    • 私信管理
      • IM主动授权webhook
      • 主动发送私信
    • 群聊管理
      • 粉丝群webhook
        • 用户加群申请 webhook
        • 用户加群webhook
      • 查询群信息
      • 设置进群问候语&群公告
      • 创建粉丝群
      • 取消进群问候语&群公告配置
      • 变更用户入群申请状态
      • 查询用户剩余建群额度
      • 查询群主所在群的用户入群申请状态
    • 经营工具
      • 小程序引导卡片
        • 创建/更新小程序引导卡片模板
        • 查询小程序引导卡片模板
        • 删除小程序引导卡片模板
      • 图片上传
  • 线索组建
    • 创建线索组件
    • 查询已创建的线索组件
    • 更新线索组件
    • 删除线索组件
  • 视频能力
    • 视频数据查询
      • 查询特定视频的视频数据
    • 近 30 天用户视频数据
      • 获取视频基础数据
      • 获取视频点赞数据
      • 获取视频评论数据
      • 获取视频播放数据
      • 获取视频分享数据
    • 视频评论数据
      • 置顶评论
      • 评论回复列表
      • 评论列表
      • 回复视频评论
    • videoid转换itemid
    • itemid转换encryptid
  • 搜索能力
    • 创建抖音搜索直达子服务
    • 查询已创建的抖音搜索直达子服务列表
    • 删除抖音搜索直达子服务
    • 校验是否有搜索直达服务的创建权限
  • 电商
    • 注册小程序积分阈值
    • 注册小程序预览图
    • 查询订单的定制完成状态
    • 定制类小程序开发者注册信息
    • 退会
  • 生活服务
    • 店铺接入
      • 商铺同步
      • 查询店铺
      • 获取抖音POI ID
      • 店铺匹配任务结果查询
      • 店铺匹配状态查询
      • 提交门店匹配任务
      • 查询全部店铺信息接口(天级别请求5次)
      • 查询店铺全部信息任务返回内容
    • 商品库接入
      • (老版本)SKU同步
      • (老版本)sku拉取(该接口由接入方实现)
      • (老版本)多门店SPU同步
      • (老版本)多门店SPU状态同步
      • (老版本)多门店SPU库存同步
      • (老版本)多门店SPU信息查询
      • 创建/修改团购商品
      • 免审修改商品
      • 上下架商品
      • 同步库存
      • 查询商品模板
      • 查询商品草稿数据
      • 查询商品线上数据
      • 查询商品线上数据列表
      • 查询商品草稿数据列表
      • 用于创建多 SKU 商品。
      • 查询商品品类
    • 端内消息同步
      • 订单同步
    • poi数据接入
      • 获取POI基础数据
      • POI用户数据
      • POI服务基础数据
      • POI服务成交用户数据
      • POI热度榜
      • POI认领列表
    • poi基础能力
      • 通过高德POI ID获取抖音POI ID
    • 优惠卷接入
      • 优惠券同步
      • 优惠券更新
    • CPS佣金设置与查询
      • 通用佣金计划查询带货数据
      • 通用佣金计划查询达人带货数据
      • 通用佣金计划查询带货达人列表
      • 通用佣金计划查询达人带货详情
      • 查询通用佣金计划
      • 发布/修改通用佣金计划
      • 修改通用佣金计划状态
      • 发布/修改直播间定向佣金计划
      • 发布/修改短视频定向佣金计划
      • 修改定向佣金计划状态
      • 取消定向佣金计划指定的达人
      • 查询达人的定向佣金计划带货数据
      • 通过商品 ID 查询定向佣金计划
      • 查询定向佣金计划带货汇总数据
  • 用户信息
    • 用户抖音主页数据
      • 获取用户视频情况
      • 获取用户粉丝数
      • 获取用户点赞数
      • 获取用户评论数
      • 获取用户分享数
      • 获取用户主页访问数
  • 分享
    • 拍抖音任务
      • 拍抖音任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 拍抖音互动任务
      • 拍抖音互动任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 分享任务
      • 创建任务
      • 查询用户任务进度
  • 客服
    • CustomerServiceUrl
  • 小程序卷
    • 「小程序券」直播玩法接入指南
    • 小程序券API列表
    • 更新日志
    • 用户卷管理
      • 查询用户可用券信息
      • 用户领券结果回调通知
      • 用户撤销核销券
      • 用户手机号授权结果回调通知
      • 用户核销券
    • 主播授权管理
      • 查询主播发券配置信息
      • 修改主播发券权限状态
      • 更新主播发券库存上限
      • 主播发券权限配置
    • 卷模版管理
      • 查询授权用户发放的活动信息
      • 创建券模板
      • 修改券模板
      • 删除券模板
      • 修改券模板库存
      • 修改券模板状态
      • 查询券模板发放统计数据
      • 查询券模板
      • 查询对账单
    • 接口发放管理
      • 创建开发者接口发券活动
      • 开发者接口发券
      • 删除开发者接口发券活动
  • 交易系统
    • 通用交易系统
      • 通用参数
      • 进件
        • 接口进件
          • 图片上传
          • 发起进件
          • 进件查询
        • 获取进件页面链接
          • 开发者获取小程序收款商户/合作方进件页面
          • 服务商获取小程序收款商户进件页面
          • 服务商获取服务商进件页面
          • 服务商获取合作方进件页面
      • 标签
        • 查询标签组信息
      • 订单
        • 查询CPS信息
        • 查询订单信息
        • 支付结果回调
      • 退款
        • 发起退款
        • 查询退款
        • 同步退款审核结果
        • 退款申请回调扩展点
        • 退款结果通知
      • 履约
        • 推送履约状态
      • 结算
        • 发起分账
        • 查询分账
        • 通知分账结果
      • 提现
        • 接口提现
          • 商户余额查询
          • 商户提现
          • 商户提现结果查询
        • 获取提现页面链接
          • 开发者获取小程序收款商户/合作方提现页面
          • 服务商获取小程序收款商户提现页面
          • 服务商获取服务商提现页面
          • 服务商获取合作方提现页面
      • 获取对账单
        • 获取资金账单
        • 获取交易账单
    • 生活服务交易系统(金融合板)
      • 通用参数
      • 错误码和返回码
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询 CPS 信息
      • 预下单
        • 预下单扩展点
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销算价扩展点
      • 支付
        • 支付结果通知
      • 核销
        • 抖音码
          • 验券准备
          • 验券
          • 撤销核销
          • 券码核销通知
          • 撤销核销通知
        • 三方码
          • 推送核销状态
          • 撤销核销
      • 分账
        • 查询分账
      • 退货退款
        • 开发者发起退款
        • 同步退款审核结果
        • 查询退款
        • 退款扩展点
        • 退款结果通知
    • 生活服务交易系统(账号融合版)
      • 错误码和返回码
      • 通用参数
      • 预约
        • 创建预约单
        • 预约接单结果回调
        • 商家取消预约
        • 用户取消预约
        • 查询预约单信息
        • 预约接单超时回调
        • 预约取消/完成通知
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询CPS信息
      • 预下单
        • 预下单回调
        • 关闭订单
        • 发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 算价扩展点
        • 营销查询算价二合一
      • 支付
        • 通知支付结果
      • 核销
        • 抖音码
          • 验券准备
          • 验券
        • 三方码
          • 推送核销状态
        • 核销工具
          • 查询用户券列表
          • 查询订单可用门店
          • 券核销消息通知
          • 撤销核销消息通知
          • 设置商家展示信息
          • 查询商家配置文案
          • 设置订单详情页按钮白名单接口
          • 设置小程序跳转path
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
      • 退货退款
        • 发起退款
        • 同步退款审核结果
        • 查询退款
        • 退款申请回调
        • 通知退款结果
    • 行业交易系统
      • API 调用
        • 通用参数
        • 错误码和返回码
      • 回调设置
        • 设置回调地址
        • 查询回调地址
      • 预下单
        • 查询 CPS 信息
        • 查询订单信息
        • 预下单回调
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 设置扩展点
        • 算价扩展点
    • 支付
      • 通知支付结果
    • 核销
      • 抖音码
        • 验券准备
        • 验券
        • 查询劵状态信息
      • 三方码
        • 推送核销状态
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
    • 提货退款
      • 开发者发起退款
      • 同步退款审核结果
      • 查询退款
      • 退款申请回调
      • 通知退款结果
  • 内容安全
    • 内容安全检测
    • 图片检测V2
    • 图片检测V3
  • 泛知识
    • 角色系统
      • 错误码
      • 上传材料
        POST
      • 代运营服务商帮老师或代运营模式机构入驻
        POST
      • 自营机构/服务商入驻
        POST
      • 新增角色
        POST
      • 查询基础认证资质
        POST
      • 更新基础认证资质
        POST
      • 查询类目认证资质
        POST
      • 更新类目认证资质
        POST
      • 添加类目认证资质
        POST
      • 获取审核任务详情
        POST
      • 小程序绑定角色
        POST
      • 小程序解除绑定角色
        POST
      • 查询小程序已绑定的角色
        POST
      • 角色授权小程序
        POST
      • 解除授权小程序
        POST
      • 查询授权小程序
        POST
      • 更新授权小程序授权信息
        POST
      • 查询抖音号绑定、能力授权
        POST
      • 新增抖音号绑定、能力授权
        POST
      • 解除抖音号绑定、解除能力授权
        POST
      • 查询实体ID
        POST
      • 查询实体已绑定抖音号列表
        POST
    • 课程库
      • 【泛知识】回调通知
      • 【泛知识】课程库 FAQ
      • 【泛知识】错误码
      • 【泛知识】上传课程资源
      • 【泛知识】查询课程资源上传状态
      • 【泛知识】查询资质
      • 【泛知识】添加课程
      • 【泛知识】修改课程
      • 【泛知识】修改课程状态
      • 【泛知识】查询课程
      • 【泛知识】修改课程免审
      • 【泛知识】查询免审课程
      • 【泛知识】修改商品退款规则
      • 【泛知识】查询可选退款规则
      • 【泛知识】查询课程类目信息
  • 担任支付
    • 进件
      • 进件状态回调
      • 发起进件请求
      • 图片上传接口
      • 进件状态查询
    • 支付
      • 支付结果回调
      • 支付常见问题
      • 预下单接口
      • 唤起收银台
      • 支付结果查询
    • 退款
      • 退款结果回调
      • 退款常见问题
      • 发起退款
      • 退款结果查询
    • 结算及分账
      • 收费规则
      • 结算及分账常见问题
      • 自动结算
        • 自动结算接入说明
        • 自动结算结果回调
        • 自动结算结果查询
      • 发起结算及分账
      • 结算及分账结果查询
      • 结算及分账结果回调
      • 可分账余额查询
    • 退分账
      • 发起退分账
      • 查询分账回退结果
    • 提现
      • 商户余额查询
      • 商户提现
      • 商户提现结果查询
      • 商户提现回调
    • 获取对账单
      • 获取交易账单
      • 获取资金账单
    • 接口获取页面链接
      • 进件
        • 开发者获取小程序收款商户/合作方进件页面
        • 服务商获取小程序收款商户进件页面
        • 服务商获取服务商进件页面
        • 服务商获取合作方进件页面
      • 提取
        • 开发者获取小程序收款商户/合作方提现页面
        • 服务商获取小程序收款商户提现页面
        • 服务商获取服务商提现页面
        • 服务商获取合作方提现页面
    • 订单推送
      • 订单同步
  • 评价
    • 获取评价数据
  • 其他
    • 用户登录态签名
    • 抖音开放平台与小程序视频打通能力
      • 抖音开放平台与小程序视频打通能力
      • 视频使用能力能力
    • 开放能力配置接口
      • 开放能力配置接口
      • 配置开放能力实现接口
      • 查询生效中配置接口
    • 解决方案测试实体管理接口
      • 解决方案测试实体管理接口
      • 新增测试实体接口
      • 查询测试实体接口
      • 删除测试实体接口
    • 直播间自定义封面
    • 上传资源
    • 能力申请
    • 查询能力申请状态
  • 订阅消息
    • 查询订阅消息模版库
    • 发送订阅消息
    • 查询小程序的模版列表
    • 添加模板
    • 删除已添加的模版
    • 查询新建订阅消息模板列表
    • 新建订阅消息模板
  • 小程序推广计划
    • 短视频任务
      • 创建任务
        • 小程序任务台能力
        • 创建任务
      • 查询任务台任务投稿视频数据(明细)
      • 查询任务台任务投稿视频数据
      • 查询小程序任务台任务 ID
      • 更新任务状态
      • 重新提交任务基础信息
      • 查询任务详情
      • 更新专属任务达人
      • 查询视频任务相关实时汇总数据
    • 直播间任务
      • 创建直播间任务
      • 更新直播间任务
  • 挂载
    • 自主挂载
      • 获取作者视频列表
      • 自主挂载存量视频绑定锚点
      • 自主挂载存量视频解绑锚点
    • 小程序直播挂载黑白名单管理能力
    • 拍抖音黑白名单管理能力
    • 申请短视频自主挂载能力
    • 查询短视频自主挂载能力申请状态
    • 申请直播自主挂载能力
    • 查询直播自主挂载能力申请状态
    • 申请短视频达人推广挂载能力
    • 查询短视频达人推广挂载能力申请状态
    • 查询直播达人推广挂载能力申请状态
    • 申请直播达人推广挂载能力
    • 短视频/直播自主挂载能力绑定抖音号
    • 获取短视频/直播自主挂载抖音号绑定二维码
    • 查询短视频/直播自主挂载能力绑定抖音号列表
    • 解除短视频/直播自主挂载能力抖音号绑定
    • 挂载权限校验
    • 修改短视频锚点配置
    • 查询短视频锚点配置
    • 查询短视频锚点配置修改记录及状态
    • 图片上传
    • 图片审核状态查询
    • 图片删除
    • 设置全局默认配置
    • 设置指定页面配置
    • 查询全局默认配置
    • 查询指定页面配置
    • 删除指定页面配置
    • 讲解卡动态更新
  • 分发
    • 添加小程序别名
    • 查询小程序别名
    • 修改小程序别名
    • 删除小程序别名
    • 设置小程序搜索标签
    • 查询小程序搜索标签列表
  • 引导关注抖音号
    • 绑定抖音号
    • 获取抖音号绑定二维码
    • 获取绑定抖音号列表
    • 解除抖音号绑定
  • 数据分析
    • 用户分析
      • 行为分析
      • 实时分析
      • 留存分析
      • 来源分析
      • 用户画像
      • 终端分析
      • 页面分析
    • 交易分析
      • 总览分析
      • 流量转化
      • 短视频交易分析
      • 获取直播房间数据
      • 直播数据分析
      • 直播交易分析
      • 商品分析
    • 短视频分析
      • 短视频投稿数据
      • 短视频总览数据
      • 短视频详细数据
      • 流量来源
    • 直播分析
      • 直播间详细数据
        • 接口 1
        • 接口 2
      • 直播间总览数据
      • 主播分析
    • 小房子直播分析
      • 小房子直播间总览数据
      • 小房子直播间详细数据
      • 小房子直播间订单数据
    • 留资分析
      • 组件使用数据
      • 流量来源
      • 组件详细数据
      • 组件使用对比
  • 服务类目
    • 获取已设置的服务类目
  • 直播间能力
    • 查询跳转抖音直播间能力申请状态
    • 申请跳转抖音直播间能力
    • 查询直播间状态组件能力申请状态
    • 申请直播间状态组件能力
  • 抖音开放能力
    • 查询抖音开放能力列表
    • 申请开通抖音开放能力
    • 查询scope配额详情
    • scope申请提额
    • 查询视频关键词列表
    • 新增视频关键词
    • 删除视频关键词
  • 页面结构自定义
    • 查询页面结构自定义能力申请状态
    • 申请页面结构自定义能力
  • 普通二维码绑定
    • 查询普通二维码绑定列表
    • 新增绑定二维码
    • 更新绑定二维码链接
    • 更新绑定二维码状态
    • 删除绑定二维码链接
  • 抖音号绑定
    • 获取抖音号绑定所需的资质模版列表
    • 获取抖音号绑定所需的资质模版信息
    • 输入抖音号绑定
    • 获取抖音号绑定二维码
    • 查询抖音号绑定列表及状态
    • 解除抖音号绑定
  • 流量主
    • 查询流量主开通状态
    • 开通流量主
    • 查询广告位列表
    • 新增广告位
    • 更新广告位状态
    • 查询广告收入
    • 查询广告结算单列表
  • 抖店绑定
    • 绑定抖店开放平台账号
    • 查询绑定的抖店开放平台账号信息
    • 配置抖店开放平台应用
    • 查询配置的抖店开放平台应用信息
    • 获取绑定抖店账号信息
  1. 角色系统

新增角色

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
https://developer.toutiao.com/auth/entity/add_role

接口说明

该接口用于已入驻实体添加角色,调用成功过后,角色下类目认证(服务商没有该信息)会进审,接口返回审核 ID,审核通过后角色生效。

  • 已有代运营服务商角色要新增机构角色。
  • 已有机构角色实体要新增代运营服务商角色。

创建沙盒环境小程序时请选择“正式小程序能力映射”,详情请关注行业角色系统能力文档。

前提条件

  • 实体已经入驻并且已经通过审核
  • 开发者需要在开发者运营平台完成主体认证(入驻开发者平台)

注意事项

  • 调用添加角色接口后,若想对正在审核中的角色认证资质进行修改,请调用更新类目认证修改接口;
  • 若未做额外备注,string 类型的默认字段默认支持字符集 utf-8
  • access_token获取的方式 获取access_token

基本信息

基本
HTTP URL正式环境:https://developer.toutiao.com/auth/entity/add_role 沙盒环境:https://open-sandbox.douyin.com/auth/entity/add_role
HTTP MethodPOST
权限要求AccessToken鉴权

certificate_materials、qualification、cooperation_agreement 、cooperation_cases 说明

参数名参数类型是否必须备注
material_typeint是资质材料类型,目前支持的类型见上传资料接口
material_expiretimestring是资料过期时间,示例:2029-09-10
material_pathsArray是资质材料链接,字符串数组

请求示例

  • 添加服务商角色

// 服务商

{

"appid": "ttd0f3a64e4fccc95f01",

"access_token": "0801121846324163432f483639344945XXXf704f6877757266773d3d",

"entity_id": "E_7216554566647824422",

"industry_role": 3,

"partner_role_info": {

"partner_info": {

​ "company_type": "企业工商户",

​ "company_addr": "中国山西晋城",

​ "cooperation_cases": [

​ {

​ "material_type": 1010,

​ "material_expiretime": "2033-03-03",

​ "material_paths": [

​ "certification/resource/f105beee222f1629e7cbfb9e243bc286"

​ ]

​ }

​ ]

}

},

"institution_role_info": {

"institution_info": {

​ "record_name": "",

​ "scene_type": "",

​ "subject_type": "",

​ "logo_uri": "",

​ "trademark_uri": "",

​ "desc": ""

},

"institution_class_info": {

​ "industry_class": {

​ "first_class": 0,

​ "second_class": 0,

​ "third_class": 0

​ },

​ "employee": {

​ "employee_material": {

​ "name": "",

​ "id_number": "",

​ "expire_time": "",

​ "front_path": "",

​ "back_path": ""

​ },

​ "cooperation_agreement": {

​ "material_type": 0,

​ "material_expiretime": "",

​ "material_paths": [""]

​ }

​ },

​ "class_material": {

​ "material_type": 0,

​ "material_expiretime": "",

​ "material_paths": [""]

​ }

}

}

}

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://developer.toutiao.com/auth/entity/add_role' \
--header 'Aweme-Check-Type;' \
--header 'Content-Type: application/json' \
--data-raw '//(机构)
{ 
  "appid": "ttcfc4b97950f8484801",
  "access_token": "08011218463241356a4a3557314770326a6d7459645257624e673d3d",
  "entity_id": "E_7230706235463548989",
  "industry_role": 2,
  "partner_role_info": {
    "partner_info": {
      "company_type": "",
      "company_addr": "",
      "cooperation_cases": [
        {
          "material_type": 0,
          "material_expiretime": "",
          "material_paths": [""]
        }
      ]
    }
  },
  "institution_role_info": {
    "institution_info": {
      "record_name": "三九小飞棍来喽",
      "scene_type": "线上机构",
      "subject_type": "企业工商户",
      "logo_uri": "certification/resource/e0882488978ce1eb808636028d52b107",
      "trademark_uri": "certification/resource/e0882488978ce1eb808636028d52b107",
      "desc": "这个简介也必须是十二个字符才可以吗"
    },
    "institution_class_info": {
      "industry_class": {
        "first_class": 40000,
        "second_class": 40600,
        "third_class": 0
      },
      "employee": {
        "employee_material": {
          "name": "花玲玲",
          "id_number": "320XXXXXXXXXXXXXXX",
          "expire_time": "2030-05-05",
          "front_path": "certification/resource/e0882488978ce1eb808636028d52b107",
          "back_path": "certification/resource/e0882488978ce1eb808636028d52b107"
        },
        "cooperation_agreement": {
          "material_type": 1005,
          "material_expiretime": "2031-06-06",
          "material_paths": [
            "certification/resource/e0882488978ce1eb808636028d52b107"
          ]
        }
      },
      "class_material": {
        "material_type": 1001,
        "material_expiretime": "2030-04-04",
        "material_paths": [
          "certification/resource/e0882488978ce1eb808636028d52b107"
        ]
      }
    }
  }
}'
响应示例响应示例
200 - 成功示例
{ 
    "add_role_taskid": "Role_717907890xxx4238252"
    "err": {
        "err_code": 0,
        "err_msg": ""
    }
}

请求参数

Header 参数
Content-Type
string 
必需
Aweme-Check-Type
string 
可选
Body 参数application/json
appid
string 
必需
服务商在抖音开放平台的应用唯一标识
access_token
string 
必需
小程序的AccessToken
entity_id
string 
实体ID
必需
industry_role
integer 
必需
添加角色类型(2:机构 3:代运营服务商)
partner_role_info
object 
服务商角色必填
可选
partner_info
object 
服务商基础信息
可选
institution_role_info
object 
机构角色必填
可选
institution_info
object 
机构基础信息
可选
institution_class_info
object 
机构类目信息
可选
示例

返回响应

🟢200成功
application/json
Body
add_role_taskid
string 
类目认证任务ID
必需
err
object 
必需
err_code
integer 
必需
err_msg
string 
必需
🟠400角色已存在
🟠400角色类型填写错误
🟠400非法token
🟠400小程序主体和被添加实体不匹配
上一页
自营机构/服务商入驻
下一页
查询基础认证资质
Built with