微信小程序开发文档 第43页
wxacode.getUnlimited 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取小程序码,适用于需要的码数量极多的业务场景。通过该接口生成的小程序码,永久有效,数量暂无限制。 更多用法详见 获取二维码。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 scene string 是 最大32个可见字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式) page string 主页 否 必须是已经发布的小程序存在的页面(否则报错),例如 pages/index/index, 根路径前不要填加 /,不能携带参数(参数请放在scene字段里),如果不填写这个字段,默认跳主页面 width number 430 否 二维码的宽度,单位 px,最小 280px,最大 1280px auto_color boolean false 否 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调,默认 false line_color Object {“r”:0,”g”:0,”b”:0} 否 auto_color 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示 is_hyaline boolean false 否 是否需要透明底色,为 true 时,生成透明底色的小程序 返回值 Buffer 返回的图片 Buffer 异常返回 Object JSON 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 45009 调用分钟频率受限(目前5000次/分钟,会调整),如需大量小程序码,建议预生成。 41030 所传page页面不存在,或者小程序没有发布 返回值说明 如果调用成功,会直接返回图片二进制内容,如果请求失败,会返回 JSON 格式的数据。 注意 POST 参数需要转成 JSON 字符串,不支持 form 表单提交。 接口只能生成已发布的小程序的二维码 调用分钟频率受限(5000次/分钟),如需大量小程序码,建议预生成 获取 scene 值 scene 字段的值会作为 query 参数传递给小程序/小游戏。用户扫描该码进入小程序/小游戏后,开发者可以获取到二维码中的 scene 值,再做处理逻辑。 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟,开发工具模拟时的 scene 的参数值需要进行 encodeURIComponent 小程序...
wxacode.get 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取小程序码,适用于需要的码数量较少的业务场景。通过该接口生成的小程序码,永久有效,有数量限制,详见获取二维码。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/getwxacode?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 path string 是 扫码进入的小程序页面路径,最大长度 128 字节,不能为空;对于小游戏,可以只传入 query 部分,来实现传参效果,如:传入 “?foo=bar”,即可在 wx.getLaunchOptionsSync 接口中的 query 参数获取到 {foo:"bar"}。 width number 430 否 二维码的宽度,单位 px。最小 280px,最大 1280px auto_color boolean false 否 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调 line_color Object {“r”:0,”g”:0,”b”:0} 否 auto_color 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示 is_hyaline boolean false 否 是否需要透明底色,为 true 时,生成透明底色的小程序码 返回值 Buffer 返回的图片 Buffer 异常返回 Object JSON 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 45029 生成码个数总和到达最大个数限制 返回值说明 如果调用成功,会直接返回图片二进制内容,如果请求失败,会返回 JSON 格式的数据。 注意 POST 参数需要转成 JSON 字符串,不支持 form 表单提交。 接口只能生成已发布的小程序的二维码 与 wxacode.createQRCode 总共生成的码数量限制为 100,000,请谨慎调用。 示例 请求 { "path":"page/index/index", "width":430 } 返回 { "errcode": 0, "errmsg": "ok", "contentType": "image/jpeg", "buffer": Buffer...
wxacode.createQRCode 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取小程序二维码,适用于需要的码数量较少的业务场景。通过该接口生成的小程序码,永久有效,有数量限制,详见获取二维码。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cgi-bin/wxaapp/createwxaqrcode?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 path string 是 扫码进入的小程序页面路径,最大长度 128 字节,不能为空;对于小游戏,可以只传入 query 部分,来实现传参效果,如:传入 “?foo=bar”,即可在 wx.getLaunchOptionsSync 接口中的 query 参数获取到 {foo:"bar"}。 width number 430 否 二维码的宽度,单位 px。最小 280px,最大 1280px 返回值 Buffer 返回的图片 Buffer 异常返回 Object JSON 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 45029 生成码个数总和到达最大个数限制 返回值说明 如果调用成功,会直接返回图片二进制内容,如果请求失败,会返回 JSON 格式的数据。 注意 POST 参数需要转成 JSON 字符串,不支持 form 表单提交。 接口只能生成已发布的小程序的二维码。开发版的带参二维码可以在开发者工具预览时生成。 与 wxacode.get 总共生成的码数量限制为 100,000,请谨慎调用。 示例 请求 { "path":"page/index/index", "width":430 } 返回 { "errcode": 0, "errmsg": "ok", "contentType": "image/jpeg", "buffer": Buffer } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.wxacode.createQRCode 需在 config.json 中配置 wxacode.createQRCode API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 path string 是 扫码进入的小程序页面路径,最大长度 128 字节,不能为空;对于小游戏,可以只传入 query 部分,来实现传参效果,如:传入 “?foo=bar”,即可在 wx.getLaunchOptionsSync 接口中的 query...
nearbyPoi.getList 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 查看地点列表 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 GET https://api.weixin.qq.com/wxa/getnearbypoilist?page=1&page_rows=20&access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 page number 是 起始页id(从1开始计数) page_rows number 是 每页展示个数(最多1000个) 返回值 Object 属性 类型 说明 errmsg string 错误信息 errcode number 错误码 data object 返回数据 data 的结构 属性 类型 说明 left_apply_num number 剩余可添加地点个数 max_apply_num number 最大可添加地点个数 data string 地址列表的 JSON 格式字符串 data.data 的结构 属性 类型 说明 poi_list Array.<Object> 地址列表 data.data.poi_list 的结构 属性 类型 说明 poi_id string 附近地点 ID qualification_address string 资质证件地址 qualification_num string 资质证件证件号 audit_status number 地点审核状态 display_status number 地点展示在附近状态 refuse_reason string 审核失败原因,audit_status=4 时返回 audit_status 的合法值 值 说明 最低版本 3 审核中 4 审核失败 5 审核通过 display_status 的合法值 值 说明 最低版本 0 未展示 1 展示中 错误 错误码 错误信息 说明 0...
pluginManager.unbindPlugin 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 删除已添加的插件 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/plugin?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 action string 是 此接口下填写 “unbind” plugin_appid string 是 插件 appId 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 错误 错误码 错误信息 说明 0 ok 正常 -1 系统错误 89236 该插件不能申请 89237 已经添加该插件 89238 申请或使用的插件已经达到上限 89239 该插件不存在 89240 无法进行此操作,只有“待确认”的申请可操作通过/拒绝 89241 无法进行此操作,只有“已拒绝/已超时”的申请可操作删除 89242 该appid不在申请列表内 89243 “待确认”的申请不可删除 89044 不存在该插件appid 请求数据示例 { "action":"unbind", "plugin_appid":"aaaa" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.pluginManager.unbindPlugin 需在 config.json 中配置 pluginManager.unbindPlugin API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 action string 是 此接口下填写 “unbind” pluginAppid string 是 插件 appId 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errCode number 错误码 errMsg string 错误信息 异常 Object 抛出的异常...
pluginManager.setDevPluginApplyStatus 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 修改插件使用申请的状态(供插件开发者调用) 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/devplugin?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 action string 是 修改操作 appid string 否 使用者的 appid。同意申请时填写。 reason string 否 拒绝理由。拒绝申请时填写。 action 的合法值 值 说明 最低版本 dev_agree 同意申请 dev_refuse 拒绝申请 dev_delete 删除已拒绝的申请者 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 错误 错误码 错误信息 说明 0 ok 正常 -1 系统错误 89236 该插件不能申请 89237 已经添加该插件 89238 申请或使用的插件已经达到上限 89239 该插件不存在 89240 无法进行此操作,只有“待确认”的申请可操作通过/拒绝 89241 无法进行此操作,只有“已拒绝/已超时”的申请可操作删除 89242 该appid不在申请列表内 89243 “待确认”的申请不可删除 89044 不存在该插件appid 请求数据示例 { "action": "dev_agree", "appid": "aaaa" } 或 { "action": "dev_refuse", "reason": "refuse reason" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.pluginManager.setDevPluginApplyStatus 需在 config.json 中配置 pluginManager.setDevPluginApplyStatus API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 action string 是...
pluginManager.getPluginList 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 查询已添加的插件 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/plugin?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 action string 是 此接口下填写 “list” 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 plugin_list Array.<Object> 申请或使用中的插件列表 plugin_list 的结构 属性 类型 说明 appid string 插件 appId status number 插件状态 nickname string 插件昵称 headimgurl string 插件头像 status 的合法值 值 说明 最低版本 1 申请中 2 申请通过 3 已拒绝 4 已超时 错误 错误码 错误信息 说明 0 ok 正常 -1 系统错误 89236 该插件不能申请 89237 已经添加该插件 89238 申请或使用的插件已经达到上限 89239 该插件不存在 89240 无法进行此操作,只有“待确认”的申请可操作通过/拒绝 89241 无法进行此操作,只有“已拒绝/已超时”的申请可操作删除 89242 该appid不在申请列表内 89243 “待确认”的申请不可删除 89044 不存在该插件appid 请求数据示例 { "action":"list" } 返回数据示例 { "errcode": 0, "errmsg": "ok", "plugin_list": [{ "appid": "aaaa", "status":...
pluginManager.getPluginDevApplyList 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取当前所有插件使用方(供插件开发者调用) 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/devplugin?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 action string 是 此接口下填写 “dev_apply_list” page number 是 要拉取第几页的数据 num number 是 每页的记录数 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 apply_list Array.<Object> 插件使用方列表 apply_list 的结构 属性 类型 说明 appid string 使用者的appid status number 插件状态 nickname string 使用者的昵称 headimgurl string 使用者的头像 categories Array.<Object> 使用者的类目 create_time string 使用者的申请时间 apply_url string 使用者的小程序码 reason string 使用者的申请说明 status 的合法值 值 说明 最低版本 1 申请中 2 申请通过 3 已拒绝 4 已超时 错误 错误码 错误信息 说明 0 ok 正常 -1 系统错误 89236 该插件不能申请 89237 已经添加该插件 89238 申请或使用的插件已经达到上限 89239 该插件不存在 89240 无法进行此操作,只有“待确认”的申请可操作通过/拒绝 89241 无法进行此操作,只有“已拒绝/已超时”的申请可操作删除 89242 该appid不在申请列表内...
pluginManager.applyPlugin 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 向插件开发者发起使用插件的申请 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/plugin?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 action string 是 此接口下填写 “apply” plugin_appid string 是 插件 appId reason string 否 申请使用理由 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 错误 错误码 错误信息 说明 0 ok 正常 -1 系统错误 89236 该插件不能申请 89237 已经添加该插件 89238 申请或使用的插件已经达到上限 89239 该插件不存在 89240 无法进行此操作,只有“待确认”的申请可操作通过/拒绝 89241 无法进行此操作,只有“已拒绝/已超时”的申请可操作删除 89242 该appid不在申请列表内 89243 “待确认”的申请不可删除 89044 不存在该插件appid 请求数据示例 { "action": "apply", "plugin_appid": "aaaa", "reason": "hello" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.pluginManager.applyPlugin 需在 config.json 中配置 pluginManager.applyPlugin API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 action string 是 此接口下填写 “apply” pluginAppid string 是 插件 appId reason string 否 申请使用理由 返回值 Object 返回的 JSON 数据包...
updatableMessage.setUpdatableMsg 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 修改被分享的动态消息。详见动态消息。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 activity_id string 是 动态消息的 ID,通过 updatableMessage.createActivityId 接口获取 target_state number 是 动态消息修改后的状态(具体含义见后文) template_info Object 是 动态消息对应的模板信息 target_state 的合法值 值 说明 最低版本 0 未开始 1 已开始 template_info 的结构 属性 类型 默认值 必填 说明 parameter_list Array.<Object> 是 模板中需要修改的参数 parameter_list 的结构 属性 类型 默认值 必填 说明 name string 是 要修改的参数名 value string 是 修改后的参数值 name 的合法值 值 说明 最低版本 member_count target_state = 0 时必填,文字内容模板中 member_count 的值 room_limit target_state = 0 时必填,文字内容模板中 room_limit 的值 path target_state = 1 时必填,点击「进入」启动小程序时使用的路径。 对于小游戏,没有页面的概念,可以用于传递查询字符串(query),如 "?foo=bar" version_type target_state = 1 时必填,点击「进入」启动小程序时使用的版本。 有效参数值为:develop(开发版),trial(体验版),release(正式版) 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg number 错误信息 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统繁忙。此时请开发者稍候再试 42001...