抖音开放平台Logo
开发者文档
小程序
控制台
  • OpenAPI 简介
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 联合授权
  • 视频能力
  • 线索组件
  • 接口调用凭证
  • 登录
  • Web 化接入
  • 隐私协议
  • 流量主
  • 小程序码与小程序链接
  • 用户信息
  • 抖音号绑定
  • 小程序推广计划
  • 内容安全
  • 任务能力
  • 分享
  • 客服
  • 小程序券
  • 「小程序券」直播玩法接入指南
  • 「小程序券」复访营销活动接入指南
  • 小程序券API列表
  • 用户券管理
  • 主播授权管理
  • 营销活动管理
  • 券模板管理
  • 接口发放管理
  • 触达与营销
  • 支付
  • 运营
  • 生活服务
  • 垂直行业
  • 其它

    • 「小程序券」直播玩法接入指南

    收藏
    我的收藏

    一、业务系统介绍

    产品功能介绍请见：直播间转化营销。

    1、业务流程

    流程概览

    券模板和券记录关系

    详细流程

    ​

    名称解释

    名称
    说明
    券模板
    小程序券的结构化信息，包含券名称、券类型、券面值、券使用门槛、库存等信息，通过定义券模版来确定券的玩法。
    券模板库存
    小程序券在所有渠道下总共可发放的库存数量。
    主播发券发放上限
    ​
    开发者分配给某主播的可发放数量上限，此上限不能超过券模板库存，每个主播都可以被授权不同的上限值。
    发放计划
    主播在抖音开播端的「小程序券配置页面」中，配置所要发放小程序券模板的库存数量，完成配置时会约定本场直播所发放的数量。
    用户领券
    抖音用户在直播间领取主播发放的券，同一个用户对同一张券只能领券一次。

    2、券模板状态机

    3、券记录（由券模版生成）状态机

    4、「券库存-主播发放上限-发放计划」三者库存关系

    二、接入流程介绍

    开发者接入抖音券组件整体流程如下：

    第一步：获取接口访问凭证

    通过 生成 client_token 接口获取接口访问凭证。
    ISV 获取 access_token 方式：ISV 代调用环节说明。

    第二步：管理券模板

    接口文档：
      1.创建券模板
      2.修改券模板
      3.查询券模板
      4.删除券模板
      5.修改券模板库存

    第三步：管理营销活动

    接口文档：
      1.创建营销活动
      2.查询营销活动
      3.修改营销活动
      4.修改营销活动状态

    第四步：配置主播发券权限

    接口文档：
      1.主播发券权限配置
      2.修改主播发券权限
      3.更新主播发券库存上限
      4.查询主播发券配置信息

    第五步：获取用户领券信息

    用户在直播间内领券后通过券链路进入小程序时会在 Query 中携带信息，开发者可以通过以下信息理解用户已有券以及发券来源。
    名称
    描述
    示例值
    user_open_id
    用户open_id
    Cv4PoJXxxxn63rNu
    coupon_id
    抖音开平券id
    714860xxxxxxx
    coupon_meta_id
    抖音开平券模板id
    702345xxxxxxx
    merchant_meta_no
    商家券模板号
    xxxx
    talent_open_id
    发券主播open_id
    Cv4PoJXxxxn63rNu
    接口文档：
      1.查询小程序下用户可用券信息
      2.用户领券结果回调通知

    第六步：接入交易能力（满减券、立减券必选，权益券不必选）

    如小程序内无交易场景，本步骤可跳过；若有交易场景，目前有两种交易方式可选：

    第七步：「核销」券或「撤销核销」券

    接口文档：
      1.用户核销券
      2.用户撤销核销券

    三、玩法涉及的能力

    能力包
    能力模块
    接口
    HTTP Method
    URL 前缀
    HTTP URL
    签名方式
    小程序券核心能力包
    ​
    券模板管理
    ​
    创建券模板
    POST
    https://open.douyin.com/api/promotion/v1/coupon
    ​
    /create_coupon_meta
    无
    修改券模板
    POST
    /update_coupon_meta_param
    无
    查询券模板
    POST
    /query_coupon_meta
    无
    删除券模板
    POST
    /delete_coupon_meta
    无
    修改券模板库存
    POST
    /update_coupon_meta_stock
    无
    修改券模板状态
    POST
    update_coupon_meta_status
    无
    用户券管理
    ​
    用户领券结果回调通知
    POST
    -
    签名算法
    用户核销券
    POST
    /batch_consume_coupon
    无
    用户撤销核销券
    POST
    /batch_rollback_consume_coupon
    无
    查询小程序下用户可用券信息
    POST
    /get_coupon_receive_info
    无
    小程序券直播能力包
    ​
    主播授权管理
    ​
    主播发券权限配置
    POST
    /set_talent_coupon
    无
    修改主播发券权限
    POST
    /update_talent_coupon_status
    无
    更新主播发券库存上限
    POST
    /update_talent_coupon_stock
    无
    查询主播发券配置信息
    POST
    /get_talent_coupon
    无

    四、常见问题

      1.是否可重复给主播授权？
        答：对同一个主播同一个券模板只能授权一次，授权后可追加库存或下架。
      2.对主播进行指定券模板下架操作后，主播剩余的库存上限会清零吗？
        答：不会清零，待重新上架后主播库存上限延用下架前的配置。
      3.在优惠券还在直播间发放过程中进行主播发券权限下架动作，券的发放会终止吗？
        答：如下架的券模板授权与正在发放中的券模板一致，发放活动会被停止。
      4.当前是否有独立的测试环境？
        答：没有，券能力还未接入沙盒环境，还不能用沙盒 appid。若小程序未上线，可先上线小程序后，在线上测试小程序券能力。
      5.在直播通过领券打开小程序会出现 X 分屏（例如七分屏）的情况，小程序的布局受到影响怎么办？
        答：可以通过 Page.onResize 进行监听，作额外处理。参考：https://developer.open-douyin.com/docs/resource/zh-CN/mini-app/develop/guide/basic-ability/resize/；同时可以在抖音开发者工具选择直播间进行调试，如下图：
      6.接入交易系统2.0和营销扩展点时报错？
        答：详情请参考：交易系统、营销扩展点 oncall 流程。
    ​