fusion2.dialog.invite

特别提示:
HTML5实现的应用,请通过下面的指引调用本接口实现邀请功能。
客户端应用,请使用Android SDK实现相应的功能。

目录

1 功能说明

1. 接口类型:前端JS接口。
2. 接口功能:邀请好友开通应用,用于提升应用安装量。
3. 功能描述:
(1)要实现邀请好友开通功能,只需在应用的前端页面代码中调用本接口,并在应用的界面上放置类似“邀请好友”的按钮。
(2)用户在应用中点击“邀请好友”按钮后,即可在打开的好友邀请弹框中选择要邀请的好友。
(3)发送邀请后,好友在手机空间应用消息中将收到此条消息;如果是双栖应用,该消息会同步至PC端,展示渠道同PC端邀请消息。
(4)好友点击消息中“接受”按钮或整条消息,即可进行应用下载。
(5)支持邀请结果回传。用户点击邀请弹框中的发送按钮后,回传给应用发起邀请者的openid,被邀请者的openids。该特性使应用可根据用户发送邀请的数量来做活动(例如“今天你邀请10个未安装游戏的好友,就能获取普吉岛豪华双人游”),从而刺激邀请的发送量;也可以根据邀请的转换率来调整游戏的合理性、平衡性(例如游戏中某个关卡的过关条件是“成功邀请5个好友来玩游戏”,但应用发现用户已经发起邀请超过100次了,都没有带来5个好友来安装应用,则及时调整,适当降低要求,以减少用户挫败感)。
(6)关于如何判断用户是通过邀请进入应用的。用户进入应用后,应用可调用接口v3/spread/verify_invkey判断该用户是否是由某个用户邀请过来的,若是,则应用可给发送邀请的用户赠送礼品。

4. 接口调用限制
(1)应用状态:应用上线前,调用本接口只能弹框,弹框中不会出现好友信息,不会发送邀请。上线后才能发送邀请。
(2)支持的平台:开发者可以直接传入被邀请好友的openid,以及邀请结果回传的功能。
(3)调用的频率限制:详见社交渠道使用优化指引

2 场景说明

2.1 入口说明

建议在应用的顶部添加类似“邀请好友”的按钮,位置明显,方便用户操作。
用户点击按钮后,会弹出好友选择页面,好友选择页面中已过滤掉已安装好友。

2.2 页面效果展示

1. 好友选择页
(1)页面列出未安装应用的好友。
(2)当天已被邀请好友不在列表中展示。
好友选择页面示例如下图所示:
m_sociality_5.png

2. 发送确认页
(1)页面中列出被邀请的好友。
(2)页面中有应用的图片和标题,建议为应用的图标或者与邀请相关的主题图片。
(3)弹框中有邀请好友的内容描述,吸引用户点击消息进入应用。
发送确认页面示例如下图所示:
m_sociality_6.png

2.3 结果展现

详见:邀请渠道效果展示


3 接口调用说明

调用本前端接口前,应用中应该部署Fusion2的跨域文件以及引用脚本,请参阅:Fusion2文档

3.1 参数说明

参数名称 是否必须 类型 描述
msg 必须 string 参数描述:邀请好友时,发送给好友的邀请信息。请尽量简洁生动,能够吸引用户进入应用。

长度限制:控制在35个汉字以内。

img 必须 string 参数描述:邀请配图的URL,用于在邀请feeds中展示。
source string 参数描述:应用自定义参数,邀请好友成功后,被邀请方通过邀请链接进入应用时会携带该参数并透传给应用,用于识别用户来源。

用户通过由该接口发送的应用消息feed进入应用时,Query String中的app_custom参数值即为该参数的值。
长度限制:这里的参数会被URL编码,需要注意编码后的长度不允许超过900个字符。
例如:
用户A向C发送邀请时,source的值为“openid=001”,用户B向C发送邀请时,source的值为“openid=002”。当用户C点击邀请信息的链接进入应用时,url中会携带app_custom参数,如果app_custom的值为“openid=001”,说明C响应的是A的邀请,如果app_custom的值为“openid=002”,说明C响应的是B的邀请。

context string 参数描述:透传参数,用于onSuccess和onCancel回调,以识别请求。

透传方式:调用本接口时传入该参数,onSuccess或onCancel回调时,在JS中使用opt.context即可获取该透传参数(opt为本接口的回调函数形参)。
例如用户操作成功后,会回调onSuccess时获取该参数的值:

onSuccess : function (opt) 
  {       
      alert("Succeeded: " + opt.context);  
  }
onSuccess 参数描述:用户操作成功后的回调方法。目前仅支持空间和朋友平台,不支持微博等其它平台。

方法要求: 回调函数的定义符合标准JS函数定义方式,即:function (opt)。
触发条件:用户点击弹出框中的“发送”按钮,提示成功,弹出框关闭。

onCancel 参数描述:用户取消操作后的回调方法。

方法要求: 回调函数的定义符合标准JS函数定义方式,即:function (opt)。
触发条件:用户点击取消或弹出框右上角的×按钮,弹出框关闭。用户取消时将同时关闭对话框,因此将先触发onCancel回调再触发onClose回调。

onClose 参数描述:对话框关闭时的回调方法。主要用于对话框关闭后进行UI方面的调整,onSuccess和onCancel则用于应用逻辑的处理,避免过度耦合。

方法要求: 回调函数的定义符合标准JS函数定义方式,即:function (opt)。
触发条件:用户点击取消或弹出框右上角的×按钮,弹出框关闭。用户取消时将同时关闭对话框,因此将先触发onCancel回调再触发onClose回调。

3.2 调用示例

fusion2.dialog.invite

({

  msg  : "邀请你来玩~",


  img : "http://qzonestyle.gtimg.cn/qzonestyle/act/qzone_app_img/app353_353_75.png",


  source : "domain=s4.app12345.qqopenapp.com",


  context : "invite",


  onSuccess : function (opt) {  alert("邀请成功"); },


  onCancel : function (opt) { alert("邀请取消"); },


  onClose : function (opt) {  alert("邀请关闭"); }

});

4. 关于“邀请好友即赠送礼品”功能的说明

“邀请好友即赠送礼品”需要开发者在程序中判断添加了该应用的用户是由哪一个用户邀请过来的,即需要验证好友邀请的加密串,腾讯提供了验证接口:v3/spread/verify_invkey


FAQ

详见:FusionAPI调用相关问题

以上信息是否解决您的问题?

Copyright © 1998 - 2019 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部