服务端API

版本:v2.21.0 更新:2021 年 12 月 25 日

登录

名称	功能说明
auth.code2Session	登录凭证校验

用户信息

名称	功能说明
auth.getPaidUnionId	用户支付完成后，获取该用户的 UnionId，无需用户授权

接口调用凭证

名称	功能说明
auth.getAccessToken	获取小程序全局唯一后台接口调用凭据（access_token）

数据分析

访问留存

名称	功能说明
analysis.getDailyRetain	获取用户访问小程序日留存
analysis.getMonthlyRetain	获取用户访问小程序月留存
analysis.getWeeklyRetain	获取用户访问小程序周留存

访问趋势

名称	功能说明
analysis.getDailyVisitTrend	获取用户访问小程序数据日趋势
analysis.getMonthlyVisitTrend	获取用户访问小程序数据月趋势
analysis.getWeeklyVisitTrend	获取用户访问小程序数据周趋势
analysis.getUserPortrait	获取小程序新增或活跃用户的画像分布数据
analysis.getVisitDistribution	获取用户小程序访问分布数据
analysis.getVisitPage	访问页面
analysis.getDailySummary	获取用户访问小程序数据概况

客服消息

名称	功能说明
customerServiceMessage.getTempMedia	获取客服消息内的临时素材
customerServiceMessage.send	发送客服消息给用户
customerServiceMessage.setTyping	下发客服当前输入状态给用户
customerServiceMessage.uploadTempMedia	把媒体文件上传到微信服务器

模板消息

名称	功能说明
templateMessage.addTemplate	组合模板并添加至帐号下的个人模板库
templateMessage.deleteTemplate	删除帐号下的某个模板
templateMessage.getTemplateLibraryById	获取模板库某个模板标题下关键词库
rst:wxbpi:templateMessage.getTemplateLibraryList	获取小程序模板库标题列表
templateMessage.getTemplateList	获取帐号下已存在的模板列表
templateMessage.send	发送模板消息

统一服务消息

名称	功能说明
下发统一服务消息	下发小程序和公众号统一的服务消息

动态消息

名称	功能说明
updatableMessage.createActivityId	创建被分享动态消息的 activity_id
updatableMessage.setUpdatableMsg	修改被分享的动态消息

插件管理

名称	功能说明
pluginManager.applyPlugin	向插件开发者发起使用插件的申请
pluginManager.getPluginDevApplyList	获取当前所有插件使用方（供插件开发者调用）
pluginManager.getPluginList	查询已添加的插件
pluginManager.setDevPluginApplyStatus	修改插件使用申请的状态（供插件开发者调用）
pluginManager.unbindPlugin	删除已添加的插件

附近的小程序

名称	功能说明
nearbyPoi.add	添加地点
nearbyPoi.delete	删除地点
nearbyPoi.getList	查看地点列表
nearbyPoi.setShowStatus	展示/取消展示附近小程序

小程序码

名称	功能说明
wxacode.createQRCode	获取小程序二维码，适用于需要的码数量较少的业务场景
wxacode.get	获取小程序码，适用于需要的码数量较少的业务场景
wxacode.getUnlimited	获取小程序码，适用于需要的码数量极多的业务场景

内容安全

名称	功能说明
security.imgSecCheck	校验一张图片是否含有违法违规内容
security.msgSecCheck	检查一段文本是否含有违法违规内容

物流助手

小程序使用

名称	功能说明
运单轨迹更新事件	运单轨迹更新事件
请求下单事件 ☁️	生成运单
logistics.cancelOrder ☁️	取消运单
logistics.getAllDelivery ☁️	获取支持的快递公司列表
logistics.getOrder ☁️	获取运单数据
logistics.getPath ☁️	查询运单轨迹
logistics.getPrinter ☁️	获取打印员
logistics.getQuota ☁️	获取电子面单余额
更新打印员 ☁️	更新打印员

服务提供方使用

名称	功能说明
logistics.getContact ☁️	获取面单联系人信息
logistics.onAddOrder	请求下单事件
取消订单事件	取消订单事件
审核商户事件	审核商户事件
查询商户余额事件	查询商户余额事件
预览面单模板 ☁️	预览面单模板
更新商户审核结果 ☁️	更新商户审核结果
更新运单轨迹 logistics.updatePath ☁️	更新运单轨迹

生物认证

名称	功能说明
soter.verifySignature	SOTER 生物认证秘钥签名验证

订阅消息

名称	功能说明
subscribeMessage.addTemplate ☁️	组合模板并添加至帐号下的个人模板库
subscribeMessage.deleteTemplate ☁️	删除帐号下的个人模板
subscribeMessage.getCategory ☁️	获取小程序账号的类目
subscribeMessage.getPubTemplateKeyWordsById ☁️	获取模板标题下的关键词列表
subscribeMessage.getPubTemplateTitleList ☁️	获取帐号所属类目下的公共模板标题
subscribeMessage.getTemplateList ☁️	获取当前帐号下的个人模板列表
subscribeMessage.send ☁️	发送订阅消息