wxPlus
addJumpFromWxListener sendShowMessageResp sendGetMessageResp
概述
微信简介
微信 (WeChat) 是腾讯公司于2011年1月21日推出的一个为智能终端提供即时通讯服务的免费应用程序，微信支持跨通信运营商、跨操作系统平台通过网络快速发送免费（需消耗少量网络流量）语音短信、视频、图片和文字。截止到2016年第一季度，微信已经覆盖中国 90% 以上的智能手机，月活跃用户达到 5.49 亿，用户覆盖 200 多个国家、超过 20 种语言。此外，各品牌的微信公众账号总数已经超过 800 万个，移动应用对接数量超过 85000 个，微信支付用户则达到了 4 亿左右。
微信提供公众平台、朋友圈、消息推送等功能，用户可以通过“摇一摇”、“搜索号码”、“附近的人”、扫二维码方式添加好友和关注公众平台，同时微信将内容分享给好友以及将用户看到的精彩内容分享到微信朋友圈。
微信功能服务
- 朋友圈：用户可以通过朋友圈发表文字和图片，同时可通过其他软件将文章或者音乐分享到朋友圈。用户可以对好友新发的照片进行“评论”或“赞”，用户只能看相同好友的评论或赞。
- 语音提醒：用户可以通过语音告诉Ta提醒打电话或是查看邮件。[19]
- 通讯录安全助手：开启后可上传手机通讯录至服务器，也可将之前上传的通讯录下载至手机。[24]
- QQ邮箱提醒：开启后可接收来自QQ邮件的邮件，收到邮件后可直接回复或转发。[24]
- 私信助手：开启后可接收来自QQ微博的私信，收到私信后可直接回复。[24]
- 漂流瓶：通过扔瓶子和捞瓶子来匿名交友。
- 查看附近的人：微信将会根据您的地理位置找到在用户附近同样开启本功能的人。（LBS功能）
- 语音记事本：可以进行语音速记，还支持视频、图片、文字记事。
- 微信摇一摇：是微信推出的一个随机交友应用，通过摇手机或点击按钮模拟摇一摇，可以匹配到同一时段触发该功能的微信用户，从而增加用户间的互动和微信粘度。
- 群发助手：通过群发助手把消息发给多个人。
- 微博阅读：可以通过微信来浏览腾讯微博内容。
- 流量查询：微信自身带有流量统计的功能，可以在设置里随时查看微信的流量动态。
- 游戏中心：可以进入微信玩游戏（还可以和好友比高分）例如“飞机大战”。
- 微信公众平台：通过这一平台，个人和企业都可以打造一个微信的公众号，可以群发文字、图片、语音三个类别的内容。目前有200万公众账号。
- 微信在IPhone、Android、Windows Phone、Symbian、BlackBerry等手机平台上都可以使用，并提供有多种语言界面。
wxPlus 模块概述
本模块封装了微信开放平台的原生 SDK，集成了微信登录、微信分享功能；可用于实现微信账号登录，分享内容到朋友圈或好友、收藏等功能；轻松、高效集成微信功能到自己的 app 内。使自己的 app 和微信实现无缝链接。
不能同时使用的模块：wx
模块使用攻略
使用之前须从微信开放平台申请开发者账号并创建应用，获取 appid 和 secret。wxPlus 模块是 wx 模块的升级版本，适配了iOS13。wx模块将停止更新
微信平台接入流程参考微信平台接入文档
模块配置
1.配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：**
- 名称：wxPlus
- 参数：urlScheme、apiKey、apiSecret
- 配置示例:
<feature name="wxPlus">
<param name="urlScheme" value="wxd0d84bbf23b4a0e4"/>
<param name="apiKey" value="wxd0d84bbf23b4a0e4"/>
<param name="apiSecret" value="a354f72aa1b4c2b8eaad137ac81434cd"/>
<param name="androidApiKey" value="wxd0d84bbf23b4a0e4"/>
<param name="androidApiSecret" value="a354f72aa1b4c2b8eaad137ac81434cd"/>
<param name="universalLink" value="https://bjtest.apicloud.com"/>
</feature>
字段描述:
urlScheme：（必须配置）用于实现应用间跳转及数据交换，本应用可以启动微信客户端，也可以从微信客户端跳回本应用。urlScheme 的 value 值是从微信开放平台获取的 appid。appid 申请方法参考微信开放平台创建移动应用。
apiKey：（必须配置）从微信开放平台获取的 appid，值与 urlScheme 相同。appid 申请方法参考微信开放平台创建移动应用。
apiSecret：从微信开放平台获取的 secret。获取 accessToken 时需要配置此项。appid 申请方法参考微信开放平台创建移动应用。
androidApiKey：（必须配置）从微信开放平台获取的 appid，值与 urlScheme 相同。appid 申请方法参考微信开放平台创建移动应用，如果该字段配置Android优先读取该字段，如果没有配置该字段会默认使用apiKey字段，该字段仅支持Android。
androidApiSecret：从微信开放平台获取的 secret。获取 accessToken 时需要配置此项。appid 申请方法参考微信开放平台创建移动应用，如果该字段配置Android优先读取该字段，如果没有配置该字段会默认使用apiSecret字段，该字段仅支持Android。
universalLink：（必须配置） 微信开发者 Universal Link。确认微信的Universal Links正常。
2.创建 entitlements 文件，APICloud 平台上的开发者，可通过此文件告诉编译服务器开通 Associated Domain 功能。配置方法参考论坛帖子。配置示例如下：
```js
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>com.apple.developer.associated-domains</key>
<array>
<string>applinks:bjtest.apicloud.com</string>
</array>
</dict>
</plist>
```
其中 com.apple.developer.associated-domains 对应的值applinks:bjtest.apicloud.com 是配置的你的应用的 Universal Links。详情参考 苹果文档
3.开通 Associated Domains。 登录苹果开发者账号，在左侧列表里找到 Identifiers，选中后再找到你的 Bundle ID （包名），选中该包名，配置开启其 Associated Domains 功能。如下下图所示：
4.服务器端支持苹果 Universal Links。支持方法参考 论坛帖子。
Android 系统平台上需注意事项请参考微信集成注意事项
模块接口
isInstalled
判断当前设备是否安装微信客户端
isInstalled(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
installed: true //布尔型；true||false，当前设备是否安装微信客户端
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误），
//0（成功）
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.isInstalled(function(ret, err) {
if (ret.installed) {
alert("当前设备已安装微信客户端");
} else {
alert('当前设备未安装微信客户端');
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
shareText
分享文本内容
shareText({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
scene：
- 类型：字符串
- 描述：（可选项）场景
- 默认值：timeline
- 取值范围：
- timeline（朋友圈）
text：
- 类型：字符串
- 描述：分享的文本
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（apiKey非法）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareText({
apiKey: '',
scene: 'timeline',
text: '我分享的文本'
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
shareImage
分享图片内容
shareImage({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
scene：
- 类型：字符串
- 描述：（可选项）场景
- 默认值：timeline
- 取值范围：
- session（会话）
- timeline（朋友圈）
- favorite（收藏）
thumb：
- 类型：字符串
- 描述：缩略图片的地址，支持 fs://、widget:// 协议。大小不能超过32K
contentUrl：
- 类型：字符串
- 描述：分享图片的地址（支持 fs://、widget://），长度不能超过10M，（注：图片内容大小不超过 10MB，不是图片大小）
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（apiKey非法）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareImage({
apiKey: '',
scene: 'session',
thumb: 'widget://a.jpg',
contentUrl: 'widget://b.jpg'
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
shareMusic
分享网络音频资源
shareMusic({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
scene：
- 类型：字符串
- 描述：（可选项）场景
- 默认值：timeline
- 取值范围：
- session（会话）
- timeline（朋友圈）
- favorite（收藏）
title：
- 类型：字符串
- 描述：（可选项）分享网络音频的标题。
description：
- 类型：字符串
- 描述：（可选项）分享网络音频的描述。
thumb：
- 类型：字符串
- 描述：（可选项）分享网络音频的缩略图地址，要求本地路径（fs://、widget://）大小不能超过32K,需要路径包含图片格式后缀，否则如果原图片为非png格式，会分享失败
musicDataUrl：
- 类型：字符串
- 描述：（可选项）分享的音频数据 url 地址，长度不能超过10k。
contentUrl：
- 类型：字符串
- 描述：分享网络音频的 url 地址，长度不能超过10k。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（apiKey非法）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareMusic({
apiKey: '',
scene: 'timeline',
title: '测试标题',
description: '分享内容的描述',
thumb: 'widget://a.jpg',
contentUrl: 'https://developer.yonyou.com/docs/test/m.mp3'
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.code);
}
});
补充说明
仅支持分享网络音频资源
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
shareVideo
分享网络视频资源
shareVideo({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
scene：
- 类型：字符串
- 描述：（可选项）场景
- 默认值：timeline
- 取值范围：
- session（会话）
- timeline（朋友圈）
- favorite（收藏）
title：
- 类型：字符串
- 描述：（可选项）分享网络视频的标题。
description：
- 类型：字符串
- 描述：（可选项）分享网络视频的描述。由于微信平台限制，对不同平台部分场景本参数无效
thumb：
- 类型：字符串
- 描述：（可选项）分享网络视频的缩略图地址，要求本地路径（fs://、widget://）大小不能超过32K,需要路径包含图片格式后缀，否则如果原图片为非png格式，会分享失败
contentUrl：
- 类型：字符串
- 描述：分享网络视频的 url 地址，长度不能超过10k。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（apiKey非法）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareVideo({
apiKey: '',
scene: 'timeline',
title: '测试标题',
description: '分享内容的描述',
thumb: 'widget://a.jpg',
contentUrl: 'http://resource.apicloud.com/video/apicloud.mp4'
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.code);
}
});
补充说明
仅支持分享网络视频资源
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
shareWebpage
分享网页
特别注意：
在微信最新版本 6.7.2 上取消分享时 status 也返回 true，此为微信bug，等待微信修复更新。
shareWebpage({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
scene：
- 类型：字符串
- 描述：（可选项）场景
- 默认值：timeline
- 取值范围：
- session（会话）
- timeline（朋友圈）
- favorite（收藏）
title：
- 类型：字符串
- 描述：（可选项）分享网页的标题
description：
- 类型：字符串
- 描述：（可选项）分享网页的描述。由于微信平台限制，对不同平台部分场景本参数无效
thumb：
- 类型：字符串
- 描述：（可选项）分享网页的缩略图地址，要求本地路径（fs://、widget://）大小不能超过32K,需要路径包含图片格式后缀，否则如果原图片为非png格式，会分享失败
contentUrl：
- 类型：字符串
- 描述：分享网页的 url 地址，长度不能超过10k。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（apiKey非法）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareWebpage({
apiKey: '',
scene: 'timeline',
title: '测试标题',
description: '分享内容的描述',
thumb: 'widget://a.jpg',
contentUrl: 'http://apicloud.com'
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
shareProgram
分享小程序
shareProgram({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
scene：
- 类型：字符串
- 描述：（可选项）场景，目前只支持会话
- 默认值：session
title：
- 类型：字符串
- 描述：（可选项）分享小程序的标题
description：
- 类型：字符串
- 描述：（可选项）分享小程序的描述。由于微信平台限制，对不同平台部分场景本参数无效
thumb：
- 类型：字符串
- 描述：（可选项）分享小程序的缩略图地址，要求本地路径（fs://、widget://）大小不能超过32K,需要路径包含图片格式后缀，否则如果原图片为非png格式，会分享失败
webpageUrl：
- 类型：字符串
- 描述：兼容低版本微信的网页
- 注意：若客户端版本低于6.5.6，小程序类型分享将自动转成网页类型分享。开发者必须填写网页链接字段，确保低版本客户端能正常打开网页链接。
userName：
- 类型：字符串
- 描述：分享小程序的原始 id
path：
- 类型：字符串
- 描述：分享小程序的页面的路径
hdImageData：
- 类型：字符串
- 描述：小程序新版本的预览图的路径(128k)(android不支持)
withShareTicket：
- 类型：布尔
- 描述：是否使用带 shareTicket 的转发
miniProgramType：
- 类型：字符串
- 描述：分享小程序的版本（正式，开发，体验）
- 取值范围：
- release：正式版
- test：开发测试版
- preview：体验版
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（apiKey非法）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareProgram({
apiKey: '',
scene: 'session',
title: '测试标题',
description: '分享内容的描述',
thumb: 'widget://a.jpg',
webpageUrl: 'http://apicloud.com',
userName: '',
path: '',
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.2及更高版本
launchMiniProgram
拉起小程序功能
注：在同一开放平台账号下的移动应用及小程序无需关联即可完成跳转，非同一开放平台账号下的小程序需与移动应用（APP）成功关联后才支持跳转
launchMiniProgram({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
miniProgramType：
- 类型：字符串
- 描述：拉起小程序的类型
- 默认：test
- 取值范围：
- test：开发版
- preview：体验版
- release：正式版
userName：
- 类型：字符串
- 描述：拉起的小程序的username，小程序的原始ID
path：
- 类型：字符串
- 描述：拉起小程序页面的可带参路径，不填默认拉起小程序首页
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
eventType: 'launch', //字符串类型；交互事件类型，取值范围如下:
//launch：跳转到微信并拉起小程序事件(android不支持)
//back：跳转回本APP事件
status: true, //布尔型；是否拉起成功，仅当 eventType 为 launch 有值
extMsg: ‘’ //字符串类型；对应JsApi navigateBackApplication中的extraData字段数据，仅当 eventType 为 back 有值
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（apiKey非法）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.launchMiniProgram({
apiKey: '',
miniProgramType: 'test',
userName: '',
path: '',
}, function(ret, err) {
if (ret.status) {
alert('成功');
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.4及更高版本
subscribeMsg
一键订阅，详情参考 微信文档。
subscribeMsg({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
scene：
- 类型：数字
- 描述：重定向后会带上scene参数，开发者可以填0-10000 的整形值，用来标识订阅场值
templateId：
- 类型：字符串
- 描述：订阅消息模板ID，在微信开放平台提交应用审核通过后获得
reserved：
- 类型：字符串
- 描述：（可选项）用于保持请求和回调的状态，授权请后原样带回给第三方。该参数可用于防止csrf攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加session进行校验，开发者可以填写a-zA-Z0-9的参数值，最多128字节，要求做urlencode
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
eventType: 'back' //字符串类型；交互事件类型；取值范围：
//start:开始跳转微信
//error:发生错误
//back:订阅成功并从微信跳转回来
//backError：订阅失败并从微信跳转回来
templateId:, //字符串类型；
action: //字符串类型；
openId: //字符串类型；
reserved: //字符串类型；
scene: //数字类型；
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误）
//0（成功）
//1（templateId为空）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.subscribeMsg({
apiKey: '',
scene: 2,
templateId: '测试标题',
reserved: '分享内容的描述'
}, function(ret, err) {
if (ret.eventType == 'back') {
alert('订阅成功');
} else {
console.log(JSON.stringify(error));
}
});
可用性
iOS 系统，Android 系统
可提供的 1.1.2 及更高版本
openCustomerService
本接口封装了跳转微信客服功能，详情参考 微信客服功能。
openCustomerService({params}, callback(ret, err))
params
corpId：
- 类型：字符串
- 描述：企业ID
url：
- 类型：字符串
- 描述：客服URL
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: false //布尔类型；操作是否成功
extMsg:, //字符串类型；业务返回数据
type: //数字类型；响应类型
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；错误码，取值范围：
//-1（未知错误）
//0（成功）
//1（templateId为空）
//2（用户取消）
//3（发送失败）
//4（授权拒绝）
//5（微信服务器返回的不支持错误）
//7 (注册SDK失败)
errStr: //字符串类型；错误信息
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.openCustomerService({
corpId: 2,
url: ' '
}, function(ret, err) {
if (ret.status) {
console.log(JSON.stringify(ret));
} else {
console.log(JSON.stringify(err));
}
});
可用性
iOS 系统，Android 系统
可提供的 1.1.2 及更高版本
auth
登录授权（用于实现第三方登录），详情参考微信官方文档，移动登录开发指南
auth({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取，不传或传入错误的 apiKey，则无法打开微信进行登录。
scope：
- 类型：字符串
- 描述：（可选项）授权域，什么是授权域?
- 默认：snsapi_userinfo
state:
- 类型：字符串
- 描述：用于保持请求和回调的状态，授权请求后原样带回给第三方，该参数可用于防止 csrf 攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加 session 进行校验。在 state 传递的过程中会将该参数作为 url 的一部分进行处理，因此建议对该参数进行url encode操作，防止其中含有影响 url 解析的特殊字符（如'#'、'&'等）导致该参数无法正确回传。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //布尔型；true||false
code: '', //字符串类型；getToken 接口需传入此值，用于换取 accessToken
state:'', // 字符串类型；第三方程序发送时用来标识其请求的唯一性的标志，由第三方程序调用 sendReq 时传入，由微信终端回传，state 字符串长度不能超过 1K
lang:'', // 字符串类型；微信客户端当前语言
country:'' // 字符串类型；微信用户当前国家信息
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误），
//0（成功，用户同意）
//1 (用户取消)
//2 (用户拒绝授权)
//3 (当前设备未安装微信客户端)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.auth({
apiKey: ''
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getToken
获取授权 accessToken（需要登录授权成功）
本接口封装的微信获取 token 的接口，详情参考微信官方文档之-----第二步：通过code获取access_token
开发者可不通过本接口来获取token，可自行访问微信接口获取。
getToken({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
apiSecret
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 secret，若不传则从当前 widget 的 config.xml 中读取。
code
- 类型：字符串
- 描述：通过 auth 接口授权成功后返回的 code 参数
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //布尔型；true||false
accessToken: '', //字符串类型；接口调用凭证，传给 getUserInfo 接口 获取用户信息；有效期2小时
dynamicToken: '', //字符串类型；当 accessToken 过期时把该值传给 refreshToken 接口刷新 accessToken 的有效期。dynamicToken 的有效期为30天
expires: 7200, //数字类型；accessToken 有效期，单位（秒）
openId: '' //字符串类型；授权用户唯一标识
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误），
//0 （成功）
//1 (apiKey值为空或非法)
//2 (apiSecret值为空或非法)
//3 (code值为空或非法)
//4 (网络超时)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.getToken({
apiKey: '',
apiSecret: '',
code: "12346857684"
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(err.code);
}
});
补充说明
此接口需要访问网络，异步调用 callback 需要一段时间才能返回 accessToken
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
getUserInfo
获取用户信息（需要获取 accessToken 成功）
本接口封装的微信获取用户信息的接口，详情参考微信官方文档之-----第三步：通过access_token调用接口
开发者可不通过本接口来获取，可自行访问微信接口获取。
getUserInfo({params}, callback(ret, err))
params
accessToken：
- 类型：字符串
- 描述：getToken 接口或 refreshToken 接口成功获取的 accessToken 值
openId：
- 类型：字符串
- 描述：getToken 接口或 refreshToken 接口成功获取的 openId 值
lang：
- 类型：字符串
- 描述：（可选项）国家地区语言版本
- 默认：zh_CN
- 取值范围：
- zh_CN 简体
- zh_TW 繁体
- en 英语
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //布尔型；true||false
openid: '', //字符串类型；普通用户的标识，对当前开发者帐号唯一
nickname: '', //字符串类型；普通用户昵称
sex: 1, //数字类型；普通用户性别，1为男性，2为女性
headimgurl: '', //字符串类型；用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空
privilege: [], //数组类型；用户特权信息，如微信沃卡用户为（chinaunicom）
unionid: '' //字符串类型；用户统一标识。针对一个微信开放平台帐号下的应用，同一用户的unionid是唯一的。
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误），
//0 （成功）,
//1 （accessToken 过期）,
//2 (openId非法),
//3 (openId值为空),
//4 (accessToken值为空),
//5 (accessToken非法)
//6 (网络超时)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.getUserInfo({
accessToken: '',
openId: ''
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(err.code);
}
});
补充说明
此接口需要访问网络，异步调用 callback 需要一段时间才能返回用户信息
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
refreshToken
调用 getUserInfo 接口错误码返回1时，代表 accessToken 过期，调用此接口刷新 accessToken
本接口封装的微信刷新 token 的接口。详情参考微信官方文档之-----第三步：通过access_token调用接口
开发者可不通过本接口刷新，可自行访问微信接口刷新。
refreshToken({params}, callback(ret, err))
params
apiKey：
- 类型：字符串
- 描述：（可选项）从微信开放平台获取的 appid，若不传则从当前 widget 的 config.xml 中读取。
dynamicToken：
- 类型：字符串
- 描述：getToken 接口或 refreshToken 接口获取的 dynamicToken 值
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //布尔型；true||false
accessToken: '', //字符串类型；接口调用凭证，传给 getUserInfo 接口 获取用户信息；有效期2小时
dynamicToken: '', //字符串类型；当 accessToken 过期时把该值传给 refreshToken 接口刷新 accessToken 的有效期。dynamicToken 的有效期为30天
expires: 7200, //数字类型；accessToken 有效期，单位（秒）
openId: '' //字符串类型；授权用户唯一标识
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 //数字类型；
//错误码：
//-1（未知错误），
//0（成功）,
//1（apiKey值为空或非法），
//2（refreshToken值为空）,
//3（refreshToken非法），
//4（网络超时）
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.refreshToken({
apiKey: '',
dynamicToken: ''
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(err.code);
}
});
补充说明
此接口需要访问网络，异步调用 callback 需要一段时间才能返回 accessToken
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
shareMutableImg
分享多张图片到朋友圈，暂仅支持 Android 平台，iOS 平台可使用 shareAction 模块来实现多图分享。注意：由于不是使用的官方sdk进行的分享，而是直接调用的微信客户端的分享界面，分享后无法回到原应用，且微信端不会给出是否分享成功的反馈，所以本接口暂无回调
shareMutableImg({params})
params
imgs：
- 类型：数组
- 描述：要分享的图片的路径组成的数组，要求本地路径（fs://、widget://）
description：
- 类型：字符串
- 描述：分享的文字
- 注意：由于微信升级的原因，此字段废除，
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareMutableImg({
description: 'weixin share image test description',
imgs: ['widget://res/1.png', 'widget://res/12.jpg', 'widget://res/123.jpg']
});
可用性
Android系统
可提供的1.0.0及更高版本
addJumpFromWxListener
监听从微信打开本 App 的事件和参数
addJumpFromWxListener(callback(ret))
callback
ret：
- 类型：JSON对象
- 描述：小程序打开APP，小程序给app带的参数
- 内部字段：
{
lang:'', //字符串类型;
country:'', //字符串类型;
type:, //数字类型;
openid:'', //字符串类型;
message: { //JSON对象
title, //字符串类型;
description:'', //字符串类型;
mediaTagName:'' //字符串类型;
messageExt:'', //字符串类型;
messageAction:''//字符串类型;
},
reqType: '', //字符串类型：微信调用本 App 的事件类型，取值范围：
//show：微信向本 App 发送的要求本App 处理的多媒体内容，处理完后调用 sendShowMessageResp 接口回发给微信
//launch：微信向本 App 发送的结构体，本 App 不需要返回
//get：微信向本 App 请求提供内容，调用 sendGetMessageResp 接口回发给微信
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.addJumpFromWxListener(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.5及更高版本
sendShowMessageResp
本 App 处理完后向微信发送的处理结果。
sendShowMessageResp({params},callback(ret))
params
type：
- 类型：数字
- 描述：类型
errStr
- 类型：字符串
- 描述：错误信息
errCode
- 类型：数字
- 描述：错误码
callback
ret：
- 类型：JSON对象
- 描述：小程序打开APP，小程序给app带的参数
- 内部字段：
{
status: //布尔类型;
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.sendShowMessageResp({
type:,
errCode:,
errStr:''
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.5及更高版本
sendGetMessageResp
本 App 处理完后向微信发送的处理结果。
sendGetMessageResp({params},callback(ret))
params
type
- 类型：数字
- 描述：类型
errStr
- 类型：字符串
- 描述：错误信息
errCode
- 类型：数字
- 描述：错误码
text
- 类型：字符串
- 描述：（可选项）存文本消息内容，与 message 为互斥参数
message
- 类型：JSON对象
- 描述：（可选项）多媒体消息
- 内部字段：
{
title: '', //字符串类型；消息的标题
description:'', //字符串类型；描述
thumb'', //字符串类型；缩略图地址，要求本地路径（fs://、widget://）**大小不能超过32K,需要路径包含图片格式后缀，否则如果原图片为非png格式，会分享失败**
mediaTagName:'', //字符串类型；描述
messageExt:'', //字符串类型；描述
messageAction:'', //字符串类型；描述
media: { //JSON对象；多媒体消息体
imageUrl:'', //字符串类型：图片地址，type为0时有效
musicUrl:'', //字符串类型：音乐网页地址，type为1时有效
musicDataUrl:'', //字符串类型：音乐文件地址，type为1时有效
videoUrl'', //字符串类型：视频文件地址，type为2时有效
webpageUrl'', //字符串类型：网页地址，type为3、4时有效。为4时若客户端版本低于6.5.6，小程序类型分享将自动转成网页类型分享。开发者必须填写网页链接字段，确保低版本客户端能正常打开网页链接。
userName:'', //字符串;分享小程序的原始 id
path:'', //字符串;分享小程序的页面的路径
hdImageData:'', //字符串;小程序新版本的预览图的路径(128k)
withShareTicket: , //布尔;是否使用带 shareTicket 的转发
miniProgramType:'', //字符串;分享小程序的版本（正式，开发，体验），取值范围：
//release：正式版
//test：开发测试版
//preview：体验版
type:0 //数字类型；类型，取值范围：
//0:图片
//1:音频
//2:视频
//3:网页
//4:小程序
}
}
callback
ret：
- 类型：JSON对象
- 描述：小程序打开APP，小程序给app带的参数
- 内部字段：
{
status: //布尔类型;
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.sendGetMessageResp({
type:...
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.5及更高版本
shareMusicVideo
音乐视频类型分享
shareMusicVideo({params}, callback(ret, err))
params
scene：
- 类型：字符串
- 描述：（可选项）场景
- 默认值：timeline
- 取值范围：
- session（会话）
- timeline（朋友圈）
- favorite（收藏）
musicUrl：
- 类型：字符串
- 描述：音频网页的 URL 地址 （必填）
musicDataUrl：
- 类型：字符串
- 描述：音频数据的 URL 地址 （必填）
singerName：
- 类型：字符串
- 描述：歌手名 （必填）
duration
- 类型：数字
- 描述：歌曲时长（单位：毫秒）（必填）
songLyric：
- 类型：字符串
- 描述：歌词 （建议填写，限制长度不超过32KB）
albumName：
- 类型：字符串
- 描述：音乐专辑名
musicGenre：
- 类型：字符串
- 描述：音乐流派
issueDate：
- 类型：数字
- 描述：发行时间Unix时间戳 （单位：秒）
title:
- 类型：字符串
- 描述：歌曲名称（必填）
description：
- 类型：字符串
- 描述：歌曲描述 （建议与歌手名字段 singerName 保持一致）
messageExt：
- 类型：字符串
- 描述：额外信息
thumbData：
- 类型：字符串
- 描述：音乐卡片缩略图路径, 不超过64KB（支持widget:// & fs://）
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON 对象
- 内部字段：
{
code: 0 // 数字类型；
// 错误码：
// -1（未知错误），
// 0（成功）,
// 1（accessToken 过期）,
// 2 (openId非法),
// 3 (openId值为空),
// 4 (accessToken值为空),
// 5 (accessToken非法)
// 6 (网络超时)
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.shareMusicVideo({
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(err.code);
}
});
补充说明
音乐视频类型使用说明：
注意事项： 音乐视频类型与音乐类型不同，分享至微信的音乐视频消息，直接点击好友会话或朋友圈下的分享内容会跳转到微信原生播放器，可以对音乐作品辅以视频制作成音乐视频，进行点赞、评论、发送给朋友、分享到朋友圈、发布至视频号等。 在播放器里点击跳转入口会跳转回App，没有安装App时会打开musicUrl链接。 音乐视频类型分享，请开发者特别注意必填的字段有： WXMediaMessage.title：歌曲名称 WXMusicVideoObject.musicUrl：音频网页的 URL 地址 WXMusicVideoObject.musicDataUrl：音频数据的 URL 地址 WXMusicVideoObject.singerName：歌手名 WXMusicVideoObject.duration：歌曲时长，单位为毫秒
注意事项
发起分享的 App 与小程序属于同一微信开放平台帐号。
支持分享小程序类型消息至会话，暂不支持分享至朋友圈。
若客户端版本低于 6.5.6 或在 iPad 客户端接收，小程序类型分享将自动转成网页类型分享。开发者必须填写网页链接字段，确保低版本客户端能正常打开网页链接。
对于音乐类型的分享，需按照如下格式发送邮件至 weixin-open@qq.com：
邮件主题：帐号XXX关于音乐类 appmsg 的分享功能申请；
邮件内容：需提供移动应用 appid 和需分享的音频网页的域名信息；
要求：申请帐号需为已完成主体认证的帐号。
对于音乐视频类型的分享，需按照如下格式发送邮件至 hansenxu@tencent.com
邮件主题：帐号XXX关于音乐视频类 appmsg 的分享功能申请；
邮件内容：需提供移动应用 appid 和需分享的音频网页的域名信息；
要求： 申请帐号需为已完成主体认证的帐号； 申请“音乐视频类型的分享权限”需先完成“音乐类型的分享权限”申请，且申请的移动应用的 appid 和域名需一致； 音乐视频类型的分享权限会涉及到相关法务协议的签署，具体签订流程和开通结果请参考邮件回复结果。
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
startWeiXinCard
跳转微信卡包
startWeiXinCard(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:, //布尔类型，是否成功
info:{} //json对象；发票信息
}
示例代码
var wxPlus = api.require('wxPlus');
wxPlus.startWeiXinCard(function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.1.6及更高版本