微信JS-SDK说明-已开放接口说明-微信api接口

基础接口

判断当前客户端版本是否支持指定JS接口

wx.checkJsApi({ 
    jsApiList: ['chooseImage'], // 需要检测的JS接口列表，所有JS接口列表见附录2, 
    success: function(res) { 
        // 以键值对的形式返回，可用的api值true，不可用为false 
        // 如：{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"} 
    });

备注：checkJsApi接口是客户端6.0.2新引入的一个预留接口，第一期开放的接口均可不使用checkJsApi来检测。

分享接口

请注意不要有诱导分享等违规行为，对于诱导分享行为将永久回收公众号接口权限，详细规则请查看：朋友圈管理常见问题。

获取“分享到朋友圈”按钮点击状态及自定义分享内容接口

wx.onMenuShareTimeline({ 
    title: '', // 分享标题 
    link: '', // 分享链接 
    imgUrl: '', // 分享图标 
    success: function () {  
        // 用户确认分享后执行的回调函数 
    }, 
    cancel: function () {  
        // 用户取消分享后执行的回调函数 
    } 
});

获取“分享给朋友”按钮点击状态及自定义分享内容接口

wx.onMenuShareAppMessage({ 
    title: '', // 分享标题 
    desc: '', // 分享描述 
    link: '', // 分享链接 
    imgUrl: '', // 分享图标 
    type: '', // 分享类型,music、video或link，不填默认为link 
    dataUrl: '', // 如果type是music或video，则要提供数据链接，默认为空 
    success: function () {  
        // 用户确认分享后执行的回调函数 
    }, 
    cancel: function () {  
        // 用户取消分享后执行的回调函数 
    } 
});

获取“分享到QQ”按钮点击状态及自定义分享内容接口

x.onMenuShareQQ({ 
    title: '', // 分享标题 
    desc: '', // 分享描述 
    link: '', // 分享链接 
    imgUrl: '' // 分享图标 
    success: function () {  
       // 用户确认分享后执行的回调函数 
    }, 
    cancel: function () {  
       // 用户取消分享后执行的回调函数 
    } 
});

获取“分享到腾讯微博”按钮点击状态及自定义分享内容接口

wx.onMenuShareWeibo({ 
    title: '', // 分享标题 
    desc: '', // 分享描述 
    link: '', // 分享链接 
    imgUrl: '' // 分享图标 
    success: function () {  
       // 用户确认分享后执行的回调函数 
    }, 
    cancel: function () {  
        // 用户取消分享后执行的回调函数 
    } 
});

图像接口

拍照或从手机相册中选图接口

wx.chooseImage({ 
    success: function (res) { 
        var localIds = res.localIds; // 返回选定照片的本地ID列表，localId可以作为img标签的src属性显示图片 
    } 
});

预览图片接口

wx.previewImage({ 
    current: '', // 当前显示的图片链接 
    urls: [] // 需要预览的图片链接列表 
});

上传图片接口

wx.uploadImage({ 
    localId: '', // 需要上传的图片的本地ID，由chooseImage接口获得 
    isShowProgressTips: 1, // 默认为1，显示进度提示 
    success: function (res) { 
        var serverId = res.serverId; // 返回图片的服务器端ID 
    } 
});

备注：上传图片有效期3天，可用微信多媒体接口下载图片到自己的服务器，此处获得的 serverId 即 media_id，参考文档 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html 目前多媒体文件下载接口的频率限制为10000次，如需要调高频率，请邮件weixin-open@qq.com,邮件主题为【申请多媒体接口调用量】，请对你的项目进行简单描述，附上产品体验链接，并对用户量和使用量进行说明。

下载图片接口

wx.downloadImage({ 
    serverId: '', // 需要下载的图片的服务器端ID，由uploadImage接口获得 
    isShowProgressTips: 1, // 默认为1，显示进度提示 
    success: function (res) { 
        var localId = res.localId; // 返回图片下载后的本地ID 
    } 
});

音频接口

开始录音接口

wx.startRecord();

停止录音接口

wx.stopRecord({ 
    success: function (res) { 
        var localId = res.localId; 
    } 
});

监听录音自动停止接口

wx.onVoiceRecordEnd({ 
    // 录音时间超过一分钟没有停止的时候会执行 complete 回调 
    complete: function (res) { 
        var localId = res.localId;  
    } 
});

播放语音接口

wx.playVoice({ 
    localId: '' // 需要播放的音频的本地ID，由stopRecord接口获得 
});

暂停播放接口

wx.pauseVoice({ 
    localId: '' // 需要暂停的音频的本地ID，由stopRecord接口获得 
});

停止播放接口

wx.stopVoice({ 
    localId: '' // 需要停止的音频的本地ID，由stopRecord接口获得 
});

监听语音播放完毕接口

wx.onVoicePlayEnd({ 
    success: function (res) { 
        var localId = res.localId; // 返回音频的本地ID 
    } 
});

上传语音接口

wx.uploadVoice({ 
    localId: '', // 需要上传的音频的本地ID，由stopRecord接口获得 
    isShowProgressTips: 1, // 默认为1，显示进度提示 
        success: function (res) { 
        var serverId = res.serverId; // 返回音频的服务器端ID 
    } 
});

备注：上传语音有效期3天，可用微信多媒体接口下载语音到自己的服务器，此处获得的 serverId 即 media_id，参考文档 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html 目前多媒体文件下载接口的频率限制为10000次，如需要调高频率，请邮件weixin-open@qq.com,邮件主题为【申请多媒体接口调用量】，请对你的项目进行简单描述，附上产品体验链接，并对用户量和使用量进行说明。

下载语音接口

wx.downloadVoice({ 
    serverId: '', // 需要下载的音频的服务器端ID，由uploadVoice接口获得 
    isShowProgressTips: 1, // 默认为1，显示进度提示 
    success: function (res) { 
        var localId = res.localId; // 返回音频的本地ID 
    } 
});

智能接口

识别音频并返回识别结果接口

wx.translateVoice({ 
   localId: '', // 需要识别的音频的本地Id，由录音相关接口获得 
    isShowProgressTips: 1, // 默认为1，显示进度提示 
    success: function (res) { 
        alert(res.translateResult); // 语音识别的结果 
    } 
});

设备信息

获取网络状态接口

wx.getNetworkType({ 
    success: function (res) { 
        var networkType = res.networkType; // 返回网络类型2g，3g，4g，wifi 
    } 
});

地理位置

使用微信内置地图查看位置接口

wx.openLocation({ 
    latitude: 0, // 纬度，浮点数，范围为90 ~ -90 
    longitude: 0, // 经度，浮点数，范围为180 ~ -180。 
    name: '', // 位置名 
    address: '', // 地址详情说明 
    scale: 1, // 地图缩放级别,整形值,范围从1~28。默认为最大 
    infoUrl: '' // 在查看位置界面底部显示的超链接,可点击跳转 
});

获取地理位置接口

wx.getLocation({ 
    success: function (res) { 
        var latitude = res.latitude; // 纬度，浮点数，范围为90 ~ -90 
        var longitude = res.longitude; // 经度，浮点数，范围为180 ~ -180。 
        var speed = res.speed; // 速度，以米/每秒计 
        var accuracy = res.accuracy; // 位置精度 
    } 
});