button 组件获取用户私信授权
收藏
我的收藏

基础库 2.92.0 开始支持本能力。支持小程序主动授权私信，需要将 button 组件 open-type 的值设置为 authorizePrivateMessage。
button 组件常规属性请参考button 按钮。

使用前提

•

使用该功能前开发者需要绑定抖音号，具体信息请参考品牌号、员工号

•

使用该功能前开发者需要去开发者后台-设置-关联设置-抖音号管理为对应的抖音号申请获取用户私信授权能力

能力说明

•

该组件用于通过小程序内获取用户主动私信授权，是实现小程序主动私信能力的前置环节，详见小程序主动私信能力概述

•

C端抖音用户点击授权后长期有效，小程序经营者可以持续向普通用户发送消息，每天可以使用服务私信持续触达场景调用小程序发送私信消息接口 1 次，发送最多 3 条消息（需包含小程序卡片消息），具体规则限制以接口文档描述为准

•

C端抖音用户在授权小程序经营者的授权有效期内再次无法拉起组件

属性说明

属性名	类型	默认值	必填	说明	最低支持版本
open-type	string		是	用于调用开放能力，此场景下需要设置为 "authorizePrivateMessage"	2.92.0
data-aweme-id	string		是	授权私信对象的抖音号，且只支持小程序绑定的品牌号、员工号	2.92.0
data-im-extra	string		否	开发者自定义的透传字段。用于满足埋点统计等诉求。传入后，可以通过接口或webhook获取该字段的信息	3.15.0
bindauthorizeprivatemessage	EventHandle		否	监听跳转的回调	2.92.0

bindauthorizeprivatemessage 事件对象的 detail

回调成功

Object 类型，属性如下：

参数	参数类型	说明
errMsg	string	跳转成功信息，恒为'authorizePrivateMessage:ok'
errNo	number	0

回调失败

Object 类型，属性如下：

参数	参数类型	说明
errMsg	string	跳转失败信息，以'authorizePrivateMessage:fail'开头
errNo	number	错误码

errMsg 的可枚举值：

errNo	errMsg	说明	最低支持版本
21100	network error	网络错误	2.92.0
21101	server error:%@	服务端错误	2.92.0
21102	request fail:%s, code=%d	请求授权失败	2.92.0
21103	invalid user	青少年模式	2.92.0
21104	guest mode	基本模式	2.92.0
21105	feature is not supported in app	宿主不支持	2.92.0
21106	awemeId not exist	抖音号不存在	2.92.0
21107	awemeId not support	只支持小程序绑定的品牌号、员工号	2.92.0
10502	cancel	用户取消	2.92.0
10601	not login	用户宿主未登陆	2.92.0

目前错误码21102的错误信息中常见错误如下：

错误码	错误信息
2100006	服务账号未绑定小程序品牌号/小程序员工号/泛知识行业合作号身份
2100007	服务账号未绑定小程序品牌号/小程序员工号/泛知识行业合作号身份
2100008	用户每日最多同意 2 次授权
2100015	已超过当日针对目标抖音用户拉起主动授权私信最大限值

扫码体验

代码示例

HTML复制
<button
  open-type="authorizePrivateMessage"
  bindauthorizeprivatemessage="eventHandler"
  data-aweme-id="{{awemeId}}"
>
  拉起主动私信授权 
</button>

JavaScript复制
Page({
  data: { 
    awemeId: "176793430",
  },
  eventHandler(e) {
    if (e.detail.errNo) {
      console.log("拉起主动私信授权失败", e.detail);
    } else {
      console.log("拉起主动私信授权成功");
    }
  },
});