抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

button组件小程序跳转私信
收藏
我的收藏

基础库 2.82.0 开始支持本能力。支持小程序跳转私信能力,需要将 button 组件 open-type 的值设置为 privateMessage。
button 组件常规属性请参考button 按钮。
使用该功能前开发者需要绑定抖音号,具体信息请参考抖音企业机构号,

属性说明

属性名
​
​
类型
​
​
默认值
​
​
必填
​
​
说明
​
​
最低支持版本
​
​
open-type
​
​
string
​
​
​
​
是
​
​
用于调用开放能力,此场景下需要设置为 "privateMessage"
​
​
2.82.0
​
​
data-aweme-id
​
​
string
​
​
​
​
是
​
​
私聊对象的抖音号,只支持小程序绑定的抖音企业机构号
​
2.92.0
​
​
data-scene
​
​
string
​
​
​
​
否
​
​
场景值,使用卡片场景时设置为"open_card_im",表示小程序卡片
​
​
2.82.0
​
​
data-im-extra
​
​
string
​
​
​
​
否
​
​
开发者自定义的透传字段,用来满足开发者埋点统计等诉求,会通过webhook回传,仅在场景值为open_card_im时生效
​
​
2.82.0
​
​
bindpm
​
​
EventHandle
​
​
​
​
否
​
​
监听跳转的成功回调
​
​
2.82.0
​
​
binderror
​
​
EventHandle
​
​
​
​
否
​
​
监听跳转的失败回调
​
​
2.82.0
​
​
​
​

代码示例

<button open-type="privateMessage" data-aweme-id="{{ awemeId }}" bindpm="pmCallback" binderror="pmError" > 跳转私聊页 </button>
Page({ data: { awemeId: "私聊对象的抖音号", }, pmCallback(e) { console.log("跳转私聊页成功", e.detail); }, pmError(e) { console.log("拉起私聊页失败", e.detail); }, });

Bug & Tip

    •Tip:使用该功能前开发者需要去开发者后台-设置-关联设置-抖音号管理为对应的抖音号申请小程序跳转私信能力。
​