Grundlegende Anweisungen
Anweisungen zur Verwendung
1. Schalten Sie JS -Dateien ein
Führen Sie die folgende JS-Datei auf der Seite ein, auf der die JS-Schnittstelle (Support https) aufgerufen werden muss: http://res.wx.qq.com/open/js/jweixin-1.0.0.js
Hinweis: Unterstützen Sie das Laden mithilfe der AMD/CMD -Standardmodul -Lademethode
2. Injizieren und konfigurieren Sie die Konfigurationsschnittstelle
Alle Seiten, die JSSDK verwenden müssen, müssen zuerst Konfigurationsinformationen injizieren. Andernfalls werden sie nicht aufgerufen (dieselbe URL muss nur einmal aufgerufen werden, und die Web -App des SPA, die die URL ändert, kann jedes Mal aufgerufen werden, wenn sich die URL ändert).
Die Codekopie lautet wie folgt:
wx.config ({{{{
DEBUG: TRUE, // Debug -Modus einschalten, werden die Rückgabewerte aller genannten APIs auf dem Kunden aufmerksam gemacht. Um die übergebenen Parameter anzuzeigen, können Sie sie auf der PC -Seite öffnen. Die Parameterinformationen werden über das Protokoll gedruckt und nur auf der PC -Seite gedruckt.
Appid: '', // Erforderlich, die eindeutige Kennung des offiziellen Kontos
Zeitstempel:, // erforderlich, um einen Signatur -Zeitstempel zu generieren
Noncest: '', // erforderlich, um eine zufällige Zeichenfolge von Signaturen zu generieren
Unterschrift: '', // Erforderlich, Unterschrift, siehe Anhang 1
JSAPILIST: [] // Erforderlich, die Liste der JS -Schnittstellen, die verwendet werden müssen, und die Liste aller JS -Schnittstellen ist in Anhang 2 angezeigt
});
3.. Überprüfen Sie die Bereitschaftsschnittstelle
Die Codekopie lautet wie folgt:
wx.ready (function () {
// Nachdem die Konfigurationsinformationen überprüft wurden, wird die Ready -Methode ausgeführt. Alle Schnittstellenaufrufe müssen erhalten werden, nachdem die Konfigurationsschnittstelle das Ergebnis erhalten hat. Config ist ein asynchroner Betrieb eines Clients. Wenn Sie also die relevante Schnittstelle aufrufen müssen, wenn die Seite geladen wird, muss die entsprechende Schnittstelle in die zubereitete Funktion platziert werden, um die korrekte Ausführung sicherzustellen. Für Schnittstellen, die nur dann aufgerufen werden, wenn der Benutzer ausgelöst wird, können sie direkt aufgerufen werden, ohne sie in die Bereitschaftsfunktion zu setzen.
});
4.. Verifizierung fehlgeschlagener Fehlerschnittstelle
Die Codekopie lautet wie folgt:
WX.Error (Funktion (res) {
// Wenn die Konfigurationsinformationsüberprüfung fehlschlägt, wird eine Fehlerfunktion ausgeführt. Wenn die Signatur abläuft, schlägt die Überprüfung fehl. Für bestimmte Fehlermeldungen können Sie den Debug -Modus der Konfiguration zum Anzeigen öffnen oder im Parameter zurückgegebene Res Ansicht. Für Spa können Sie die Signatur hier aktualisieren.
});
Schnittstellenanweisungen
Alle Schnittstellen werden über WX -Objekte aufgerufen (können auch mit JWeixin -Objekten verwendet werden). Die Parameter sind ein Objekt. Zusätzlich zu den Parametern, die jede Schnittstelle selbst übergeben muss, gibt es auch die folgenden allgemeinen Parameter:
Erfolg: Eine Rückruffunktion, die ausgeführt wird, wenn die Schnittstelle erfolgreich aufgerufen wird.
FAIL: Eine Rückruffunktion, die ausgeführt wird, wenn eine Schnittstelle fehlschlägt.
Vollständig: Die Rückruffunktion, die ausgeführt wird, wenn die Schnittstelle abgeschlossen ist, und unabhängig von Erfolg oder Misserfolg wird ausgeführt.
Abbrechen: Die Rückruffunktion Wenn der Benutzer auf Abbrechen klickt, werden nur einige APIs verwendet, bei denen Benutzer die Operationen abbrechen.
Auslöser: Eine Methode, die zum Auslösen hört, wenn eine Schaltfläche im Menü klickt. Diese Methode unterstützt nur verwandte Schnittstellen im Menü.
Die obigen Funktionen haben alle einen Parameter, Typ -Objekt, zusätzlich zu den Daten, die von jeder Schnittstelle selbst zurückgegeben werden, gibt es auch eine gemeinsame Eigenschaft ERRMSG, deren Wertformat wie folgt lautet:
Wenn der Anruf erfolgreich ist: "XXX: OK", wobei xxx der Schnittstellenname des Anrufs ist
Wenn der Benutzer absagt: "xxx: cancel", wobei xxx der aufgerufene Schnittstellenname ist
Wenn der Anruf fehlschlägt: Der Wert ist eine spezifische Fehlermeldung
Grundlegende Schnittstelle
Bestimmen Sie, ob die aktuelle Client -Version die angegebene JS -Schnittstelle unterstützt
Die Codekopie lautet wie folgt:
wx.checkjsapi ({{
JSAPILIST: ['sumimage'] // Liste der JS -Schnittstellen, die erkannt werden müssen, siehe Anhang 2 für alle JS -Schnittstellenlisten.
Erfolg: Funktion (res) {
// Rückgabe als Schlüsselwertpaare, der verfügbare API-Wert ist wahr und nicht für false verfügbar
// Zum Beispiel: {"checkResult": {"sumimage": trum}, "errmsg": "checkjsapi: ok"}
});
Sharing -Schnittstelle
Holen Sie sich den Klickstatus der Schaltfläche "Teilen an Momente
Die Codekopie lautet wie folgt:
wx.onmenusharetimeline ({{
Titel: '', // Titel teilen
Link: '', // Link teilen
IMGURL: '', // Ikone teilen
Erfolg: function () {
// Die Rückruffunktion, die ausgeführt wurde, nachdem der Benutzer die Freigabe bestätigt hat
},
Abbrechen: function () {
// Die Rückruffunktion, die ausgeführt wird, nachdem der Benutzer die Freigabe abgebrochen hat
}
});
Rufen Sie den Status der Schaltfläche "Anteil an Freunde freigeben" an und passen Sie die Inhaltsschnittstelle zur Freigabe an
Die Codekopie lautet wie folgt:
wx.onmenushareAppMessage ({{
Titel: '', // Titel teilen
Desc: '', // die Beschreibung teilen
Link: '', // Link teilen
IMGURL: '', // Ikone teilen
Typ: '', // Teilen von Typ, Musik, Video oder Link, wenn nicht ausgefüllt, ist der Standard -Link Link
DataUrl: '', // Wenn der Typ Musik oder Video ist, ist der Datenlink bereitzustellen, der Standard ist leer
Erfolg: function () {
// Die Rückruffunktion, die ausgeführt wurde, nachdem der Benutzer die Freigabe bestätigt hat
},
Abbrechen: function () {
// Die Rückruffunktion, die ausgeführt wird, nachdem der Benutzer die Freigabe abgebrochen hat
}
});
Rufen Sie den Status der Schaltfläche "In QQ" klicken und die Sharing -Inhaltsoberfläche anpassen
Die Codekopie lautet wie folgt:
wx.onmenushareqq ({{
Titel: '', // Titel teilen
Desc: '', // die Beschreibung teilen
Link: '', // Link teilen
IMGURL: '' // Ikone teilen
Erfolg: function () {
// Die Rückruffunktion, die ausgeführt wurde, nachdem der Benutzer die Freigabe bestätigt hat
},
Abbrechen: function () {
// Die Rückruffunktion, die ausgeführt wird, nachdem der Benutzer die Freigabe abgebrochen hat
}
});
Rufen Sie den Klickstatus der Schaltfläche "An Tencent Weibo zum Teilen von Tencent Weibo ab und passen Sie die Interface Sharing Inhalts an
Die Codekopie lautet wie folgt:
wx.onmenushareweibo ({{
Titel: '', // Titel teilen
Desc: '', // die Beschreibung teilen
Link: '', // Link teilen
IMGURL: '' // Ikone teilen
Erfolg: function () {
// Die Rückruffunktion, die ausgeführt wurde, nachdem der Benutzer die Freigabe bestätigt hat
},
Abbrechen: function () {
// Die Rückruffunktion, die ausgeführt wird, nachdem der Benutzer die Freigabe abgebrochen hat
}
});
Bildschnittstelle
Machen Sie ein Bild oder wählen Sie ein Bild von der Mobile -Album -Album -Oberfläche aus
Die Codekopie lautet wie folgt:
wx.chooseImage ({{
Erfolg: Funktion (res) {
var localids = res.Localids; // Gibt die lokale ID -Liste des ausgewählten Fotos zurück. LocalID kann Bilder als SRC -Attribut des IMG -Tags anzeigen
}
});
Vorschau -Bildschnittstelle
Die Codekopie lautet wie folgt:
wx.previewImage ({{
aktuell: '', // Link zum aktuell angezeigten Bild
URLs: [] // Liste der Bildlinks, die vorsichtigt werden müssen
});
Image -Schnittstelle hochladen
Die Codekopie lautet wie folgt:
wx.uploadimage ({{
LokalID: '', // Die lokale ID des hochgeladenen Bildes, erhalten durch die ChoiceImage -Schnittstelle
isShowProgressTips: 1 // Standard ist 1, und die Fortschritteanforderungen anzeigen
Erfolg: Funktion (res) {
var serverid = res.serverid; // Geben Sie die serverseitige ID des Bildes zurück
}
});
Hinweis: Sie können das hochgeladene Bild per WeChat mit der Multimedia -Dateischnittstelle herunterladen. Die hier erhaltene ServerID ist media_id. Referenzdokument
Laden Sie die Bildschnittstelle herunter
Die Codekopie lautet wie folgt:
wx.downloadImage ({{
ServerID: '', // Die serverseitige ID des heruntergeladenen Bildes, erhalten von der UploadImage-Schnittstelle
isShowProgressTips: 1 // Standard ist 1, und die Fortschritteanforderungen anzeigen
Erfolg: Funktion (res) {
var localId = res.LocalId; // Geben Sie die lokale ID zurück, nachdem das Bild heruntergeladen wurde
}
});
Audio -Schnittstelle
Starten Sie die Aufzeichnungsschnittstelle
Die Codekopie lautet wie folgt:
WX.StarTrecord ();
Stoppen Sie die Aufnahme der Schnittstelle
Die Codekopie lautet wie folgt:
wx.stoprecord ({{{
Erfolg: Funktion (res) {
var localId = res.LocalId;
}
});
Automatische Stoppschnittstelle zur Überwachung der Aufzeichnung
Die Codekopie lautet wie folgt:
wx.onvoicerecordend ({{
// Vollständiger Rückruf wird ausgeführt, wenn die Aufzeichnungszeit mehr als eine Minute beträgt und nicht aufhört.
Vollständige: Funktion (res) {
var localId = res.LocalId;
}
});
Sprachschnittstelle spielen
Die Codekopie lautet wie folgt:
wx.playvoice ({{
LOCALID: '' // Die lokale ID des von der StopRecord -Schnittstelle erhaltenen Audio -Audio
});
Pause Playback -Schnittstelle
Die Codekopie lautet wie folgt:
wx.pausevoice ({{
LOCALID: '' // Die lokale ID des Audios, die durchgehalten werden muss, erhalten von der StopRecord -Schnittstelle
});
Stop -Playback -Oberfläche stoppen
Die Codekopie lautet wie folgt:
wx.stopvoice ({{
LOCALID: '' // Die lokale ID des Audios, die gestoppt werden muss, erhalten von der StopRecord -Schnittstelle
});
Überwachung der Sprach -Wiedergabeberechnungsschnittstelle
Die Codekopie lautet wie folgt:
wx.onvoiceplayend ({{
ServerID: '', // Die serverseitige ID des Audio, die heruntergeladen werden muss, erhalten von der UploadVoice-Schnittstelle
Erfolg: Funktion (res) {
var localId = res.LocalId; // Geben Sie die lokale ID des Audios zurück
}
});
Sprachschnittstelle hochladen
Die Codekopie lautet wie folgt:
wx.uploadvoice ({{
LOCALID: '', // Die lokale ID des Audios, die hochgeladen werden muss, erhalten von der Stoprecord -Schnittstelle
isShowProgressTips: 1 // Standard ist 1, und die Fortschritteanforderungen anzeigen
Erfolg: Funktion (res) {
var serverid = res.serverid; // Gibt die serverseitige ID des Audios zurück
}
});
Hinweis: Sie können die hochgeladene Stimme per Multimedia -Dateischnittstelle von Wechat herunterladen. Die hier erhaltene ServerID ist media_id. Referenzdokument
Sprachschnittstelle herunterladen
Die Codekopie lautet wie folgt:
wx.downloadVoice ({{
ServerID: '', // Die serverseitige ID des Audio, die heruntergeladen werden muss, erhalten von der UploadVoice-Schnittstelle
isShowProgressTips: 1 // Standard ist 1, und die Fortschritteanforderungen anzeigen
Erfolg: Funktion (res) {
var localId = res.LocalId; // Geben Sie die lokale ID des Audios zurück
}
});
Intelligente Schnittstelle
Identifizieren Sie Audio und kehren Sie zur Schnittstelle zur Erkennungsergebnis zurück
Die Codekopie lautet wie folgt:
wx.translatevoice ({{
LocalID: '', // Die lokale ID des Audios, die identifiziert werden muss, erhalten aus der aufzeichnungsbezogenen Schnittstelle
isShowProgressTips: 1, // Standard ist 1, und die Fortschritteanforderungen anzeigen
Erfolg: Funktion (res) {
Alert (res.Translateresult); // das Ergebnis der Spracherkennung
}
});
Ausrüstungsinformationen
Rufen Sie die Netzwerkstatusschnittstelle ab
Die Codekopie lautet wie folgt:
wx.getNetworkType ({{
Erfolg: Funktion (res) {
var networkType = res.networkType; // Netzwerktypen 2G, 3G, 4G, WLAN zurückgeben
}
});
Geografische Lage
Verwenden Sie die integrierte Karte von WeChat, um die Standortschnittstelle anzuzeigen
Die Codekopie lautet wie folgt:
wx.openLocation ({{
Breitengrad: 0, // Breitengrad, schwimmende Punktzahl, Bereich 90 ~ -90
Länge: 0, // Länge, schwimmende Punktzahl, reichen von 180 bis -180.
Name: '', // Standortname
Adresse: '', // Adressdetails
Skalierung: 1, // Karten -Zoomebene, Formungswert, reichen von 1 bis 28. Standard ist maximal
INFOURL: '' // Der Hyperlink, der unten in der Schnittstelle zur Ansichtsposition angezeigt wird, kann geklickt werden, um zu springen
});
Holen Sie sich die Geolocation -Schnittstelle
Die Codekopie lautet wie folgt:
wx.getLocation ({{{
Zeitstempel: 0, // Standort Signaturzeitstempel, nur vor Version 6.0.2 erforderlich
Noncest: '', // Signatur zufälliger Zeichenfolge, nur vor Version 6.0.2 verfügbar
AddrSign: '', // Signatur der Position, erst vor Version 6.0.2 bereitgestellt, siehe Anhang 4 für Details
Erfolg: Funktion (res) {
Varginationslänge = res.longitude; // Breitengrad, schwimmende Punktzahl, Bereich 90 ~ -90
Vargum Latitude = Res.Latitude; // Länge, schwebende Punktzahl, reichen von 180 bis -180.
var speed = res.speed; // Geschwindigkeit, gemessen in Metern pro Sekunde
var accuracy = res.curacy; // Positionsgenauigkeit
}
});
Schnittstellenbetrieb
Die Codekopie lautet wie folgt:
Verstecken Sie die Menüschnittstelle in der oberen rechten Ecke
wx.hideoptionMenu ();
Zeigen Sie die Menüschnittstelle in der oberen rechten Ecke an
wx.showoptionMenu ();
Schließen Sie die aktuelle Webfensterschnittstelle
WX.CLOSEWINDOW ();
Taste der Batch -Versteckfunktion
wx.hidemenuitems ({{
Menulist: [] //, um Menüelemente auszublenden, siehe Anhang 3
});
Taste der Batch -Anzeigefunktion Schnittstelle
wx.showMenuitems ({{
Menulist: [] // Alle zu angezeigten Menüelemente sind in Anhang 3 angezeigt
});
Verstecken Sie alle Schnittstellen ohne grasische Taste
wx.hideAllnonbasemenuitem ();
Zeigen Sie alle Funktionen für Funktionstaste an
wx.showallnonbasemenuitem ();
Scannen Sie den Wechat
Klicken Sie auf die WeChat -Scan -Schnittstelle
wx.scanqrcode ({{
Desc: 'scanqrcode desc',
NeedResult: 0, // Die Standardeinstellung ist 0. Das Scan -Ergebnis wird von WeChat verarbeitet. 1 gibt das Scan -Ergebnis direkt zurück.
Scantype: ["QRCode", "Barcode"], // Sie können angeben, ob Sie den QR -Code oder den 1R -Code scannen. Beide sind standardmäßig
Erfolg: function () {
var result = res.resultstr; // Wenn NeedResult 1 ist, wird das Ergebnis zurückgegeben, indem der Code gescannt wird
}
});
Ernteadresse
Bearbeiten der Lieferadressoberfläche bearbeiten
Die Codekopie lautet wie folgt:
wx.editaddress (
Zeitstempel: 0, // Standort Signaturzeitstempel, nur vor Version 6.0.2 erforderlich
Noncest: '', // Signatur zufälliger Zeichenfolge, nur vor Version 6.0.2 verfügbar
AddrSign: '', // Signatur der Position, erst vor Version 6.0.2 bereitgestellt, siehe Anhang 4 für Details
Erfolg: Funktion (res) {
var userername = res.username; // Name des Empfängers
var tellnumber = res.telnumber; // Telefonnummer des Senderes
var postalcode = res.postalcode; // Postleitzahl
var provincename = res.provinzenName; // Adresse der nationalen Standard -Lieferadresse erster Ebene Adresse
var CityName = Res.CityName; // Nationale Standard -Lieferadresse der zweiten Ebene
var CountryName = Res.CountryName; // Adresse der nationalen Standardverlieferungsadresse dritter Stufe
var adress = res.address; // Detaillierte Informationen zur Lieferadresse
var nationalCode = res.nationalcode; // Lieferadresse Ländercode
}
});
Holen Sie sich die nächstgelegene Zustelladressenschnittstelle
Die Codekopie lautet wie folgt:
wx.getlatestaddress ({{
Zeitstempel: 0, // Standort Signaturzeitstempel, nur vor Version 6.0.2 erforderlich
Noncest: '', // Signatur zufälliger Zeichenfolge, nur vor Version 6.0.2 verfügbar
AddrSign: '', // Signatur der Position, erst vor Version 6.0.2 bereitgestellt, siehe Anhang 4 für Details
Erfolg: Funktion (res) {
var userername = res.username; // Name des Empfängers
var tellnumber = res.telnumber; // Telefonnummer des Senderes
var postalcode = res.postalcode; // Postleitzahl
var provincename = res.provinzenName; // Adresse der nationalen Standard -Lieferadresse erster Ebene Adresse
var CityName = Res.CityName; // Nationale Standard -Lieferadresse der zweiten Ebene
var CountryName = Res.CountryName; // Adresse der nationalen Standardverlieferungsadresse dritter Stufe
var adress = res.address; // Detaillierte Informationen zur Lieferadresse
var nationalCode = res.nationalcode; // Lieferadresse Ländercode
}
});
Wechat -Laden
Springen Sie zur WeChat -Produktseitenschnittstelle
Die Codekopie lautet wie folgt:
wx.openProductSpecificView ({{
ProductID: '', // Produkt -ID
ViewType: '' // 0. Standardwert, Gewöhnliche Produktdetails Seite 1. Scannen Sie die Produktdetails Seite 2. Produktdetails Seite speichern
});
Wechat -Karten -Gutschein
Geben Sie die Liste der Kartencoupons für Geschäfte frei und erhalten Sie die Liste der Benutzerauswahl
Die Codekopie lautet wie folgt:
WX.CHOOSECARD ({{
ShopID: '', // Store -ID
CardType: '', // Kartentyp
Cardid: '', // Karten -ID
Zeitstempel: 0, // Karten -Gutschein Signaturzeitstempel
Noncest: '', // zufällige Zeichenfolge von Karten -Gutschein -Signatur
Kartenzeichen: '', // Für Karten -Gutscheinunterzeichnung finden Sie in Anhang 6 für Details
Erfolg: Funktion (res) {
var cardList = res.Cardlist; // Benutzer ausgewählte Kartenlisteninformationen
}
});
Fügen Sie die Karten -Gutscheinschnittstelle in Chargen hinzu
Die Codekopie lautet wie folgt:
wx.addcard ({{
Kartenliste: [{{
Cardid: '',
CARDEEXT: ''
}], // Liste der zu hinzugefügten Karten -Gutscheine
Erfolg: Funktion (res) {
var cardList = res.Cardlist; // Informationen zur Kartenpotonliste hinzugefügt
}
});
Überprüfen Sie die Karten -Gutscheinschnittstelle im WeChat -Kartenpaket
Die Codekopie lautet wie folgt:
wx.opencard ({{{
Kartenliste: [{{
Cardid: '',
Code: ''
}] // Liste der geöffneten Kartengutscheine
});
Wechat -Zahlung
Initiieren Sie eine WeChat -Zahlungsanfrage
Die Codekopie lautet wie folgt:
wx.choosewxpay ({{
Zeitstempel: 0, // Signaturzeitstempel zahlen
Noncest: '', // Zahlungssignatur zufälliger Zeichenfolge
Paket: '', // für Bestelldetails finden Sie in Anhang 5
Paysign: '', // Zahlungsunterschrift, siehe Anhang 5 für Details
});