# 接口调用凭证
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取接口调用凭据 | getAccessToken | /cgi-bin/token |
| 获取稳定版接口调用凭据 | getStableAccessToken | /cgi-bin/stable_token |
# openApi管理
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 查询API调用额度 | getApiQuota | /cgi-bin/openapi/quota/get |
| 重置API调用次数 | clearQuota | /cgi-bin/clear_quota |
| 重置指定API调用次数 | clearApiQuota | /cgi-bin/openapi/quota/clear |
| 使用AppSecret重置API调用次数 | clearQuotaByAppSecret | /cgi-bin/clear_quota/v2 |
| 查询rid信息 | getRidInfo | /cgi-bin/openapi/rid/get |
| 网络通信检测 | callbackCheck | /cgi-bin/callback/check |
| 获取微信API服务器IP | getApiDomainIp | /cgi-bin/get_api_domain_ip |
| 获取微信推送服务器IP | getCallbackIp | /cgi-bin/getcallbackip |
# 用户信息
# 用户信息
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取插件用户openpid | getPluginOpenPId | /wxa/getpluginopenpid |
| 检查加密信息 | checkEncryptedData | /wxa/business/checkencryptedmsg |
| 支付后获取Unionid | getPaidUnionid | /wxa/getpaidunionid |
# 网络
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取用户encryptKey | getUserEncryptKey | /wxa/business/getuserencryptkey |
# 手机号
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取手机号 | getPhoneNumber | /wxa/business/getuserphonenumber |
# 小程序登录
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 小程序登录凭证校验 | code2Session | /sns/jscode2session |
| 检验登录态 | checkSessionKey | /wxa/checksession |
| 重置登录态 | ResetUserSessionKey | /wxa/resetusersessionkey |
# 小程序码与小程序链接
# 小程序码
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取小程序码 | getQRCode | /wxa/getwxacode |
| 获取不限制的小程序码 | getUnlimitedQRCode | /wxa/getwxacodeunlimit |
| 获取小程序二维码 | createQRCode | /cgi-bin/wxaapp/createwxaqrcode |
# URL Scheme
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 查询scheme码 | queryScheme | /wxa/queryscheme |
| 获取加密scheme码 | generateScheme | /wxa/generatescheme |
| 获取NFC的小程序scheme | generateNFCScheme | /wxa/generatenfcscheme |
# URL Link
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取加密URLLink | generateUrlLink | /wxa/generate_urllink |
| 查询加密URLLink | queryUrlLink | /wxa/query_urllink |
# Short Link
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取ShortLink | generateShortLink | /wxa/genwxashortlink |
# 小程序客服
# 客服消息
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取临时素材 | getMedia | /cgi-bin/media/get |
| 客服输入状态 | typing | /cgi-bin/message/custom/business/typing |
| 新增临时素材 | uploadTempMedia | /cgi-bin/media/upload |
| 发送客服消息 | sendCustomMessage | /cgi-bin/message/custom/send |
# 微信客服
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 查询绑定情况 | getKfWorkBound | /customservice/work/get |
| 绑定微信客服 | bindKfWork | /customservice/work/bind |
| 解除绑定微信客服 | unbindKfWork | /customservice/work/unbind |
# 消息相关
# 动态消息
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 创建activity_id | createActivityId | /cgi-bin/message/wxopen/activityid/create |
| 修改动态消息 | setUpdatableMsg | /cgi-bin/message/wxopen/updatablemsg/send |
| 修改小程序聊天工具的动态卡片消息 | setChatToolMsg | /cgi-bin/message/wxopen/chattoolmsg/send |
# 订阅消息
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 删除模板 | delwxanewtemplate | /wxaapi/newtmpl/deltemplate |
| 获取类目 | getCategory | /wxaapi/newtmpl/getcategory |
| 获取模板中的关键词 | getpubnewtemplatekeywords | /wxaapi/newtmpl/getpubtemplatekeywords |
| 获取类目下的公共模板 | getPubNewTemplatetitles | /wxaapi/newtmpl/getpubtemplatetitles |
| 获取已有模板列表 | getwxapubnewtemplate | /wxaapi/newtmpl/gettemplate |
| 发送订阅消息 | sendMessage | /cgi-bin/message/subscribe/send |
| 选用模板 | addwxanewtemplate | /wxaapi/newtmpl/addtemplate |
| 激活与更新服务卡片 | setUserNotify | /wxa/set_user_notify |
| 更新服务卡片扩展信息 | setUserNotifyExt | /wxa/set_user_notifyext |
| 查询服务卡片状态 | getUserNotify | /wxa/get_user_notify |
# 用工关系
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 推送用工消息 | SendEmployeeRelationMsg | /cgi-bin/message/wxopen/employeerelationmsg/send |
| 解绑用工关系 | UnbindUserB2CAuthInfo | /wxa/business/unbinduserb2cauthinfo |
# 小程序安全
# 内容安全
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 文本内容安全识别 | msgSecCheck | /wxa/msg_sec_check |
| 多媒体内容安全识别 | mediaCheckAsync | /wxa/media_check_async |
# 安全风控
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取用户安全等级 | getUserRiskRank | /wxa/getuserriskrank |
# 数据分析
# 访问留存
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取用户访问小程序周留存 | getWeeklyRetain | /datacube/getweanalysisappidweeklyretaininfo |
| 获取用户访问小程序月留存 | getMonthlyRetain | /datacube/getweanalysisappidmonthlyretaininfo |
| 获取用户访问小程序日留存 | getDailyRetain | /datacube/getweanalysisappiddailyretaininfo |
# 访问趋势
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取用户访问小程序数据月趋势 | getMonthlyVisitTrend | /datacube/getweanalysisappidmonthlyvisittrend |
| 获取用户访问小程序数据日趋势 | getDailyVisitTrend | /datacube/getweanalysisappiddailyvisittrend |
| 获取用户访问小程序数据周趋势 | getWeeklyVisitTrend | /datacube/getweanalysisappidweeklyvisittrend |
# 其他
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取用户访问小程序数据概况 | getDailySummary | /datacube/getweanalysisappiddailysummarytrend |
| 获取访问页面数据 | getVisitPage | /datacube/getweanalysisappidvisitpage |
| 获取小程序用户画像分布 | getUserPortrait | /datacube/getweanalysisappiduserportrait |
| 获取小程序性能数据 | getPerformanceData | /wxa/business/performance/boot |
| 获取用户小程序访问分布数据 | getVisitDistribution | /datacube/getweanalysisappidvisitdistribution |
# 硬件设备
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 发送设备消息 | sendHardwareDeviceMessage | /cgi-bin/message/device/subscribe/send |
| 获取设备票据 | getSnTicket | /wxa/getsnticket |
| 创建设备组 | createIotGroupId | /wxa/business/group/createid |
| 查询设备组信息 | getIotGroupInfo | /wxa/business/group/getinfo |
| 设备组添加设备 | addIotGroupDevice | /wxa/business/group/adddevice |
| 设备组删除设备 | removeIotGroupDevice | /wxa/business/group/removedevice |
| 查询license资源包列表 | getLicensePkgList | /wxa/business/license/getpkglist |
| 激活设备license | activeLicenseDevice | /wxa/business/license/activedevice |
| 查询设备激活详情 | getLicenseDeviceInfo | /wxa/business/license/getdeviceinfo |
# 运维中心
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 查询域名配置 | getDomainInfo | /wxa/getwxadevinfo |
| 获取性能数据 | getPerformance | /wxaapi/log/get_performance |
| 获取访问来源 | getSceneList | /wxaapi/log/get_scene |
| 获取客户端版本 | getVersionList | /wxaapi/log/get_client_version |
| 查询实时日志 | realtimelogSearch | /wxaapi/userlog/userlog_search |
| 获取用户反馈列表 | getFeedback | /wxaapi/feedback/list |
| 获取mediaId图片 | getFeedbackmedia | /cgi-bin/media/getfeedbackmedia |
| 查询js错误详情 | getJsErrDetail | /wxaapi/log/jserr_detail |
| 查询错误列表 | getJsErrList | /wxaapi/log/jserr_list |
| 获取分阶段发布详情 | getGrayReleasePlan | /wxa/getgrayreleaseplan |
# 插件管理
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 插件申请管理 | managePluginApplication | /wxa/devplugin |
| 插件管理 | managePlugin | /wxa/plugin |
# 云开发
# 云函数
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 触发云函数 | invokeCloudFunction | /tcb/invokecloudfunction |
# 数据库
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 数据库插入记录 | addDatabaseItem | /tcb/databaseadd |
| 数据库聚合 | aggregateDatabase | /tcb/databaseaggregate |
| 新增集合 | addDatabaseCollection | /tcb/databasecollectionadd |
| 删除集合 | deleteDatabaseCollection | /tcb/databasecollectiondelete |
| 获取集合信息 | getDatabaseCollection | /tcb/databasecollectionget |
| 统计集合记录数 | getDatabaseCount | /tcb/databasecount |
| 数据库删除记录 | deleteDatabaseItem | /tcb/databasedelete |
| 数据库导出 | exportDatabaseItem | /tcb/databasemigrateexport |
| 数据库导入 | importDatabaseItem | /tcb/databasemigrateimport |
| 数据库迁移状态查询 | getDatabaseMigrateStatus | /tcb/databasemigratequeryinfo |
| 数据库查询记录 | getDatabaseRecord | /tcb/databasequery |
| 数据库更新记录 | updateDatabaseRecord | /tcb/databaseupdate |
| 更新数据库索引 | updateDatabaseIndex | /tcb/updateindex |
# 存储
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取文件上传链接 | getUploadTcbFileLink | /tcb/uploadfile |
| 获取文件下载链接 | getDownloadTcbFileLink | /tcb/batchdownloadfile |
| 删除文件 | deleteTcbCloudFile | /tcb/batchdeletefile |
# 其他
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 发送短信v2 | newSendCloudBaseSms | /tcb/sendsmsv2 |
| 发送短信 | sendCloudBaseSms | /tcb/sendsms |
| 创建发短信任务 | createSendSmsTask | /tcb/createsendsmstask |
| 云开发上报接口 | cloudbaseReportAPI | /tcb/cloudbasereport |
| 查询短信记录 | describeSmsRecords | /tcb/describesmsrecords |
| 描述扩展上传文件信息 | describeExtensionUploadInfo | /tcb/describeextensionuploadinfo |
| 获取云开发数据 | getCloudBaseStatistics | /tcb/getstatistics |
| 获取cloudID对应的数据 | getOpenData | /wxa/getopendata |
| 获取实时语音签名 | getCloudBaseVoIPSign | /wxa/getvoipsign |
| 获取腾讯云API调用凭证 | getCloudToken | /tcb/getqcloudtoken |
# 物流助手
# 小程序使用
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 绑定/解绑物流账号 | bindAccount | /cgi-bin/express/business/account/bind |
| 获取所有绑定的物流账号 | getAllAccount | /cgi-bin/express/business/account/getall |
| 获取支持的快递公司列表 | getAllDelivery | /cgi-bin/express/business/delivery/getall |
| 取消运单 | cancelOrder | /cgi-bin/express/business/order/cancel |
| 配置面单打印员 | updatePrinter | /cgi-bin/express/business/printer/update |
| 获取电子面单余额 | getQuota | /cgi-bin/express/business/quota/get |
| 获取运单数据 | getOrder | /cgi-bin/express/business/order/get |
| 模拟更新订单状态 | testUpdateOrder | /cgi-bin/express/business/test_update_order |
| 获取打印员 | getPrinter | /cgi-bin/express/business/printer/getall |
| 查询运单轨迹 | getPath | /cgi-bin/express/business/path/get |
| 批量获取运单数据 | batchGetOrder | /cgi-bin/express/business/order/batchget |
| 生成运单 | addOrder | /cgi-bin/express/business/order/add |
# 运力方使用
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 更新商户审核结果 | updateBusiness | /cgi-bin/express/delivery/service/business/update |
| 更新运单轨迹 | updatePath | /cgi-bin/express/delivery/path/update |
| 预览面单模板 | previewTemplate | /cgi-bin/express/delivery/template/preview |
| 获取面单联系人信息 | getContact | /cgi-bin/express/delivery/contact/get |
# 即时配送
# 小程序使用
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取已支持的配送公司列表 | getAllImmeDelivery | /cgi-bin/express/local/business/delivery/getall |
| 预下配送单 | preAddOrder | /cgi-bin/express/local/business/order/pre_add |
| 拉取已绑定账号 | getBindAccount | /cgi-bin/express/local/business/shop/get |
| 预取消配送单 | preCancelOrder | /cgi-bin/express/local/business/order/precancel |
| 申请开通即时配送 | openDelivery | /cgi-bin/express/local/business/open |
| 发起绑定请求 | bindLocalAccount | /cgi-bin/express/local/business/shop/add |
| 重新下单 | reOrder | /cgi-bin/express/local/business/order/readd |
| 模拟更新配送单状态 | realMockUpdateOrder | /cgi-bin/express/local/business/realmock_update_order |
| 模拟配送公司更新配送单状态 | mockUpdateOrder | /cgi-bin/express/local/business/test_update_order |
| 拉取配送单信息 | getLocalOrder | /cgi-bin/express/local/business/order/get |
| 异常件退回商家确认 | abnormalConfirm | /cgi-bin/express/local/business/order/confirm_return |
| 取消配送单 | cancelLocalOrder | /cgi-bin/express/local/business/order/cancel |
| 添加小费 | addTips | /cgi-bin/express/local/business/order/addtips |
| 添加配送单 | addLocalOrder | /cgi-bin/express/local/business/order/add |
# 运力方使用
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 更新配送单状态 | updateOrder | /cgi-bin/express/local/delivery/update_order |
# 小程序交易管理服务
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 品牌申请 | famousBrandApply | /wxa/sec/famousbrand/apply |
| 小程序品牌申请状态查询 | getFamousBrandApplyStatus | /wxa/sec/famousbrand/get_status |
# 交易保障
# 基础能力
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取小程序交易体验分违规记录 | GetPenaltyList | /wxaapi/wxamptrade/get_penalty_list |
| 获取交易保障标状态 | GetGuaranteeStatus | /wxaapi/wxamptrade/get_guarantee_status |
# 附近小程序
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 添加地点 | addNearbyPoi | /wxa/addnearbypoi |
| 删除地点 | deleteNearbyPoi | /wxa/delnearbypoi |
| 查看地点 | getNearbyPoiList | /wxa/getnearbypoilist |
| 设置展示状态 | setShowStatus | /wxa/setnearbypoishowstatus |
# 小程序直播
# 直播间管理
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 创建直播间 | createRoom | /wxaapi/broadcast/room/create |
| 获取直播间列表和回放 | getLiveInfo | /wxa/business/getliveinfo |
| 删除直播间 | deleteRoom | /wxaapi/broadcast/room/deleteroom |
| 导入商品 | importGoods | /wxaapi/broadcast/room/addgoods |
| 编辑直播间 | editRoom | /wxaapi/broadcast/room/editroom |
| 获取直播间推流地址 | getPushUrl | /wxaapi/broadcast/room/getpushurl |
| 获取直播间分享二维码 | getSharedCode | /wxaapi/broadcast/room/getsharedcode |
| 获取主播副号 | getSubAnchor | /wxaapi/broadcast/room/getsubanchor |
| 修改主播副号 | modifySubAnchor | /wxaapi/broadcast/room/modifysubanchor |
| 删除主播副号 | deleteSubAnchor | /wxaapi/broadcast/room/deletesubanchor |
| 添加主播副号 | addSubAnchor | /wxaapi/broadcast/room/addsubanchor |
| 删除直播间商品 | deleteDoods | /wxaapi/broadcast/goods/deleteInRoom |
| 推送商品 | pushGoods | /wxaapi/broadcast/goods/push |
| 上下架商品 | SaleGoods | /wxaapi/broadcast/goods/onsale |
| 直播间商品排序 | sortGoods | /wxaapi/broadcast/goods/sort |
| 修改直播间小助手 | modifyAssistant | /wxaapi/broadcast/room/modifyassistant |
| 查询直播间小助手 | getAssistantList | /wxaapi/broadcast/room/getassistantlist |
| 删除直播间小助手 | removeAssistant | /wxaapi/broadcast/room/removeassistant |
| 添加管理直播间小助手 | addveAssistant | /wxaapi/broadcast/room/addassistant |
| 禁言管理 | updateComment | /wxaapi/broadcast/room/updatecomment |
| 官方收录管理 | updateFeedPublic | /wxaapi/broadcast/room/updatefeedpublic |
| 客服功能管理 | updateKF | /wxaapi/broadcast/room/updatekf |
| 回放功能管理 | updateReplay | /wxaapi/broadcast/room/updatereplay |
| 下载商品讲解视频 | downloadGoodsVideo | /wxaapi/broadcast/goods/getVideo |
# 商品管理
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 添加并提审商品 | addGoods | /wxaapi/broadcast/goods/add |
| 重新提交商品审核 | resubmitAudit | /wxaapi/broadcast/goods/audit |
| 获取商品的信息与审核状态 | getGoodsAuditInfo | /wxa/business/getgoodswarehouse |
| 撤回商品审核 | resetAudit | /wxaapi/broadcast/goods/resetaudit |
| 更新商品 | updateGoodsinfo | /wxaapi/broadcast/goods/update |
| 获取商品列表 | getGoodsInfo | /wxaapi/broadcast/goods/getapproved |
| 删除商品 | deleteGoodsInfo | /wxaapi/broadcast/goods/delete |
# 成员管理
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 设置成员角色 | getRoleListdw | /wxaapi/broadcast/role/addrole |
| 移除成员角色 | deleteRole | /wxaapi/broadcast/role/deleterole |
| 查询成员列表 | getRoleList | /wxaapi/broadcast/role/getrolelist |
# 长期订阅
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 发送直播开始事件 | pushMessage | /wxa/business/push_message |
| 获取长期订阅用户 | getFollowers | /wxa/business/get_wxa_followers |
# 图像处理与文字识别
# 图像处理
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 图片智能裁剪 | imgAiCrop | /cv/img/aicrop |
| 二维码/条码识别 | imgQrcode | /cv/img/qrcode |
| 图片高清化 | imgsuperresolution | /cv/img/superresolution |
# OCR
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 通用印刷体识别 | commocr | /cv/ocr/comm |
| 行驶证识别 | drivingocr | /cv/ocr/driving |
| 银行卡识别 | bankcardOcr | /cv/ocr/bankcard |
| 营业执照识别 | bizlicenseOcr | /cv/ocr/bizlicense |
| 驾驶证识别 | drivinglicenseocr | /cv/ocr/drivinglicense |
| 身份证识别 | idcardOcr | /cv/ocr/idcard |
# 微信红包封面
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 获取微信红包封面 | getRedPacketCoverUrl | /redpacketcover/wxapp/cover_url/get_by_token |
# 微信服务市场
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 调用服务市场接口 | invokeService | /wxa/servicemarket |
# 生物认证
| 接口名称 | 英文名 | 请求路径 |
|---|---|---|
| 生物认证秘钥签名验证 | verifySignature | /cgi-bin/soter/verify_signature |