更新记录
1.0.1(2026-08-04)
- 修复 HarmonyOS 平台文件缺少公开 API 同名导出,导致 uni-app x 调用
getApiSupportInfo / isInstall / isWXAppSupportApi 等接口时报 undefined is not callable 的问题。
- 保留原有
*ByHarmony 平台分发入口,并补齐 interface.uts 声明的微信公开 API 代理,不影响 Android、iOS、Web、小程序和既有 uni-app 调用入口。
- HarmonyOS 当前继续返回明确的微信能力降级结果;登录、分享、支付等真实能力仍需对应微信开放平台配置和 Harmony SDK 支持。
- Harmony 原生 UTS 已变化,升级后需要重新构建并安装匹配的 Harmony HAP 或自定义基座。
平台兼容性
uni-app(4.84)
| Vue2 |
Vue3 |
Chrome |
Safari |
app-vue |
app-nvue |
Android |
iOS |
鸿蒙 |
| √ |
√ |
- |
- |
√ |
√ |
√ |
√ |
√ |
| 微信小程序 |
支付宝小程序 |
抖音小程序 |
百度小程序 |
快手小程序 |
京东小程序 |
鸿蒙元服务 |
QQ小程序 |
飞书小程序 |
小红书小程序 |
快应用-华为 |
快应用-联盟 |
| - |
- |
- |
- |
- |
- |
- |
- |
- |
- |
- |
- |
uni-app x(4.84)
| Chrome |
Safari |
Android |
iOS |
鸿蒙 |
微信小程序 |
| - |
- |
√ |
√ |
√ |
- |
# lizhao-wechat-kit
lizhao-wechat-kit 是纯 UTS 的微信开放能力 API 插件,支持统一调用微信注册、授权登录、分享、支付、商家转账用户确认、打开小程序、打开客服与微信回流监听。
插件简介
- 插件名:
lizhao-wechat-kit
- 插件类型:UTS API 插件
- 调用环境:
uni-app / uni-app x
- 导入路径:
@/uni_modules/lizhao-wechat-kit
目录结构
uni_modules/lizhao-wechat-kit
├─ package.json
├─ readme.md
├─ changelog.md
└─ utssdk
├─ interface.uts
├─ unierror.uts
├─ index.uts
├─ app-android
├─ app-ios
├─ app-harmony
├─ web
├─ mp-weixin
└─ mp-alipay
支持平台
| 平台 |
是否支持 |
说明 |
| uni-app |
是 |
支持 API 调用 |
| uni-app x |
是 |
支持 API 调用 |
| Android |
是 |
接入微信 OpenSDK |
| iOS |
是 |
接入微信 OpenSDK(需 universalLink) |
| Harmony |
否 |
当前版本返回明确不支持错误 |
| Web |
否 |
当前版本返回明确不支持错误 |
| 微信小程序 |
否 |
当前版本返回明确不支持错误 |
| 支付宝小程序 |
否 |
当前版本返回明确不支持错误 |
安装说明
import * as WeChatKit from '@/uni_modules/lizhao-wechat-kit'
API 列表
register(options)
isInstall()
isWXAppSupportApi(api)
openWXApp(options)
getApiSupportInfo(options)
login(options)
share(options)
pay(options)
requestMerchantTransfer(options)
launchMiniProgram(options)
openCustomerService(options)
onLaunchFromWX(options)
offLaunchFromWX(listener?)
getTTWeChatSDK()
参数说明
register(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatRegisterOptions |
是 |
注册参数对象 |
无 |
appId / appid / universalLink / success / fail / complete |
| options.appId |
string |
条件 |
微信开放平台 AppID,与 appid 二选一 |
无 |
无 |
| options.appid |
string |
条件 |
appId 兼容字段 |
无 |
无 |
| options.universalLink |
string |
否 |
iOS Universal Link |
无 |
无 |
| options.success |
function |
否 |
成功回调 |
无 |
无 |
| options.fail |
function |
否 |
失败回调 |
无 |
无 |
| options.complete |
function |
否 |
完成回调 |
无 |
无 |
login(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatLoginOptions |
是 |
登录参数对象 |
无 |
state / success / fail / complete |
| options.state |
string |
否 |
登录透传状态 |
无 |
无 |
| options.success |
function |
否 |
成功回调,返回 code/state/lang/country |
无 |
无 |
| options.fail |
function |
否 |
失败回调 |
无 |
无 |
| options.complete |
function |
否 |
完成回调 |
无 |
无 |
share(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatShareOptions |
是 |
分享参数对象 |
无 |
type / scene / title / desc / text / imageUrl / thumbImageUrl / videoUrl / musicUrl / href / filePath / fileExt / miniProgram / success / fail / complete |
| options.type |
number |
是 |
分享类型 |
无 |
0:text / 1:image / 2:video / 3:webpage / 4:miniProgram / 5:music / 6:file |
| options.scene |
number |
是 |
分享场景 |
0 |
0:会话 / 1:朋友圈 / 2:收藏 |
| options.title |
string |
否 |
分享标题 |
无 |
无 |
| options.desc |
string |
否 |
分享描述 |
无 |
无 |
| options.text |
string |
否 |
文本分享内容 |
无 |
无 |
| options.imageUrl |
string |
否 |
图片本地路径 |
无 |
无 |
| options.thumbImageUrl |
string |
否 |
缩略图本地路径 |
无 |
无 |
| options.videoUrl |
string |
否 |
视频链接 |
无 |
无 |
| options.musicUrl |
string |
否 |
音乐链接 |
无 |
无 |
| options.href |
string |
否 |
网页链接 |
无 |
无 |
| options.filePath |
string |
否 |
文件本地路径 |
无 |
无 |
| options.fileExt |
string |
否 |
文件扩展名 |
无 |
无 |
| options.miniProgram |
object |
否 |
小程序分享参数 |
无 |
userName / path / miniProgramType / webpageUrl |
pay(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatPayOptions |
是 |
支付参数对象 |
无 |
partnerId / prepayId / nonceStr / timeStamp / package / sign / signType / extData / success / fail / complete |
| options.partnerId |
string |
是 |
商户号 |
无 |
无 |
| options.prepayId |
string |
是 |
预支付交易会话标识 |
无 |
无 |
| options.nonceStr |
string |
是 |
随机串 |
无 |
无 |
| options.timeStamp |
number |
是 |
时间戳(秒) |
无 |
无 |
| options.package |
string |
是 |
扩展字段 |
无 |
无 |
| options.sign |
string |
是 |
支付签名 |
无 |
无 |
| options.signType |
string |
否 |
签名算法 |
MD5 |
无 |
| options.extData |
string |
否 |
扩展数据 |
无 |
无 |
requestMerchantTransfer(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatRequestMerchantTransferOptions |
是 |
商家转账用户确认参数 |
无 |
mchId / package / appId / openId / subAppId / subMchId / transferId / businessType / success / fail / complete |
| options.mchId |
string |
是 |
商户号 |
无 |
无 |
| options.package |
string |
是 |
转账业务包参数 |
无 |
无 |
| options.appId |
string |
否 |
子应用 appId |
无 |
无 |
| options.openId |
string |
否 |
用户 openId |
无 |
无 |
| options.subAppId |
string |
否 |
子商户 appId |
无 |
无 |
| options.subMchId |
string |
否 |
子商户号 |
无 |
无 |
| options.transferId |
string |
否 |
转账单号 |
无 |
无 |
| options.businessType |
string |
否 |
业务类型 |
transfer_to_change |
无 |
launchMiniProgram(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatLaunchMiniProgramOptions |
是 |
打开小程序参数 |
无 |
userName / path / miniProgramType / success / fail / complete |
| options.userName |
string |
是 |
小程序原始 ID |
无 |
无 |
| options.path |
string |
否 |
小程序页面路径 |
无 |
无 |
| options.miniProgramType |
number |
否 |
小程序版本 |
0 |
0:正式 / 1:开发 / 2:体验 |
openCustomerService(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatOpenCustomerServiceOptions |
是 |
微信客服参数 |
无 |
corpId / url / success / fail / complete |
| options.corpId |
string |
否 |
企业 ID |
无 |
无 |
| options.url |
string |
是 |
客服会话或 URL 跳转地址 |
无 |
无 |
onLaunchFromWX(options)
| 参数 |
类型 |
必填 |
说明 |
默认值 |
可选参数 |
| options |
TTWeChatLaunchListenerOptions |
是 |
微信回流事件订阅参数 |
无 |
success / fail / complete |
| options.success |
function |
是 |
回流事件回调,返回 data/scene/platform/timestamp |
无 |
无 |
| options.fail |
function |
否 |
失败回调 |
无 |
无 |
| options.complete |
function |
否 |
完成回调 |
无 |
无 |
返回值说明
| 字段 |
类型 |
说明 |
| code |
string |
登录授权码(服务端换取 access_token) |
| state |
string |
登录透传状态 |
| platform |
string |
当前平台 |
| completed |
boolean |
当前链路是否完成 |
| opened |
boolean |
拉起动作是否成功触发 |
| registered |
boolean |
SDK 是否已注册 |
错误码说明
| 错误码 |
含义 |
说明 |
| 9014101 |
platform unsupported |
当前平台不支持该能力 |
| 9014102 |
wechat sdk not registered |
未先调用 register |
| 9014103 |
invalid options |
参数非法 |
| 9014104 |
wechat not installed |
设备未安装微信 |
| 9014105 |
wechat api not supported |
当前微信版本不支持目标 API |
| 9014106 |
user cancel |
用户取消 |
| 9014107 |
wechat request failed |
请求发送或回调失败 |
| 9014108 |
wechat signature or config invalid |
签名、配置或 universalLink 不匹配 |
| 9014109 |
not implemented |
当前平台实现未提供 |
| 9014110 |
system error |
系统环境异常 |
| 9014111 |
operation busy |
操作冲突或微信返回 busy |
权限说明
- Android:按微信 OpenSDK 要求完成应用与权限配置。
- iOS:需配置 URL Scheme 与 Universal Link。
自定义基座说明
本插件接入微信 OpenSDK(原生依赖与平台配置),默认需要自定义基座。
uni-app 示例
import * as WeChatKit from '@/uni_modules/lizhao-wechat-kit'
WeChatKit.register({
appId: 'wx1234567890abcdef',
universalLink: 'https://your.domain.com/app/',
success() {
WeChatKit.login({
state: Date.now().toString(),
success(res) {
console.log('login code =', res.code)
},
fail(err) {
console.error('login fail', err)
}
})
}
})
uni-app x 示例
import * as WeChatKit from '@/uni_modules/lizhao-wechat-kit'
WeChatKit.register({
appId: 'wx1234567890abcdef',
universalLink: 'https://your.domain.com/app/'
})
WeChatKit.share({
type: 3,
scene: 0,
title: '分享标题',
desc: '分享描述',
href: 'https://example.com'
})
注意事项
- 必须先调用
register,再调用其他微信能力。
pay 与 requestMerchantTransfer 的签名参数必须由服务端生成。
- 不支持平台会返回明确错误,不会静默成功。
- iOS 需确保开放平台配置与
universalLink 严格一致。
联系方式
信-微:l-z-1-8-7-1512-5421(-去掉,不这样写会被和谐)
作者系列UTS插件
以下为已在 DCloud 插件市场上架的作者系列 UTS 插件,可按业务场景组合使用。未列出的插件表示当前未确认公开市场页,后续上架后再补充。
| 插件 |
能力方向 |
插件市场 |
lizhao-nfc-pro |
NFC 标签读写、NDEF、IsoDep 与诊断 |
查看插件 |
lizhao-float-window |
悬浮窗、画中画、权限与诊断 |
查看插件 |
lizhao-device-id |
设备标识、隐私策略与诊断 |
查看插件 |
lizhao-scan-pro |
原生扫码、连续扫码、相册识别 |
查看插件 |
lizhao-choose-file |
原生文件选择、上传、进度与取消 |
查看插件 |
lizhao-bg-audio |
背景音频播放、队列、倍速与事件 |
查看插件 |
lizhao-smart-tts |
系统 TTS、云端合成、听书方案 |
查看插件 |
lizhao-share-plus |
系统分享、远程文件下载后分享 |
查看插件 |
lizhao-sqlite-pro |
原生 SQLite、迁移、备份与诊断 |
查看插件 |
lizhao-icon-pro |
SVG 图标组件、多主题与缓存 |
查看插件 |
lizhao-cast-screen |
DLNA 投屏、AirPlay 路由入口 |
查看插件 |
lizhao-call-kit |
电话、短信、通讯录原生能力 |
查看插件 |
lizhao-app-keepalive |
应用保活、唤醒、自愈与报告 |
查看插件 |
lizhao-doc-corrector |
文档扫描、矫正、增强与识别 |
查看插件 |
lizhao-emu-detect |
模拟器环境检测、风险评分与证据 |
查看插件 |
lizhao-gallery-pro |
相册媒体分页、筛选、缩略图与导出 |
查看插件 |
lizhao-video-thumb |
视频封面、批量取帧与 Base64 返回 |
查看插件 |
lizhao-ble |
BLE 扫描、连接、读写、通知与自动重连 |
查看插件 |
lizhao-sse-pro |
SSE、Line、JSONL 与 Raw 流式请求 |
查看插件 |