Instruksi dasar
Petunjuk Penggunaan
1.Tentroduce file JS
Perkenalkan file JS berikut pada halaman yang perlu memanggil antarmuka JS (dukungan https): http://res.wx.qq.com/open/js/jweixin-1.0.0.js
CATATAN: PEMBUATAN DUKUNGAN Menggunakan metode pemuatan modul AMD/CMD Modul
2. Suntikkan dan konfigurasikan antarmuka konfigurasi
Semua halaman yang perlu menggunakan JSSDK terlebih dahulu harus menyuntikkan informasi konfigurasi, jika tidak mereka tidak akan dipanggil (URL yang sama perlu dipanggil hanya sekali, dan aplikasi web spa yang mengubah URL dapat dipanggil setiap kali URL berubah).
Salinan kode adalah sebagai berikut:
wx.config ({
DEBUG: Benar, // Nyalakan mode debug, nilai pengembalian semua API yang disebut akan diberitahu pada klien. Untuk melihat parameter yang diteruskan, Anda dapat membukanya di sisi PC. Informasi parameter akan dicetak melalui log dan hanya akan dicetak di sisi PC.
Appid: '', // Diperlukan, pengidentifikasi unik dari akun resmi
Timestamp:, // Diperlukan untuk menghasilkan cap waktu tanda tangan
NONCEST: '', // Diperlukan untuk menghasilkan string tanda tangan acak
Tanda Tangan: '', // Diperlukan, tanda tangan, lihat Lampiran 1
JSAPILIST: [] // Diperlukan, daftar antarmuka JS yang perlu digunakan, dan daftar semua antarmuka JS ditampilkan dalam Lampiran 2
});
3. Verifikasi melalui antarmuka siap
Salinan kode adalah sebagai berikut:
wx.ready (function () {
// Setelah informasi konfigurasi diverifikasi, metode Ready akan dieksekusi. Semua panggilan antarmuka harus diperoleh setelah antarmuka konfigurasi mendapatkan hasilnya. Config adalah operasi klien yang tidak sinkron. Oleh karena itu, jika Anda perlu memanggil antarmuka yang relevan saat halaman dimuat, antarmuka yang relevan harus ditempatkan dalam fungsi siap untuk dipanggil untuk memastikan eksekusi yang benar. Untuk antarmuka yang dipanggil hanya ketika pengguna memicu, mereka dapat dipanggil secara langsung tanpa menempatkannya dalam fungsi siap.
});
4. Verifikasi Antarmuka kesalahan gagal
Salinan kode adalah sebagai berikut:
wx.error (function (res) {
// Jika verifikasi informasi konfigurasi gagal, fungsi kesalahan akan dijalankan. Jika tanda tangan berakhir, verifikasi akan gagal. Untuk pesan kesalahan tertentu, Anda dapat membuka mode debug konfigurasi untuk dilihat, atau Anda dapat melihatnya di parameter res yang dikembalikan. Untuk Spa, Anda dapat memperbarui tanda tangan di sini.
});
Instruksi Panggilan Antarmuka
Semua antarmuka dipanggil melalui objek WX (juga dapat digunakan dengan objek jweixin). Parameter adalah objek. Selain parameter yang perlu dilewati setiap antarmuka itu sendiri, ada juga parameter umum berikut:
Sukses: Fungsi panggilan balik yang dieksekusi ketika antarmuka berhasil.
Gagal: Fungsi panggilan balik dieksekusi ketika antarmuka panggilan gagal.
Lengkap: Fungsi callback dieksekusi ketika antarmuka panggilan selesai, dan akan dieksekusi terlepas dari keberhasilan atau kegagalan.
Batal: Fungsi panggilan balik ketika pengguna mengklik untuk membatalkan, hanya beberapa API yang memiliki pengguna membatalkan operasi yang akan digunakan.
Pemicu: Metode yang mendengarkan pemicu saat tombol diklik di menu. Metode ini hanya mendukung antarmuka terkait dalam menu.
Fungsi di atas semuanya memiliki parameter, tipe objek, selain data yang dikembalikan oleh setiap antarmuka itu sendiri, ada juga ERRMSG properti umum, yang format nilainya adalah sebagai berikut:
Saat panggilan berhasil: "xxx: ok", di mana xxx adalah nama antarmuka panggilan
Saat pengguna membatalkan: "xxx: batal", di mana xxx adalah nama antarmuka yang disebut
Saat panggilan gagal: nilainya adalah pesan kesalahan spesifik
Antarmuka dasar
Tentukan apakah versi klien saat ini mendukung antarmuka JS yang ditentukan
Salinan kode adalah sebagai berikut:
wx.checkjsapi ({
JSAPILIST: ['PilihImage'] // Daftar antarmuka JS yang perlu dideteksi, lihat Lampiran 2 untuk semua daftar antarmuka JS.
Sukses: function (res) {
// Kembali sebagai pasangan nilai kunci, nilai API yang tersedia adalah benar, dan tidak tersedia untuk false
// misalnya: {"checkResult": {"pilihImage": true}, "errmsg": "checkjsapi: ok"}
});
Berbagi Antarmuka
Dapatkan status klik tombol "Bagikan ke Moments" dan sesuaikan antarmuka konten berbagi
Salinan kode adalah sebagai berikut:
wx.onmenusharetimeline ({
Judul: '', // Bagikan Judul
Tautan: '', // Bagikan Tautan
Imgurl: '', // Bagikan Ikon
Sukses: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna mengonfirmasi berbagi
},
Batal: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna membatalkan berbagi
}
});
Dapatkan status klik tombol "Bagikan ke Teman" dan sesuaikan antarmuka konten berbagi
Salinan kode adalah sebagai berikut:
wx.onmenushareAppMessage ({
Judul: '', // Bagikan Judul
desc: '', // berbagi deskripsi
Tautan: '', // Bagikan Tautan
Imgurl: '', // Bagikan Ikon
Ketik: '', // Jenis berbagi, musik, video atau tautan, jika tidak diisi, defaultnya adalah tautan
DataUrl: '', // Jika jenisnya adalah musik atau video, tautan data disediakan, standarnya kosong
Sukses: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna mengonfirmasi berbagi
},
Batal: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna membatalkan berbagi
}
});
Dapatkan status klik tombol "Bagikan ke QQ" dan sesuaikan antarmuka konten berbagi
Salinan kode adalah sebagai berikut:
wx.onmenushareqq ({
Judul: '', // Bagikan Judul
desc: '', // berbagi deskripsi
Tautan: '', // Bagikan Tautan
Imgurl: '' // Bagikan Ikon
Sukses: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna mengonfirmasi berbagi
},
Batal: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna membatalkan berbagi
}
});
Dapatkan status klik tombol "Bagikan ke Tencent Weibo" dan sesuaikan antarmuka konten berbagi
Salinan kode adalah sebagai berikut:
wx.onmenushareweibo ({
Judul: '', // Bagikan Judul
desc: '', // berbagi deskripsi
Tautan: '', // Bagikan Tautan
Imgurl: '' // Bagikan Ikon
Sukses: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna mengonfirmasi berbagi
},
Batal: function () {
// Fungsi panggilan balik dieksekusi setelah pengguna membatalkan berbagi
}
});
Antarmuka gambar
Ambil gambar atau pilih gambar dari antarmuka album ponsel
Salinan kode adalah sebagai berikut:
wx.chooseimage ({
Sukses: function (res) {
var localids = res.localids; // Mengembalikan daftar ID lokal dari foto yang dipilih. LocalID dapat menampilkan gambar sebagai atribut SRC dari tag IMG
}
});
Pratinjau antarmuka gambar
Salinan kode adalah sebagai berikut:
wx.previewImage ({
Saat ini: '', // tautan ke gambar yang saat ini ditampilkan
URL: [] // Daftar tautan gambar yang perlu dipratinjau
});
Unggah antarmuka gambar
Salinan kode adalah sebagai berikut:
wx.uploadimage ({
localid: '', // ID lokal dari gambar yang akan diunggah, diperoleh dengan antarmuka pilihan
IsShowProgressTips: 1 // default adalah 1, menampilkan prompt kemajuan
Sukses: function (res) {
var serverid = res.serverId; // mengembalikan ID sisi server gambar
}
});
Catatan: Anda dapat mengunduh gambar yang diunggah oleh WeChat menggunakan antarmuka file multimedia. ServerID yang diperoleh di sini adalah media_id. Dokumen referensi ../ 12/58BFCFABBD501C7CD77C19BD9CFA8354.html
Unduh antarmuka gambar
Salinan kode adalah sebagai berikut:
wx.downloadImage ({
ServerID: '', // ID sisi server dari gambar yang akan diunduh, diperoleh dari antarmuka unggah
IsShowProgressTips: 1 // default adalah 1, menampilkan prompt kemajuan
Sukses: function (res) {
var localid = res.localid; // Kembalikan ID lokal setelah gambar diunduh
}
});
Antarmuka audio
Mulai perekaman antarmuka
Salinan kode adalah sebagai berikut:
wx.startrecord ();
Berhenti merekam antarmuka
Salinan kode adalah sebagai berikut:
wx.stoprecord ({
Sukses: function (res) {
var localid = res.localid;
}
});
Antarmuka berhenti otomatis untuk memantau perekaman
Salinan kode adalah sebagai berikut:
wx.onvoicerecordend ({
// Callback lengkap akan dieksekusi ketika waktu perekaman lebih dari satu menit dan tidak berhenti.
Lengkap: function (res) {
var localid = res.localid;
}
});
Mainkan antarmuka suara
Salinan kode adalah sebagai berikut:
wx.playvoice ({
LocalId: '' // ID lokal audio yang akan dimainkan, diperoleh oleh Antarmuka StopRecord
});
Jeda antarmuka pemutaran
Salinan kode adalah sebagai berikut:
wx.pausevoice ({
localid: '' // ID lokal audio yang perlu dijeda, diperoleh oleh stoprecord antarmuka
});
Hentikan Antarmuka Playback
Salinan kode adalah sebagai berikut:
wx.stopvoice ({
LocalID: '' // ID lokal audio yang perlu dihentikan, diperoleh dengan antarmuka stoprecord
});
Memantau antarmuka pemutaran suara
Salinan kode adalah sebagai berikut:
wx.onvoiceplayend ({
ServerID: '', // ID sisi server dari audio yang perlu diunduh, diperoleh dari antarmuka unggahanvoice
Sukses: function (res) {
var localid = res.localid; // Kembalikan ID lokal audio
}
});
Unggah antarmuka suara
Salinan kode adalah sebagai berikut:
wx.uploadvoice ({
localid: '', // ID lokal audio yang perlu diunggah, diperoleh dengan antarmuka stoprecord
IsShowProgressTips: 1 // default adalah 1, menampilkan prompt kemajuan
Sukses: function (res) {
var serverid = res.serverId; // Mengembalikan ID sisi server audio
}
});
Catatan: Anda dapat mengunduh suara yang diunggah oleh antarmuka file multimedia WeChat. ServerID yang diperoleh di sini adalah media_id. Dokumen referensi ../ 12/58BFCFABBD501C7CD77C19BD9CFA8354.html
Unduh Antarmuka Suara
Salinan kode adalah sebagai berikut:
wx.downloadvoice ({
ServerID: '', // ID sisi server dari audio yang perlu diunduh, diperoleh dari antarmuka unggahanvoice
IsShowProgressTips: 1 // default adalah 1, menampilkan prompt kemajuan
Sukses: function (res) {
var localid = res.localid; // Kembalikan ID lokal audio
}
});
Antarmuka yang cerdas
Identifikasi audio dan kembali ke antarmuka hasil pengakuan
Salinan kode adalah sebagai berikut:
wx.translatevoice ({
localid: '', // ID lokal audio yang perlu diidentifikasi, diperoleh dari antarmuka yang berhubungan dengan rekaman
IsShowProgressTips: 1, // default adalah 1, menampilkan prompt kemajuan
Sukses: function (res) {
peringatan (res.translateresult); // Hasil pengenalan ucapan
}
});
Informasi peralatan
Dapatkan Antarmuka Status Jaringan
Salinan kode adalah sebagai berikut:
wx.getNetworkType ({
Sukses: function (res) {
var networkType = res.networkType; // Kembalikan Jenis Jaringan 2G, 3G, 4G, WiFi
}
});
Lokasi Geografis
Gunakan peta weChat bawaan untuk melihat antarmuka lokasi
Salinan kode adalah sebagai berikut:
wx.openlocation ({
Latitude: 0, // Latitude, Nomor Titik Mengambang, Kisaran 90 ~ -90
Longitude: 0, // Longitude, Nomor Titik Mengambang, berkisar dari 180 hingga -180.
Nama: '', // Nama Lokasi
Alamat: '', // detail alamat
Skala: 1, // Level zoom peta, nilai pembentukan, kisaran dari 1 hingga 28. Default maksimum
Infourl: '' // Hyperlink yang ditampilkan di bagian bawah antarmuka lokasi tampilan dapat diklik untuk melompat
});
Dapatkan antarmuka geolokasi
Salinan kode adalah sebagai berikut:
wx.getLocation ({
Timestamp: 0, // Lokasi tanda waktu tanda tangan, hanya disediakan sebelum versi 6.0.2 diperlukan
NONCEST: '', // Lokasi Signature Random String, hanya tersedia sebelum versi 6.0.2
AddRSign: '', // Location Signature, hanya disediakan sebelum versi 6.0.2, lihat Lampiran 4 untuk detailnya
Sukses: function (res) {
var bujur = res.longitude; // latitude, nomor titik mengambang, kisaran 90 ~ -90
var latitude = res.latitude; // Longitude, nomor titik mengambang, berkisar dari 180 hingga -180.
var speed = res.speed; // kecepatan, diukur dalam meter per detik
Accuracy var = res.Accuracy; // Posisikan akurasi
}
});
Operasi antarmuka
Salinan kode adalah sebagai berikut:
Sembunyikan antarmuka menu di sudut kanan atas
wx.hideoptionmenu ();
Tampilkan antarmuka menu di sudut kanan atas
wx.showoptionmenu ();
Tutup antarmuka jendela web saat ini
wx.closewindow ();
Batch Sembunyikan Antarmuka Tombol Fungsi
wx.hidemenuitems ({
Menulist: [] // Untuk menyembunyikan item menu, lihat Lampiran 3
});
Antarmuka tombol fungsi tampilan batch
wx.showMenuitems ({
Menulist: [] // Semua item menu yang akan ditampilkan ditampilkan di Lampiran 3
});
Sembunyikan semua antarmuka tombol non-basic
wx.hideallnonbaseMenuitem ();
Tampilkan semua antarmuka tombol fungsi
wx.showallnonbaseMenuitem ();
Pindai WeChat
Klik antarmuka pemindaian WeChat
wx.scanqrcode ({
desc: 'scanqrcode desc',
NeedResult: 0, // standarnya adalah 0. Hasil pemindaian diproses oleh WeChat. 1 akan secara langsung mengembalikan hasil pemindaian.
scantype: ["qrcode", "barcode"], // Anda dapat menentukan apakah akan memindai kode QR atau kode 1R, keduanya default
Sukses: function () {
var result = res.ResultStr; // Saat dibutuhkan adalah 1, hasilnya dikembalikan dengan memindai kode
}
});
Alamat panen
Edit Antarmuka Alamat Pengiriman
Salinan kode adalah sebagai berikut:
wx.editaddress (
Timestamp: 0, // Lokasi tanda waktu tanda tangan, hanya disediakan sebelum versi 6.0.2 diperlukan
NONCEST: '', // Lokasi Signature Random String, hanya tersedia sebelum versi 6.0.2
AddRSign: '', // Location Signature, hanya disediakan sebelum versi 6.0.2, lihat Lampiran 4 untuk detailnya
Sukses: function (res) {
var username = res.username; // Nama penerima barang
var telnumber = res.telnumber; // nomor telepon penerima
var postalcode = res.postalcode; // Kode Pos
var provincename = res.provincename; // Alamat Pengiriman Standar Nasional Alamat Tingkat Pertama
var cityname = res.cityname; // Alamat Pengiriman Standar Nasional Alamat Tingkat Kedua
var countryname = res.countryName; // Alamat Pengiriman Standar Nasional Alamat Tingkat Ketiga
var address = res.address; // informasi alamat pengiriman terperinci
var nationalcode = res.nationalCode; // Alamat Pengiriman Kode Negara
}
});
Dapatkan antarmuka alamat pengiriman terdekat
Salinan kode adalah sebagai berikut:
wx.getlatestAddress ({
Timestamp: 0, // Lokasi tanda waktu tanda tangan, hanya disediakan sebelum versi 6.0.2 diperlukan
NONCEST: '', // Lokasi Signature Random String, hanya tersedia sebelum versi 6.0.2
AddRSign: '', // Location Signature, hanya disediakan sebelum versi 6.0.2, lihat Lampiran 4 untuk detailnya
Sukses: function (res) {
var username = res.username; // Nama penerima barang
var telnumber = res.telnumber; // nomor telepon penerima
var postalcode = res.postalcode; // Kode Pos
var provincename = res.provincename; // Alamat Pengiriman Standar Nasional Alamat Tingkat Pertama
var cityname = res.cityname; // Alamat Pengiriman Standar Nasional Alamat Tingkat Kedua
var countryname = res.countryName; // Alamat Pengiriman Standar Nasional Alamat Tingkat Ketiga
var address = res.address; // informasi alamat pengiriman terperinci
var nationalcode = res.nationalCode; // Alamat Pengiriman Kode Negara
}
});
Toko WeChat
Lompat ke antarmuka halaman produk WeChat
Salinan kode adalah sebagai berikut:
wx.openproductspecifiFiew ({
ProductId: '', // ID Produk
ViewType: '' // 0.
});
Kupon Kartu WeChat
Lepaskan daftar kupon kartu untuk toko dan dapatkan daftar pilihan pengguna
Salinan kode adalah sebagai berikut:
wx.choosecard ({
ShopID: '', // Simpan ID
CardType: '', // Jenis Kartu
Cardid: '', // ID kartu
Timestamp: 0, // CARD CARPON Tanda Tangan Waktu Cap
non -cestr: '', // String acak tanda tangan kupon kartu
Cardsign: '', // untuk tanda tangan kupon kartu, silakan merujuk ke Lampiran 6 untuk detailnya
Sukses: function (res) {
var cardlist = res.cardlist; // informasi daftar kartu yang dipilih pengguna
}
});
Tambahkan antarmuka kupon kartu dalam batch
Salinan kode adalah sebagai berikut:
wx.addcard ({
CardList: [{
Cardid: '',
Cardext: ''
}], // daftar kupon kartu yang akan ditambahkan
Sukses: function (res) {
var cardlist = res.cardlist; // Menambahkan informasi daftar kupon kartu
}
});
Periksa antarmuka kupon kartu di paket kartu weChat
Salinan kode adalah sebagai berikut:
wx.opencard ({
CardList: [{
Cardid: '',
Kode: ''
}] // Daftar kupon kartu yang akan dibuka
});
Pembayaran WeChat
Memulai permintaan pembayaran weChat
Salinan kode adalah sebagai berikut:
wx.choosewxpay ({
Timestamp: 0, // bayar timestamp tanda tangan
NONCEST: '', // PEMBAYARAN PEMBAYARAN ACICD STRING
Paket: '', // Untuk detail pesanan, silakan merujuk ke Lampiran 5
PaySign: '', // Tanda Tangan Pembayaran, lihat Lampiran 5 untuk detailnya
});