WeChat JS-SDK Description-Open Interface Description

Basic interface

Determine whether the current client version supports the specified JS interface

 wx.checkJsApi({
 jsApiList: ['chooseImage'], // List of JS interfaces that need to be detected. For a list of all JS interfaces, see Appendix 2.
 success: function(res) {
 // Return as a key-value pair, true for available APIs and false for unavailable APIs
        // For example: {"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}
 });

Note: checkJsApi is a reserved interface newly introduced in client 6.0.2. All interfaces opened in the first phase can be detected without using checkJsApi.

Sharing interface

Please be careful not to engage in any illegal behavior such as inducing sharing. For any behavior of inducing sharing, the public account interface permissions will be permanently revoked. For detailed rules, please see: Frequently Asked Questions about Moments Management.

Get the "Share to Moments" button click status and customize the sharing content interface

 wx.onMenuShareTimeline({
 title: '', // Share title
 link: '', // Share link
 imgUrl: '', // share icon
 success: function () {
 //Callback function executed after the user confirms sharing
 },
 cancel: function () {
 //Callback function executed after the user cancels sharing
 }
 });

Get the "Share with Friends" button click status and customize the sharing content interface

 wx.onMenuShareAppMessage({
 title: '', // Share title
 desc: '', // Share description
 link: '', // Share link
 imgUrl: '', // share icon
 type: '', // Sharing type, music, video or link, if not filled in, the default is link
 dataUrl: '', // If type is music or video, a data link must be provided, empty by default
 success: function () {
 //Callback function executed after the user confirms sharing
 },
 cancel: function () {
 //Callback function executed after the user cancels sharing
 }
 });

Get the "Share to QQ" button click status and customize the sharing content interface

 x.onMenuShareQQ({
 title: '', // Share title
 desc: '', // Share description
 link: '', // Share link
 imgUrl: '' // Share icon
 success: function () {
 //Callback function executed after the user confirms sharing
 },
 cancel: function () {
 //Callback function executed after the user cancels sharing
 }
 });

Get the "Share to Tencent Weibo" button click status and customize the sharing content interface

 wx.onMenuShareWeibo({
 title: '', // Share title
 desc: '', // Share description
 link: '', // Share link
 imgUrl: '' // Share icon
 success: function () {
 //Callback function executed after the user confirms sharing
 },
 cancel: function () {
 //Callback function executed after the user cancels sharing
 }
 });

Graphics interface

Interface for taking photos or selecting pictures from mobile phone albums

 wx.chooseImage({
 success: function (res) {
 var localIds = res .localIds; // Returns the local ID list of the selected photo. The localId can be used as the src attribute of the img tag to display the image.
 }
 });

Preview image interface

 wx.previewImage({
 current: '', // Currently displayed image link
 urls: [] // List of image links to be previewed
 });

Upload picture interface

 wx.uploadImage({
 localId: '', // The local ID of the image to be uploaded, obtained by the chooseImage interface
 isShowProgressTips: 1, // Default is 1, show progress tips
 success: function (res) {
 var serverId = res .serverId; // Returns the server ID of the image
 }
 });

Note: The uploaded image is valid for 3 days. You can use the WeChat multimedia interface to download the image to your own server. The serverId obtained here is media_id. Please refer to the document../12/58bfcfabbd501c7cd77c19bd9cfa8354.html. The frequency limit of the multimedia file download interface is currently 10,000 times. If you need to increase the frequency, please email [email protected] with the subject of [Apply for multimedia interface call quantity]. Please briefly describe your project, attach a product experience link, and explain the number of users and usage.

Download image interface

 wx.downloadImage({
 serverId: '', // The server ID of the image to be downloaded, obtained by the uploadImage interface
 isShowProgressTips: 1, // Default is 1, show progress tips
 success: function (res) {
 var localId = res .localId; // Returns the local ID of the downloaded image
 }
 });

Audio Interface

Start recording interface

 wx.startRecord();

Stop recording interface

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

Monitor recording automatic stop interface

 wx.onVoiceRecordEnd({
 // The complete callback will be executed when the recording time exceeds one minute without stopping
    complete: function (res) {
        var localId = res .localId;
 }
 });

Play voice interface

 wx.playVoice({
 localId: '' // The local ID of the audio to be played, obtained by the stopRecord interface
 });

Pause playback interface

 wx.pauseVoice({
 localId: '' // The local ID of the audio to be paused, obtained by the stopRecord interface
 });

Stop Playing Interface

 wx.stopVoice({
 localId: '' // The local ID of the audio to be stopped, obtained by the stopRecord interface
 });

Monitor the voice playback completion interface

 wx.onVoicePlayEnd({
 success: function (res) {
 var localId = res .localId; // Returns the local ID of the audio
 }
 });

Upload voice interface

 wx.uploadVoice({
 localId: '', // The local ID of the audio to be uploaded, obtained by the stopRecord interface
 isShowProgressTips: 1, // Default is 1, show progress tips
        success: function (res) {
 var serverId = res .serverId; // Returns the server ID of the audio
 }
 });

Note: The uploaded voice is valid for 3 days. You can use the WeChat multimedia interface to download the voice to your own server. The serverId obtained here is media_id. Please refer to the document../12/58bfcfabbd501c7cd77c19bd9cfa8354.html. The frequency limit of the multimedia file download interface is currently 10,000 times. If you need to increase the frequency, please email [email protected] with the subject of [Apply for multimedia interface call quantity]. Please briefly describe your project, attach a product experience link, and explain the number of users and usage.

Download Voice Interface

 wx.downloadVoice({
 serverId: '', // The server ID of the audio to be downloaded, obtained from the uploadVoice interface
 isShowProgressTips: 1, // Default is 1, show progress tips
 success: function (res) {
 var localId = res .localId; // Returns the local ID of the audio
 }
 });

Smart Interface

Recognize audio and return recognition result interface

 wx.translateVoice({
 localId: '', // The local ID of the audio to be identified, obtained from the recording related interface
 isShowProgressTips: 1, // Default is 1, show progress tips
 success: function (res) {
 alert(res.translateResult); // Speech recognition result
 }
 });

Device Information

Get network status interface

 wx.getNetworkType({
 success: function (res) {
 var networkType = res .networkType; // Returns network type 2g, 3g, 4g, wifi
 }
 });

Location

Use WeChat built-in map to view location interface

 wx.openLocation({
 latitude: 0, // latitude, floating point number, range is 90 ~ -90
 longitude: 0, // Longitude, floating point number, range is 180 ~ -180.
 name: '', // location name
 address: '', // Address details
 scale: 1, // Map zoom level, integer value, ranging from 1 to 28. The default is the maximum
 infoUrl: '' // The hyperlink displayed at the bottom of the viewing location interface, you can click to jump
 });

Get geographic location interface

 wx.getLocation({
 success: function (res) {
 var latitude = res .latitude; // Latitude, floating point number, range is 90 ~ -90
 var longitude = res .longitude; // Longitude, floating point number, range is 180 ~ -180.
 var speed = res .speed; // speed in meters per second
 var accuracy = res .accuracy; // Position accuracy
 }
 });