抖音开放平台Logo
开发者文档
控制台

tt.shareMessageToFriend

收藏
我的收藏

基础库 2.74.0 开始支持本方法,这是一个异步方法。

给指定的好友分享游戏信息。

前提条件
业务背景
使用限制

目前仅支持 抖音、抖音极速版 APP

注意事项
  • 注意游戏场景,不要过度频繁引导分享:定向分享需要与游戏场景强相关,建议结合游戏内的好友系统、互动系统,会起到事半功倍的效果
  • 配合“邀请有奖”或“礼物赠送”等功能模式,可以更大程度激发用户的分享意愿(具体实现:通过定向分享能力,入参中传入分享者的 openid(query 字段),并结合 tt.getLaunchOptionsSynctt.onShow 获取启动参数中的 query 来判断是否通过分享链接启动的,并给分享人发放对应的奖励)
相关教程

语法

tt.shareMessageToFriend(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
querystring

查询字符串,格式为JSONString。从这条转发消息进入后,可通过 tt.getLaunchOptionsSynctt.onShow 获取启动参数中的 query 用来实现信息透传

2.74.0
openIdstring
发送对象的 openId
2.74.0
templateIdstring
分享素材模板 id,指定通过平台审核的 templateId 来选择分享内容,需在平台设置且通过审核
2.74.0
successfunction
接口调用成功的回调函数
2.74.0
failfunction
接口调用失败的回调函数
2.74.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
2.74.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"shareMessageToFriend:ok"
2.74.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"shareMessageToFriend:fail" + 详细错误信息
2.74.0

错误码

errNoerrMsg说明最低支持版本
0get game user info error
2.74.0
0get share info error
2.74.0
10502cancel
2.74.0
20001invalid param
参数错误
2.74.0
20000frequency_control
今天TA接受到的邀请太多啦,明天再试试吧
2.74.0
21500get game user info catch error
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
21500get share info catch error${JSON.stringify(error)}
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
10301feature is not supported in app
2.74.0
21101sendMessage is in progress, please do not call again
2.74.0
21000container not exist
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
21000no openID
2.74.0
21000query error
2.74.0
21000schema error
2.74.0
21000query conent error
2.74.0
21000sec_uid not exist
2.74.0
21000get target uid failed
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
21000sendMessage failed
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
20000internal error
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
10601shareMessageToFriend
2.74.0
21000sendGameInviteMessage failed
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
21000sendGameInviteMessage failed
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
21000sendGameInviteMessage failed
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
21000sendGameInviteMessage failed
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
21000sendGameInviteMessage failed
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
10402native exception
小游戏框架内部错误,有需要请创建工单咨询
2.74.0
20000share info entity error
2.74.0
20000game user info entity error
2.74.0

代码示例

let queryObj = { 'key1': 'value1', 'key2': 'value2', }; tt.shareMessageToFriend({ openId: 'xxxxx', templateId: 'xxxxxx', query: JSON.stringify(queryObj), success(res) { console.log('success'); }, fail(res) { console.log('fail', res); }, });