Senparc.Weixin.Open
从第三方平台跳转至微信公众平台授权注册页面
第三方平台的appid
公众号的 appid
是否复用公众号的资质进行微信认证(1:申请复用资质进行微信 认证 0:不申请)
用户扫码授权后,MP 扫码页面将跳转到该地址(注:Host 需和第三方平台在微信开放平台上面填写的登 录授权的发起页域名一致)
公众号管理员扫码后在手机端完成授权确认。跳转回第三方平台,会在上述 redirect_uri后拼接 ticket=*
跳转至第三方平台,第三方平台调用快速注册API完成注册
使用公众号appid换取authorizer_access_token
公众号扫码授权的凭证(公众平台扫码页面回跳到第三方平台时携带)
获取帐号基本信息
小程序的access_token
新创建小程序appid及authorization_code换取authorizer_refresh_token进而得到authorizer_access_token。
修改头像
图片格式只支持:BMP、JPEG、JPG、GIF、PNG,大小不超过2M
注:实际头像始终为正方形
小程序的access_token
头像素材media_id
裁剪框左上角x坐标(取值范围:[0, 1])
裁剪框左上角y坐标(取值范围:[0, 1])
裁剪框右下角x坐标(取值范围:[0, 1])
裁剪框右下角y坐标(取值范围:[0, 1])
修改功能介绍
小程序的access_token
功能介绍
跳转至第三方平台,第三方平台调用快速注册API完成管理员换绑。
小程序的access_token
换绑管理员任务序列号(公众平台最终点击提交回跳到第三方平台时携带)
跳转至第三方平台,第三方平台调用快速注册API完成注册
使用公众号appid换取authorizer_access_token
公众号扫码授权的凭证(公众平台扫码页面回跳到第三方平台时携带)
获取帐号基本信息
新创建小程序appid及authorization_code换取authorizer_refresh_token进而得到authorizer_access_token。
修改头像
图片格式只支持:BMP、JPEG、JPG、GIF、PNG,大小不超过2M
注:实际头像始终为正方形
小程序的access_token
头像素材media_id
裁剪框左上角x坐标(取值范围:[0, 1])
裁剪框左上角y坐标(取值范围:[0, 1])
裁剪框右下角x坐标(取值范围:[0, 1])
裁剪框右下角y坐标(取值范围:[0, 1])
修改功能介绍
小程序的access_token
功能介绍
跳转至第三方平台,第三方平台调用快速注册API完成管理员换绑。
换绑管理员任务序列号(公众平台最终点击提交回跳到第三方平台时携带)
小程序信息
帐号appid
帐号类型(1:订阅号,2:服务号,3:小程序)
主体类型(0-个人,1-企业,2-媒体,3-政府,4-其他组织)
主体名称
主体标识,非个人主体时返回的是企业或者政府或其他组织的代号
实名验证状态
(1:实名验证成功,2:实名验证中,3:实名验证失败)
调用接口1.1创建帐号时,realname_status会初始化为2对于注册方式为微信认证的帐号,资质认证成功时,realname_status会更新为1
注意!!!当realname_status不为1时,帐号只允许调用本文档内的以下API:(即无权限调用其他API)
微信认证相关接口(参考2.x) 帐号设置相关接口(参考3.x)
(微信认证信息)
(功能介绍信息)
头像信息
名称信息
注册国家
认证类型;如果未完成微信认证则返回0;
微信认证信息
是否资质认证。若是,拥有微信认证相关的权限。
是否名称认证。对于公众号(订阅号、服务号),是名称认证,微信客户端才会有微信认证打勾的标识
是否需要年审(qualification_verify = true时才有该字段)
年审开始时间 时间戳(qualification_verify = true时才有该字段)
年审截止时间 时间戳(qualification_verify = true时才有该字段)
功能介绍信息
功能介绍
功能介绍已使用修改次数(本月)
功能介绍修改次数总额度(本月)
头像信息
头像url
头像已使用修改次数(本月)
头像修改次数总额度(本月)
名称信息
小程序名称
小程序名称已使用修改次数(本年)
小程序名称修改次数总额度(本年)
快速注册小程序返回结果
新创建小程序的appid
新创建小程序的授权码
复用公众号微信认证小程序是否成功
小程序是否和公众号关联成功
向需要AccessToken的API发送消息的公共方法
这里的AccessToken是通用接口的AccessToken,非OAuth的。如果不需要,可以为null,此时urlFormat不要提供{0}参数
如果是Get方式,可以为null
代理请求超时时间(毫秒)
向需要AccessToken的API发送消息的公共方法
这里的AccessToken是通用接口的AccessToken,非OAuth的。如果不需要,可以为null,此时urlFormat不要提供{0}参数
用accessToken参数填充{0}
如果是Get方式,可以为null
代理请求超时时间(毫秒)
ComponentApi
获取第三方平台access_token
第三方平台appid
第三方平台appsecret
微信后台推送的ticket,此ticket会定时推送,具体请见本页末尾的推送说明
获取预授权码
第三方平台方appid
获取授权地址
第三方平台方appid
预授权码
回调URL
要授权的帐号类型
指定授权唯一的小程序或公众号
使用授权码换取公众号的授权信息
服务开发方的appid
服务开发方的access_token
授权code,会在授权成功时返回给第三方平台,详见第三方平台授权流程说明
代理请求超时时间(毫秒)
确认授权
服务开发方的appid
服务开发方的access_token
授权code,会在授权成功时返回给第三方平台,详见第三方平台授权流程说明
服务开发方的access_token
服务开发方的access_token
代理请求超时时间(毫秒)
获取(刷新)授权公众号的令牌
获取授权方信息
注意:此方法返回的JSON中,authorization_info.authorizer_appid等几个参数通常为空(哪怕公众号有权限)
获取授权方的选项设置信息
服务开发商的appid
服务开发方的access_token
授权公众号appid
选项名称
代理请求超时时间(毫秒)
设置授权方的选项信息
服务开发方的access_token
服务开发商的appid
授权公众号appid
选项名称
设置的选项值
代理请求超时时间(毫秒)
快速创建个人小程序
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/Register_Mini_Programs/fastregisterpersonalweapp.html
个人用户名字
个人用户微信号
任务id
动作类型:create或query,当为create时,taskid可不传参,当为query时,idName,wxUser可不传参
第三方联系电话(方便法人与第三方联系)
创建试用小程序
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/beta_Mini_Programs/fastregister.html
小程序名称,昵称半自动设定,强制后缀“的体验小程序”。且该参数会进行关键字检查,如果命中品牌关键字则会报错。如遇到品牌大客户要用试用小程序,建议用户先换个名字,认证后再修改成品牌名。只支持4-30个字符
微信用户的openid(不是微信号),试用小程序创建成功后会默认将该用户设置为小程序管理员。获取openid的方法请查看公众号获取openid
试用小程序快速认证
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/beta_Mini_Programs/fastverify.html
第三方平台接口调用令牌authorizer_access_token
企业名(需与工商部门登记信息一致);如果是“无主体名称个体工商户”则填“个体户+法人姓名”,例如“个体户张三”
企业代码
法人微信号
法人姓名(绑定银行卡)
法人身份证号
企业代码类型 1:统一社会信用代码(18 位) 2:组织机构代码(9 位 xxxxxxxx-x) 3:营业执照注册号(15 位)
第三方联系电话
修改试用小程序名称
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/beta_Mini_Programs/fastmodify.html
拉取所有已授权的帐号信息
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/api/api_get_authorizer_list.html
第三方平台 APPID
令牌
偏移位置/起始位置
拉取数量,最大为 500
配置小程序用户隐私保护指引
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/set_privacy_setting.html
服务开发方的access_token
收集方(开发者)信息配置
要收集的用户信息配置,可选择的用户信息类型参考下方详情,当privacy_ver传2或者不传是必填;当privacy_ver传1时,该参数不可传,否则会报错
用户隐私保护指引的版本,1表示现网版本;2表示开发版。默认是2开发版。
代理请求超时时间(毫秒)
查询小程序用户隐私保护指引
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/get_privacy_setting.html
服务开发方的access_token
1表示现网版本,即,传1则该接口返回的内容是现网版本的;2表示开发版,即,传2则该接口返回的内容是开发版本的。默认是2。
代理请求超时时间(毫秒)
上传小程序用户隐私保护指引
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/upload_privacy_exfile.html
服务开发方的access_token
ServiceProvider
代理请求超时时间(毫秒)
获取第三方平台业务域名校验文件
本接口用于获取第三方平台小程序业务域名的校验文件。
使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
文档:https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/thirdparty-management/domain-mgnt/getThirdpartyJumpDomainConfirmFile.html
操作类型。
最多可以添加200个小程序业务域名,以;隔开。注意:域名不需带有http:// 等协议内容,也不能在域名末尾附加详细的 URI 地址,严格按照类似 www.qq.com 的写法。
是否同时修改“全网发布版本的值”。(false:只改“测试版”;true:同时改“测试版”和“全网发布版”)省略时,默认为false。
设置第三方平台业务域名
本接口用于配置第三方平台小程序业务域名。
配置业务域名时,需要将校验文件放置在域名根目录下,例如wx.qq.com,并确保可以访问该文件。可以通过获取第三方小程序业务域名的校验文件接口获取检验文件。
授权给第三方代开发的小程序,其业务域名只可以为在第三方平台账号中配置的小程序业务域名。即调用接口设置小程序业务域名之前可以调本接口先进行第三方平台小程序业务域名配置。
使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
文档:https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/thirdparty-management/domain-mgnt/modifyThirdpartyJumpDomain.html
操作类型。
最多可以添加200个小程序业务域名,以;隔开。注意:域名不需带有http:// 等协议内容,也不能在域名末尾附加详细的 URI 地址,严格按照类似 www.qq.com 的写法。
是否同时修改“全网发布版本的值”。(false:只改“测试版”;true:同时改“测试版”和“全网发布版”)省略时,默认为false。
【异步方法】获取第三方平台access_token
第三方平台appid
第三方平台appsecret
微信后台推送的ticket,此ticket会定时推送,具体请见本页末尾的推送说明
【异步方法】获取预授权码
第三方平台方appid
【异步方法】使用授权码换取公众号的授权信息
服务开发方的appid
服务开发方的access_token
授权code,会在授权成功时返回给第三方平台,详见第三方平台授权流程说明
代理请求超时时间(毫秒)
【异步方法】确认授权
服务开发方的appid
服务开发方的access_token
授权code,会在授权成功时返回给第三方平台,详见第三方平台授权流程说明
服务开发方的access_token
服务开发方的access_token
代理请求超时时间(毫秒)
【异步方法】获取(刷新)授权公众号的令牌
【异步方法】获取授权方信息
注意:此方法返回的JSON中,authorization_info.authorizer_appid等几个参数通常为空(哪怕公众号有权限)
【异步方法】获取授权方的选项设置信息
服务开发商的appid
服务开发方的access_token
授权公众号appid
选项名称
代理请求超时时间(毫秒)
【异步方法】设置授权方的选项信息
服务开发方的access_token
服务开发商的appid
授权公众号appid
选项名称
设置的选项值
代理请求超时时间(毫秒)
【异步方法】快速创建个人小程序
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/Register_Mini_Programs/fastregisterpersonalweapp.html
个人用户名字
个人用户微信号
任务id
动作类型:create或query,当为create时,taskid可不传参,当为query时,idName,wxUser可不传参
第三方联系电话(方便法人与第三方联系)
【异步方法】创建试用小程序
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/beta_Mini_Programs/fastregister.html
小程序名称,昵称半自动设定,强制后缀“的体验小程序”。且该参数会进行关键字检查,如果命中品牌关键字则会报错。如遇到品牌大客户要用试用小程序,建议用户先换个名字,认证后再修改成品牌名。只支持4-30个字符
微信用户的openid(不是微信号),试用小程序创建成功后会默认将该用户设置为小程序管理员。获取openid的方法请查看公众号获取openid
【异步方法】试用小程序快速认证
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/beta_Mini_Programs/fastverify.html
第三方平台接口调用令牌authorizer_access_token
企业名(需与工商部门登记信息一致);如果是“无主体名称个体工商户”则填“个体户+法人姓名”,例如“个体户张三”
企业代码
法人微信号
法人姓名(绑定银行卡)
法人身份证号
企业代码类型 1:统一社会信用代码(18 位) 2:组织机构代码(9 位 xxxxxxxx-x) 3:营业执照注册号(15 位)
第三方联系电话
【异步方法】修改试用小程序名称
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/beta_Mini_Programs/fastmodify.html
【异步方法】拉取所有已授权的帐号信息
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/api/api_get_authorizer_list.html
第三方平台 APPID
令牌
偏移位置/起始位置
拉取数量,最大为 500
【异步方法】配置小程序用户隐私保护指引
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/set_privacy_setting.html
服务开发方的access_token
收集方(开发者)信息配置
要收集的用户信息配置,可选择的用户信息类型参考下方详情,当privacy_ver传2或者不传是必填;当privacy_ver传1时,该参数不可传,否则会报错
用户隐私保护指引的版本,1表示现网版本;2表示开发版。默认是2开发版。
代理请求超时时间(毫秒)
【异步方法】查询小程序用户隐私保护指引
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/get_privacy_setting.html
服务开发方的access_token
1表示现网版本,即,传1则该接口返回的内容是现网版本的;2表示开发版,即,传2则该接口返回的内容是开发版本的。默认是2。
代理请求超时时间(毫秒)
【异步方法】上传小程序用户隐私保护指引
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/upload_privacy_exfile.html
服务开发方的access_token
ServiceProvider
代理请求超时时间(毫秒)
获取第三方平台业务域名校验文件
本接口用于获取第三方平台小程序业务域名的校验文件。
使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
文档:https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/thirdparty-management/domain-mgnt/getThirdpartyJumpDomainConfirmFile.html
操作类型。
最多可以添加200个小程序业务域名,以;隔开。注意:域名不需带有http:// 等协议内容,也不能在域名末尾附加详细的 URI 地址,严格按照类似 www.qq.com 的写法。
是否同时修改“全网发布版本的值”。(false:只改“测试版”;true:同时改“测试版”和“全网发布版”)省略时,默认为false。
设置第三方平台业务域名
本接口用于配置第三方平台小程序业务域名。
配置业务域名时,需要将校验文件放置在域名根目录下,例如wx.qq.com,并确保可以访问该文件。可以通过获取第三方小程序业务域名的校验文件接口获取检验文件。
授权给第三方代开发的小程序,其业务域名只可以为在第三方平台账号中配置的小程序业务域名。即调用接口设置小程序业务域名之前可以调本接口先进行第三方平台小程序业务域名配置。
使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
文档:https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/thirdparty-management/domain-mgnt/modifyThirdpartyJumpDomain.html
操作类型。
最多可以添加200个小程序业务域名,以;隔开。注意:域名不需带有http:// 等协议内容,也不能在域名末尾附加详细的 URI 地址,严格按照类似 www.qq.com 的写法。
是否同时修改“全网发布版本的值”。(false:只改“测试版”;true:同时改“测试版”和“全网发布版”)省略时,默认为false。
拉取所有已授权的帐号信息返回结果
授权的帐号总数
当前查询的帐号基本信息列表
已授权的 appid
刷新令牌
授权的时间
获取授权方的选项设置信息返回结果
第三方平台appid
授权公众号appid
选项名称
创建试用小程序接口返回结果
该请求的唯一标识符,用于关联微信用户和后面产生的appid
用户授权确认url,需将该url发送给用户,用户进入授权页面完成授权方可创建小程序
创建个人主体小程序接口返回结果
任务id,后面query查询需要用到
给用户扫码认证的验证url
任务的状态 0成功
获取授权方的账户信息返回结果
授权方信息
授权信息
授权方昵称
授权方头像
授权方公众号类型,0代表订阅号,1代表由历史老帐号升级后的订阅号,2代表服务号
授权方认证类型,-1代表未认证,0代表微信认证,1代表新浪微博认证,2代表腾讯微博认证,3代表已资质认证通过但还未通过名称认证,4代表已资质认证通过、还未通过名称认证,但通过了新浪微博认证,5代表已资质认证通过、还未通过名称认证,但通过了腾讯微博认证
授权方公众号的原始ID
公众号的主体名称
用以了解以下功能的开通状况(0代表未开通,1代表已开通): open_store:是否开通微信门店功能 open_scan:是否开通微信扫商品功能 open_pay:是否开通微信支付功能 open_card:是否开通微信卡券功能 open_shake:是否开通微信摇一摇功能
二维码图片的URL,开发者最好自行也进行保存
帐号介绍
授权方公众号所设置的微信号,可能为空
二维码图片的URL,开发者最好自行也进行保存
是否开通微信扫商品功能
小程序已设置的各个服务器域名
设置第三方平台业务域名 返回结果
文件名
文件内容
查询小程序用户隐私保护指引
代码是否存在, 0 不存在, 1 存在 。如果最近没有通过commit接口上传代码,则会出现 code_exist=0的情况。
代码检测出来的用户信息类型(privacy_key)
要收集的用户信息配置
更新时间
收集方(开发者)信息配置
用户信息类型对应的中英文描述
信息收集方(开发者)的邮箱
信息收集方(开发者)的手机号
信息收集方(开发者)的qq
信息收集方(开发者)的微信号
自定义 用户隐私保护指引文件的media_id
通知方式,指的是当开发者收集信息有变动时,通过该方式通知用户
存储期限,指的是开发者收集用户信息存储多久
用户信息类型的英文名称
该用户信息类型的用途
用户信息类型的中文名称
用户信息类型
用户信息类型
用户信息类型的中文描述
用户信息类型的英文key
设置第三方平台业务域名 返回结果
目前生效的 “全网发布版”第三方平台“小程序业务域名”。如果修改失败,该字段不会返回。如果没有已发布的第三方平台,该字段也不会返回。
目前生效的 “测试版”第三方平台“小程序业务域名”。如果修改失败,该字段不会返回
未通过验证的域名。如果不存在未通过验证的域名,该字段不会返回。
设置第三方平台服务器域名 返回结果
目前生效的 “全网发布版”第三方平台“小程序服务器域名”。如果修改失败,该字段不会返回。如果没有已发布的第三方平台,该字段也不会返回。
目前生效的 “测试版”第三方平台“小程序服务器域名”。如果修改失败,该字段不会返回
未通过验证的域名。如果不存在未通过验证的域名,该字段不会返回。
使用授权码换取公众号的授权信息返回结果
授权信息
授权信息
授权方appid
授权方appid
授权方令牌(在授权的公众号具备API权限时,才有此返回值)
有效期(在授权的公众号具备API权限时,才有此返回值)
刷新令牌(在授权的公众号具备API权限时,才有此返回值),刷新令牌主要用于公众号第三方平台获取和刷新已授权用户的access_token,只会在授权时刻提供,请妥善保存。 一旦丢失,只能让用户重新授权,才能再次拿到新的刷新令牌
可根据这个字段判断是否为小程序类型授权
小程序已设置的各个服务器域名
公众号授权给开发者的权限集列表(请注意,当出现用户已经将消息与菜单权限集授权给了某个第三方,再授权给另一个第三方时,由于该权限集是互斥的,后一个第三方的授权将去除此权限集,开发者可以在返回的func_info信息中验证这一点,避免信息遗漏),
1到8分别代表:
消息与菜单权限集
用户管理权限集
帐号管理权限集
网页授权权限集
微信小店权限集
多客服权限集
业务通知权限集
微信卡券权限集
获取(刷新)授权公众号的令牌返回结果
授权方令牌
有效期,为2小时
刷新令牌
上传小程序用户隐私保护指引
文件的media_id
否 信息收集方(开发者)的邮箱地址,4种联系方式至少要填一种
否 信息收集方(开发者)的手机号,4种联系方式至少要填一种
否 信息收集方(开发者)的qq号,4种联系方式至少要填一种
否 信息收集方(开发者)的微信号,4种联系方式至少要填一种
否 如果开发者不使用微信提供的标准化用户隐私保护指引模板,也可以上传自定义的用户隐私保护指引,通过上传接口上传后可获取media_id
是 通知方式,指的是当开发者收集信息有变动时,通过该方式通知用户。这里服务商需要按照实际情况填写,例如通过弹窗或者公告或者其他方式。
否 存储期限,指的是开发者收集用户信息存储多久。如果不填则展示为【开发者承诺,除法律法规另有规定,开发者对你的信息保存期限应当为实现处理目的所必要的最短时间】,如果填请填数字+天,例如“30天”,否则会出现87072的报错。
官方的可选值参考下方说明;该字段也支持自定义
请填写收集该信息的用途。例如privacy_key=Location(位置信息),那么privacy_text则填写收集位置信息的用途。无需再带上“为了”或者“用于”这些字眼,小程序端的显示格式是为了xxx,因此开发者只需要直接填写用途即可。
之前的JsApiTicketBag
授权方AppId,缓存中实际的Key
第三方平台AppId
授权信息
授权信息(请使用TryUpdateAuthorizationInfo()方法进行更新)
授权方资料信息
只针对这个AppId的锁
授权方信息(用户的微信公众号)
包括通用接口JsApiTicket容器,用于自动管理JsApiTicket,如果过期会重新获取
注册应用凭证信息,此操作只是注册,不会马上获取Ticket,并将清空之前的Ticket,
标记Authorizer名称(如微信公众号名称),帮助管理员识别
尝试注册
获取或更新AuthorizationInfo。
如果读取refreshToken失败,则返回null。
获取可用AuthorizerAccessToken
获取可用的GetAuthorizerInfoResult
是否强制重新获取新的Ticket
尝试更新AuthorizationInfo(如果没有AccessToken则不更新)
尝试更新AuthorizationInfo(如果没有AccessToken则不更新)。
如果AuthorizerBag更新则返回最新的对象,否则返回null
刷新AuthorizerToken
使用完整的应用凭证获取Ticket,如果不存在将自动注册
///
获取可用Ticket
是否强制重新获取新的Ticket
获取可用Ticket
是否强制重新获取新的Ticket
【异步方法】注册应用凭证信息,此操作只是注册,不会马上获取Ticket,并将清空之前的Ticket,
标记Authorizer名称(如微信公众号名称),帮助管理员识别
尝试注册
【异步方法】获取或更新AuthorizationInfo。
如果读取refreshToken失败,则返回null。
【异步方法】获取可用AuthorizerAccessToken
【异步方法】获取可用的GetAuthorizerInfoResult
是否强制重新获取新的Ticket
【异步方法】尝试更新AuthorizationInfo(如果没有AccessToken则不更新)
【异步方法】尝试更新AuthorizationInfo(如果没有AccessToken则不更新)。
如果AuthorizerBag更新则返回最新的对象,否则返回null
【异步方法】刷新AuthorizerToken
【异步方法】使用完整的应用凭证获取Ticket,如果不存在将自动注册
///
【异步方法】获取可用Ticket
是否强制重新获取新的Ticket
【异步方法】获取可用Ticket
是否强制重新获取新的Ticket
第三方APP信息包
第三方平台AppId
第三方平台AppSecret
第三方平台ComponentVerifyTicket(每隔10分钟微信会主动推送到服务器,IP必须在白名单内)
第三方平台ComponentVerifyTicket过期时间(实际上过期之后仍然可以使用一段时间)
ComponentAccessTokenResult
ComponentAccessToken过期时间
PreAuthCodeResult 预授权码结果
预授权码过期时间
AuthorizerAccessToken
只针对这个AppId的锁
ComponentBag
通用接口ComponentAccessToken容器,用于自动管理ComponentAccessToken,如果过期会重新获取
ComponentVerifyTicket服务器推送更新时间(分钟)
获取ComponentVerifyTicket的方法
从数据库中获取已存的AuthorizerAccessToken的方法
AuthorizerAccessToken更新后的回调
注册应用凭证信息,此操作只是注册,不会马上获取Token,并将清空之前的Token,
获取ComponentVerifyTicket的方法
从数据库中获取已存的AuthorizerAccessToken的方法
AuthorizerAccessToken更新后的回调
标记名称(如开放平台名称),帮助管理员识别
检查AppId是否已经注册,如果没有,则创建
标记Component名称(如微信公众号名称),帮助管理员识别
获取ComponentVerifyTicket
如果不存在,则返回null
更新ComponentVerifyTicket信息
使用完整的应用凭证获取Token,如果不存在将自动注册
如果为null则自动获取
获取可用AccessToken
如果为null则自动获取
是否强制重新获取新的Token
获取可用AccessToken
如果为null则自动获取
是否强制重新获取新的Token
使用完整的应用凭证获取Token,如果不存在将自动注册
获取可用Token
是否强制重新获取新的Token
获取可用Token
是否强制重新获取新的Token
获取QueryAuthResult(此方法每次都会发出请求,不缓存)
是否将Authorization更新到AuthorizerContanier
【异步方法】册应用凭证信息,此操作只是注册,不会马上获取Token,并将清空之前的Token
获取ComponentVerifyTicket的方法
从数据库中获取已存的AuthorizerAccessToken的方法
AuthorizerAccessToken更新后的回调
标记名称(如开放平台名称),帮助管理员识别
【异步方法】检查AppId是否已经注册,如果没有,则创建
标记Component名称(如微信公众号名称),帮助管理员识别
获取ComponentVerifyTicket
如果不存在,则返回null
更新ComponentVerifyTicket信息
【异步方法】使用完整的应用凭证获取Token,如果不存在将自动注册
如果为null则自动获取
【异步方法】获取可用AccessToken
如果为null则自动获取
是否强制重新获取新的Token
【异步方法】获取可用AccessToken
如果为null则自动获取
是否强制重新获取新的Token
【异步方法】使用完整的应用凭证获取Token,如果不存在将自动注册
【异步方法】获取可用Token
是否强制重新获取新的Token
【异步方法】获取可用Token
是否强制重新获取新的Token
【异步方法】获取QueryAuthResult(此方法每次都会发出请求,不缓存)
是否将Authorization更新到AuthorizerContanier
获取第三方平台access_token
第三方平台access_token
有效期
jsapi_ticket请求后的JSON返回格式
获取到的凭证
凭证有效时间,单位:秒
获取预授权码返回结果
预授权码
有效期,为20分钟
微信公众服务器Post过来的加密参数集合(不包括PostData)
开发平台“公众号第三方平台”的AppId
加密类型,通常为"aes"
授权成功通知
公众号appid
授权码(code)
过期时间
请求消息接口
请求消息
创建试用小程序事件推送
创建小程序appid
唯一标识符
小程序名称
试用小程序快速认证事件推送
创建小程序appid
注册时提交的资料
结果2失败,3成功
小程序名称
驳回原因
注册审核事件推送
创建小程序appid
第三方授权码
注册时提交的资料
授权更新通知
公众号appid
授权码(code)
过期时间
选项设置信息选项名称
地理位置上报选项
0 无上报
1 进入会话时上报
2 每5s上报
语音识别开关选项
0 关闭语音识别
1 开启语音识别
客服开关选项
0 关闭多客服
1 开启多客服
公众号第三方平台推送消息类型
推送component_verify_ticket协议
推送取消授权通知
更新授权
授权成功通知
小程序注册审核事件推送
小程序名称设置及改名审核事件推送
试用小程序快速认证事件推送
创建试用小程序成功/失败的事件推送
应用授权作用域
不弹出授权页面,直接跳转,只能获取用户openid
弹出授权页面,可通过openid拿到昵称、性别、所在地。并且,即使在未关注的情况下,只要用户授权,也能获取其信息
网站应用授权登录
授权方公众号类型
授权方认证类型
公众号/小程序授权给开发者的权限集列表(1-15为公众号权限,17-19为小程序权限)。
请注意:1)该字段的返回不会考虑公众号是否具备该权限集的权限(因为可能部分具备),请根据公众号的帐号类型和认证情况,来判断公众号的接口权限。
文档中已取消
小程序“修改服务器地址”接口的action类型
添加
删除
覆盖
获取
小程序“修改业务域名”接口的action类型
添加
删除
覆盖
获取
小程序“线上代码的可见状态”接口的action类型
帐号类型(1:订阅号,2:服务号,3:小程序)
主体类型(1:企业)
认证类型
1:实名验证成功,2:实名验证中,3:实名验证失败
小程序昵称审核状态,1:审核中,2:审核失败,3:审核成功
小程序类目审核状态,1:审核中,2:审核失败,3:审核成功
要授权的帐号类型
企业代码类型 1:统一社会信用代码(18位) 2:组织机构代码(9位xxxxxxxx-x) 3:营业执照注册号(15位)
“设置第三方平台服务器域名”接口,action 参数枚举
添加
删除。说明,删除不存在的域名会视为成功,返回 errcode 为0
覆盖
获取 ,action=get时,会同时返回测试版和全网发布版的“小程序服务器域名”值。
“设置第三方平台业务域名”接口,action 参数枚举
添加
删除。说明,删除不存在的域名会视为成功,返回 errcode 为0
覆盖
获取 ,action=get时,会同时返回测试版和全网发布版的“小程序服务器域名”值。
第三方平台异常
ComponentBag
根据xml信息,返回InfoType
根据xml信息,返回InfoType
加密(原始)的XML
解密之后的XML
请求消息,对应解密之之后的XML数据
推送component_verify_ticket协议
推送取消授权通知
授权成功通知
授权更新通知
创建开放平台帐号并绑定公众号/小程序。
该API用于创建一个开放平台帐号,并将一个尚未绑定开放平台帐号的公众号/小程序绑定至该开放平台帐号上。新创建的开放平台帐号的主体信息将设置为与之绑定的公众号或小程序的主体。
授权公众号或小程序的appid
将公众号/小程序绑定到开放平台帐号下
授权公众号或小程序的appid
开放平台帐号appid
将公众号/小程序从开放平台帐号下解绑
授权公众号或小程序的appid
开放平台帐号appid
获取公众号/小程序所绑定的开放平台帐号
授权公众号或小程序的appid
【异步方法】创建开放平台帐号并绑定公众号/小程序。
该API用于创建一个开放平台帐号,并将一个尚未绑定开放平台帐号的公众号/小程序绑定至该开放平台帐号上。新创建的开放平台帐号的主体信息将设置为与之绑定的公众号或小程序的主体。
授权公众号或小程序的appid
【异步方法】将公众号/小程序绑定到开放平台帐号下
授权公众号或小程序的appid
开放平台帐号appid
【异步方法】将公众号/小程序从开放平台帐号下解绑
授权公众号或小程序的appid
开放平台帐号appid
获取公众号/小程序所绑定的开放平台帐号
授权公众号或小程序的appid
创建开放平台帐号并绑定公众号/小程序接口返回结果
所创建的开放平台帐号的appid
获取公众号/小程序所绑定的开放平台帐号
公众号或小程序所绑定的开放平台帐号的appid
代公众号发起网页授权
获取验证地址
公众号的appid
第三方平台的appid
重定向地址,需要urlencode,这里填写的应是服务开发方的回调地址
重定向后会带上state参数,开发者可以填写任意参数值,最多128字节
授权作用域,拥有多个作用域用逗号(,)分隔。此处暂时只放一作用域。
默认,填code
获取AccessToken
服务开发方的appid
服务开发方的access_token
GetAuthorizeUrl()接口返回的code
刷新access_token(如果需要)
填写通过access_token获取到的refresh_token参数
获取用户基本信息
调用接口凭证
普通用户的标识,对当前公众号唯一
返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语
【异步方法】获取AccessToken
服务开发方的appid
服务开发方的access_token
GetAuthorizeUrl()接口返回的code
【异步方法】刷新access_token(如果需要)
填写通过access_token获取到的refresh_token参数
【异步方法】获取用户基本信息
调用接口凭证
普通用户的标识,对当前公众号唯一
返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语
获取OAuth AccessToken的结果
如果错误,返回结果{"errcode":40029,"errmsg":"invalid code"}
接口调用凭证
access_token接口调用凭证超时时间,单位(秒)
用户刷新access_token
授权用户唯一标识
用户授权的作用域,使用逗号(,)分隔
通过OAuth的获取到的用户信息(snsapi_userinfo=scope)
用户的性别,值为1时是男性,值为2时是女性,值为0时是未知
用户个人资料填写的省份
普通用户个人资料填写的城市
国家,如中国为CN
用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空
用户特权信息,json 数组,如微信沃卡用户为(chinaunicom)
作者注:其实这个格式称不上JSON,只是个单纯数组。
代公众号发起网页授权
微信扫码登录网页授权
第三方应用唯一标识
重定向地址,需要进行UrlEncode
用于保持请求和回调的状态,授权请求后原样带回给第三方。该参数可用于防止csrf攻击(跨站请求伪造攻击),建议第三方带上该参数,可设置为简单的随机数加session进行校验
应用授权作用域,拥有多个作用域用逗号(,)分隔,网页应用目前仅填写snsapi_login即可
填code
获取AccessToken
应用唯一标识,在微信开放平台提交应用审核通过后获得
应用密钥AppSecret,在微信开放平台提交应用审核通过后获得
GetQRConnectUrl()接口返回的code
填authorization_code
刷新access_token(如果需要)
第三方应用唯一标识
填写通过access_token获取到的refresh_token参数
填refresh_token
获取用户基本信息
调用接口凭证
普通用户的标识,对当前公众号唯一
检验授权凭证(access_token)是否有效
用户的唯一标识
【异步方法】获取AccessToken
应用唯一标识,在微信开放平台提交应用审核通过后获得
应用密钥AppSecret,在微信开放平台提交应用审核通过后获得
GetQRConnectUrl()接口返回的code
填authorization_code
【异步方法】刷新access_token(如果需要)
第三方应用唯一标识
填写通过access_token获取到的refresh_token参数
填refresh_token
【异步方法】获取用户基本信息
调用接口凭证
普通用户的标识,对当前公众号唯一
【异步方法】检验授权凭证(access_token)是否有效
用户的唯一标识
刷新access_token有效期返回结果
接口调用凭证
access_token接口调用凭证超时时间,单位(秒)
用户刷新access_token
授权用户唯一标识
用户授权的作用域,使用逗号(,)分隔
获取OAuth AccessToken的结果
如果错误,返回结果{"errcode":40029,"errmsg":"invalid code"}
只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。
通过OAuth的获取到的用户信息(snsapi_userinfo=scope)
普通用户的标识,对当前开发者帐号唯一
普通用户昵称
用户的性别,值为1时是男性,值为2时是女性,值为0时是未知
普通用户个人资料填写的省份
普通用户个人资料填写的城市
国家,如中国为CN
用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空
用户特权信息,json 数组,如微信沃卡用户为(chinaunicom)
作者注:其实这个格式称不上JSON,只是个单纯数组。
注册第三方平台
注册第三方平台信息
获取ComponentVerifyTicket的方法
从数据库中获取已存的AuthorizerAccessToken的方法
AuthorizerAccessToken更新后的回调
标记名称(如开放平台名称),帮助管理员识别
根据 SenparcWeixinSetting 自动注册第三方平台信息
RegisterService
SenparcWeixinSetting
统一标识,如果为null,则使用 SenparcWeixinSetting.ItemKey
RequestMessage工厂
获取XDocument转换后的IRequestMessageBase实例。
如果MsgType不存在,抛出UnknownRequestMsgTypeException异常
获取XDocument转换后的IRequestMessageBase实例。
如果MsgType不存在,抛出UnknownRequestMsgTypeException异常
获取XDocument转换后的IRequestMessageBase实例。
如果MsgType不存在,抛出UnknownRequestMsgTypeException异常
如Request.InputStream
小程序代码模版库管理
获取草稿箱内的所有临时代码草稿
第三方平台自己的component_access_token
获取代码模版库中的所有小程序代码模版
第三方平台自己的component_access_token
将草稿箱的草稿选为小程序代码模版
第三方平台自己的component_access_token
草稿ID,本字段可通过“获取草稿箱内的所有临时代码草稿”接口获得
删除指定小程序代码模版
第三方平台自己的component_access_token
要删除的模版ID
获取草稿箱内的所有临时代码草稿
第三方平台自己的component_access_token
获取代码模版库中的所有小程序代码模版
第三方平台自己的component_access_token
将草稿箱的草稿选为小程序代码模版
第三方平台自己的component_access_token
草稿ID,本字段可通过“获取草稿箱内的所有临时代码草稿”接口获得
删除指定小程序代码模版
第三方平台自己的component_access_token
要删除的模版ID
草稿列表
开发者上传草稿的时间
模板版本号,开发者自定义字段
模板描述,开发者自定义字段
草稿ID
草稿列表
开发者上传草稿的时间
模板版本号,开发者自定义字段
模板描述,开发者自定义字段
草稿ID
为授权的小程序帐号上传小程序代码
从第三方平台获取到的该小程序授权
代码库中的代码模版ID
第三方自定义的配置
代码版本号
代码描述
获取小程序的体验二维码
从第三方平台获取到的该小程序授权
获取授权小程序帐号的可选类目
从第三方平台获取到的该小程序授权
获取小程序的第三方提交代码的页面配置
从第三方平台获取到的该小程序授权
将第三方提交的代码包提交审核
注意:只有上个版本被驳回,才能使用 feedback_info、feedback_stuff 这两个字段,否则忽略处理。
从第三方平台获取到的该小程序授权
审核项列表(选填,至多填写 5 项)
预览信息(小程序页面截图和操作录屏)
小程序版本说明和功能解释
反馈内容,至多 200 字
用 | 分割的 media_id 列表,至多 5 张图片, 可以通过新增临时素材接口上传而得到
用户生成内容场景(UGC)信息安全声明
用于声明是否不使用“代码中检测出但是未配置的隐私相关接口”
订单中心path
查询某个指定版本的审核状态
从第三方平台获取到的该小程序授权
提交审核时获得的审核id
查询最新一次提交的审核状态
从第三方平台获取到的该小程序授权
小程序审核撤回
注意:单个帐号每天审核撤回次数最多不超过 1 次,一个月不超过 10 次
从第三方平台获取到的该小程序授权
发布已通过审核的小程序
从第三方平台获取到的该小程序授权
修改小程序线上代码的可见状态
从第三方平台获取到的该小程序授权
设置可访问状态,发布后默认可访问,close为不可见,open为可见
小程序版本回退(仅供第三方代小程序调用)
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/code/get_history_version.html
从第三方平台获取到的该小程序授权
查询当前设置的最低基础库版本及各版本用户占比(仅供第三方代小程序调用)
从第三方平台获取到的该小程序授权
设置最低基础库版本(仅供第三方代小程序调用)
从第三方平台获取到的该小程序授权
版本
小程序分阶段发布接口
从第三方平台获取到的该小程序授权
灰度的百分比,1到100的整数
小程序取消分阶段发布
从第三方平台获取到的该小程序授权
小程序查询当前分阶段发布详情
从第三方平台获取到的该小程序授权
查询服务商的当月提审限额(quota)和加急次数
加急审核申请
有加急次数的第三方可以通过该接口,对已经提审的小程序进行加急操作,加急后的小程序预计2-12小时内审完。
审核单ID
提审素材上传接口
文档 https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/code/submit_audit.html
为授权的小程序帐号上传小程序代码
从第三方平台获取到的该小程序授权
代码库中的代码模版ID
第三方自定义的配置
代码版本号
代码描述
获取小程序的体验二维码
从第三方平台获取到的该小程序授权
获取授权小程序帐号的可选类目
从第三方平台获取到的该小程序授权
获取小程序的第三方提交代码的页面配置
从第三方平台获取到的该小程序授权
将第三方提交的代码包提交审核
注意:只有上个版本被驳回,才能使用 feedback_info、feedback_stuff 这两个字段,否则忽略处理。
从第三方平台获取到的该小程序授权
审核项列表(选填,至多填写 5 项)
预览信息(小程序页面截图和操作录屏)
小程序版本说明和功能解释
反馈内容,至多 200 字
用 | 分割的 media_id 列表,至多 5 张图片, 可以通过新增临时素材接口上传而得到
用户生成内容场景(UGC)信息安全声明
用于声明是否不使用“代码中检测出但是未配置的隐私相关接口”
订单中心path
查询某个指定版本的审核状态
从第三方平台获取到的该小程序授权
提交审核时获得的审核id
查询最新一次提交的审核状态
从第三方平台获取到的该小程序授权
小程序审核撤回
注意:单个帐号每天审核撤回次数最多不超过 1 次,一个月不超过 10 次
从第三方平台获取到的该小程序授权
发布已通过审核的小程序
从第三方平台获取到的该小程序授权
修改小程序线上代码的可见状态
从第三方平台获取到的该小程序授权
设置可访问状态,发布后默认可访问,close为不可见,open为可见
小程序版本回退(仅供第三方代小程序调用)
文档:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/code/get_history_version.html
文档:
从第三方平台获取到的该小程序授权
查询当前设置的最低基础库版本及各版本用户占比(仅供第三方代小程序调用)
从第三方平台获取到的该小程序授权
设置最低基础库版本(仅供第三方代小程序调用)
从第三方平台获取到的该小程序授权
版本
小程序分阶段发布接口
从第三方平台获取到的该小程序授权
灰度的百分比,1到100的整数
小程序取消分阶段发布
从第三方平台获取到的该小程序授权
小程序查询当前分阶段发布详情
从第三方平台获取到的该小程序授权
查询服务商的当月提审限额(quota)和加急次数
加急审核申请
有加急次数的第三方可以通过该接口,对已经提审的小程序进行加急操作,加急后的小程序预计2-12小时内审完。
审核单ID
提审素材上传接口
文档 https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/code/submit_audit.html
模板信息列表
更新时间,时间戳
模板版本号,开发者自定义字段
模板描述,开发者自定义字段
小程序版本
最新的审核ID,只在使用GetLatestAuditStatus接口时才有返回值
审核状态,其中0为审核成功,1为审核失败,2为审核中,3为已撤回,4为审核延后
当status=1,审核被拒绝时,返回的拒绝原因
当 status = 1 时,会返回审核失败的小程序截图示例。用 | 分隔的 media_id 的列表,可通过获取永久素材接口拉取截图内容
一级类目名称
二级类目名称
三级类目名称
一级类目的ID编号
二级类目的ID编号
三级类目的ID编号
0:初始状态 1:执行中 2:暂停中 3:执行完毕 4:被删除
创建时间
受影响比例
版本号
CodeApi.QueryQuota() 返回结果
quota剩余值
当月分配quota
剩余加急次数
当月分配加急次数
小程序的页面
小程序的标签,多个标签用空格分隔,标签不能多于10个,标签长度不超过20
一级类目
二级类目
三级类目
小程序页面的标题,标题长度不超过32
一级类目的ID
二级类目的ID
三级类目的ID
预览信息(小程序页面截图和操作录屏)
录屏mediaid列表,可以通过提审素材上传接口获得
截屏mediaid列表,可以通过提审素材上传接口获得
用户生成内容场景(UGC)信息安全声明
UGC场景 0,不涉及用户生成内容, 1.用户资料,2.图片,3.视频,4.文本,5其他, 可多选,当scene填0时无需填写下列字段
当scene选其他时的说明,不超时256字
内容安全机制 1.使用平台建议的内容安全API,2.使用其他的内容审核产品,3.通过人工审核把关,4.未做内容审核把关
是否有审核团队, 0.无,1.有,默认0
说明当前对UGC内容的审核机制,不超过256字
第三方代码提审资料上传接口 返回结果
修改服务器地址 接口
操作类型
request合法域名,当action参数是get时不需要此字段。
socket合法域名,当action参数是get时不需要此字段。
uploadFile合法域名,当action参数是get时不需要此字段。
downloadFile合法域名,当action参数是get时不需要此字段。
udp 合法域名;当 action 是 get 时不需要此字段
tcp 合法域名;当 action 是 get 时不需要此字段
修改服务器地址 接口
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/Mini_Programs/setwebviewdomain.html
操作类型
小程序业务域名,当 action 参数是 get 时不需要此字段
快速配置小程序服务器域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/modifyServerDomainDirectly.html
操作类型
request 合法域名,当action参数是get时不需要此字段
socket 合法域名,当action参数是get时不需要此字段
uploadFile 合法域名,当action参数是get时不需要此字段
downloadFile 合法域名,当action参数是get时不需要此字段
udp 合法域名;当 action 是 get 时不需要此字段
tcp 合法域名;当 action 是 get 时不需要此字段
获取业务域名校验文件
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getJumpDomainConfirmFile.html
快速配置小程序服务器域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/modifyServerDomainDirectly.html
操作类型
小程序业务域名,当 action 参数是 get 时不需要此字段
获取发布后生效服务器域名列表
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getEffectiveServerDomain.html
获取发布后生效业务域名列表
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getEffectiveJumpDomain.html
获取DNS预解析域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getPrefetchDomain.html
设置DNS预解析域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/setPrefetchDomain.html
预解析域名
【异步方法】修改服务器地址 接口
操作类型
request合法域名,当action参数是get时不需要此字段。
socket合法域名,当action参数是get时不需要此字段。
uploadFile合法域名,当action参数是get时不需要此字段。
downloadFile合法域名,当action参数是get时不需要此字段。
udp 合法域名;当 action 是 get 时不需要此字段
tcp 合法域名;当 action 是 get 时不需要此字段
【异步方法】修改服务器地址 接口
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/Mini_Programs/setwebviewdomain.html
操作类型
小程序业务域名,当 action 参数是 get 时不需要此字段
快速配置小程序服务器域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/modifyServerDomainDirectly.html
操作类型
request 合法域名,当action参数是get时不需要此字段
socket 合法域名,当action参数是get时不需要此字段
uploadFile 合法域名,当action参数是get时不需要此字段
downloadFile 合法域名,当action参数是get时不需要此字段
udp 合法域名;当 action 是 get 时不需要此字段
tcp 合法域名;当 action 是 get 时不需要此字段
获取业务域名校验文件
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getJumpDomainConfirmFile.html
快速配置小程序服务器域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/modifyServerDomainDirectly.html
操作类型
小程序业务域名,当 action 参数是 get 时不需要此字段
获取发布后生效服务器域名列表
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getEffectiveServerDomain.html
获取发布后生效业务域名列表
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getEffectiveJumpDomain.html
获取DNS预解析域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/getPrefetchDomain.html
设置DNS预解析域名
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/domain-management/setPrefetchDomain.html
预解析域名
获取发布后生效服务器域名列表
获取发布后生效业务域名列表
获取DNS预解析域名 接口返回类型
预解析 dns 域名
总共可配置域名个数
获取业务域名校验文件
快速配置小程序服务器域名接口返回类型
修改域名接口返回类型
预览信息(小程序页面截图和操作录屏)
设置DNS预解析域名 接口返回类型
快速配置小程序业务域名接口返回类型
修改业务域名接口返回类型
修改服务器地址 接口
操作类型
request合法域名,当action参数是get时不需要此字段。
socket合法域名,当action参数是get时不需要此字段。
uploadFile合法域名,当action参数是get时不需要此字段。
downloadFile合法域名,当action参数是get时不需要此字段。
【异步方法】修改服务器地址 接口
操作类型
request合法域名,当action参数是get时不需要此字段。
socket合法域名,当action参数是get时不需要此字段。
uploadFile合法域名,当action参数是get时不需要此字段。
downloadFile合法域名,当action参数是get时不需要此字段。
修改域名接口返回类型
小程序订阅消息模板的管理
获取小程序模板库标题列表
subscribeMessage.getPubTemplateTitleList
接口调用凭证
类目 id,多个用逗号隔开
用于分页,表示从 start 开始。从 0 开始计数。
用于分页,表示拉取 limit 条记录。最大为 30。
请求超时时间
获取模板库某个模板标题下关键词库
subscribeMessage.getPubTemplateKeyWordsById
接口调用凭证
模板标题 id,可通过接口获取
请求超时时间
组合模板并添加至帐号下的个人模板库
subscribeMessage.addTemplate
接口调用凭证
模板标题id,可通过接口获取,也可登录小程序后台查看获取
开发者自行组合好的模板关键词列表,关键词顺序可以自由搭配(例如[3,5,4]或[4,5,3]),最多支持10个关键词组合
请求超时时间
获取帐号下已存在的模板列表
subscribeMessage.getTemplateList
接口调用凭证
请求超时时间
【异步方法】 获取小程序账号的类目
subscribeMessage.getCategory
接口调用凭证
请求超时时间
删除帐号下的某个模板
接口调用凭证
要删除的模板id
请求超时时间
【异步方法】获取小程序模板库标题列表
subscribeMessage.getPubTemplateTitleList
接口调用凭证
类目 id,多个用逗号隔开
用于分页,表示从 start 开始。从 0 开始计数。
用于分页,表示拉取 limit 条记录。最大为 30。
请求超时时间
【异步方法】获取模板库某个模板标题下关键词库
subscribeMessage.getPubTemplateKeyWordsById
接口调用凭证
模板标题 id,可通过接口获取
请求超时时间
【异步方法】组合模板并添加至帐号下的个人模板库
subscribeMessage.addTemplate
接口调用凭证
模板标题id,可通过接口获取,也可登录小程序后台查看获取
开发者自行组合好的模板关键词列表,关键词顺序可以自由搭配(例如[3,5,4]或[4,5,3]),最多支持10个关键词组合
请求超时时间
【异步方法】获取帐号下已存在的模板列表
subscribeMessage.getTemplateList
接口调用凭证
请求超时时间
【异步方法】 获取小程序账号的类目
subscribeMessage.getCategory
接口调用凭证
请求超时时间
【异步方法】删除帐号下的某个模板
接口调用凭证
要删除的模板id
请求超时时间
“组合模板并添加至帐号下的个人模板库”接口:AddTemplate 结果
添加至帐号下的模板id,发送小程序模板消息时所需
类目列表
类目id,查询公共模板库时需要
类目的中文名
“获取模板库某个模板标题下关键词库”接口:GetPubTemplateKeyWordsById 结果
关键词id,添加模板时需要
关键词内容
关键词内容对应的示例
参数类型
“获取小程序模板库标题列表”接口:GetPubTemplateTitles 结果
模板库标题总数
模板标题id(获取模板标题下的关键词库时需要)
模板标题内容
模版类型,2 为一次性订阅,3 为长期订阅
模版所属类目 id
“获取帐号下已存在的模板列表”接口:GetTemplateList 结果
帐号下的模板列表
模板id,发送小程序模板消息时所需
模板标题
模板内容
模板内容示例
模版类型,2 为一次性订阅,3 为长期订阅
是否命中关键字策略。若命中,可以选填关键字材料
命中关键字的说明描述(给用户看的)
小程序名称设置及改名
https://api.weixin.qq.com/wxa/setnickname?access_token=TOKEN
小程序的access_token
昵称 必填
身份证照片–临时素材mediaid 个人号必填
组织机构代码证或营业执照–临时素材mediaid 组织号必填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
小程序改名审核状态查询
小程序的access_token
审核单id
微信认证名称检测
小程序的access_token
名称(昵称)
小程序名称设置及改名
https://api.weixin.qq.com/wxa/setnickname?access_token=TOKEN
小程序的access_token
昵称 必填
身份证照片–临时素材mediaid 个人号必填
组织机构代码证或营业执照–临时素材mediaid 组织号必填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
其他证明材料---临时素材 mediaid 选填
小程序改名审核状态查询
小程序的access_token
审核单id
微信认证名称检测
小程序的access_token
名称(昵称)
审核昵称
审核状态,1:审核中,2:审核失败,3:审核成功
失败原因
审核提交时间
审核完成时间
小程序名称设置及改名结果
材料说明
审核单id
获取搜索状态
设置搜索状态
获取搜索状态
设置搜索状态
获取搜索状态返回类型
1 表示不可搜索,0 表示可搜索
申请隐私接口 返回值
申请设置订单页 path 信息
订单页path
申请提交的图片url,审核版会显示
申请提交的视频url,审核版会显示
申请提交的测试账号,审核版会显示
申请提交的测试密码,审核版会显示
申请提交的测试备注,审核版会显示
申请提交的批量的appid
申请设置订单页path信息结果
获取订单页 path 信息结果
订单页 path 信息
订单页path
申请提交的图片url,审核版会显示
申请提交的视频url,审核版会显示
申请提交的测试账号,审核版会显示
申请提交的测试密码,审核版会显示
申请提交的测试备注,审核版会显示
订单页 path 状态,见其他说明
申请时间
获取隐私接口列表结果
隐私接口
api 英文名
api 中文名
api描述
申请时间 ,该字段发起申请后才会有
接口状态,该字段发起申请后才会有
1-待申请开通,2-无权限,3-申请中,4-申请失败,5-已开通
申请单号,该字段发起申请后才会有
申请被驳回原因或者无权限,该字段申请驳回时才会有
api文档链接
分组名
修改服务器地址 接口
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/Mini_Programs/setwebviewdomain.html
操作类型
小程序业务域名,当 action 参数是 get 时不需要此字段
【异步方法】修改服务器地址 接口
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/Mini_Programs/setwebviewdomain.html
操作类型
小程序业务域名,当 action 参数是 get 时不需要此字段
修改业务域名接口返回类型
微信SNS接口
code 换取 session_key
小程序的AppID
第三方平台appid
第三方平台的component_access_token
登录时获取的 code
保持默认:authorization_code
请求超时时间
【异步方法】code 换取 session_key
小程序的AppID
第三方平台appid
第三方平台的component_access_token
登录时获取的 code
保持默认:authorization_code
请求超时时间
JsCode2Json接口结果
用户唯一标识
会话密钥
用户在开放平台的唯一标识符,在满足 UnionID 下发条件的情况下会返回
小程序模板消息接口
获取小程序模板库标题列表
接口调用凭证
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。
请求超时时间
获取模板库某个模板标题下关键词库
接口调用凭证
模板标题id,可通过接口获取,也可登录小程序后台查看获取
请求超时时间
组合模板并添加至帐号下的个人模板库
接口调用凭证
模板标题id,可通过接口获取,也可登录小程序后台查看获取
开发者自行组合好的模板关键词列表,关键词顺序可以自由搭配(例如[3,5,4]或[4,5,3]),最多支持10个关键词组合
请求超时时间
获取帐号下已存在的模板列表
接口调用凭证
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。最后一页的list长度可能小于请求的count
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。最后一页的list长度可能小于请求的count
请求超时时间
删除帐号下的某个模板
接口调用凭证
要删除的模板id
请求超时时间
【异步方法】获取小程序模板库标题列表
接口调用凭证
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。
请求超时时间
【异步方法】获取模板库某个模板标题下关键词库
接口调用凭证
模板标题id,可通过接口获取,也可登录小程序后台查看获取
请求超时时间
【异步方法】组合模板并添加至帐号下的个人模板库
接口调用凭证
模板标题id,可通过接口获取,也可登录小程序后台查看获取
开发者自行组合好的模板关键词列表,关键词顺序可以自由搭配(例如[3,5,4]或[4,5,3]),最多支持10个关键词组合
请求超时时间
【异步方法】获取帐号下已存在的模板列表
接口调用凭证
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。最后一页的list长度可能小于请求的count
offset和count用于分页,表示从offset开始,拉取count条记录,offset从0开始,count最大为20。最后一页的list长度可能小于请求的count
请求超时时间
【异步方法】删除帐号下的某个模板
接口调用凭证
要删除的模板id
请求超时时间
创建开放平台帐号并绑定公众号/小程序。
该API用于创建一个开放平台帐号,并将一个尚未绑定开放平台帐号的公众号/小程序绑定至该开放平台帐号上。新创建的开放平台帐号的主体信息将设置为与之绑定的公众号或小程序的主体。
授权公众号或小程序的appid
【同步接口】绑定小程序的体验者 接口
authorizer_access_token
微信号
【同步接口】解除绑定小程序的体验者 接口
authorizer_access_token
微信号
【同步接口】获取体验者列表 接口
authorizer_access_token
获取公众号/小程序所绑定的开放平台帐号
授权公众号或小程序的appid
【异步方法】创建开放平台帐号并绑定公众号/小程序。
该API用于创建一个开放平台帐号,并将一个尚未绑定开放平台帐号的公众号/小程序绑定至该开放平台帐号上。新创建的开放平台帐号的主体信息将设置为与之绑定的公众号或小程序的主体。
授权公众号或小程序的appid
【异步方法】绑定小程序的体验者 接口
authorizer_access_token
微信号
【异步方法】解除绑定小程序的体验者 接口
authorizer_access_token
微信号
【异步方法】获取体验者列表 接口
authorizer_access_token
获取公众号/小程序所绑定的开放平台帐号
授权公众号或小程序的appid
创建开放平台帐号并绑定公众号/小程序接口返回结果
所创建的开放平台帐号的appid
获取公众号/小程序所绑定的开放平台帐号
公众号或小程序所绑定的开放平台帐号的appid
小程序接口
【同步方法】获取展示的公众号信息
【同步方法】获取可以用来设置的公众号列表
页码,从 0 开始
每页记录数,最大为 20
【同步方法】设置展示的公众号信息
是否打开扫码关注组件,0 关闭,1 开启
如果开启,需要传新的公众号 appid
获取小程序违规处罚记录
如果start_time和end_time都没有指定,则表示查询距离当前时间最近的90天内的记录。
查询时间段的开始时间,如果不填,则表示end_time之前90天内的记录
查询时间段的结束时间,如果不填,则表示start_time之后90天内的记录
获取小程序申诉记录
违规处罚记录id(通过getillegalrecords接口返回的记录id)
获取隐私接口列表
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/apply_api/get_privacy_interface.html
申请隐私接口
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/apply_api/apply_privacy_interface.html
申请的api英文名,例如wx.choosePoi,严格区分大小写
申请说原因,不超过300个字符;需要以utf-8编码提交,否则会出现审核失败
(辅助网页)例如,上传官网网页链接用于辅助审核
(辅助图片)填写图片的url ,最多10个
(辅助视频)填写视频的链接 ,最多支持1个;视频格式只支持mp4格式
查询小程序版本信息
调用本接口可以查询小程序的体验版和线上版本信息。
说明:如果需要查询审核中版本信息可通过 getLatestAuditStatus 接口获取。
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/code-management/getVersionInfo.html
第三方平台接口调用凭证authorizer_access_token,该参数为 URL 参数,非 Body 参数。
获取订单页 path 信息
该接口用于获取订单页 path 信息。
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/getOrderPathInfo.html
第三方平台接口调用凭证authorizer_access_token,该参数为 URL 参数,非 Body 参数。
0:线上版,1:审核版
申请设置订单页 path 信息
该接口用于申请设置订单页 path 信息
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/applySetOrderPathInfo.html
第三方平台接口调用凭证authorizer_access_token,该参数为 URL 参数,非 Body 参数。
0:线上版,1:审核版
【异步方法】获取展示的公众号信息
【异步方法】获取可以用来设置的公众号列表
页码,从 0 开始
每页记录数,最大为 20
【异步方法】设置展示的公众号信息
是否打开扫码关注组件,0 关闭,1 开启
如果开启,需要传新的公众号 appid
【异步方法】获取小程序违规处罚记录
如果start_time和end_time都没有指定,则表示查询距离当前时间最近的90天内的记录。
查询时间段的开始时间,如果不填,则表示end_time之前90天内的记录
查询时间段的结束时间,如果不填,则表示start_time之后90天内的记录
【异步方法】获取小程序申诉记录
违规处罚记录id(通过getillegalrecords接口返回的记录id)
【异步方法】获取隐私接口列表
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/apply_api/get_privacy_interface.html
【异步方法】申请隐私接口
https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/apply_api/apply_privacy_interface.html
申请的api英文名,例如wx.choosePoi,严格区分大小写
申请说原因,不超过300个字符;需要以utf-8编码提交,否则会出现审核失败
(辅助网页)例如,上传官网网页链接用于辅助审核
(辅助图片)填写图片的url ,最多10个
(辅助视频)填写视频的链接 ,最多支持1个;视频格式只支持mp4格式
【异步方法】查询小程序版本信息
调用本接口可以查询小程序的体验版和线上版本信息。
说明:如果需要查询审核中版本信息可通过 getLatestAuditStatus 接口获取。
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/code-management/getVersionInfo.html
第三方平台接口调用凭证authorizer_access_token,该参数为 URL 参数,非 Body 参数。
获取订单页 path 信息
该接口用于获取订单页 path 信息。
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/getOrderPathInfo.html
第三方平台接口调用凭证authorizer_access_token,该参数为 URL 参数,非 Body 参数。
0:线上版,1:审核版
申请设置订单页 path 信息
该接口用于申请设置订单页 path 信息
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/applySetOrderPathInfo.html
第三方平台接口调用凭证authorizer_access_token,该参数为 URL 参数,非 Body 参数。
0:线上版,1:审核版
半屏小程序列表
https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/embedded-management/getEmbeddedList.html
半屏小程序列表
授权方式。0表示需要管理员确认,1表示自动通过,2表示自动拒绝
半屏小程序详情
半屏小程序appid
添加时间
头像url
半屏小程序昵称
申请理由
申请状态
半屏小程序管理
添加半屏小程序
添加的半屏小程序 appid
申请理由,不超过 30 个字
删除半屏小程序
已添加的半屏小程序appid
取消授权小程序
半屏小程序授权方式。0表示需要管理员验证;1表示自动通过;2表示自动拒绝。
获取半屏小程序调用列表
query参数,分页起始值 ,默认值为0
query参数,一次拉取最大值,最大 1000,默认值为10
获取半屏小程序授权列表
设置授权方式
半屏小程序授权方式。0表示需要管理员验证;1表示自动通过;2表示自动拒绝。
添加半屏小程序
添加的半屏小程序 appid
申请理由,不超过 30 个字
删除半屏小程序
已添加的半屏小程序appid
取消授权小程序
半屏小程序授权方式。0表示需要管理员验证;1表示自动通过;2表示自动拒绝。
获取半屏小程序调用列表
query参数,分页起始值 ,默认值为0
query参数,一次拉取最大值,最大 1000,默认值为10
获取半屏小程序授权列表
设置授权方式
半屏小程序授权方式。0表示需要管理员验证;1表示自动通过;2表示自动拒绝。
“获取小程序申诉记录”接口返回结果
申诉记录列表
申诉单id
申诉时间
申诉次数
申诉来源(0--用户,1--服务商)
申诉状态,1正在处理,2申诉通过,3申诉不通过,4申诉已撤销
审核时间
审核结果理由
处罚原因描述
违规材料和申诉材料
违规材料
申诉材料(针对违规材料提供的资料
违规内容
违规链接
申诉理由
证明材料列表(可以通过“获取临时素材”接口下载对应的材料)
“获取小程序违规处罚记录”接口返回结果
违规处罚记录列表
违规处罚记录id
违规处罚时间
违规原因
违规内容
规则链接
违反的规则名称
是否可以设置 1 可以,0,不可以
是否已经设置,1 已设置,0,未设置
展示的公众号 appid
展示的公众号 nickname
展示的公众号头像
总记录数
公众号信息列表
公众号昵称
公众号 appid
公众号头像
添加栏目接口请求数据
一级类目ID
二级类目ID
key:资质名称,value:资质图片
账号可以设置的所有类目
类目Id
类目名称
层级
类目父级Id
子级类目Id
是否为敏感类目(1为敏感类目,需要提供相应资质审核;0为非敏感类目,无需审核
Sensitive_type为1的类目需要提供的资质文件名称
资质文件示例
账号已经设置的所有类目
一个更改周期内可以设置类目的次数
本更改周期内还可以设置类目的次数
最多可以设置的类目数量
一级类目ID
一级类目名称
二级类目ID
二级类目名称
审核状态(1审核中 2审核不通过 3审核通过)
审核不通过原因
status:关联状态
1:已关联
2:等待小程序管理员确认中
3:小程序管理员拒绝关联
12:等待公众号管理员确认中
小程序 gh_id
小程序 appid
(官方文档无说明)例:SOURCE_NORMAL
昵称
是否在公众号管理页展示中
是否展示在附近的小程序中
是否已经发布
头像 url
微信认证及支付信息
(官方文档无说明)例:1
小程序邮箱
微信认证及支付信息
0 表示未开通,1 表示开通
(官方文档无说明)例:1、2
“微信认证”“微信支付”等字符串信息
从第三方平台跳转至微信公众平台授权注册页面
第三方平台的appid
公众号的 appid
新管理员信息填写完成点击提交后,将跳转到该地址
(注:Host需和第三方平台在微信开放平台上面填写的登录授权的发起页域名一致)
点击页面提交按钮。 跳转回第三方平台,会在上述 redirect_uri 后拼接 taskid=*
方法
获取账号可以设置的所有类目
小程序的access_token
添加类目
小程序的access_token
添加类目参数
删除类目
小程序的access_token
一级类目ID
二级类目ID
获取账号已经设置的所有类目
小程序的access_token
修改类目
小程序的access_token
一级类目ID
二级类目ID
资质名称,资质图片
获取公众号关联的小程序
小程序的access_token
获取账号可以设置的所有类目
小程序的access_token
添加类目
小程序的access_token
添加类目参数
删除类目
小程序的access_token
一级类目ID
二级类目ID
获取账号已经设置的所有类目
小程序的access_token
修改类目
小程序的access_token
一级类目ID
二级类目ID
资质名称,资质图片
获取公众号关联的小程序
小程序的access_token