• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 登录
  • 用户信息
  • 广告
  • 支付
  • 分享
  • 小程序跳转
  • 抖音视频能力
  • 收货地址
  • 设置
  • 授权
  • 评价能力
  • 数据分析
  • 视频拍摄器
  • 引导关注
  • 订阅消息
  • 电商插件能力(即将废弃)
  • 会员运营
  • (即将废弃)tt.checkShopMember
  • (即将废弃)tt.getShopMemberInfo
  • (即将废弃)tt.getShopMemberReferralResult
  • (即将废弃)tt.openEcMemberCenter
  • (即将废弃)tt.openEcShop
  • 权益核销
  • 流量引导
  • 导购成交
  • 商品和订单查询
  • C2B 定制
  • (即将废弃)tt.openEcCart
  • (即将废弃)tt.openEcOrder
  • (即将废弃)tt.getShopRecordToken
  • (即将废弃)tt.updateShopMemberPoints
  • AI/AR能力
  • 转发和挂载
  • 直播能力
  • 流量来源识别
  • 侧边栏能力
  • 隐私信息授权
  • web化
  • 行业开放
  • 第三方平台
  • 其它
  • 注意
    本文档即将废弃,新文档请参见 plugin.getShopMemberReferralResult
    基础库 2.74.0.0 开始支持本接口,使用时可用 tt.canIUse 判断是否可用。
    在使用行业相关的组件和 API 前,需要在代码中配置行业 SDK 的权限:行业 SDK 的权限配置,行业 SDK 的权限配置在基础库 2.74.0.0 抖音版本 23.0 以上支持。

    语法

    tt.getShopMemberReferralResult(options);

    参数说明

    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    shopId
    string
    --
    当前小程序绑定的抖音小店 id,与 ShareParams 中 extra.ecReferralParams 中的 shopId 一致。
    2.55.0.0
    activityId
    string
    --
    裂变活动 id
    2.55.0.0
    pagination
    object
    分页配置
    2.55.0.0
    success
    function
    --
    接口调用成功的回调函数
    2.55.0.0
    fail
    function
    --
    接口调用失败的回调函数
    2.55.0.0
    complete
    function
    --
    接口调用结束的回调函数(调用成功、失败都会执行)
    2.55.0.0

    pagination 说明

    默认值:
    { "pageNo": 1, "pageSize": 20 }
    属性说明:
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    pageNo
    number
    --
    当传入pagination 时,必填
    页码
    2.55.0.0
    pageSize
    number
    --
    当传入pagination 时,必填
    一页的数量,最大值: 50
    2.55.0.0

    回调成功

    参数
    参数类型
    说明
    最低支持版本
    referralCount
    number
    当前用户在当前活动中,完成入会被邀请人的数量
    2.55.0.0
    referralList
    UserInfo[]
    当前用户在当前活动中,完成入会邀请人的明细
    2.55.0.0
    errMsg
    string
    回调信息
    2.55.0.0
    list 参数说明:
    参数
    参数类型
    说明
    最低支持版本
    avatarUrl
    string
    邀请会员头像
    2.55.0.0
    nickname
    string
    邀请会员昵称
    2.55.0.0
    joinTime
    string
    邀请会员的入会时间
    2.55.0.0

    回调失败

    参数为 Object 类型,属性如下:
    参数
    参数类型
    说明
    最低支持版本
    errNo
    number
    错误码
    2.55.0.0
    errMsg
    string
    错误信息
    2.55.0.0

    错误码

    errNo
    errMsg
    说明
    最低支持版本
    10101
    Platform auth deny
    权限错误,不在白名单内;
    2.55.0.0
    10301
    The feature is only support in Douyin and DonyinLite
    仅支持在抖音、抖音Lite实用,当前 App 不支持这个功能
    2.55.0.0
    20000
    xxx should be string, but got xxx
    参数类型校验错误,请检查参数类型
    2.55.0.0
    21500
    Invalid login status, please check login status
    获取宿主 sessionid 失败,用户未登录
    2.55.0.0
    21501
    Network error
    网络错误,请检查网络状况
    2.55.0.0
    21502
    Server error
    服务端网关错误(如 404、502等),请联系客服助手
    2.55.0.0
    13000
    系统错误
    服务内部错误,请稍后重试或是联系客服
    2.55.0.0
    21601
    抖音小店 id 不合法,仅支持 0-9 的字符
    2.55.0.0
    21602
    活动 id 不合法,仅支持 0-9 的字符
    2.55.0.0
    21604
    该用户为非会员
    当前用户不是店铺会员,无法获取会员信息
    2.55.0.0
    21605
    该店铺为非会员店铺
    当前抖音小店未开通会员体系,请到抖店开放平台配置会员体系
    2.55.0.0
    21607
    抖音小店 id 与当前小程序无绑定关系
    抖音小店 id 与当前小程序未绑定,请检查当前小程序是否绑定抖音小店
    2.55.0.0
    21608
    小程序未绑定对应应用
    当前小程序未在店铺后台授权,请到抖店开放平台进行授权
    2.55.0.0

    代码示例

    // 代码示例 Page({ onLoad() { tt.getShopMemberReferralResult({ shopId: "1111116433", activityId: "688", success(res) { // 获取当前用户在 activityId 为 "688" 的活动中邀请入会成功的人数 console.log("调用成功", res.referralCount); }, fail(res) { console.log("调用失败", res); }, }); }, // 设置 ShareParams 的 extra.ecReferralParams 参数,确保裂变活动生效 onShareAppMessage(Option) { console.log("ShareOptions:", Option); return { //执行函数后,这里是需要该函数返回的对象 title: "分享标题", extra: { ecReferralParams: { activityId: "688", shopId: "1111116433", }, }, imageUrl: "https://example.com/test.png", success(res) { console.log("分享成功"), res; }, fail(e) { console.log("分享失败", e); }, }; }, });

    Bug & Tip

      Tip:使用该接口时需要用户身份信息,请确保在调用接口前,用户已经登录宿主 App
      Tip:使用该接口时,请确保设置转发功能的 ShareParamsextra.ecReferralParams,以确保裂变活动生效,参见 ShareParams 说明
      Tip:目前该接口只支持抖音 App 和抖音极速版 App,所以请在抖音 App 和抖音极速版 App 中调用