Основные инструкции
Инструкции для использования
1. Принципировать файлы JS
Представьте следующий файл JS на странице, который должен вызвать интерфейс JS (поддержка https): http://res.wx.qq.com/open/js/jweixin-1.0.0.js
Примечание. Поддержка загрузки с использованием метода загрузки стандартного модуля AMD/CMD
2. Включите и настройте интерфейс конфигурации
Все страницы, которые необходимо использовать JSSDK, должны сначала вводить информацию о конфигурации, в противном случае они не будут вызваны (один и тот же URL должен вызывать только один раз, и веб -приложение SPA, которое изменяет URL -адрес, можно вызывать каждый раз, когда меняется URL).
Кода -копия выглядит следующим образом:
wx.config ({
отладка: true, // Включить режим отладки, возвращаемые значения всех API -файлов будут предупреждены на клиенте. Чтобы просмотреть прошедшие параметры, вы можете открыть их на стороне ПК. Информация о параметрах будет напечатана через журнал и будет напечатана только на стороне ПК.
Appid: '', // требуется, уникальный идентификатор официальной учетной записи
TimeStamp:, // Требуется генерировать фирменную печать времени
noncestr: '', // необходимо генерировать случайную строку подписей
Подпись: '', // требуется, подпись, см. Приложение 1
jsapilist: [] // Требуется список интерфейсов JS, которые необходимо использовать, и список всех интерфейсов JS показан в Приложении 2
});
3. Проверьте через готовую интерфейс
Кода -копия выглядит следующим образом:
wx.ready (function () {
// После проверки информации конфигурации будет выполнен метод готового. Все интерфейсные вызовы должны быть получены после того, как интерфейс конфигурации получает результат. Config - это асинхронная работа клиента. Поэтому, если вам необходимо вызвать соответствующий интерфейс при загрузке страницы, соответствующий интерфейс должен быть помещен в функцию готового, чтобы быть вызванным для обеспечения правильного выполнения. Для интерфейсов, которые называются только при вызове пользователя, их можно назвать непосредственно, не помещая их в готовую функцию.
});
4. Интерфейс ошибки проверки.
Кода -копия выглядит следующим образом:
wx.error (function (res) {
// Если проверка информации конфигурации не выполняется, будет выполнена функция ошибки. Если подпись истекает, проверка потерпит неудачу. Для конкретных сообщений об ошибках вы можете открыть режим отладки конфигурации для просмотра, или вы можете просмотреть его в возвращенном параметре Res. Для спа, вы можете обновить подпись здесь.
});
Инструкции по интерфейсу
Все интерфейсы вызываются через объекты wx (также могут использоваться с объектами jwexin). Параметры являются объектом. В дополнение к параметрам, которые должен пройти каждый интерфейс, существуют также следующие общие параметры:
Успех: функция обратного вызова, выполняемая при успешном интерфейсе.
Неудача: функция обратного вызова, выполненная при сбое интерфейсных вызовов.
Завершите: функция обратного вызова, выполненная при завершении интерфейса, и будет выполнена независимо от успеха или неудачи.
Отмена: функция обратного вызова, когда пользователь нажимает, чтобы отменить, будут использоваться только некоторые API, в которых пользователи отменяют операции.
Триггер: метод, который прослушивает запуск, когда кнопка нажимается в меню. Этот метод поддерживает только связанные интерфейсы в меню.
Все вышеуказанные функции имеют параметр, объект типа, в дополнение к данным, возвращаемым каждым интерфейсом, также существует общее свойство errmsg, формат значения которого заключается в следующем:
Когда вызов успешно: «XXX: OK», где XXX - это имя интерфейса вызова
Когда пользователь отменяет: «xxx: ancfel», где xxx - это имя интерфейса, названное имя интерфейса
Когда вызов снят сбой: его значение является конкретным сообщением об ошибке
Базовый интерфейс
Определите, поддерживает ли текущая версия клиента указанный интерфейс JS
Кода -копия выглядит следующим образом:
wx.checkjsapi ({
jsapilist: ['selectiMage'] // Список интерфейсов JS, которые необходимо обнаружить, см. Приложение 2 для всех списков интерфейсов JS.
Успех: function (res) {
// Возврат в виде пары клавиш значения, доступное значение API верно и не доступно для FALSE
// Например: {"CheckResult": {"selectImage": true}, "errmsg": "checkjsapi: ok"}
});
Обмен интерфейсом
Получите статус нажатия кнопки «Поделиться в моменты» и настроить интерфейс общего содержания
Кода -копия выглядит следующим образом:
wx.onmenushareTimeline ({
Название: '', // Поделиться название
Ссылка: '', // поделиться ссылкой
Imgurl: '', // поделиться значком
Успех: function () {
// функция обратного вызова, выполненная после того, как пользователь подтверждает общий доступ
},
Отмена: function () {
// Функция обратного вызова, выполненная после того, как пользователь отменил общий доступ
}
});
Получите статус нажмите кнопку «Поделиться с друзьями» и настроить интерфейс общего содержания
Кода -копия выглядит следующим образом:
wx.onmenushareappmessage ({
Название: '', // Поделиться название
desc: '', // поделиться описанием
Ссылка: '', // поделиться ссылкой
Imgurl: '', // поделиться значком
Тип: '', // Тип обмена, музыка, видео или ссылка, если не заполнен, по умолчанию - ссылка
DataRl: '', // Если тип - музыка или видео, должна быть предоставлена ссылка на данные, по умолчанию пусто
Успех: function () {
// функция обратного вызова, выполненная после того, как пользователь подтверждает общий доступ
},
Отмена: function () {
// Функция обратного вызова, выполненная после того, как пользователь отменил общий доступ
}
});
Получите статус нажатия кнопки «Поделиться в QQ» и настроить интерфейс общего содержания
Кода -копия выглядит следующим образом:
wx.onmenushareqq ({
Название: '', // Поделиться название
desc: '', // поделиться описанием
Ссылка: '', // поделиться ссылкой
Imgurl: '' // поделиться значком
Успех: function () {
// функция обратного вызова, выполненная после того, как пользователь подтверждает общий доступ
},
Отмена: function () {
// Функция обратного вызова, выполненная после того, как пользователь отменил общий доступ
}
});
Получите статус нажмите кнопку «Поделиться в Tencent Weibo» и настроить интерфейс общего содержания
Кода -копия выглядит следующим образом:
wx.onmenushareweibo ({
Название: '', // Поделиться название
desc: '', // поделиться описанием
Ссылка: '', // поделиться ссылкой
Imgurl: '' // поделиться значком
Успех: function () {
// функция обратного вызова, выполненная после того, как пользователь подтверждает общий доступ
},
Отмена: function () {
// Функция обратного вызова, выполненная после того, как пользователь отменил общий доступ
}
});
Интерфейс изображения
Сделайте снимок или выберите изображение в интерфейсе альбома мобильного телефона
Кода -копия выглядит следующим образом:
wx.chooseimage ({
Успех: function (res) {
var localids = res.localids; // Возвращает локальный список идентификации выбранной фотографии. LocalID может отображать изображения в качестве атрибута SRC тега IMG
}
});
Предварительный просмотр интерфейса изображения
Кода -копия выглядит следующим образом:
wx.previewimage ({
Current: '', // ссылка на отображаемое в настоящее время изображение
URLS: [] // Список ссылок изображений, которые необходимо предварительно просмотреть
});
Загрузите интерфейс изображения
Кода -копия выглядит следующим образом:
wx.uploadimage ({
Localid: '', // локальный идентификатор изображения, который будет загружен, получен интерфейсом ChoiceMage
isshowprogresstips: 1 // по умолчанию 1, отображая подсказки о прогрессе
Успех: function (res) {
var serverid = res.serverid; // возвращать идентификатор на стороне сервера изображения
}
});
Примечание. Вы можете загрузить загруженное изображение WeChat, используя мультимедийный файловый интерфейс. Сервер, полученный здесь, Media_id. Справочный документ ../ 12/58BFCFABBD501C7CD77C19BD9CFA8354.HTML
Скачать интерфейс изображения
Кода -копия выглядит следующим образом:
wx.downloadimage ({
ServerId: '', // идентификатор на стороне сервера изображения, который будет загружен, получен из интерфейса uploadImage
isshowprogresstips: 1 // по умолчанию 1, отображая подсказки о прогрессе
Успех: function (res) {
var localid = res.localid; // вернуть локальный идентификатор после загрузки изображения
}
});
Аудио -интерфейс
Начните записывать интерфейс
Кода -копия выглядит следующим образом:
wx.startrecord ();
Прекратите записывать интерфейс
Кода -копия выглядит следующим образом:
wx.stoprecord ({
Успех: function (res) {
var localid = res.localid;
}
});
Автоматический интерфейс остановки для мониторинга записи
Кода -копия выглядит следующим образом:
wx.onvoicerecordend ({
// Полный обратный вызов будет выполнен, когда время записи будет более одной минутой и не останавливается.
Завершите: function (res) {
var localid = res.localid;
}
});
Воспроизвести голосовой интерфейс
Кода -копия выглядит следующим образом:
wx.playvoice ({
Localid: '' // локальный идентификатор звука, который будет воспроизведен, полученный интерфейсом StopRecord
});
Пауза воспроизводить интерфейс
Кода -копия выглядит следующим образом:
wx.pausevoice ({
Localid: '' // локальный идентификатор звука, который необходимо приостановить, полученным интерфейсом StopRecord
});
Остановить интерфейс воспроизведения
Кода -копия выглядит следующим образом:
wx.stopvoice ({
Localid: '' // локальный идентификатор звука, который необходимо остановить, полученным интерфейсом StopRecord
});
Мониторинг интерфейса воспроизведения голоса
Кода -копия выглядит следующим образом:
wx.onvoiceplayend ({
ServerId: '', // идентификатор на стороне сервера звука, который необходимо загрузить, получен из интерфейса uploadVoice
Успех: function (res) {
var localid = res.localid; // вернуть локальный идентификатор звука
}
});
Загрузите голосовой интерфейс
Кода -копия выглядит следующим образом:
wx.uploadvoice ({
Localid: '', // локальный идентификатор звука, который необходимо загрузить, полученным интерфейсом StopRecord
isshowprogresstips: 1 // по умолчанию 1, отображая подсказки о прогрессе
Успех: function (res) {
var serverid = res.serverid; // возвращает идентификатор на стороне сервера звука
}
});
Примечание. Вы можете скачать загруженный голос с помощью мультимедийного файлового интерфейса WeChat. Сервер, полученный здесь, Media_id. Справочный документ ../ 12/58BFCFABBD501C7CD77C19BD9CFA8354.HTML
Скачать голосовой интерфейс
Кода -копия выглядит следующим образом:
wx.downloadvoice ({
ServerId: '', // идентификатор на стороне сервера звука, который необходимо загрузить, получен из интерфейса uploadVoice
isshowprogresstips: 1 // по умолчанию 1, отображая подсказки о прогрессе
Успех: function (res) {
var localid = res.localid; // вернуть локальный идентификатор звука
}
});
Интеллектуальный интерфейс
Определите аудио и верните интерфейс результатов распознавания
Кода -копия выглядит следующим образом:
wx.translatevoice ({
Localid: '', // локальный идентификатор звука, который необходимо определить, получен из интерфейса, связанного с записи
isshowprogresstips: 1, // по умолчанию - 1, отображая подсказки о прогрессе
Успех: function (res) {
предупреждение (Res.translateresult); // результат распознавания речи
}
});
Информация о оборудовании
Получить интерфейс состояния сети
Кода -копия выглядит следующим образом:
wx.getnetworktype ({
Успех: function (res) {
var networkType = res.netWorkType; // возвращать типы сети 2G, 3G, 4G, WiFi
}
});
Географическое расположение
Используйте встроенную карту WeChat для просмотра интерфейса местоположения
Кода -копия выглядит следующим образом:
wx.openlocation ({
Широта: 0, // широта, номер плавающей точки, диапазон 90 ~ -90
Долгота: 0, // долгота, номер плавающей запятой, варьируется от 180 до -180.
Имя: '', // Имя местоположения
Адрес: '', // Детали адреса
Масштаб: 1, // Уровень увеличения карты, значение формирования, диапазон от 1 до 28. По умолчанию максимально
Infourl: '' // Гиперссылка, отображаемая в нижней части интерфейса места просмотра, можно нажать, чтобы прыгнуть
});
Получите интерфейс геолокации
Кода -копия выглядит следующим образом:
wx.getLocation ({
TimeStamp: 0, // Signature Signature TimeStact, предоставленная только до версии 6.0.2.
noncestr: '', // Signature Signature Signature String String, доступная только до версии 6.0.2
AddrSign: '', // Подпись местоположения, предоставленная только перед версией 6.0.2, см. Приложение 4 для получения подробной информации
Успех: function (res) {
var longitude = res.longity; // Широта, номер плавающей точки, диапазон 90 ~ -90
var latitude = res.latitude; // долгота, номер плавающей запятой, варьируется от 180 до -180.
var speed = res.speed; // скорость, измеренная в метрах в секунду
VAR Точность = Res.Ccuracy; // Точность позиции
}
});
Операция интерфейса
Кода -копия выглядит следующим образом:
Скрыть интерфейс меню в правом верхнем углу
wx.hideoptionmenu ();
Отображать интерфейс меню в правом верхнем углу
wx.showoptionmenu ();
Закройте текущий интерфейс веб -окна
wx.closewindow ();
Кнопка «Скрыть»
wx.hidemenuitems ({
Менулистист: [] // Скрыть пункты меню, см. Приложение 3
});
Кнопка функции пакетного отображения
wx.showmenuitems ({
Менулистист: [] // Все элементы меню, которые будут отображаться, показаны в Приложении 3
});
Скрыть все не базовые кнопки интерфейсы
wx.hideallnonbasemenuitem ();
Показать все интерфейсы кнопки функций
wx.showallnonbasemenuitem ();
Сканируйте WeChat
Нажмите на интерфейс сканирования WeChat
wx.scanqrcode ({
desc: 'scanqrcode desc',
NeedResult: 0, // По умолчанию 0. Результат сканирования обрабатывается WeChat. 1 будет напрямую вернуть результат сканирования.
Scantype: ["qrcode", "Barcode"], // Вы можете указать, сканировать ли QR -код или 1R -код, оба по умолчанию по умолчанию
Успех: function () {
var result = res.resultstr; // Когда eedresult составляет 1, результат возвращается путем сканирования кода
}
});
Адрес урожая
Редактировать интерфейс адреса доставки
Кода -копия выглядит следующим образом:
wx.editAddress (
TimeStamp: 0, // Signature Signature TimeStact, предоставленная только до версии 6.0.2.
noncestr: '', // Signature Signature Signature String String, доступная только до версии 6.0.2
AddrSign: '', // Подпись местоположения, предоставленная только перед версией 6.0.2, см. Приложение 4 для получения подробной информации
Успех: function (res) {
var username = res.username; // Имя грузоподъемника
var telnumber = res.telnumber; // номер телефона грузоподъемника
var postalCode = res.postalCode; // Почтовый индекс
var ProvinceName = res.provinceName; // Национальный стандартный адрес доставки первого уровня
var CityName = res.cityName; // Национальный стандартный адрес доставки второго уровня адреса
var countryName = res.countryName; // Национальный стандартный адрес доставки третьего уровня адреса
var address = res.address; // Подробная информация о адресах доставки
var nationalCode = res.nationalCode; // Код страны по доставке
}
});
Получите ближайший интерфейс адреса доставки
Кода -копия выглядит следующим образом:
wx.getlatestaddress ({
TimeStamp: 0, // Signature Signature TimeStact, предоставленная только до версии 6.0.2.
noncestr: '', // Signature Signature Signature String String, доступная только до версии 6.0.2
AddrSign: '', // Подпись местоположения, предоставленная только перед версией 6.0.2, см. Приложение 4 для получения подробной информации
Успех: function (res) {
var username = res.username; // Имя грузоподъемника
var telnumber = res.telnumber; // номер телефона грузоподъемника
var postalCode = res.postalCode; // Почтовый индекс
var ProvinceName = res.provinceName; // Национальный стандартный адрес доставки первого уровня
var CityName = res.cityName; // Национальный стандартный адрес доставки второго уровня адреса
var countryName = res.countryName; // Национальный стандартный адрес доставки третьего уровня адреса
var address = res.address; // Подробная информация о адресах доставки
var nationalCode = res.nationalCode; // Код страны по доставке
}
});
WeChat Store
Перейти к интерфейсу страницы продукта WeChat
Кода -копия выглядит следующим образом:
wx.openproductspecificview ({
ProductId: '', // идентификатор продукта
ViewType: '' // 0. Значение по умолчанию, обычные данные о продукте Страница 1. Сканируйте сведения о продукте Страница 2. Страница хранить детали продукта
});
WeChat Card Coupon
Выпустите список купонов карты для магазинов и получите список выбора пользователя
Кода -копия выглядит следующим образом:
wx.choosecard ({
Shopid: '', // Идентификатор магазина
CardType: '', // Тип карты
Cardid: '', // идентификатор карты
TimeStamp: 0, // карта купона фирменная марка Time Time
noncestr: '', // Случайная строка подписи купона карты
Cardign: '', // для подписи купона карты, пожалуйста, обратитесь к Приложению 6 для получения подробной информации
Успех: function (res) {
var cardlist = res.cardlist; // Пользовательская информация списка карт
}
});
Добавить интерфейс купона карты в партиях
Кода -копия выглядит следующим образом:
wx.addcard ({
карт списка: [{
Кардид: '',
cardext: ''
}], // Список купонов карты, которые будут добавлены
Успех: function (res) {
var cardlist = res.cardlist; // Добавлена информация о списке купонов карты
}
});
Проверьте интерфейс купона карты в пакете карт WeChat
Кода -копия выглядит следующим образом:
wx.opencard ({
карт списка: [{
Кардид: '',
Код: ''
}] // Список купонов карты, которые будут открыты
});
WeChat платеж
Инициировать запрос на оплату WeChat
Кода -копия выглядит следующим образом:
wx.choosewxpay ({
TimeStamp: 0, // оплата подписи времени.
noncestr: '', // платежная подпись случайная строка
Пакет: '', // для получения информации о заказе, пожалуйста, обратитесь к Приложению 5
PaySign: '', // Оплата подписи, см. Приложение 5 для получения подробной информации
});