## 接口调用凭证 ```json [ { "接口名称": "[获取接口调用凭据](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)", "请求路径": "/cgi-bin/token", "描述": "本接口用于获取获取全局唯一后台接口调用凭据（Access Token），token 有效期为 7200 秒，开发者需要进行妥善保存，使用注意事项请参考此文档" }, { "接口名称": "[获取稳定版接口调用凭据](/miniprogram/dev/server/API/mp-access-token/api_getstableaccesstoken)", "请求路径": "/cgi-bin/stable_token", "描述": "本接口用于获取获取全局唯一后台接口调用凭据（Access Token），token 有效期为 7200 秒，但此接口和 getAccessToken 互相隔离，" } ] ``` ## openApi管理 ```json [ { "接口名称": "[查询API调用额度](/miniprogram/dev/server/API/openApi-mgnt/api_getapiquota)", "请求路径": "/cgi-bin/openapi/quota/get", "描述": "本接口用于查询服务端接口的的每日调用接口的额度，调用次数，频率限制" }, { "接口名称": "[重置API调用次数](/miniprogram/dev/server/API/openApi-mgnt/api_clearquota)", "请求路径": "/cgi-bin/clear_quota", "描述": "本接口是通过access_token清空服务端接口的每日调用接口次数" }, { "接口名称": "[重置指定API调用次数](/miniprogram/dev/server/API/openApi-mgnt/api_clearapiquota)", "请求路径": "/cgi-bin/openapi/quota/clear", "描述": "本接口使用 access_token 来重置指定接口的每日调用次数" }, { "接口名称": "[使用AppSecret重置API调用次数](/miniprogram/dev/server/API/openApi-mgnt/api_clearquotabyappsecret)", "请求路径": "/cgi-bin/clear_quota/v2", "描述": "本接口是通过AppSecret清空服务端接口的每日调用接口次数" }, { "接口名称": "[查询rid信息](/miniprogram/dev/server/API/openApi-mgnt/api_getridinfo)", "请求路径": "/cgi-bin/openapi/rid/get", "描述": "本接口用于查询调用服务端接口报错返回的rid详情信息，辅助开发者高效定位问题" }, { "接口名称": "[网络通信检测](/miniprogram/dev/server/API/openApi-mgnt/api_callbackcheck)", "请求路径": "/cgi-bin/callback/check", "描述": "为了帮助开发者排查回调连接失败的问题，提供这个网络检测的API" }, { "接口名称": "[获取微信API服务器IP](/miniprogram/dev/server/API/openApi-mgnt/api_getapidomainip)", "请求路径": "/cgi-bin/get_api_domain_ip", "描述": "该接口用于获取微信 api 服务器 ip 地址（开发者服务器主动访问 api.weixin.qq.com 的远端地址）" }, { "接口名称": "[获取微信推送服务器IP](/miniprogram/dev/server/API/openApi-mgnt/api_getcallbackip)", "请求路径": "/cgi-bin/getcallbackip", "描述": "该接口用于获取微信推送服务器 ip 地址（向开发者服务器推送信息的微信服务器来源地址）" } ] ``` ## 用户信息 ### 用户信息 ```json [ { "接口名称": "[获取插件用户openpid](/miniprogram/dev/server/API/user-info/basic-info/api_getpluginopenpid)", "请求路径": "/wxa/getpluginopenpid", "描述": "通过 wx.pluginLogin 接口获得插件用户标志凭证 code 后传到开发者服务器，开发者服务器调用此接口换取插件用户的唯一标识 openpid" }, { "接口名称": "[检查加密信息](/miniprogram/dev/server/API/user-info/basic-info/api_checkencrypteddata)", "请求路径": "/wxa/business/checkencryptedmsg", "描述": "检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近3天生成的加密数据" }, { "接口名称": "[支付后获取Unionid](/miniprogram/dev/server/API/user-info/basic-info/api_getpaidunionid)", "请求路径": "/wxa/getpaidunionid", "描述": "该接口用于在用户支付完成后，获调用本接口前需要用户完成支付，用户支付完成后，取该用户的 UnionId，无需用户授权" } ] ``` ### 网络 ```json [ { "接口名称": "[获取用户encryptKey](/miniprogram/dev/server/API/user-info/internet/api_getuserencryptkey)", "请求路径": "/wxa/business/getuserencryptkey", "描述": "该接口用于获取用户encryptKey" } ] ``` ### 手机号 ```json [ { "接口名称": "[获取手机号](/miniprogram/dev/server/API/user-info/phone-number/api_getphonenumber)", "请求路径": "/wxa/business/getuserphonenumber", "描述": "该接口用于将code换取用户手机号" } ] ``` ## 小程序登录 ```json [ { "接口名称": "[小程序登录凭证校验](/miniprogram/dev/server/API/user-login/api_code2session)", "请求路径": "/sns/jscode2session", "描述": "登录凭证校验" }, { "接口名称": "[检验登录态](/miniprogram/dev/server/API/user-login/api_checksessionkey)", "请求路径": "/wxa/checksession", "描述": "校验服务器所保存的登录态 sessionkey 是否有效" }, { "接口名称": "[重置登录态](/miniprogram/dev/server/API/user-login/api_resetusersessionkey)", "请求路径": "/wxa/resetusersessionkey", "描述": "重置指定的登录态 sessionkey" } ] ``` ## 小程序码与小程序链接 ### 小程序码 ```json [ { "接口名称": "[获取小程序码](/miniprogram/dev/server/API/qrcode-link/qr-code/api_getqrcode)", "请求路径": "/wxa/getwxacode", "描述": "该接口用于获取小程序码，适用于需要的码数量较少的业务场景" }, { "接口名称": "[获取不限制的小程序码](/miniprogram/dev/server/API/qrcode-link/qr-code/api_getunlimitedqrcode)", "请求路径": "/wxa/getwxacodeunlimit", "描述": "该接口用于获取小程序码，适用于需要的码数量极多的业务场景" }, { "接口名称": "[获取小程序二维码](/miniprogram/dev/server/API/qrcode-link/qr-code/api_createqrcode)", "请求路径": "/cgi-bin/wxaapp/createwxaqrcode", "描述": "获取小程序二维码，适用于需要的码数量较少的业务场景" } ] ``` ### URL Scheme ```json [ { "接口名称": "[查询scheme码](/miniprogram/dev/server/API/qrcode-link/url-scheme/api_queryscheme)", "请求路径": "/wxa/queryscheme", "描述": "该接口用于查询小程序 scheme 码，包括加密 scheme 和明文 scheme" }, { "接口名称": "[获取加密scheme码](/miniprogram/dev/server/API/qrcode-link/url-scheme/api_generatescheme)", "请求路径": "/wxa/generatescheme", "描述": "该接口用于获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景" }, { "接口名称": "[获取NFC的小程序scheme](/miniprogram/dev/server/API/qrcode-link/url-scheme/api_generatenfcscheme)", "请求路径": "/wxa/generatenfcscheme", "描述": "该接口用于获取用于 NFC 的小程序 scheme 码，适用于 NFC 拉起小程序的业务场景" } ] ``` ### URL Link ```json [ { "接口名称": "[获取加密URLLink](/miniprogram/dev/server/API/qrcode-link/url-link/api_generateurllink)", "请求路径": "/wxa/generate_urllink", "描述": "获取小程序 URL Link，适用于短信、邮件、网页、微信内等拉起小程序的业务场景" }, { "接口名称": "[查询加密URLLink](/miniprogram/dev/server/API/qrcode-link/url-link/api_queryurllink)", "请求路径": "/wxa/query_urllink", "描述": "该接口用于查询小程序加密 url_link 配置" } ] ``` ### Short Link ```json [ { "接口名称": "[获取ShortLink](/miniprogram/dev/server/API/qrcode-link/short-link/api_generateshortlink)", "请求路径": "/wxa/genwxashortlink", "描述": "获取小程序 Short Link，适用于微信内拉起小程序的业务场景" } ] ``` ## 小程序客服 ### 客服消息 ```json [ { "接口名称": "[添加客服账号](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_addkfaccount)", "请求路径": "/customservice/kfaccount/add", "描述": "本接口用于为公众号、小程序添加客服账号，每个账号最多添加100个客服账号" }, { "接口名称": "[获取所有客服账号](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_getkflist)", "请求路径": "/cgi-bin/customservice/getkflist", "描述": "本接口用于获取所有客服账号" }, { "接口名称": "[获取在线客服列表](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_getonlinekflist)", "请求路径": "/cgi-bin/customservice/getonlinekflist", "描述": "本接口用于获取当前在线客服列表" }, { "接口名称": "[删除客服账号](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_delkfaccount)", "请求路径": "/customservice/kfaccount/del", "描述": "本接口用于删除客服账号" }, { "接口名称": "[发送客服消息](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_sendcustommessage)", "请求路径": "/cgi-bin/message/custom/send", "描述": "本接口用于发送多种类型的客服消息，主要应用在有人工消息处理环节的场景" }, { "接口名称": "[客服输入状态](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_typing)", "请求路径": "/cgi-bin/message/custom/business/typing", "描述": "本接口用于设置客服输入状态" }, { "接口名称": "[设置客服管理员](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_setkfadmin)", "请求路径": "/customservice/kfaccount/setadmin", "描述": "该接口将账号客服编号对应客服账号设置为客服管理员" }, { "接口名称": "[取消客服管理员](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_cancelkfadmin)", "请求路径": "/customservice/kfaccount/canceladmin", "描述": "该接口根据账号客服编号，解除对应客服账号客服管理员身份" }, { "接口名称": "[新增临时素材](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_uploadtempmedia)", "请求路径": "/cgi-bin/media/upload", "描述": "本接口用于上传临时多媒体文件" }, { "接口名称": "[获取临时素材](/miniprogram/dev/server/API/kf-mgnt/kf-message/api_getmedia)", "请求路径": "/cgi-bin/media/get", "描述": "本接口用于获取临时素材（即下载临时的多媒体文件）" } ] ``` ### 客服子商户 ```json [ { "接口名称": "[客服子商户创建商户](/miniprogram/dev/server/API/kf-mgnt/kf-management/api_registerbusiness)", "请求路径": "/cgi-bin/business/register", "描述": "一个小程序账号可为平台内的商户创建多个子商户账号，创建后在小程序客服组件唤起子商户单独的会话" }, { "接口名称": "[客服子商户更新商户信息](/miniprogram/dev/server/API/kf-mgnt/kf-management/api_updatebusiness)", "请求路径": "/cgi-bin/business/update", "描述": "本接口用于更新「客服子商户」的信息" }, { "接口名称": "[客服子商户拉取单个商户信息](/miniprogram/dev/server/API/kf-mgnt/kf-management/api_getbusiness)", "请求路径": "/cgi-bin/business/get", "描述": "本接口用于拉取「客服子商户」的信息" }, { "接口名称": "[客服子商户拉取多个商户信息](/miniprogram/dev/server/API/kf-mgnt/kf-management/api_listbusiness)", "请求路径": "/cgi-bin/business/list", "描述": "本接口用于拉取多个「客服子商户」的信息" } ] ``` ## 微信客服 ```json [ { "接口名称": "[查询绑定情况](/miniprogram/dev/server/API/kf-work/api_getkfworkbound)", "请求路径": "/customservice/work/get", "描述": "查询小程序的微信客服绑定情况" }, { "接口名称": "[绑定微信客服](/miniprogram/dev/server/API/kf-work/api_bindkfwork)", "请求路径": "/customservice/work/bind", "描述": "为小程序绑定微信客服" }, { "接口名称": "[解除绑定微信客服](/miniprogram/dev/server/API/kf-work/api_unbindkfwork)", "请求路径": "/customservice/work/unbind", "描述": "为小程序解除绑定微信客服" } ] ``` ## 消息相关 ### 动态消息 ```json [ { "接口名称": "[创建activity_id](/miniprogram/dev/server/API/mp-message-management/updatable-message/api_createactivityid)", "请求路径": "/cgi-bin/message/wxopen/activityid/create", "描述": "该接口用于创建被分享动态消息或私密消息的 activity_id" }, { "接口名称": "[修改动态消息](/miniprogram/dev/server/API/mp-message-management/updatable-message/api_setupdatablemsg)", "请求路径": "/cgi-bin/message/wxopen/updatablemsg/send", "描述": "该接口用于修改被分享的动态消息" }, { "接口名称": "[修改小程序聊天工具的动态卡片消息](/miniprogram/dev/server/API/mp-message-management/updatable-message/api_setchattoolmsg)", "请求路径": "/cgi-bin/message/wxopen/chattoolmsg/send", "描述": "该接口用于修改被分享的小程序聊天工具的动态卡片消息" } ] ``` ### 订阅消息 ```json [ { "接口名称": "[删除模板](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_delwxanewtemplate)", "请求路径": "/wxaapi/newtmpl/deltemplate", "描述": "删除私有模板库中的模板" }, { "接口名称": "[获取类目](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_getcategory)", "请求路径": "/wxaapi/newtmpl/getcategory", "描述": "本接口用于获取小程序、公众号所属类目用于查询公共模板" }, { "接口名称": "[获取模板中的关键词](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_getpubnewtemplatekeywords)", "请求路径": "/wxaapi/newtmpl/getpubtemplatekeywords", "描述": "该接口用于获取模板标题下的关键词列表" }, { "接口名称": "[获取类目下的公共模板](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_getpubnewtemplatetitles)", "请求路径": "/wxaapi/newtmpl/getpubtemplatetitles", "描述": "该接口用于获取帐号所属类目下的公共模板，可从中选用模板使用" }, { "接口名称": "[获取已有模板列表](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_getwxapubnewtemplate)", "请求路径": "/wxaapi/newtmpl/gettemplate", "描述": "该接口用于获取当前帐号下的已有的模板列表" }, { "接口名称": "[发送订阅消息](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_sendmessage)", "请求路径": "/cgi-bin/message/subscribe/send", "描述": "该接口用于发送订阅消息" }, { "接口名称": "[选用模板](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_addwxanewtemplate)", "请求路径": "/wxaapi/newtmpl/addtemplate", "描述": "从公共模板库中选用模板到私有模板库" }, { "接口名称": "[激活与更新服务卡片](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_setusernotify)", "请求路径": "/wxa/set_user_notify", "描述": "激活与更新服务卡片" }, { "接口名称": "[更新服务卡片扩展信息](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_setusernotifyext)", "请求路径": "/wxa/set_user_notifyext", "描述": "更新服务卡片扩展信息" }, { "接口名称": "[查询服务卡片状态](/miniprogram/dev/server/API/mp-message-management/subscribe-message/api_getusernotify)", "请求路径": "/wxa/get_user_notify", "描述": "查询服务卡片状态" } ] ``` ## 用工关系 ```json [ { "接口名称": "[推送用工消息](/miniprogram/dev/server/API/laboruse/api_sendemployeerelationmsg)", "请求路径": "/cgi-bin/message/wxopen/employeerelationmsg/send", "描述": "向已绑定用工关系的用户通过小程序商家助手发送模版消息" }, { "接口名称": "[解绑用工关系](/miniprogram/dev/server/API/laboruse/api_unbinduserb2cauthinfo)", "请求路径": "/wxa/business/unbinduserb2cauthinfo", "描述": "批量解绑B2C模块已绑定的用工关系" } ] ``` ## 小程序安全 ### 内容安全 ```json [ { "接口名称": "[文本内容安全识别](/miniprogram/dev/server/API/sec-center/sec-check/api_msgseccheck)", "请求路径": "/wxa/msg_sec_check", "描述": "该接口用于检查一段文本是否含有违法违规内容" }, { "接口名称": "[多媒体内容安全识别](/miniprogram/dev/server/API/sec-center/sec-check/api_mediacheckasync)", "请求路径": "/wxa/media_check_async", "描述": "本接口用于异步校验图片/音频是否含有违法违规内容" } ] ``` ### 安全风控 ```json [ { "接口名称": "[获取用户安全等级](/miniprogram/dev/server/API/sec-center/safety-control-capability/api_getuserriskrank)", "请求路径": "/wxa/getuserriskrank", "描述": "该接口用于根据提交的用户信息数据获取用户的安全等级 risk_rank（无需用户授权）" } ] ``` ## 数据分析 ### 访问留存 ```json [ { "接口名称": "[获取用户访问小程序周留存](/miniprogram/dev/server/API/data-analysis/visit-retain/api_getweeklyretain)", "请求路径": "/datacube/getweanalysisappidweeklyretaininfo", "描述": "该接口用于获取用户访问小程序周留存" }, { "接口名称": "[获取用户访问小程序月留存](/miniprogram/dev/server/API/data-analysis/visit-retain/api_getmonthlyretain)", "请求路径": "/datacube/getweanalysisappidmonthlyretaininfo", "描述": "该接口用于获取用户访问小程序月留存" }, { "接口名称": "[获取用户访问小程序日留存](/miniprogram/dev/server/API/data-analysis/visit-retain/api_getdailyretain)", "请求路径": "/datacube/getweanalysisappiddailyretaininfo", "描述": "该接口用于获取用户访问小程序日留存" } ] ``` ### 访问趋势 ```json [ { "接口名称": "[获取用户访问小程序数据月趋势](/miniprogram/dev/server/API/data-analysis/visit-trend/api_getmonthlyvisittrend)", "请求路径": "/datacube/getweanalysisappidmonthlyvisittrend", "描述": "该接口用于获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据)" }, { "接口名称": "[获取用户访问小程序数据日趋势](/miniprogram/dev/server/API/data-analysis/visit-trend/api_getdailyvisittrend)", "请求路径": "/datacube/getweanalysisappiddailyvisittrend", "描述": "该接口用于获取用户访问小程序数据日趋势" }, { "接口名称": "[获取用户访问小程序数据周趋势](/miniprogram/dev/server/API/data-analysis/visit-trend/api_getweeklyvisittrend)", "请求路径": "/datacube/getweanalysisappidweeklyvisittrend", "描述": "该接口用于获取用户访问小程序数据周趋势" } ] ``` ### 其他 ```json [ { "接口名称": "[获取用户访问小程序数据概况](/miniprogram/dev/server/API/data-analysis/others/api_getdailysummary)", "请求路径": "/datacube/getweanalysisappiddailysummarytrend", "描述": "该接口用于获取用户访问小程序数据概况" }, { "接口名称": "[获取访问页面数据](/miniprogram/dev/server/API/data-analysis/others/api_getvisitpage)", "请求路径": "/datacube/getweanalysisappidvisitpage", "描述": "该接口用于访问页面" }, { "接口名称": "[获取小程序用户画像分布](/miniprogram/dev/server/API/data-analysis/others/api_getuserportrait)", "请求路径": "/datacube/getweanalysisappiduserportrait", "描述": "该接口用于获取小程序新增或活跃用户的画像分布数据" }, { "接口名称": "[获取小程序性能数据](/miniprogram/dev/server/API/data-analysis/others/api_getperformancedata)", "请求路径": "/wxa/business/performance/boot", "描述": "该接口用于获取小程序启动性能，运行性能等数据" }, { "接口名称": "[获取用户小程序访问分布数据](/miniprogram/dev/server/API/data-analysis/others/api_getvisitdistribution)", "请求路径": "/datacube/getweanalysisappidvisitdistribution", "描述": "该接口用于获取用户小程序访问分布数据" } ] ``` ## 硬件设备 ```json [ { "接口名称": "[发送设备消息](/miniprogram/dev/server/API/hardware-device/api_sendhardwaredevicemessage)", "请求路径": "/cgi-bin/message/device/subscribe/send", "描述": "通过该接口向用户发送设备消息" }, { "接口名称": "[获取设备票据](/miniprogram/dev/server/API/hardware-device/api_getsnticket)", "请求路径": "/wxa/getsnticket", "描述": "通过该接口可获取设备票据，5 分钟内有效" }, { "接口名称": "[创建设备组](/miniprogram/dev/server/API/hardware-device/api_createiotgroupid)", "请求路径": "/wxa/business/group/createid", "描述": "本接口用于创建设备组，便于用户一次性订阅多个设备" }, { "接口名称": "[查询设备组信息](/miniprogram/dev/server/API/hardware-device/api_getiotgroupinfo)", "请求路径": "/wxa/business/group/getinfo", "描述": "本接口用于查询设备组的信息" }, { "接口名称": "[设备组添加设备](/miniprogram/dev/server/API/hardware-device/api_addiotgroupdevice)", "请求路径": "/wxa/business/group/adddevice", "描述": "本接口用于为设备组添加设备" }, { "接口名称": "[设备组删除设备](/miniprogram/dev/server/API/hardware-device/api_removeiotgroupdevice)", "请求路径": "/wxa/business/group/removedevice", "描述": "本接口为设备组删除已添加的设备" }, { "接口名称": "[查询license资源包列表](/miniprogram/dev/server/API/hardware-device/api_getlicensepkglist)", "请求路径": "/wxa/business/license/getpkglist", "描述": "查询小程序已购买的 license 资源包列表信息" }, { "接口名称": "[激活设备license](/miniprogram/dev/server/API/hardware-device/api_activelicensedevice)", "请求路径": "/wxa/business/license/activedevice", "描述": "该接口用于批量绑定设备，并消耗相应的资源包中的激活码序号" }, { "接口名称": "[查询设备激活详情](/miniprogram/dev/server/API/hardware-device/api_getlicensedeviceinfo)", "请求路径": "/wxa/business/license/getdeviceinfo", "描述": "该接口用于批量查询设备剩余有效期" } ] ``` ## 运维中心 ```json [ { "接口名称": "[查询域名配置](/miniprogram/dev/server/API/operation/api_getdomaininfo)", "请求路径": "/wxa/getwxadevinfo", "描述": "该接口用于查询小程序域名配置信息" }, { "接口名称": "[获取性能数据](/miniprogram/dev/server/API/operation/api_getperformance)", "请求路径": "/wxaapi/log/get_performance", "描述": "该接口用于获取性能数据" }, { "接口名称": "[获取访问来源](/miniprogram/dev/server/API/operation/api_getscenelist)", "请求路径": "/wxaapi/log/get_scene", "描述": "该接口用于获取访问来源" }, { "接口名称": "[获取客户端版本](/miniprogram/dev/server/API/operation/api_getversionlist)", "请求路径": "/wxaapi/log/get_client_version", "描述": "该接口用于获取客户端版本" }, { "接口名称": "[查询实时日志](/miniprogram/dev/server/API/operation/api_realtimelogsearch)", "请求路径": "/wxaapi/userlog/userlog_search", "描述": "该接口用于查询实时日志" }, { "接口名称": "[获取用户反馈列表](/miniprogram/dev/server/API/operation/api_getfeedback)", "请求路径": "/wxaapi/feedback/list", "描述": "该接口用于获取用户反馈列表" }, { "接口名称": "[获取mediaId图片](/miniprogram/dev/server/API/operation/api_getfeedbackmedia)", "请求路径": "/cgi-bin/media/getfeedbackmedia", "描述": "该接口用于获取 mediaId 图片" }, { "接口名称": "[查询js错误详情](/miniprogram/dev/server/API/operation/api_getjserrdetail)", "请求路径": "/wxaapi/log/jserr_detail", "描述": "该接口用于查询JS错误详情" }, { "接口名称": "[查询错误列表](/miniprogram/dev/server/API/operation/api_getjserrlist)", "请求路径": "/wxaapi/log/jserr_list", "描述": "本接口用于查询错误列表" }, { "接口名称": "[获取分阶段发布详情](/miniprogram/dev/server/API/operation/api_getgrayreleaseplan)", "请求路径": "/wxa/getgrayreleaseplan", "描述": "该接口用于查询当前分阶段发布详情" } ] ``` ## 插件管理 ```json [ { "接口名称": "[插件申请管理](/miniprogram/dev/server/API/plugin-management/api_managepluginapplication)", "请求路径": "/wxa/devplugin", "描述": "该接口供插件开发者调用，用于获取当前所有插件使用方信息以及修改插件使用申请的状态" }, { "接口名称": "[插件管理](/miniprogram/dev/server/API/plugin-management/api_manageplugin)", "请求路径": "/wxa/plugin", "描述": "该接口用于管理插件，支持申请、查看、更新、删除插件等操作" } ] ``` ## 云开发 ### 云函数 ```json [ { "接口名称": "[触发云函数](/miniprogram/dev/server/API/cloudbase/functions/api_invokecloudfunction)", "请求路径": "/tcb/invokecloudfunction", "描述": "通过本接口可以触发指定云开发环境中的云函数" }, { "接口名称": "[延时调用云函数](/miniprogram/dev/server/API/cloudbase/functions/api_adddelayedfunctiontask)", "请求路径": "/tcb/adddelayedfunctiontask", "描述": "该接口用于延时调用云函数" } ] ``` ### 数据库 ```json [ { "接口名称": "[数据库插入记录](/miniprogram/dev/server/API/cloudbase/database/api_adddatabaseitem)", "请求路径": "/tcb/databaseadd", "描述": "通过本接口可以数据库插入记录" }, { "接口名称": "[数据库聚合](/miniprogram/dev/server/API/cloudbase/database/api_aggregatedatabase)", "请求路径": "/tcb/databaseaggregate", "描述": "通过本接口可以数据库聚合" }, { "接口名称": "[新增集合](/miniprogram/dev/server/API/cloudbase/database/api_adddatabasecollection)", "请求路径": "/tcb/databasecollectionadd", "描述": "通过本接口可以新增集合" }, { "接口名称": "[删除集合](/miniprogram/dev/server/API/cloudbase/database/api_deletedatabasecollection)", "请求路径": "/tcb/databasecollectiondelete", "描述": "通过本接口可以删除集合" }, { "接口名称": "[获取集合信息](/miniprogram/dev/server/API/cloudbase/database/api_getdatabasecollection)", "请求路径": "/tcb/databasecollectionget", "描述": "通过本接口可以获取特定云环境下集合信息" }, { "接口名称": "[统计集合记录数](/miniprogram/dev/server/API/cloudbase/database/api_getdatabasecount)", "请求路径": "/tcb/databasecount", "描述": "通过本接口可以统计集合记录数或统计查询语句对应的结果记录数" }, { "接口名称": "[数据库删除记录](/miniprogram/dev/server/API/cloudbase/database/api_deletedatabaseitem)", "请求路径": "/tcb/databasedelete", "描述": "通过本接口可以数据库删除记录" }, { "接口名称": "[数据库导出](/miniprogram/dev/server/API/cloudbase/database/api_exportdatabaseitem)", "请求路径": "/tcb/databasemigrateexport", "描述": "通过本接口可以进行数据库导出" }, { "接口名称": "[数据库导入](/miniprogram/dev/server/API/cloudbase/database/api_importdatabaseitem)", "请求路径": "/tcb/databasemigrateimport", "描述": "通过本接口可以进行数据库导入" }, { "接口名称": "[数据库迁移状态查询](/miniprogram/dev/server/API/cloudbase/database/api_getdatabasemigratestatus)", "请求路径": "/tcb/databasemigratequeryinfo", "描述": "通过本接口可以数据库迁移状态查询" }, { "接口名称": "[数据库查询记录](/miniprogram/dev/server/API/cloudbase/database/api_getdatabaserecord)", "请求路径": "/tcb/databasequery", "描述": "通过本接口可以数据库查询记录" }, { "接口名称": "[数据库更新记录](/miniprogram/dev/server/API/cloudbase/database/api_updatedatabaserecord)", "请求路径": "/tcb/databaseupdate", "描述": "通过本接口可以数据库更新记录" }, { "接口名称": "[更新数据库索引](/miniprogram/dev/server/API/cloudbase/database/api_updatedatabaseindexs)", "请求路径": "/tcb/updateindex", "描述": "通过本接口可以变更数据库索引" } ] ``` ### 存储 ```json [ { "接口名称": "[获取文件上传链接](/miniprogram/dev/server/API/cloudbase/storage/api_getuploadtcbfilelink)", "请求路径": "/tcb/uploadfile", "描述": "通过本接口可以获取文件上传链接" }, { "接口名称": "[获取文件下载链接](/miniprogram/dev/server/API/cloudbase/storage/api_getdownloadtcbfilelink)", "请求路径": "/tcb/batchdownloadfile", "描述": "通过本接口可以获取文件下载链接" }, { "接口名称": "[删除文件](/miniprogram/dev/server/API/cloudbase/storage/api_deletetcbcloudfile)", "请求路径": "/tcb/batchdeletefile", "描述": "通过本接口可以删除文件" } ] ``` ### 其他 ```json [ { "接口名称": "[创建发短信任务](/miniprogram/dev/server/API/cloudbase/others/api_createsendsmstask)", "请求路径": "/tcb/createsendsmstask", "描述": "该接口用于创建发短信任务" }, { "接口名称": "[云开发上报接口](/miniprogram/dev/server/API/cloudbase/others/api_cloudbasereportapi)", "请求路径": "/tcb/cloudbasereport", "描述": "该接口为云开发通用上报接口" }, { "接口名称": "[查询短信记录](/miniprogram/dev/server/API/cloudbase/others/api_describesmsrecords)", "请求路径": "/tcb/describesmsrecords", "描述": "该接口用于查询 2 个月内的短信记录" }, { "接口名称": "[描述扩展上传文件信息](/miniprogram/dev/server/API/cloudbase/others/api_describeextensionuploadinfo)", "请求路径": "/tcb/describeextensionuploadinfo", "描述": "该接口用于描述扩展上传文件信息" }, { "接口名称": "[获取云开发数据](/miniprogram/dev/server/API/cloudbase/others/api_getcloudbasestatistics)", "请求路径": "/tcb/getstatistics", "描述": "该接口用于获取云开发数据" }, { "接口名称": "[获取cloudID对应的数据](/miniprogram/dev/server/API/cloudbase/others/api_getopendata)", "请求路径": "/wxa/getopendata", "描述": "该接口用于换取 cloudID 对应的开放数据" }, { "接口名称": "[获取实时语音签名](/miniprogram/dev/server/API/cloudbase/others/api_getcloudbasevoipsign)", "请求路径": "/wxa/getvoipsign", "描述": "该接口用于获取实时语音签名" }, { "接口名称": "[获取腾讯云API调用凭证](/miniprogram/dev/server/API/cloudbase/others/api_getcloudtoken)", "请求路径": "/tcb/getqcloudtoken", "描述": "通过本接口可以获取腾讯云API调用凭证,腾讯云可用 API 概览" } ] ``` ## 物流助手 ### 小程序使用 ```json [ { "接口名称": "[绑定/解绑物流账号](/miniprogram/dev/server/API/express/express-by-business/api_bindaccount)", "请求路径": "/cgi-bin/express/business/account/bind", "描述": "该接口用于绑定、解绑物流账号" }, { "接口名称": "[获取所有绑定的物流账号](/miniprogram/dev/server/API/express/express-by-business/api_getallaccount)", "请求路径": "/cgi-bin/express/business/account/getall", "描述": "该接口用于获取所有绑定的物流账号" }, { "接口名称": "[获取支持的快递公司列表](/miniprogram/dev/server/API/express/express-by-business/api_getalldelivery)", "请求路径": "/cgi-bin/express/business/delivery/getall", "描述": "该接口用于获取支持的快递公司列表" }, { "接口名称": "[取消运单](/miniprogram/dev/server/API/express/express-by-business/api_cancelorder)", "请求路径": "/cgi-bin/express/business/order/cancel", "描述": "该接口用于取消运单" }, { "接口名称": "[配置面单打印员](/miniprogram/dev/server/API/express/express-by-business/api_updateprinter)", "请求路径": "/cgi-bin/express/business/printer/update", "描述": "该接口用于配置面单打印员，可以设置多个，若需要使用微信打单 PC 软件，才需要调用" }, { "接口名称": "[获取电子面单余额](/miniprogram/dev/server/API/express/express-by-business/api_getquota)", "请求路径": "/cgi-bin/express/business/quota/get", "描述": "该接口用于获取电子面单余额" }, { "接口名称": "[获取运单数据](/miniprogram/dev/server/API/express/express-by-business/api_getorder)", "请求路径": "/cgi-bin/express/business/order/get", "描述": "该接口用于获取运单数据" }, { "接口名称": "[模拟更新订单状态](/miniprogram/dev/server/API/express/express-by-business/api_testupdateorder)", "请求路径": "/cgi-bin/express/business/test_update_order", "描述": "该接口用于模拟快递公司更新订单状态, 该接口只能用户测试" }, { "接口名称": "[获取打印员](/miniprogram/dev/server/API/express/express-by-business/api_getprinter)", "请求路径": "/cgi-bin/express/business/printer/getall", "描述": "该接口用于获取打印员" }, { "接口名称": "[查询运单轨迹](/miniprogram/dev/server/API/express/express-by-business/api_getpath)", "请求路径": "/cgi-bin/express/business/path/get", "描述": "该接口用于查询运单轨迹" }, { "接口名称": "[批量获取运单数据](/miniprogram/dev/server/API/express/express-by-business/api_batchgetorder)", "请求路径": "/cgi-bin/express/business/order/batchget", "描述": "该接口用于批量获取运单数据" }, { "接口名称": "[生成运单](/miniprogram/dev/server/API/express/express-by-business/api_addorder)", "请求路径": "/cgi-bin/express/business/order/add", "描述": "该接口用于生成运单" } ] ``` ### 运力方使用 ```json [ { "接口名称": "[更新商户审核结果](/miniprogram/dev/server/API/express/express-by-provider/api_updatebusiness)", "请求路径": "/cgi-bin/express/delivery/service/business/update", "描述": "该接口用于更新商户审核结果" }, { "接口名称": "[更新运单轨迹](/miniprogram/dev/server/API/express/express-by-provider/api_updatepath)", "请求路径": "/cgi-bin/express/delivery/path/update", "描述": "该接口用于更新运单轨迹" }, { "接口名称": "[预览面单模板](/miniprogram/dev/server/API/express/express-by-provider/api_previewtemplate)", "请求路径": "/cgi-bin/express/delivery/template/preview", "描述": "该接口用于预览面单模板" }, { "接口名称": "[获取面单联系人信息](/miniprogram/dev/server/API/express/express-by-provider/api_getcontact)", "请求路径": "/cgi-bin/express/delivery/contact/get", "描述": "该接口用于获取面单联系人信息" }, { "接口名称": "[运力取消订单](/miniprogram/dev/server/API/express/express-by-provider/api_scatterdeliverycancel)", "请求路径": "/cgi-bin/express/delivery/single_waybill/cancel_order", "描述": "运力公司取消订单" }, { "接口名称": "[运力更新需支付的运费](/miniprogram/dev/server/API/express/express-by-provider/api_scatterupdateorderfee)", "请求路径": "/cgi-bin/express/delivery/single_waybill/fee", "描述": "支付分订单更新运费接口，须保证该订单状态不是待揽件状态" }, { "接口名称": "[运力公司退款](/miniprogram/dev/server/API/express/express-by-provider/api_scatterdeliveryrefund)", "请求路径": "/cgi-bin/express/delivery/single_waybill/refund_order", "描述": "运力公司退款(可部分退款)" }, { "接口名称": "[对账单下载](/miniprogram/dev/server/API/express/express-by-provider/api_scatter_get_bill)", "请求路径": "/cgi-bin/express/delivery/single_waybill/get_bill", "描述": "运力公司下载对账单" }, { "接口名称": "[运力返回用户投诉处理结果](/miniprogram/dev/server/API/express/express-by-provider/api_scatterupdatecomplainresult)", "请求路径": "/cgi-bin/express/delivery/scatter/update_complaint_result", "描述": "运力返回用户投诉处理结果" }, { "接口名称": "[运力更新订单状态](/miniprogram/dev/server/API/express/express-by-provider/api_scatterupdateorderstatus)", "请求路径": "/cgi-bin/express/delivery/single_waybill/update", "描述": "运力更新订单状态" } ] ``` ## 即时配送 ### 小程序使用 ```json [ { "接口名称": "[获取已支持的配送公司列表](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_getallimmedelivery)", "请求路径": "/cgi-bin/express/local/business/delivery/getall", "描述": "该接口用于获取已支持的配送公司列表" }, { "接口名称": "[预下配送单](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_preaddorder)", "请求路径": "/cgi-bin/express/local/business/order/pre_add", "描述": "使用场景描述" }, { "接口名称": "[拉取已绑定账号](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_getbindaccount)", "请求路径": "/cgi-bin/express/local/business/shop/get", "描述": "商家可通过本接口查询自己已经在小程序后台绑定的和配送公司签约的账号；\n服务商可通过本接口查询代开发的小程序在小程序后台绑定的和配送公司签约的账号，为其完成后续的" }, { "接口名称": "[预取消配送单](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_precancelorder)", "请求路径": "/cgi-bin/express/local/business/order/precancel", "描述": "使用场景描述" }, { "接口名称": "[申请开通即时配送](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_opendelivery)", "请求路径": "/cgi-bin/express/local/business/open", "描述": "该接口用于第三方代商户发起开通即时配送权限" }, { "接口名称": "[发起绑定请求](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_bindlocalaccount)", "请求路径": "/cgi-bin/express/local/business/shop/add", "描述": "该接口用于第三方代商户发起绑定配送公司帐号的请求" }, { "接口名称": "[重新下单](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_reorder)", "请求路径": "/cgi-bin/express/local/business/order/readd", "描述": "在调用下配送单接口、订单被取消、过期或者投递异常的情况下，可调用此接口，重新下单，需要保持orderid一致" }, { "接口名称": "[模拟更新配送单状态](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_realmockupdateorder)", "请求路径": "/cgi-bin/express/local/business/realmock_update_order", "描述": "该接口用于模拟配送公司更新配送单状态，可进行测试账户下的单，将请求转发到运力测试环境" }, { "接口名称": "[模拟配送公司更新配送单状态](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_mockupdateorder)", "请求路径": "/cgi-bin/express/local/business/test_update_order", "描述": "该接口用于模拟配送公司更新配送单状态, 该接口只用于沙盒环境，即订单并没有真实流转到运力方." }, { "接口名称": "[拉取配送单信息](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_getlocalorder)", "请求路径": "/cgi-bin/express/local/business/order/get", "描述": "商家可使用本接口查询某一配送单的配送状态，便于商家掌握配送情况" }, { "接口名称": "[异常件退回商家确认](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_abnormalconfirm)", "请求路径": "/cgi-bin/express/local/business/order/confirm_return", "描述": "该接口用于异常件退回商家后商家确认收货" }, { "接口名称": "[取消配送单](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_cancellocalorder)", "请求路径": "/cgi-bin/express/local/business/order/cancel", "描述": "该接口用于取消配送单" }, { "接口名称": "[添加小费](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_addtips)", "请求路径": "/cgi-bin/express/local/business/order/addtips", "描述": "该接口可以对待接单状态的订单增加小费" }, { "接口名称": "[添加配送单](/miniprogram/dev/server/API/immediate-delivery/deliver-by-business/api_addlocalorder)", "请求路径": "/cgi-bin/express/local/business/order/add", "描述": "该接口用于下配送单" } ] ``` ### 运力方使用 ```json [ { "接口名称": "[更新配送单状态](/miniprogram/dev/server/API/immediate-delivery/deliver-by-provider/api_updateorder)", "请求路径": "/cgi-bin/express/local/delivery/update_order", "描述": "该接口用于配送公司更新配送单状态" } ] ``` ## 微信物流服务 ### 查询组件 ```json [ { "接口名称": "[查询运单](/miniprogram/dev/server/API/weixin-express/express-search/api_query_trace)", "请求路径": "/cgi-bin/express/delivery/open_msg/query_trace", "描述": "商户在调用完trace_waybill接口后，可以使用本接口查询到对应运单的详情信息" }, { "接口名称": "[获取运力id列表](/miniprogram/dev/server/API/weixin-express/express-msg/api_get_delivery_list)", "请求路径": "/cgi-bin/express/delivery/open_msg/get_delivery_list", "描述": "商户使用此接口获取所有运力id的列表" }, { "接口名称": "[传运单](/miniprogram/dev/server/API/weixin-express/express-search/api_trace_waybill)", "请求路径": "/cgi-bin/express/delivery/open_msg/trace_waybill", "描述": "商户使用此接口向微信提供某交易单号对应的运单号" }, { "接口名称": "[更新物流信息](/miniprogram/dev/server/API/weixin-express/express-search/api_update_waybill_goods)", "请求路径": "/cgi-bin/express/delivery/open_msg/update_waybill_goods", "描述": "该接口用于更新物品信息" } ] ``` ### 消息组件 ```json [ { "接口名称": "[更新物品信息接口](/miniprogram/dev/server/API/weixin-express/express-msg/api_update_follow_waybill_goods)", "请求路径": "/cgi-bin/express/delivery/open_msg/update_follow_waybill_goods", "描述": "更新物品信息" }, { "接口名称": "[查运单](/miniprogram/dev/server/API/weixin-express/express-msg/api_query_follow_trace)", "请求路径": "/cgi-bin/express/delivery/open_msg/query_follow_trace", "描述": "商户在调用完trace_waybill接口后，可以使用本接口查询到对应运单的详情信息" }, { "接口名称": "[传运单](/miniprogram/dev/server/API/weixin-express/express-msg/api_follow_waybill)", "请求路径": "/cgi-bin/express/delivery/open_msg/follow_waybill", "描述": "商户使用此接口向微信提供某交易单号对应的运单号" }, { "接口名称": "[获取运力id列表](/miniprogram/dev/server/API/weixin-express/express-msg/api_get_delivery_list)", "请求路径": "/cgi-bin/express/delivery/open_msg/get_delivery_list", "描述": "商户使用此接口获取所有运力id的列表" } ] ``` ### 无忧退货 ```json [ { "接口名称": "[开通无忧退货](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_open)", "请求路径": "/wxa/business/insurance_freight/open", "描述": "本接口用于开通无忧退货" }, { "接口名称": "[查询开通状态](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_query_open)", "请求路径": "/wxa/business/insurance_freight/query_open", "描述": "本接口用于查询开通状态" }, { "接口名称": "[发货时投保](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_createorder)", "请求路径": "/wxa/business/insurance_freight/createorder", "描述": "本接口用于发货时投保" }, { "接口名称": "[无忧退理赔](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_claim)", "请求路径": "/wxa/business/insurance_freight/claim", "描述": "本接口用于无忧退理赔，收到用户退货后再触发" }, { "接口名称": "[申请充值订单号](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_createchargeid)", "请求路径": "/wxa/business/insurance_freight/createchargeid", "描述": "本接口用于申请充值订单号 (支持自定义金额)" }, { "接口名称": "[申请支付](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_applypay)", "请求路径": "/wxa/business/insurance_freight/applypay", "描述": "本接口用于无忧退货申请支付" }, { "接口名称": "[拉取充值订单信息](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_getpayorderlist)", "请求路径": "/wxa/business/insurance_freight/getpayorderlist", "描述": "本接口用于拉取充值订单信息" }, { "接口名称": "[充值保费退款](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_refund)", "请求路径": "/wxa/business/insurance_freight/refund", "描述": "本接口用于充值保费退款" }, { "接口名称": "[拉取理赔摘要](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_getsummary)", "请求路径": "/wxa/business/insurance_freight/getsummary", "描述": "本接口可用于查询当前保费、投保单量、理赔单量、账号余额等信息" }, { "接口名称": "[拉取保单信息](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_getorderlist)", "请求路径": "/wxa/business/insurance_freight/getorderlist", "描述": "本接口用于拉取保单信息" }, { "接口名称": "[设置保费告警余额](/miniprogram/dev/server/API/weixin-express/freight/api_insurance_freight_update_notify_funds)", "请求路径": "/wxa/business/insurance_freight/update_notify_funds", "描述": "开发者可通过接口自定义余额为xx时通知小程序管理员（余额xx无改动情况下24h内通知一次）" } ] ``` ### 退货组件 ```json [ { "接口名称": "[解绑退货ID](/miniprogram/dev/server/API/weixin-express/express-return/api_unbindreturnid)", "请求路径": "/cgi-bin/express/delivery/no_worry_return/unbind", "描述": "当商家同意退货申请之后，与用户达成协商「无需退货」时，可以通过本接口可以接触商家退货单与退货 ID的绑定" }, { "接口名称": "[查询退货ID状态](/miniprogram/dev/server/API/weixin-express/express-return/api_getreturnid)", "请求路径": "/cgi-bin/express/delivery/no_worry_return/get", "描述": "本接口用于商家查询用户退货状态（是否填写退货信息）及追踪用户退货物流，方便仓库收货" }, { "接口名称": "[创建退货ID](/miniprogram/dev/server/API/weixin-express/express-return/api_addreturnid)", "请求路径": "/cgi-bin/express/delivery/no_worry_return/add", "描述": "商家在同意用户退货之后，通过本接口创建退货ID，shoporderid和退货 ID 一一对应" } ] ``` ### 同城配送 ```json [ { "接口名称": "[开通门店权限](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_apply)", "请求路径": "/cgi-bin/express/intracity/apply", "描述": "在使用门店相关接口前需要先开通门店权限，开通门店权限前可以使用页面或者使用此API开通门店（无加密，可直接调用）" }, { "接口名称": "[创建门店](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_createstore)", "请求路径": "/cgi-bin/express/intracity/createstore", "描述": "创建门店时需要传入自定义的门店编号，自定义的门店编号需要唯一，确保不重复创建 门店创建后系统生成全局唯一门店编号wxstoreid，后续创建运力订单时需要该门店" }, { "接口名称": "[查询门店](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_querystore)", "请求路径": "/cgi-bin/express/intracity/querystore", "描述": "获取本小程序所创建的门店，不传wxstoreid和outstoreid则返回本小程序所有门店信息" }, { "接口名称": "[更新门店](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_updatestore)", "请求路径": "/cgi-bin/express/intracity/updatestore", "描述": "更新门店信息" }, { "接口名称": "[门店运费充值](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_storecharge)", "请求路径": "/cgi-bin/express/intracity/storecharge", "描述": "返回微信服务市场的充值页面地址，通过该页面可以为门店充值指定运力的运费，充值后运费有使用有效期，默认有效期为1个月，超期未使用的运费降原路退回" }, { "接口名称": "[门店运费退款](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_store_refund)", "请求路径": "/cgi-bin/express/intracity/storerefund", "描述": "该接口可以将门店指定运力的运费余额退还，如果门店有在途的配送订单，需要等配送完成或者取消配送订单之后才可以操作退款；操作退款后，退款金额五分钟内到账" }, { "接口名称": "[门店运费流水查询](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_queryflow)", "请求路径": "/cgi-bin/express/intracity/queryflow", "描述": "查询门店运力资金流水" }, { "接口名称": "[门店余额查询](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_balancequery)", "请求路径": "/cgi-bin/express/intracity/balancequery", "描述": "查询门店运力余额" }, { "接口名称": "[查询运费](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_preaddorder)", "请求路径": "/cgi-bin/express/intracity/preaddorder", "描述": "商家通过该接口传入配送单的相关信息，同城配送后台将根据配送信息向运力查询并返回实时的运费和配送距离" }, { "接口名称": "[创建配送单](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_addorder)", "请求路径": "/cgi-bin/express/intracity/addorder", "描述": "创建同城配送单，会根据门店设置的运力偏好来选择运力公司下单" }, { "接口名称": "[查询配送单](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_queryorder)", "请求路径": "/cgi-bin/express/intracity/queryorder", "描述": "通过该接口查询订单是否创建成功，以及订单创建后的状态更新" }, { "接口名称": "[取消配送单](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_cancelorder)", "请求路径": "/cgi-bin/express/intracity/cancelorder", "描述": "通过该接口可以取消已创建的订单，取消配送中的订单需要扣减违约金" }, { "接口名称": "[设置扣费主体](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_setpaymode)", "请求路径": "/cgi-bin/express/intracity/setpaymode", "描述": "默认扣费主体和充值主体都是门店，该接口可以让开发者设置门店的扣费主体，接口调用成功后，小程序的管理员会收到模板消息，点击模板消息确认更改门店扣费主体后，修改生效" }, { "接口名称": "[查询扣费主体](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_getpaymode)", "请求路径": "/cgi-bin/express/intracity/getpaymode", "描述": "查询小程序的扣费主体" }, { "接口名称": "[查询支持同城配送的城市](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_getcity)", "请求路径": "/cgi-bin/express/intracity/getcity", "描述": "用于查询全国可以使用微信同城配送的城市" }, { "接口名称": "[模拟回调接口](/miniprogram/dev/server/API/weixin-express/same_city_distribution/api_intracity_mocknotify)", "请求路径": "/cgi-bin/express/intracity/mocknotify", "描述": "由于测试订单没有快递员接单，不会自动推送订单状态变化回调，为了方便开发者在沙箱环境联调，我们提供了模拟回调接口，针对测试订单开发者可以通过该接口触发其他说明中订" } ] ``` ### 消息推送 ```json [ { "接口名称": "[用户手机状态查询](/miniprogram/dev/server/API/weixin-express/msgpush/api_deliveryuserquery)", "请求路径": "/cgi-bin/express/delivery/userquery", "描述": "运力方可以调用此接口来获取某手机号是否绑定" }, { "接口名称": "[推送已绑定物流轨迹信息](/miniprogram/dev/server/API/weixin-express/msgpush/api_deliverypathnotify)", "请求路径": "/cgi-bin/express/delivery/pathnotify", "描述": "运力方可以调用此接口来推送物流轨迹消息" } ] ``` ## 付费管理 ```json [ { "接口名称": "[查询购买资源包的用量情况](/miniprogram/dev/server/API/charge/api_getusagedetail)", "请求路径": "/wxa/charge/usage/get", "描述": "小程序可通过本接口查询已购买资源包的用量情况" }, { "接口名称": "[获取小程序某个付费能力的最近用量数据](/miniprogram/dev/server/API/charge/api_getrecentaverageusage)", "请求路径": "/wxa/charge/usage/get_recent_average", "描述": "小程序可通过本接口查询某个付费能力最近三个月的平均用量" } ] ``` ## 小程序交易管理服务 ```json [ { "接口名称": "[发货信息录入](/miniprogram/dev/server/API/order_shipping/api_uploadshippinginfo)", "请求路径": "/wxa/sec/order/upload_shipping_info", "描述": "用户交易后，默认资金将会进入冻结状态，开发者在发货后，需要在小程序平台录入相关发货信息，平台会将发货信息以消息的形式推送给购买的微信用户" }, { "接口名称": "[发货信息合单录入](/miniprogram/dev/server/API/order_shipping/api_uploadcombinedshippinginfo)", "请求路径": "/wxa/sec/order/upload_combined_shipping_info", "描述": "用户交易后，默认资金将会进入冻结状态，开发者在发货后，需要在小程序平台录入相关发货信息，平台会将发货信息以消息的形式推送给购买的微信用户" }, { "接口名称": "[查询订单发货状态](/miniprogram/dev/server/API/order_shipping/api_getorder)", "请求路径": "/wxa/sec/order/get_order", "描述": "可以通过交易单号或商户号+商户单号来查询该支付单的发货状态" }, { "接口名称": "[查询订单列表](/miniprogram/dev/server/API/order_shipping/api_getorderlist)", "请求路径": "/wxa/sec/order/get_order_list", "描述": "可以通过支付时间、支付者openid或订单状态来查询订单列表" }, { "接口名称": "[确认收货提醒](/miniprogram/dev/server/API/order_shipping/api_notifyconfirmreceive)", "请求路径": "/wxa/sec/order/notify_confirm_receive", "描述": "如你已经从你的快递物流服务方获知到用户已经签收相关商品，可以通过该接口提醒用户及时确认收货，以提高资金结算效率，每个订单仅可调用一次" }, { "接口名称": "[消息跳转路径设置](/miniprogram/dev/server/API/order_shipping/api_setmsgjumppath)", "请求路径": "/wxa/sec/order/set_msg_jump_path", "描述": "如你已经在小程序内接入平台提供的确认收货组件，可以通过该接口设置发货消息及确认收货消息的跳转动作，用户点击发货消息时会直接进入你的小程序订单列表页面或详情页面进" }, { "接口名称": "[查询小程序是否已开通发货信息管理服务](/miniprogram/dev/server/API/order_shipping/api_istrademanaged)", "请求路径": "/wxa/sec/order/is_trade_managed", "描述": "调用该接口可查询小程序账号是否已开通小程序发货信息管理服务（已开通的小程序，可接入发货信息管理服务API进行发货管理）" }, { "接口名称": "[查询小程序是否已完成交易结算管理确认](/miniprogram/dev/server/API/order_shipping/api_istrademanagementconfirmationcompleted)", "请求路径": "/wxa/sec/order/is_trade_management_confirmation_completed", "描述": "调用该接口可查询小程序账号是否已完成交易结算管理确认（即对小程序已关联的所有商户号都完成了订单管理授权或解绑）" }, { "接口名称": "[特殊发货报备](/miniprogram/dev/server/API/order_shipping/api_opspecialorder)", "请求路径": "/wxa/sec/order/opspecialorder", "描述": "调用该接口可以对未发货的订单进行特殊发货报备，适用于预售商品订单和测试订单" }, { "接口名称": "[品牌申请](/miniprogram/dev/server/API/order_shipping/api_famousbrandapply)", "请求路径": "/wxa/sec/famousbrand/apply", "描述": "本接口用于小程序品牌申请" }, { "接口名称": "[小程序品牌申请状态查询](/miniprogram/dev/server/API/order_shipping/api_getfamousbrandapplystatus)", "请求路径": "/wxa/sec/famousbrand/get_status", "描述": "本接口用于查询小程序品牌申请状态" }, { "接口名称": "[小程序交易类型变更申请](/miniprogram/dev/server/API/order_shipping/api_setwxatradetypecgi)", "请求路径": "/wxa/sec/order/setwxatradetypecgi", "描述": "本接口用于小程序开发者提交交易类型变更申请" } ] ``` ## 交易保障 ### 基础能力 ```json [ { "接口名称": "[获取小程序交易体验分违规记录](/miniprogram/dev/server/API/transaction-guarantee/basic/api_getpenaltylist)", "请求路径": "/wxaapi/wxamptrade/get_penalty_list", "描述": "获取小程序交易体验分违规记录" }, { "接口名称": "[获取交易保障标状态](/miniprogram/dev/server/API/transaction-guarantee/basic/api_getguaranteestatus)", "请求路径": "/wxaapi/wxamptrade/get_guarantee_status", "描述": "获取交易保障标状态" } ] ``` ### 交易评价管理 ```json [ { "接口名称": "[查询评价列表](/miniprogram/dev/server/API/transaction-guarantee/comment/api_getccommentlist)", "请求路径": "/wxaapi/comment/mpcommentlist/get", "描述": "查询某小程序下面所有的评价" }, { "接口名称": "[查询评论列表](/miniprogram/dev/server/API/transaction-guarantee/comment/api_getcommentreplylist)", "请求路径": "/wxaapi/comment/replyandcommentreplylist/get", "描述": "查询某评价下面所有的评论和回复" }, { "接口名称": "[查询评价详情](/miniprogram/dev/server/API/transaction-guarantee/comment/api_getcommentinfo)", "请求路径": "/wxaapi/comment/commentinfo/get", "描述": "查询某条评价的详细内容" }, { "接口名称": "[创建评论](/miniprogram/dev/server/API/transaction-guarantee/comment/api_addreply)", "请求路径": "/wxaapi/comment/reply/add", "描述": "目前开发者创建的第一条回复定义为评论" }, { "接口名称": "[删除评论](/miniprogram/dev/server/API/transaction-guarantee/comment/api_deletereply)", "请求路径": "/wxaapi/comment/reply/delete", "描述": "目前开发者创建的第一条回复定义为评论，如果删除该条评论，基于这条评论的所有回复将会被一并删除" }, { "接口名称": "[创建回复](/miniprogram/dev/server/API/transaction-guarantee/comment/api_addcommentreply)", "请求路径": "/wxaapi/comment/commentreply/add", "描述": "本接口用于对某条评论发起回复" }, { "接口名称": "[删除回复](/miniprogram/dev/server/API/transaction-guarantee/comment/api_deletecommentreply)", "请求路径": "/wxaapi/comment/commentreply/delete", "描述": "本接口用于删除评论的回复" }, { "接口名称": "[重置Api客服quota](/miniprogram/dev/server/API/transaction-guarantee/comment/api_resetapikfquota)", "请求路径": "/wxaapi/comment/apikfquota/reset", "描述": "本接口用于重置客服quota的api" }, { "接口名称": "[确认和解](/miniprogram/dev/server/API/transaction-guarantee/comment/api_confirmcompromise)", "请求路径": "/wxaapi/comment/confirmcompromise", "描述": "本接口用于向平台反馈和解状态" } ] ``` ### 交易投诉处理 ```json [ { "接口名称": "[商家回应投诉](/miniprogram/dev/server/API/transaction-guarantee/complaint/api_respondcomplaint)", "请求路径": "/wxaapi/minishop/bussiRespondComplaint", "描述": "该接口用于商家处理投诉" }, { "接口名称": "[商家补充凭证](/miniprogram/dev/server/API/transaction-guarantee/complaint/api_supplyproof)", "请求路径": "/wxaapi/minishop/bussiSupplyProof", "描述": "该接口用于商家补充凭证" }, { "接口名称": "[商家提交退款凭证](/miniprogram/dev/server/API/transaction-guarantee/complaint/api_submitrefund)", "请求路径": "/wxaapi/minishop/bussiSupplyRefund", "描述": "该接口用于提交退款凭证" }, { "接口名称": "[查询投诉单详情](/miniprogram/dev/server/API/transaction-guarantee/complaint/api_getorderdetail)", "请求路径": "/wxaapi/minishop/complaintOrderDetail", "描述": "该接口用于查询投诉单详情" }, { "接口名称": "[商家申诉](/miniprogram/dev/server/API/transaction-guarantee/complaint/api_busiappeal)", "请求路径": "/wxaapi/minishop/busiAppeal", "描述": "该接口用于商家发起申诉处理" } ] ``` ## B2b门店助手 ### 门店认证授权 ```json [ { "接口名称": "[开通流程](/miniprogram/dev/server/API/B2b/store_assistant/api_retailbusinessapply)", "请求路径": "/wxa/business/retailbusinessapply", "描述": "方式1：小程序后台开通" }, { "接口名称": "[预录入门店信息](/miniprogram/dev/server/API/B2b/store_assistant/api_batchcreateretail)", "请求路径": "/wxa/business/batchcreateretail", "描述": "通过本API可提前预录入门店信息" }, { "接口名称": "[门店信息查询](/miniprogram/dev/server/API/B2b/store_assistant/api_getretailinfo)", "请求路径": "/wxa/business/getretailinfo", "描述": "查询已完成门店认证授权用户的门店信息" }, { "接口名称": "[全量授权门店查询](/miniprogram/dev/server/API/B2b/store_assistant/api_getretailopenidlist)", "请求路径": "/wxa/business/getretailopenidlist", "描述": "该接口用于拉取小程序下所有已授权门店信息" } ] ``` ### 消息触达 ```json [ { "接口名称": "[模板消息列表及下发](/miniprogram/dev/server/API/B2b/notify/api_retailnotifybusiness)", "请求路径": "/wxa/business/retailnotifybusiness", "描述": "该接口用于下发模板消息" }, { "接口名称": "[消息效果数据](/miniprogram/dev/server/API/B2b/notify/api_getretailmessagelist)", "请求路径": "/wxa/business/getretailmessagelist", "描述": "该接口用于获取发送的消息数据" } ] ``` ### B2b支付 ```json [ { "接口名称": "[商户号进件](/miniprogram/dev/server/API/B2b/bill/api_retailregistermch)", "请求路径": "/retail/B2b/retailregistermch", "描述": "可以通过 api 方式进行商户号的进件" }, { "接口名称": "[上传商户图片](/miniprogram/dev/server/API/B2b/bill/api_retailuploadmchfile)", "请求路径": "/retail/B2b/retailuploadmchfile", "描述": "可以通过 api 上传资料获取图片 id，进件时填充图片 id" }, { "接口名称": "[查询商户号开通状态](/miniprogram/dev/server/API/B2b/bill/api_retailgetmchorder)", "请求路径": "/retail/B2b/retailgetmchorder", "描述": "可以通过api方式查询商户号进件订单（包含状态信息等）" }, { "接口名称": "[申请开通银行转账](/miniprogram/dev/server/API/B2b/bill/api_registeronlywqf)", "请求路径": "/retail/B2b/registeronlywqf", "描述": "在微信支付开通成功、但未开通银行转账的情况下，商户可以申请开通银行转账支付方式" }, { "接口名称": "[跳转银行转账页面](/miniprogram/dev/server/API/B2b/bill/api_createwqflink)", "请求路径": "/retail/B2b/createwqflink", "描述": "申请开通银行转账后，当开通状态描述为“待完善信息”、“待用户签约”、“申请驳回”时，都需要跳转到微企付页面完成相应操作" }, { "接口名称": "[获取小程序下所有商户的信息](/miniprogram/dev/server/API/B2b/bill/api_getmchinfo)", "请求路径": "/retail/B2b/getmchinfo", "描述": "可以通过 api 方式获取某个小程序下所有商户的信息" }, { "接口名称": "[报名微信支付技术服务费优惠活动](/miniprogram/dev/server/API/B2b/bill/api_setmchprofitrate)", "请求路径": "/retail/B2b/setmchprofitrate", "描述": "页面端方式：" }, { "接口名称": "[报名银行转账技术服务费优惠活动](/miniprogram/dev/server/API/B2b/bill/api_updatewqfchargefee)", "请求路径": "/retail/B2b/updatewqfchargefee", "描述": "页面端方式：" }, { "接口名称": "[查询银行转账的技术服务费率](/miniprogram/dev/server/API/B2b/bill/api_getwqfchargefee)", "请求路径": "/retail/B2b/getwqfchargefee", "描述": "可以通过商户号状态查询获取，见请求响应中的 wqfcertifiedrate 字段" }, { "接口名称": "[查询订单](/miniprogram/dev/server/API/B2b/bill/api_getorder)", "请求路径": "/retail/B2b/getorder", "描述": "该接口用于查询B2b订单信息" }, { "接口名称": "[关闭订单](/miniprogram/dev/server/API/B2b/bill/api_closeb2border)", "请求路径": "/retail/B2b/closeb2border", "描述": "仅当订单处于待支付状态（ORDERPREPAY）时，可以调用本接口主动关闭订单" }, { "接口名称": "[退款](/miniprogram/dev/server/API/B2b/bill/api_refundorder)", "请求路径": "/retail/B2b/refund", "描述": "当交易发生之后160天内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付金额退还给买家，微信支付将在收到退款请求并且验证成功之后，将支付款按原路退" }, { "接口名称": "[查询退款](/miniprogram/dev/server/API/B2b/bill/api_getrefund)", "请求路径": "/retail/B2b/getrefund", "描述": "该接口用于查询B2b退款单信息" }, { "接口名称": "[获取密钥AppKey](/miniprogram/dev/server/API/B2b/bill/api_getappkey)", "请求路径": "/retail/B2b/getappkey", "描述": "获取B2b商户号的密钥AppKey" }, { "接口名称": "[接口下载交易账单与资金账单](/miniprogram/dev/server/API/B2b/bill/api_downloadbill)", "请求路径": "/retail/B2b/downloadbill", "描述": "该接口支持查询近 90 天内的账单" }, { "接口名称": "[查询账户余额](/miniprogram/dev/server/API/B2b/bill/api_getmchbalance)", "请求路径": "/retail/B2b/getmchbalance", "描述": "查询B2b商户号下的余额" }, { "接口名称": "[发起手动提现](/miniprogram/dev/server/API/B2b/bill/api_manualwithdraw)", "请求路径": "/retail/B2b/withdraw", "描述": "用api发起手动提现" }, { "接口名称": "[查询提现状态](/miniprogram/dev/server/API/B2b/bill/api_querywithdraw)", "请求路径": "/retail/B2b/querywithdraw", "描述": "查询提现状态" }, { "接口名称": "[微信支付自动提现接口](/miniprogram/dev/server/API/B2b/bill/api_setautowithdraw)", "请求路径": "/retail/B2b/setautowithdraw", "描述": "该接口用于为B2b商户号设置微信支付自动提现" }, { "接口名称": "[添加分账方](/miniprogram/dev/server/API/B2b/bill/api_addprofitsharingaccount)", "请求路径": "/retail/B2b/addprofitsharingaccount", "描述": "可以通过 api 方式添加分账方，单个小程序添加的分账接收方上限为 1000" }, { "接口名称": "[删除分账方](/miniprogram/dev/server/API/B2b/bill/api_delprofitsharingaccount)", "请求路径": "/retail/B2b/delprofitsharingaccount", "描述": "可以通过 api 方式删除分账方" }, { "接口名称": "[查询分账方](/miniprogram/dev/server/API/B2b/bill/api_queryprofitsharingaccount)", "请求路径": "/retail/B2b/queryprofitsharingaccount", "描述": "通过 api 方式查询分账方" }, { "接口名称": "[请求分账](/miniprogram/dev/server/API/B2b/bill/api_createprofitsharingorder)", "请求路径": "/retail/B2b/createprofitsharingorder", "描述": "通过此接口发起分账请求，将结算后的资金分给分账接收方" }, { "接口名称": "[查询分账结果](/miniprogram/dev/server/API/B2b/bill/api_queryprofitsharingorder)", "请求路径": "/retail/B2b/queryprofitsharingorder", "描述": "可用于查询某笔支付单的某笔分账单是否已经分账完成" }, { "接口名称": "[查询分账剩余金额](/miniprogram/dev/server/API/B2b/bill/api_queryprofitsharingremainamt)", "请求路径": "/retail/B2b/queryprofitsharingremainamt", "描述": "可用于查询某笔支付单分账完剩余金额" }, { "接口名称": "[完成分账](/miniprogram/dev/server/API/B2b/bill/api_finishprofitsharingorder)", "请求路径": "/retail/B2b/finishprofitsharingorder", "描述": "某笔支付单在下单时标识需要分账后，该笔支付单的金额会被冻结，直到调用该接口告知完成分账后，金额才会解冻，能够发起提现" }, { "接口名称": "[请求分账回退](/miniprogram/dev/server/API/B2b/bill/api_refundprofitsharing)", "请求路径": "/retail/B2b/refundprofitsharing", "描述": "已分账订单，在完成退款后，通过调用此接口，可将已分账的资金从分账接收方的账户回退给分账方" }, { "接口名称": "[查询分账回退结果](/miniprogram/dev/server/API/B2b/bill/api_queryrefundprofitsharingorder)", "请求路径": "/retail/B2b/queryrefundprofitsharingorder", "描述": "通过此接口查询回退结果" } ] ``` ## 短剧媒资管理 ### 媒资上传 ```json [ { "接口名称": "[单个文件上传](/miniprogram/dev/server/API/minidrama/vod_fileupload/api_singlefileupload)", "请求路径": "/wxa/sec/vod/singlefileupload", "描述": "该接口用于上传媒体（和封面）文件，上传小文件（小于10MB）时使用" }, { "接口名称": "[拉取上传](/miniprogram/dev/server/API/minidrama/vod_fileupload/api_pullupload)", "请求路径": "/wxa/sec/vod/pullupload", "描述": "该接口用于将一个网络上的视频拉取上传到平台" }, { "接口名称": "[查询任务](/miniprogram/dev/server/API/minidrama/vod_fileupload/api_gettask)", "请求路径": "/wxa/sec/vod/gettask", "描述": "该接口用于查询拉取上传的任务状态" }, { "接口名称": "[申请分片上传](/miniprogram/dev/server/API/minidrama/vod_fileupload/api_applyupload)", "请求路径": "/wxa/sec/vod/applyupload", "描述": "上传大文件时需使用分片上传方式，分为 3 个步骤：" }, { "接口名称": "[上传分片](/miniprogram/dev/server/API/minidrama/vod_fileupload/api_uploadpart)", "请求路径": "/wxa/sec/vod/uploadpart", "描述": "将文件的其中一个分片上传到平台，最多支持100个分片，每个分片大小为5MB，最后一个分片可以小于5MB" }, { "接口名称": "[确认上传](/miniprogram/dev/server/API/minidrama/vod_fileupload/api_commitupload)", "请求路径": "/wxa/sec/vod/commitupload", "描述": "该接口用于完成整个分片上传流程，合并所有文件分片，确认媒体文件（和封面图片文件）上传到平台的结果，返回文件的 ID" } ] ``` ### 媒资管理 ```json [ { "接口名称": "[获取媒资列表](/miniprogram/dev/server/API/minidrama/vod_media/api_listmedia)", "请求路径": "/wxa/sec/vod/listmedia", "描述": "该接口用于获取已上传到平台的媒资列表" }, { "接口名称": "[获取媒资详细信息](/miniprogram/dev/server/API/minidrama/vod_media/api_getmedia)", "请求路径": "/wxa/sec/vod/getmedia", "描述": "该接口用于获取已上传到平台的指定媒资信息，用于开发者后台管理使用" }, { "接口名称": "[获取媒资播放链接](/miniprogram/dev/server/API/minidrama/vod_media/api_getmedialink)", "请求路径": "/wxa/sec/vod/getmedialink", "描述": "该接口用于获取视频临时播放链接，用于给用户的播放使用" }, { "接口名称": "[删除媒资](/miniprogram/dev/server/API/minidrama/vod_media/api_deletemedia)", "请求路径": "/wxa/sec/vod/deletemedia", "描述": "该接口用于删除指定媒资" } ] ``` ### 剧目提审 ```json [ { "接口名称": "[剧目提审](/miniprogram/dev/server/API/minidrama/auditdrama/api_auditdrama)", "请求路径": "/wxa/sec/vod/auditdrama", "描述": "剧目提交审核" }, { "接口名称": "[获取剧目列表](/miniprogram/dev/server/API/minidrama/auditdrama/api_listdramas)", "请求路径": "/wxa/sec/vod/listdramas", "描述": "该接口用于获取已提交的剧目列表" }, { "接口名称": "[获取剧目信息](/miniprogram/dev/server/API/minidrama/auditdrama/api_getdrama)", "请求路径": "/wxa/sec/vod/getdrama", "描述": "该接口用于查询已提交的剧目" }, { "接口名称": "[提交替换剧集审核](/miniprogram/dev/server/API/minidrama/auditdrama/api_submitreplacemedias)", "请求路径": "/wxa/sec/vod/submitreplacedramamedias", "描述": "该接口用于提交剧目替换剧集审核" }, { "接口名称": "[替换审核通过的剧集](/miniprogram/dev/server/API/minidrama/auditdrama/api_replacedramamedia)", "请求路径": "/wxa/sec/vod/replacedramamedia", "描述": "该接口用于替换剧目审核通过的剧集" }, { "接口名称": "[修改剧目基本信息](/miniprogram/dev/server/API/minidrama/auditdrama/api_submitmodifydramabasicinforeq)", "请求路径": "/wxa/sec/vod/modifydramabasicinfo", "描述": "该接口用于修改剧目基本信息" }, { "接口名称": "[查询剧目审核信息](/miniprogram/dev/server/API/minidrama/auditdrama/api_getdramalatestauditinfo)", "请求路径": "/wxa/sec/vod/getdramalatestauditinfo", "描述": "该接口用于查询剧目最后一条审核信息" } ] ``` ### 数据统计 ```json [ { "接口名称": "[查询CDN用量数据](/miniprogram/dev/server/API/minidrama/usagedata/api_getcdnusagedata)", "请求路径": "/wxa/sec/vod/getcdnusagedata", "描述": "该接口用于查询点播 CDN 的流量数据" }, { "接口名称": "[查询CDN日志下载链接列表](/miniprogram/dev/server/API/minidrama/usagedata/api_getcdnlogs)", "请求路径": "/wxa/sec/vod/getcdnlogs", "描述": "查询域名的 CDN 访问日志的下载链接" }, { "接口名称": "[查询流量包详情](/miniprogram/dev/server/API/minidrama/usagedata/api_listpackages)", "请求路径": "/wxa/sec/vod/listpackages", "描述": "该接口用于查询流量包的使用详情" } ] ``` ### 剧目授权 ```json [ { "接口名称": "[查询被授权信息](/miniprogram/dev/server/API/minidrama/authorizeapp/api_getauthorizedobjects)", "请求路径": "/wxa/sec/vod/getauthorizedobjects", "描述": "该接口用于被授权方查询自己被授权的剧目授权信息，适用场景包括剧目授权和账号授权" }, { "接口名称": "[增加剧目授权](/miniprogram/dev/server/API/minidrama/authorizedrama/api_authorizedrama)", "请求路径": "/wxa/sec/vod/authorizedrama", "描述": "该接口用于授权方给被授权方授权一些剧目的播放权限" }, { "接口名称": "[解除剧目授权](/miniprogram/dev/server/API/minidrama/authorizedrama/api_deauthorizedrama)", "请求路径": "/wxa/sec/vod/deauthorizedrama", "描述": "该接口用于授权方解除被授权方一些剧目的播放授权" }, { "接口名称": "[查询授权信息](/miniprogram/dev/server/API/minidrama/authorizedrama/api_getauthorizeobjects)", "请求路径": "/wxa/sec/vod/getauthorizeobjects", "描述": "该接口用于授权方查询剧目授权信息" } ] ``` ### 账号授权 ```json [ { "接口名称": "[增加账号授权](/miniprogram/dev/server/API/minidrama/authorizeapp/api_authorizeapp)", "请求路径": "/wxa/sec/vod/authorizeapp", "描述": "该接口用于授权方给被授权方授权所有剧目的播放权限" }, { "接口名称": "[解除账号授权](/miniprogram/dev/server/API/minidrama/authorizeapp/api_deauthorizeapp)", "请求路径": "/wxa/sec/vod/deauthorizeapp", "描述": "该接口用于授权方解除被授权方的播放授权" }, { "接口名称": "[查询账号授权信息](/miniprogram/dev/server/API/minidrama/authorizeapp/api_getauthorizeapps)", "请求路径": "/wxa/sec/vod/getauthorizeapps", "描述": "该接口用于授权方查询账号授权信息" }, { "接口名称": "[查询被授权信息](/miniprogram/dev/server/API/minidrama/authorizeapp/api_getauthorizedobjects)", "请求路径": "/wxa/sec/vod/getauthorizedobjects", "描述": "该接口用于被授权方查询自己被授权的剧目授权信息，适用场景包括剧目授权和账号授权" } ] ``` ### 版权授权 ```json [ { "接口名称": "[增加版权授权](/miniprogram/dev/server/API/minidrama/authorizecopyright/api_authorizecopyright)", "请求路径": "/wxa/sec/vod/authorizecopyright", "描述": "该接口用于授权受版权保护的剧目" }, { "接口名称": "[解除版权授权](/miniprogram/dev/server/API/minidrama/authorizecopyright/api_deauthorizecopyright)", "请求路径": "/wxa/sec/vod/deauthorizecopyright", "描述": "该接口用于解除受版权保护的剧目的授权" }, { "接口名称": "[查询版权授权信息](/miniprogram/dev/server/API/minidrama/authorizecopyright/api_getcopyrightauthorizationlist)", "请求路径": "/wxa/sec/vod/getcopyrightauthorizationlist", "描述": "该接口用于授权方查询版权授权信息" }, { "接口名称": "[查询被版权授权信息](/miniprogram/dev/server/API/minidrama/authorizecopyright/api_getcopyrightauthorizedlist)", "请求路径": "/wxa/sec/vod/getcopyrightauthorizedlist", "描述": "该接口用于被授权方查询自己被版权授权的信息" } ] ``` ## 短剧播放器 ```json [ { "接口名称": "[播放原始视频-推荐位控制接口](/miniprogram/dev/server/API/dramaOthersAPI/api_setplayerdramarecmdswitch)", "请求路径": "/wxadrama/setplayerdramarecmdswitch", "描述": "开发者可通过后台接口选择播放上传未经转码的原始视频" }, { "接口名称": "[刷剧剧目设置](/miniprogram/dev/server/API/dramaOthersAPI/api_developersetflushdrama)", "请求路径": "/wxadrama/developersetflushdrama", "描述": "开发者可通过后台接口设置刷剧剧目" }, { "接口名称": "[推荐剧目](/miniprogram/dev/server/API/dramaOthersAPI/api_developersetrecmddrama)", "请求路径": "/wxadrama/developersetrecmddrama", "描述": "开启推荐位之后，推荐剧目范围默认为播放小程序所有已授权的剧目" }, { "接口名称": "[短剧上架](/miniprogram/dev/server/API/dramaOthersAPI/api_developerpublishdrama)", "请求路径": "/wxadrama/developerpublishdrama", "描述": "开发者可通过后台接口设置小程序内短剧的上架时间" }, { "接口名称": "[获取已上架短剧](/miniprogram/dev/server/API/dramaOthersAPI/api_developergetpublisheddrama)", "请求路径": "/wxadrama/developergetpublisheddrama", "描述": "开发者可以通过该接口查询通过“短剧上架设置接口”设置上架的短剧" }, { "接口名称": "[设置短剧变现类型](/miniprogram/dev/server/API/dramaOthersAPI/api_developersetiaadrama)", "请求路径": "/wxadrama/developersetiaadrama", "描述": "在视频号推荐、视频号入口展示、播放器选集等场景，对IAA/IAP/IAAP有不同的精准策略" }, { "接口名称": "[获取短剧变现类型](/miniprogram/dev/server/API/dramaOthersAPI/api_developergetiaadrama)", "请求路径": "/wxadrama/developergetiaadrama", "描述": "获取已设置短剧的变现类型" }, { "接口名称": "[批处理短剧合作推广计划](/miniprogram/dev/server/API/dramaOthersAPI/api_batchprocessdramapromotion)", "请求路径": "/wxadrama/batchprocessdramapromotion", "描述": "开发者注意：使用该接口前请阅读并同意《微信小程序平台短剧推广计划合作协议》；你以任何方式使用该接口，即视为你确认同意《微信小程序平台短剧推广计划合作协议》，自愿" }, { "接口名称": "[获取短剧合作推广活动](/miniprogram/dev/server/API/dramaOthersAPI/api_getfinderevent)", "请求路径": "/wxadrama/getfinderevent", "描述": "该接口可获取当前小程序短剧所关联的短剧合作推广活动" } ] ``` ## 小说作品管理 ### 作品管理 ```json [ { "接口名称": "[创建作品](/miniprogram/dev/server/API/novel/business/api_createbook)", "请求路径": "/wxa/book/createbook", "描述": "该接口用于创建作品（小说）" }, { "接口名称": "[编辑作品](/miniprogram/dev/server/API/novel/business/api_updatebook)", "请求路径": "/wxa/book/updatebook", "描述": "该接口用于编辑作品编辑版的基础信息、章节顺序、分卷信息，不直接影响发布版，需要提审通过后才会更新发布版" }, { "接口名称": "[删除作品](/miniprogram/dev/server/API/novel/business/api_deletebook)", "请求路径": "/wxa/book/deletebook", "描述": "该接口用于删除作品，同时作用于编辑版和发布版" }, { "接口名称": "[获取作品列表](/miniprogram/dev/server/API/novel/business/api_listbook)", "请求路径": "/wxa/book/listbook", "描述": "该接口用于获取所有作品列表，分为发布版列表和编辑版列表" }, { "接口名称": "[获取作品信息](/miniprogram/dev/server/API/novel/business/api_getbook)", "请求路径": "/wxa/book/getbook", "描述": "该接口用于获取作品详细信息，同获取作品列表，这里也会区分发布版和编辑版" }, { "接口名称": "[上传章节](/miniprogram/dev/server/API/novel/business/api_createchapter)", "请求路径": "/wxa/book/createchapter", "描述": "该接口用于上传章节到作品编辑版信息里，不直接影响发布版，需要提审通过后才会更新发布版" }, { "接口名称": "[批量上传章节](/miniprogram/dev/server/API/novel/business/api_batchcreatechapter)", "请求路径": "/wxa/book/batchcreatechapter", "描述": "该接口用于批量上传章节到作品编辑版信息里，不直接影响发布版，需要提审通过后才会更新发布版" }, { "接口名称": "[删除章节](/miniprogram/dev/server/API/novel/business/api_deletechapter)", "请求路径": "/wxa/book/deletechapter", "描述": "该接口用于删除作品编辑版里的章节，不直接影响发布版，需要提审通过后才会更新发布版" }, { "接口名称": "[替换章节](/miniprogram/dev/server/API/novel/business/api_replacechapter)", "请求路径": "/wxa/book/replacechapter", "描述": "该接口用于替换作品编辑版里的已有章节内容，不直接影响发布版，需要提审通过后才会更新发布版" }, { "接口名称": "[获取章节列表](/miniprogram/dev/server/API/novel/business/api_listchapter)", "请求路径": "/wxa/book/listchapter", "描述": "该接口用于获取章节信息" }, { "接口名称": "[获取章节信息](/miniprogram/dev/server/API/novel/business/api_getchapter)", "请求路径": "/wxa/book/getchapter", "描述": "该接口用于获取章节信息" }, { "接口名称": "[调整章节顺序](/miniprogram/dev/server/API/novel/business/api_reorderchapter)", "请求路径": "/wxa/book/reorderchapter", "描述": "该接口用于调整作品编辑版信息中的章节顺序，不直接影响发布版，需要提审通过后才会更新发布版" }, { "接口名称": "[调整章节相对顺序](/miniprogram/dev/server/API/novel/business/api_updatechapterseq)", "请求路径": "/wxa/book/updatechapterseq", "描述": "该接口用于调整作品编辑版信息中的章节顺序，不直接影响发布版，需要提审通过后才会更新发布版" }, { "接口名称": "[作品提审](/miniprogram/dev/server/API/novel/business/api_auditbook)", "请求路径": "/wxa/book/auditbook", "描述": "作品提交审核" } ] ``` ### 授权管理 ```json [ { "接口名称": "[新增账号-小说授权](/miniprogram/dev/server/API/novel/auth/api_addbookauth)", "请求路径": "/wxa/book/addbookauth", "描述": "增加账号-小说的授权关系数据，主授权账号使用可一次调用新增多条授权关系（上限20条）\n1. 同appid每天限额调用1000000次\n2. 同appid每分钟限" }, { "接口名称": "[查看主授权关系列表-查看被授权关系列表](/miniprogram/dev/server/API/novel/auth/api_querybookauth)", "请求路径": "/wxa/book/querybookauth", "描述": "查看账号的小说授权关系列表，主授权账号使用\n1. 同 appid 每天限额调用 10000 次" }, { "接口名称": "[删除指定的授权关系](/miniprogram/dev/server/API/novel/auth/api_delbookauth)", "请求路径": "/wxa/book/delbookauth", "描述": "删除账号的小说授权关系，主授权账号使用\n1. 同appid每天限额调用10000次" }, { "接口名称": "[新增账号-账号授权](/miniprogram/dev/server/API/novel/auth/api_addbookauthbyappid)", "请求路径": "/wxa/book/addbookauthbyappid", "描述": "增加账号-账号的授权关系数据，主授权账号可一次调用新增多条授权关系（上限20条）" }, { "接口名称": "[查看账号主授权关系列表](/miniprogram/dev/server/API/novel/auth/api_querybookauthv2)", "请求路径": "/wxa/book/querybookauthv2", "描述": "此接口可用于查看账号的授权关系列表，也可以看账号被授权关系列表" }, { "接口名称": "[删除指定的账号授权关系](/miniprogram/dev/server/API/novel/auth/api_delbookauthbyappid)", "请求路径": "/wxa/book/delbookauthbyappid", "描述": "删除账号维度授权关系，主授权账号使用" } ] ``` ### 预览设置 ```json [ { "接口名称": "[预览设置修改](/miniprogram/dev/server/API/novel/preview/api_setpreviewsetting)", "请求路径": "/wxa/business/novelreader/setpreviewsetting", "描述": "设置书本章节预览字数" }, { "接口名称": "[预览设置获取](/miniprogram/dev/server/API/novel/preview/api_getpreviewsetting)", "请求路径": "/wxa/business/novelreader/getpreviewsetting", "描述": "获取书本章节预览字数设置" } ] ``` ### 其他 ```json [ { "接口名称": "[读后推荐](/miniprogram/dev/server/API/novel/other/api_novelreadersetrecmdnovel)", "请求路径": "/wxa/business/novelreader/setrecmdnovel", "描述": "阅读器插件支持在阅读后推荐其他小说,开发者需要主动设置想要推荐的小说" } ] ``` ## 微信学生身份快速验证 ```json [ { "接口名称": "[快速获取学生身份](/miniprogram/dev/server/API/student/api_quickcheckstudentidentity)", "请求路径": "/intp/quickcheckstudentidentity", "描述": "该接口用于获取学生身份" } ] ``` ## 城市服务 ### 基础能力 ```json [ { "接口名称": "[获取城市服务限定页面链接](/miniprogram/dev/server/API/cityservice/basic/api_cityserviceservicehomepath)", "请求路径": "/cityservice/getservicepath", "描述": "本接口用于获取城市服务限定页面链接" }, { "接口名称": "[消息通路发消息](/miniprogram/dev/server/API/cityservice/basic/api_cityservice_sendmsgdata)", "请求路径": "/cityservice/sendmsgdata", "描述": "接入微信城市服务，业务方需确保功能的闭环服务体验，需接入消息通路" }, { "接口名称": "[校验实名信息](/miniprogram/dev/server/API/cityservice/basic/api_checkrealnameinfo)", "请求路径": "/intp/realname/checkrealnameinfo", "描述": "业务方页面获得code之后，需要通过该接口进行实名信息的校验" }, { "接口名称": "[仿原生跳转](/miniprogram/dev/server/API/cityservice/basic/api_transportcode_getbusinessview)", "请求路径": "/intp/transportcode/getbusinessview", "描述": "根据需求不同跳转不同的微信仿原生页面实现不同的功能需求" } ] ``` ### 微信就医助手 ```json [ { "接口名称": "[消息推送接口](/miniprogram/dev/server/API/cityservice/medicalassistant/api_cityservice_sendchannelmsg)", "请求路径": "/cityservice/sendchannelmsg", "描述": "用于下发就医助手消息，结合通用参数和不同子状态status参数组合实现各类业务消息推送，要获取所有status参数，请查看微信就医助手开发文档" } ] ``` ### 微信长辈就医 ```json [ { "接口名称": "[查询用户实名API](/miniprogram/dev/server/API/cityservice/elderMedical/api_cityservice_getmedrealname)", "请求路径": "/cityservice/getmedrealname", "描述": "查询老年患者实名信息" }, { "接口名称": "[查询用户是否开通](/miniprogram/dev/server/API/cityservice/elderMedical/api_cityservice_getmsgrelation)", "请求路径": "/cityservice/getmsgrelation", "描述": "检查用户长辈就医开通状态" }, { "接口名称": "[查询所有公告](/miniprogram/dev/server/API/cityservice/elderMedical/api_intp_eldermed_gethospnoticelist)", "请求路径": "/intp/eldermedical/gethospnoticelist", "描述": "查询当前医院所有的公告，包括草稿状态下的公告，微信侧保留最近五条公告" }, { "接口名称": "[公告草稿预览设置](/miniprogram/dev/server/API/cityservice/elderMedical/api_previewhopsnotice)", "请求路径": "/intp/eldermedical/previewhopsnotice", "描述": "设置草稿的预览人员名单" }, { "接口名称": "[正式发布公告](/miniprogram/dev/server/API/cityservice/elderMedical/api_intp_eldermed_publichopsnotice)", "请求路径": "/intp/eldermedical/publichopsnotice", "描述": "确认草稿状态下的公告效果后，将草稿状态的公告设置发布状态，设置完成后公告所有人可见" }, { "接口名称": "[添加公告草稿](/miniprogram/dev/server/API/cityservice/elderMedical/api_sethopsnotice)", "请求路径": "/intp/eldermedical/sethopsnotice", "描述": "添加一条草稿状态的公告，草稿状态下的公告指定用户可以查看效果" } ] ``` ## 附近小程序 ```json [ { "接口名称": "[添加地点](/miniprogram/dev/server/API/nearby-poi/api_addnearbypoi)", "请求路径": "/wxa/addnearbypoi", "描述": "该接口用于添加附近小程序的地点" }, { "接口名称": "[删除地点](/miniprogram/dev/server/API/nearby-poi/api_deletenearbypoi)", "请求路径": "/wxa/delnearbypoi", "描述": "该接口用于删除附近小程序的地点" }, { "接口名称": "[查看地点](/miniprogram/dev/server/API/nearby-poi/api_getnearbypoilist)", "请求路径": "/wxa/getnearbypoilist", "描述": "该接口用于查看附近小程序的地点列表" }, { "接口名称": "[设置展示状态](/miniprogram/dev/server/API/nearby-poi/api_setshowstatus)", "请求路径": "/wxa/setnearbypoishowstatus", "描述": "该接口用于展示/取消展示附近小程序" } ] ``` ## 小程序直播 ### 直播间管理 ```json [ { "接口名称": "[创建直播间](/miniprogram/dev/server/API/livebroadcast/studio-management/api_createroom)", "请求路径": "/wxaapi/broadcast/room/create", "描述": "调用此接口创建直播间，创建成功后将在直播间列表展示" }, { "接口名称": "[获取直播间列表和回放](/miniprogram/dev/server/API/livebroadcast/studio-management/api_getliveinfo)", "请求路径": "/wxa/business/getliveinfo", "描述": "该接口用于获取直播间列表及直播间信息" }, { "接口名称": "[删除直播间](/miniprogram/dev/server/API/livebroadcast/studio-management/api_deleteroom)", "请求路径": "/wxaapi/broadcast/room/deleteroom", "描述": "该接口用于删除直播间" }, { "接口名称": "[导入商品](/miniprogram/dev/server/API/livebroadcast/studio-management/api_importgoods)", "请求路径": "/wxaapi/broadcast/room/addgoods", "描述": "该接口用于往指定直播间导入商品" }, { "接口名称": "[编辑直播间](/miniprogram/dev/server/API/livebroadcast/studio-management/api_editroom)", "请求路径": "/wxaapi/broadcast/room/editroom", "描述": "该接口用于编辑直播间" }, { "接口名称": "[获取直播间推流地址](/miniprogram/dev/server/API/livebroadcast/studio-management/api_getpushurl)", "请求路径": "/wxaapi/broadcast/room/getpushurl", "描述": "该接口用于获取直播间推流地址" }, { "接口名称": "[获取直播间分享二维码](/miniprogram/dev/server/API/livebroadcast/studio-management/api_getsharedcode)", "请求路径": "/wxaapi/broadcast/room/getsharedcode", "描述": "该接口用于获取直播间分享二维码" }, { "接口名称": "[获取主播副号](/miniprogram/dev/server/API/livebroadcast/studio-management/api_getsubanchor)", "请求路径": "/wxaapi/broadcast/room/getsubanchor", "描述": "该接口用于获取主播副号" }, { "接口名称": "[修改主播副号](/miniprogram/dev/server/API/livebroadcast/studio-management/api_modifysubanchor)", "请求路径": "/wxaapi/broadcast/room/modifysubanchor", "描述": "该接口用于修改主播副号" }, { "接口名称": "[删除主播副号](/miniprogram/dev/server/API/livebroadcast/studio-management/api_deletesubanchor)", "请求路径": "/wxaapi/broadcast/room/deletesubanchor", "描述": "该接口用于删除主播副号" }, { "接口名称": "[添加主播副号](/miniprogram/dev/server/API/livebroadcast/studio-management/api_addsubanchor)", "请求路径": "/wxaapi/broadcast/room/addsubanchor", "描述": "该接口用于点击直播副号" }, { "接口名称": "[删除直播间商品](/miniprogram/dev/server/API/livebroadcast/studio-management/api_deletedoods)", "请求路径": "/wxaapi/broadcast/goods/deleteInRoom", "描述": "该接口用于删除直播间商品" }, { "接口名称": "[推送商品](/miniprogram/dev/server/API/livebroadcast/studio-management/api_pushgoods)", "请求路径": "/wxaapi/broadcast/goods/push", "描述": "该接口用于推送商品到直播间" }, { "接口名称": "[上下架商品](/miniprogram/dev/server/API/livebroadcast/studio-management/api_salegoods)", "请求路径": "/wxaapi/broadcast/goods/onsale", "描述": "该接口用于下架或者上架商品" }, { "接口名称": "[直播间商品排序](/miniprogram/dev/server/API/livebroadcast/studio-management/api_sortgoods)", "请求路径": "/wxaapi/broadcast/goods/sort", "描述": "该接口用于直播间商品排序" }, { "接口名称": "[修改直播间小助手](/miniprogram/dev/server/API/livebroadcast/studio-management/api_modifyassistant)", "请求路径": "/wxaapi/broadcast/room/modifyassistant", "描述": "该接口用于修改直播间小助手" }, { "接口名称": "[查询直播间小助手](/miniprogram/dev/server/API/livebroadcast/studio-management/api_getassistantlist)", "请求路径": "/wxaapi/broadcast/room/getassistantlist", "描述": "该接口用于查询直播间小助手" }, { "接口名称": "[删除直播间小助手](/miniprogram/dev/server/API/livebroadcast/studio-management/api_removeassistant)", "请求路径": "/wxaapi/broadcast/room/removeassistant", "描述": "该接口用于删除直播间小助手" }, { "接口名称": "[添加管理直播间小助手](/miniprogram/dev/server/API/livebroadcast/studio-management/api_addveassistant)", "请求路径": "/wxaapi/broadcast/room/addassistant", "描述": "该接口用于添加管理直播间小助手" }, { "接口名称": "[禁言管理](/miniprogram/dev/server/API/livebroadcast/studio-management/api_updatecomment)", "请求路径": "/wxaapi/broadcast/room/updatecomment", "描述": "该接口用于开启/关闭直播间全局禁言" }, { "接口名称": "[官方收录管理](/miniprogram/dev/server/API/livebroadcast/studio-management/api_updatefeedpublic)", "请求路径": "/wxaapi/broadcast/room/updatefeedpublic", "描述": "该接口用于开启/关闭直播间官方收录" }, { "接口名称": "[客服功能管理](/miniprogram/dev/server/API/livebroadcast/studio-management/api_updatekf)", "请求路径": "/wxaapi/broadcast/room/updatekf", "描述": "该接口用于开启/关闭客服功能" }, { "接口名称": "[回放功能管理](/miniprogram/dev/server/API/livebroadcast/studio-management/api_updatereplay)", "请求路径": "/wxaapi/broadcast/room/updatereplay", "描述": "该接口用于开启/关闭回放功能" }, { "接口名称": "[下载商品讲解视频](/miniprogram/dev/server/API/livebroadcast/studio-management/api_downloadgoodsvideo)", "请求路径": "/wxaapi/broadcast/goods/getVideo", "描述": "该接口用于下载商品讲解视频" }, { "接口名称": "[直播挂件设置全局KEY](/miniprogram/dev/server/API/livebroadcast/studio-management/api_setdefault_goodskey)", "请求路径": "/wxaapi/broadcast/goods/setkey", "描述": "若已设置此全局key，且添加商品时未指定goodsKey字段，则我们会使用此全局key作为该商品的goodsKey" }, { "接口名称": "[直播挂件获取全局KEY](/miniprogram/dev/server/API/livebroadcast/studio-management/api_getdefault_goodskey)", "请求路径": "/wxaapi/broadcast/goods/getkey", "描述": "查看当前设定的全局 KEY" } ] ``` ### 商品管理 ```json [ { "接口名称": "[添加并提审商品](/miniprogram/dev/server/API/livebroadcast/commodity-management/api_addgoods)", "请求路径": "/wxaapi/broadcast/goods/add", "描述": "调用此接口上传并提审需要直播的商品信息，审核通过后商品录入【小程序直播】商品库" }, { "接口名称": "[重新提交商品审核](/miniprogram/dev/server/API/livebroadcast/commodity-management/api_resubmitaudit)", "请求路径": "/wxaapi/broadcast/goods/audit", "描述": "调用此接口可以对已撤回提审的商品再次发起提审申请" }, { "接口名称": "[获取商品的信息与审核状态](/miniprogram/dev/server/API/livebroadcast/commodity-management/api_getgoodsauditinfo)", "请求路径": "/wxa/business/getgoodswarehouse", "描述": "该接口用于获取商品的信息与审核状态" }, { "接口名称": "[撤回商品审核](/miniprogram/dev/server/API/livebroadcast/commodity-management/api_resetaudit)", "请求路径": "/wxaapi/broadcast/goods/resetaudit", "描述": "该接口用于撤回商品审核，消耗的提审次数不返还" }, { "接口名称": "[更新商品](/miniprogram/dev/server/API/livebroadcast/commodity-management/api_updategoodsinfo)", "请求路径": "/wxaapi/broadcast/goods/update", "描述": "调用此接口可以更新商品信息，审核通过的商品仅允许更新价格类型与价格，审核中的商品不允许更新，未审核的商品允许更新所有字段， 只传入需要更新的字段" }, { "接口名称": "[获取商品列表](/miniprogram/dev/server/API/livebroadcast/commodity-management/api_getgoodsinfo)", "请求路径": "/wxaapi/broadcast/goods/getapproved", "描述": "该接口用户获取不同审核状态的商品信息" }, { "接口名称": "[删除商品](/miniprogram/dev/server/API/livebroadcast/commodity-management/api_deletegoodsinfo)", "请求路径": "/wxaapi/broadcast/goods/delete", "描述": "调用此接口，可删除【小程序直播】商品库中的商品，删除后直播间上架的该商品也将被同步删除，不可恢复；" } ] ``` ### 成员管理 ```json [ { "接口名称": "[设置成员角色](/miniprogram/dev/server/API/livebroadcast/role-management/api_getrolelistdw)", "请求路径": "/wxaapi/broadcast/role/addrole", "描述": "调用此接口设置小程序直播成员的管理员、运营者和主播角色" }, { "接口名称": "[移除成员角色](/miniprogram/dev/server/API/livebroadcast/role-management/api_deleterole)", "请求路径": "/wxaapi/broadcast/role/deleterole", "描述": "调用此接口可移除小程序直播成员的管理员、运营者和主播角色" }, { "接口名称": "[查询成员列表](/miniprogram/dev/server/API/livebroadcast/role-management/api_getrolelist)", "请求路径": "/wxaapi/broadcast/role/getrolelist", "描述": "该接口用于查询小程序直播成员列表" } ] ``` ### 长期订阅 ```json [ { "接口名称": "[发送直播开始事件](/miniprogram/dev/server/API/livebroadcast/subscribe-management/api_pushmessage)", "请求路径": "/wxa/business/push_message", "描述": "该接口用于向长期订阅用户群发直播间开始事件" }, { "接口名称": "[获取长期订阅用户](/miniprogram/dev/server/API/livebroadcast/subscribe-management/api_getfollowers)", "请求路径": "/wxa/business/get_wxa_followers", "描述": "该接口用于获取长期订阅用户列表" } ] ``` ## 图像处理与文字识别 ### 图像处理 ```json [ { "接口名称": "[图片智能裁剪](/miniprogram/dev/server/API/img-ocr/img/api_imgaicrop)", "请求路径": "/cv/img/aicrop", "描述": "本接口用于对图片主体区域进行智能识别和裁剪" }, { "接口名称": "[二维码/条码识别](/miniprogram/dev/server/API/img-ocr/img/api_imgqrcode)", "请求路径": "/cv/img/qrcode", "描述": "识别图片中的二维码、条码、DataMatrix和PDF417" }, { "接口名称": "[图片高清化](/miniprogram/dev/server/API/img-ocr/img/api_imgsuperresolution)", "请求路径": "/cv/img/superresolution", "描述": "该接口用于将图片高清化，由于系统维护原因，已下架，如有需要使用，可前往微信开放社区发帖/联系微信服务市场客服" } ] ``` ### OCR ```json [ { "接口名称": "[通用印刷体识别](/miniprogram/dev/server/API/img-ocr/ocr/api_commocr)", "请求路径": "/cv/ocr/comm", "描述": "本接口用于识别通用印刷体" }, { "接口名称": "[行驶证识别](/miniprogram/dev/server/API/img-ocr/ocr/api_drivingocr)", "请求路径": "/cv/ocr/driving", "描述": "提供机动车行驶证信息OCR识别" }, { "接口名称": "[银行卡识别](/miniprogram/dev/server/API/img-ocr/ocr/api_bankcardocr)", "请求路径": "/cv/ocr/bankcard", "描述": "本接口提供银行卡卡面信息OCR识别" }, { "接口名称": "[营业执照识别](/miniprogram/dev/server/API/img-ocr/ocr/api_bizlicenseocr)", "请求路径": "/cv/ocr/bizlicense", "描述": "本接口提供营业执照 OCR 识别能力" }, { "接口名称": "[驾驶证识别](/miniprogram/dev/server/API/img-ocr/ocr/api_drivinglicenseocr)", "请求路径": "/cv/ocr/drivinglicense", "描述": "本接口用于驾驶证识别" }, { "接口名称": "[身份证识别](/miniprogram/dev/server/API/img-ocr/ocr/api_idcardocr)", "请求路径": "/cv/ocr/idcard", "描述": "本接口提供身份证正反面OCR识别功能" } ] ``` ## 微信红包封面 ```json [ { "接口名称": "[获取微信红包封面](/miniprogram/dev/server/API/red-packet-cover/api_getredpacketcoverurl)", "请求路径": "/redpacketcover/wxapp/cover_url/get_by_token", "描述": "本接口用于获得指定用户可以领取的红包封面链接" } ] ``` ## 微信服务市场 ```json [ { "接口名称": "[调用服务市场接口](/miniprogram/dev/server/API/wx-service-market/api_invokeservice)", "请求路径": "/wxa/servicemarket", "描述": "该接口用于调用服务平台上架的api，适用于公众号、小程序和第三方平台调用，区别仅仅在于accesstoken的生成而已" }, { "接口名称": "[异步获取处理数据](/miniprogram/dev/server/API/wx-service-market/api_servicemarketretrieve)", "请求路径": "/wxa/servicemarketretrieve", "描述": "开发者可通过调用服务市场接口获取request_id，可调用本接口获取异步处理后的数据" } ] ``` ## 生物认证 ```json [ { "接口名称": "[生物认证秘钥签名验证](/miniprogram/dev/server/API/soter/api_verifysignature)", "请求路径": "/cgi-bin/soter/verify_signature", "描述": "该接口用于SOTER 生物认证秘钥签名验证" } ] ``` ## 微信人脸核身 ```json [ { "接口名称": "[获取用户人脸核身会话唯一标识](/miniprogram/dev/server/API/face/api_getverifyid)", "请求路径": "/cityservice/face/identify/getverifyid", "描述": "业务方后台根据「用户实名信息（姓名+身份证）」调用 接口获取人脸核身会话唯一标识 字段，然后给到小程序前端调用 接口使用" }, { "接口名称": "[查询用户人脸核身真实验证结果](/miniprogram/dev/server/API/face/api_queryverifyinfo)", "请求路径": "/cityservice/face/identify/queryverifyinfo", "描述": "业务方后台根据人脸核身会话唯一标识 verifyId 字段调用 queryVerifyInfo 接口查询用户人脸核身真实验证结果" } ] ``` ## 微信搜一搜 ```json [ { "接口名称": "[搜一搜数据推送](/miniprogram/dev/server/API/wxsearch/api_submitpages)", "请求路径": "/wxa/search/wxaapi_submitpages", "描述": "小程序可以通过该功能推送优质内容的页面路径、参数和结构化数据等信息，让微信搜索可以更及时地收录到小程序内容，推送的内容将会被用于微信搜索结果展示，详情参考 内容" } ] ``` ## 虚拟支付 ```json [ { "接口名称": "[查询代币余额](/miniprogram/dev/server/API/VirtualPayment/api_query_user_balance)", "请求路径": "/xpay/query_user_balance", "描述": "本接口用于查询代币余额" }, { "接口名称": "[扣减代币](/miniprogram/dev/server/API/VirtualPayment/api_currency_pay)", "请求路径": "/xpay/currency_pay", "描述": "本接口用于扣减代币（一般用于代币支付）" }, { "接口名称": "[查询创建的订单](/miniprogram/dev/server/API/VirtualPayment/api_query_order)", "请求路径": "/xpay/query_order", "描述": "本接口用于查询创建的订单（现金单，非代币单）" }, { "接口名称": "[代币支付退款](/miniprogram/dev/server/API/VirtualPayment/api_cancel_currency_pay)", "请求路径": "/xpay/cancel_currency_pay", "描述": "本接口用于代币支付退款(currency_pay接口的逆操作)" }, { "接口名称": "[通知已发货完成](/miniprogram/dev/server/API/VirtualPayment/api_notify_provide_goods)", "请求路径": "/xpay/notify_provide_goods", "描述": "通知已经发货完成（只能通知现金单）,正常通过xpaygoodsdeliver_notify消息推送返回成功就不需要调用这个api接口" }, { "接口名称": "[代币赠送](/miniprogram/dev/server/API/VirtualPayment/api_present_currency)", "请求路径": "/xpay/present_currency", "描述": "代币赠送接口，由于目前不支持按单号查赠送单的功能，所以当需要赠送的时候可以一直重试到返回0或者返回268490004（重复操作）为止" }, { "接口名称": "[下载小程序账单](/miniprogram/dev/server/API/VirtualPayment/api_download_bill)", "请求路径": "/xpay/download_bill", "描述": "用于下载小程序账单，第一次调用触发生成下载url，可以间隔轮训来获取最终生成的下载url" }, { "接口名称": "[启动订单退款任务](/miniprogram/dev/server/API/VirtualPayment/api_refund_order)", "请求路径": "/xpay/refund_order", "描述": "可对支付时间 365 天以内的订单发起退款" }, { "接口名称": "[创建提现单](/miniprogram/dev/server/API/VirtualPayment/api_create_withdraw_order)", "请求路径": "/xpay/create_withdraw_order", "描述": "本接口用于创建提现单" }, { "接口名称": "[查询提现单](/miniprogram/dev/server/API/VirtualPayment/api_query_withdraw_order)", "请求路径": "/xpay/query_withdraw_order", "描述": "本接口用于查询提现单" }, { "接口名称": "[批量上传道具](/miniprogram/dev/server/API/VirtualPayment/api_start_upload_goods)", "请求路径": "/xpay/start_upload_goods", "描述": "启动批量上传道具任务，一次仅支持上传一个道具，多个道具需分多次请求" }, { "接口名称": "[查询批量上传道具任务](/miniprogram/dev/server/API/VirtualPayment/api_query_upload_goods)", "请求路径": "/xpay/query_upload_goods", "描述": "本接口用于查询批量上传道具任务" }, { "接口名称": "[启动批量发布道具任务](/miniprogram/dev/server/API/VirtualPayment/api_start_publish_goods)", "请求路径": "/xpay/start_publish_goods", "描述": "启动批量发布道具任务，一次仅支持发布一个道具，多个道具需分多次请求" }, { "接口名称": "[查询批量发布道具任务](/miniprogram/dev/server/API/VirtualPayment/api_query_publish_goods)", "请求路径": "/xpay/query_publish_goods", "描述": "本接口用于查询批量发布道具任务" }, { "接口名称": "[查询商家账户可提现余额](/miniprogram/dev/server/API/VirtualPayment/api_query_biz_balance)", "请求路径": "/xpay/query_biz_balance", "描述": "查询商家账户里的可提现余额" }, { "接口名称": "[查询广告金充值账户](/miniprogram/dev/server/API/VirtualPayment/api_query_transfer_account)", "请求路径": "/xpay/query_transfer_account", "描述": "本接口用于查询广告金充值账户" }, { "接口名称": "[查询广告金发放记录](/miniprogram/dev/server/API/VirtualPayment/api_query_adver_funds)", "请求路径": "/xpay/query_adver_funds", "描述": "本接口用于查询广告金发放记录" }, { "接口名称": "[充值广告金](/miniprogram/dev/server/API/VirtualPayment/api_create_funds_bill)", "请求路径": "/xpay/create_funds_bill", "描述": "本接口用于充值广告金" }, { "接口名称": "[绑定广告金充值账户](/miniprogram/dev/server/API/VirtualPayment/api_bind_transfer_accout)", "请求路径": "/xpay/bind_transfer_accout", "描述": "本接口用于绑定广告金充值账户" }, { "接口名称": "[查询广告金充值记录](/miniprogram/dev/server/API/VirtualPayment/api_query_funds_bill)", "请求路径": "/xpay/query_funds_bill", "描述": "本接口用于查询广告金充值记录" }, { "接口名称": "[查询广告金回收记录](/miniprogram/dev/server/API/VirtualPayment/api_query_recover_bill)", "请求路径": "/xpay/query_recover_bill", "描述": "本接口用于查询广告金回收记录" }, { "接口名称": "[获取投诉列表](/miniprogram/dev/server/API/VirtualPayment/api_get_complaint_list)", "请求路径": "/xpay/get_complaint_list", "描述": "本接口用于获取投诉列表" }, { "接口名称": "[获取投诉详情](/miniprogram/dev/server/API/VirtualPayment/api_get_complaint_detail)", "请求路径": "/xpay/get_complaint_detail", "描述": "本接口用于获取投诉详情" }, { "接口名称": "[获取协商历史](/miniprogram/dev/server/API/VirtualPayment/api_get_negotiation_history)", "请求路径": "/xpay/get_negotiation_history", "描述": "本接口用于获取协商历史" }, { "接口名称": "[回复用户](/miniprogram/dev/server/API/VirtualPayment/api_response_complaint)", "请求路径": "/xpay/response_complaint", "描述": "本接口用于回复用户" }, { "接口名称": "[完成投诉处理](/miniprogram/dev/server/API/VirtualPayment/api_complete_complaint)", "请求路径": "/xpay/complete_complaint", "描述": "本接口用于完成投诉处理" }, { "接口名称": "[上传媒体文件](/miniprogram/dev/server/API/VirtualPayment/api_upload_vp_file)", "请求路径": "/xpay/upload_vp_file", "描述": "本接口用于上传媒体文件（如图片，凭证等）" }, { "接口名称": "[获取微信支付反馈投诉图片的签名头部](/miniprogram/dev/server/API/VirtualPayment/api_get_upload_file_sign)", "请求路径": "/xpay/get_upload_file_sign", "描述": "本接口用于获取微信支付反馈投诉图片的签名头部" }, { "接口名称": "[下载广告金对应的商户订单信息](/miniprogram/dev/server/API/VirtualPayment/api_download_adverfunds_order)", "请求路径": "/xpay/download_adverfunds_order", "描述": "本接口用于下载广告金对应的商户订单信息" }, { "接口名称": "[查询签约关系](/miniprogram/dev/server/API/VirtualPayment/api_query_subscribe_contract)", "请求路径": "/xpay/query_subscribe_contract", "描述": "本接口用于查询签约关系" }, { "接口名称": "[预通知扣款](/miniprogram/dev/server/API/VirtualPayment/api_send_subscribe_pre_payment)", "请求路径": "/xpay/send_subscribe_pre_payment", "描述": "本接口用于预通知扣款" }, { "接口名称": "[发起订阅扣款](/miniprogram/dev/server/API/VirtualPayment/api_submit_subscribe_pay_order)", "请求路径": "/xpay/submit_subscribe_pay_order", "描述": "本接口用于发起订阅扣款" }, { "接口名称": "[商家解约](/miniprogram/dev/server/API/VirtualPayment/api_cancel_subscribe_contract)", "请求路径": "/xpay/cancel_subscribe_contract", "描述": "本接口用于商家解约" }, { "接口名称": "[下载支付订单](/miniprogram/dev/server/API/VirtualPayment/api_start_download_order)", "请求路径": "/xpay/start_download_order", "描述": "发起下载订单任务，成功后用 querydownloadorder 接口查询结果" }, { "接口名称": "[查询下载订单任务](/miniprogram/dev/server/API/VirtualPayment/api_query_download_order)", "请求路径": "/xpay/query_download_order", "描述": "查询通过 startdownlaodorder 发起的下载任务结果" }, { "接口名称": "[下载虚拟支付ios月结账单](/miniprogram/dev/server/API/VirtualPayment/api_download_ios_settlement_bill)", "请求路径": "/xpay/download_ios_settlement_bill", "描述": "查询指定月份范围内的 iOS 结算账单列表及其下载链接" }, { "接口名称": "[商户被管控原因查询](/miniprogram/dev/server/API/VirtualPayment/api_query_punishment_reasons)", "请求路径": "/xpay/query_punishment_reasons", "描述": "查询商户被管控原因" } ] ```