微信小程序开发文档 第18页

soter.verifySignature 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 SOTER 生物认证秘钥签名验证 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cgi-bin/soter/verify_signature?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 openid string 是 用户 openid json_string string 是 通过 wx.startSoterAuthentication 成功回调获得的 resultJSON 字段 json_signature string 是 通过 wx.startSoterAuthentication 成功回调获得的 resultJSONSignature 字段 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errmsg string 错误信息 errcode number 错误码 is_ok boolean 验证结果 请求示例 { "openid": "$openid", "json_string": "$resultJSON", "json_signature": "$resultJSONSignature" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.soter.verifySignature 需在 config.json 中配置 soter.verifySignature API 的权限，详情 请求参数 属性 类型 默认值 必填 说明 openid string 是 用户 openid jsonString string 是 通过 wx.startSoterAuthentication 成功回调获得的 resultJSON 字段 jsonSignature string 是 通过 wx.startSoterAuthentication 成功回调获得的 resultJSONSignature 字段 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errMsg string 错误信息 errCode number 错误码 isOk boolean 验证结果 异常 Object 抛出的异常 属性 类型...

serviceMarket.invokeService 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 调用服务平台提供的服务 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/servicemarket?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 service string 是 服务 ID api string 是 接口名 data string 是 服务提供方接口定义的 JSON 格式的数据 client_msg_id string 是 随机字符串 ID，调用方请求的唯一标识 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 template_id string 添加至帐号下的模板id，发送小程序模板消息时所需 请求数据示例 { "service" : "wx79ac3de8be320b71", "api" : "OcrAllInOne", "data" : { "img_url": "http://mmbiz.qpic.cn/mmbiz_jpg/7UFjuNbYxibu66xSqsQqKcuoGBZM77HIyibdiczeWibdMeA2XMt5oibWVQMgDibriazJSOibLqZxcO6DVVcZMxDKgeAtbQ/0", "data_type": 3, "ocr_type": 1 }, "client_msg_id" : "id123" } 返回数据示例 { "errcode": 0, "errmsg": "ok", "data": "{\"idcard_res\":{\"type\":0,\"name\":{\"text\":\"abc\",\"pos\"…0312500}}},\"image_width\":480,\"image_height\":304}}" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.serviceMarket.invokeService 需在 config.json 中配置 serviceMarket.invokeService API 的权限，详情 请求参数 属性 类型 默认值 必填 说明 service string 是 服务 ID api string 是 接口名 data string 是 服务提供方接口定义的 JSON 格式的数据...

search.submitPages 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 小程序开发者可以通过本接口提交小程序页面url及参数信息，让微信可以更及时的收录到小程序的页面信息，开发者提交的页面信息将可能被用于小程序搜索结果展示。 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/search/wxaapi_submitpages?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 pages Array.<Object> 是 小程序页面信息列表 pages 的结构 属性 类型 默认值 必填 说明 path string 是 页面路径 query string 是 页面参数 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 -1 系统繁忙，此时请开发者稍候再试 0 请求成功 40066 递交的页面被sitemap标记为拦截，具体查看errmsg提示。 40210 pages 中的path参数不存在或为空 40212 paegs 当中存在不合法的query，query格式遵循URL标准，即k1=v1&k2=v2 40219 pages不存在或者参数为空 47001 http请求包不是合法的JSON 47004 每次提交的页面数超过1000（备注：每次提交页面数应小于或等于1000） 47006 当天提交页面数达到了配额上限，请明天再试 85091 小程序的搜索开关被关闭。请访问设置页面打开开关再重试 85083 小程序的搜索功能被禁用 请求示例 curl -d ' { "pages": [ { "path": "pages/index/index", "query": "userName=wechat_user" }, { "path": "pages/video/index", "query": "vid=123" } ] }' https://api.weixin.qq.com/wxa/search/wxaapi_submitpages?access_token=TOKEN 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.search.submitPages 需在 config.json 中配置 search.submitPages API 的权限，详情 请求参数 属性 类型 默认值 必填...

search.siteSearch 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 小程序内部搜索API提供针对页面的查询能力，小程序开发者输入搜索词后，将返回自身小程序和搜索词相关的页面。因此，利用该接口，开发者可以查看指定内容的页面被微信平台的收录情况；同时，该接口也可供开发者在小程序内应用，给小程序用户提供搜索能力。 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/sitesearch?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 keyword string 是 关键词 next_page_info string 是 请求下一页的参数，开发者无需理解。为空时查询的是第一页内容，如需查询下一页，把返回参数的next_page_info填充到这里即可 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 items Array.<Object> 搜索结果列表 has_next_page boolean 是否有下一页 next_page_info string 请求下一页的参数，开发者无需理解，如需查询下一页结果，把该参数填充到下页请求参数中的next_page_info即可 hit_count number 估算索引文档数 errcode 的合法值 值 说明 最低版本 -1 系统繁忙，此时请开发者稍候再试 47101 搜索结果总数超过了1000条 47102 next_page_info参数错误 items 的结构 属性 类型 说明 title string 小程序页面标题 description string 小程序页面摘要 image string 小程序页面代表图 path string 小程序页面路径 使用示例 curl -d ' { "query": "微信", "next_page_info": "" }' https://api.weixin.qq.com/wxa/sitesearch?access_token=TOKEN 调用成功时的返回示例 { "errcode":0, "errmsg":"ok", "items": [ { "title": "<em class="highlight">微信</em>版本更新！", "description": "...今日，<em class="highlight">微信</em>官方发布<em class="highlight">微信</em>X.Y.Z版本...", "image": "http://image.weixin.qq.com/1.jpeg", "path": "pages/normal/index?id=20191210A0C29X00" }, { "title": "<em...

search.imageSearch 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 本接口提供基于小程序的站内搜商品图片搜索能力 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/imagesearch?access_token=TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 img Array.<FormData> 是 form-data中媒体文件标识，有filename、filelength、content-type等信息 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 items Array.<Object> 搜索结果列表 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统繁忙，此时请开发者稍候再试 41005 获取图片数据失败，请检查图片数据格式 items 的结构 属性 类型 说明 title string 小程序商品页面标题 img_url string 小程序商品页面主图url price string 小程序商品页面价格 path string 小程序商品页面地址 请求示例 curl -F 'img=@test.jpg' "https://api.weixin.qq.com/wxa/imagesearch?access_token=TOKEN" 云调用请求示例 // javascript // cloud = require('wx-server-sdk') // ... // 方法返回 Promise cloud.openapi.search.imageSearch({ img: { contentType: 'image/png', value: Buffer } }) 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.search.imageSearch 需在 config.json 中配置 search.imageSearch API 的权限，详情 请求参数 属性 类型 默认值 必填 说明 img Array.<FormData> 是 form-data中媒体文件标识，有filename、filelength、content-type等信息 返回值 Object 返回的 JSON...

ocr.vehicleLicense 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 本接口提供基于小程序的行驶证 OCR 识别 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cv/ocr/driving?type=MODE&img_url=ENCODE_URL&access_token=ACCESS_TOCKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 type string 是 图片识别模式，photo（拍照模式）或 scan（扫描模式） img_url string 是 要检测的图片 url，传这个则不用传 img 参数。 img FormData 是 form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 vehicle_type string 车辆类型 owner string 所有人 addr string 住址 use_character string 使用性质 model string 品牌型号 vin string 车辆识别代 engine_num string 发动机号码 register_date string 注册日期 issue_date string 发证日期 plate_num_b string 车牌号码 record string 号牌 passengers_num string 核定载人数 total_quality string 总质量 totalprepare_quality_quality string 整备质量 使用说明 接口限制 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用，次数限制为500次/天。 使用 Tips 此接口为后台接口，可基于自有业务承载情况，搭配小程序的拍照、相册选照等一起使用，即可完成身份证照片的采集、上传、识别、信息返回等流程，用于需要基于身份证、银行卡等实体卡或证，采集照片或文字信息等的业务场景。 图片说明 文件大小限制：小于2M 图片支持使用img参数实时上传，也支持使用img_url参数传送图片地址，由微信后台下载图片进行识别。type 有两种类型 拍摄图片样例 请求数据示例 示例1： curl https://api.weixin.qq.com/cv/ocr/driving?type=photo&img_url= ENCODE_URL&access_token=ACCESS_TOCKEN 示例2： curl -F ‘img=@test.jpg’“https://api.weixin.qq.com/cv/ocr/driving?type=photo&access_token=ACCESS_TOCKEN” 返回数据示例 {...

ocr.printedText 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 本接口提供基于小程序的通用印刷体 OCR 识别 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cv/ocr/comm?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 img_url string 是 要检测的图片 url，传这个则不用传 img 参数。 img FormData 是 form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 items string 识别结果 img_size string 图片大小 使用说明 接口限制 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用，次数限制为500次/天。 使用 Tips 此接口为后台接口，可基于自有业务承载情况，搭配小程序的拍照、相册选照等一起使用，即可完成身份证照片的采集、上传、识别、信息返回等流程，用于需要基于身份证、银行卡等实体卡或证，采集照片或文字信息等的业务场景。 图片说明 文件大小限制：小于2M 图片支持使用img参数实时上传，也支持使用img_url参数传送图片地址，由微信后台下载图片进行识别。 通用印刷体OCR适用于屏幕截图、印刷体照片等场景 请求数据示例 示例1： curl http://api.weixin.qq.com/cv/ocr/comm?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN 示例2： curl -F ‘img=@test.jpg’“http://api.weixin.qq.com/cv/ocr/comm?access_token=ACCESS_TOCKEN” 返回数据示例 { "errcode": 0, "errmsg": "ok", "items": [ //识别结果 { "text": "腾讯", "pos": { "left_top": { "x": 575, "y": 519 }, "right_top": { "x": 744, "y": 519 }, "right_bottom": { "x": 744, "y": 532 }, "left_bottom": { "x": 573, "y": 532 } } }, {...

ocr.idcard 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 本接口提供基于小程序的身份证 OCR 识别 调用方式： HTTPS 调用 云调用 增量调用（加强版） HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cv/ocr/idcard?type=MODE&img_url=ENCODE_URL&access_token=ACCESS_TOCKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 img_url string 是 要检测的图片 url，传这个则不用传 img 参数。 img FormData 是 form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 type string 正面或背面，Front / Back valid_date string 有效期 使用说明 接口限制 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用，次数限制为500次/天。更强的能力需求，可以走服务市场调用。 使用 Tips 此接口为后台接口，可基于自有业务承载情况，搭配小程序的拍照、相册选照等一起使用，即可完成身份证照片的采集、上传、识别、信息返回等流程，用于需要基于身份证、银行卡等实体卡或证，采集照片或文字信息等的业务场景。 图片说明 文件大小限制：小于2M 图片支持使用img参数实时上传，也支持使用img_url参数传送图片地址，由微信后台下载图片进行识别。type 有两种类型 拍摄图片样例 photo：拍照模型，带背景的图片（示例如下） scan：扫描模式，不带背景的图片（示例如下） 请求数据示例 示例1： curl https://api.weixin.qq.com/cv/ocr/idcard?type=photo&img_url= ENCODE_URL&access_token=ACCESS_TOCKEN 示例2： curl -F ‘img=@test.jpg’“https://api.weixin.qq.com/cv/ocr/idcard?type=photo&access_token=ACCESS_TOCKEN” 返回数据示例 正面返回 { "errcode": "0", "errmsg": "ok", "type": "Front", "name": "张三", "id": "123456789012345678", "addr": "广东省广州市", "gender": "男", "nationality": "汉" } 背面返回 { "errcode": 0, "errmsg": "ok", "type": "Back", "valid_date": "20070105-20270105" } 常见错误码 错误码 errmsg 说明 -1 system error...

ocr.driverLicense 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 本接口提供基于小程序的驾驶证 OCR 识别 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cv/ocr/drivinglicense?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 img_url string 是 要检测的图片 url，传这个则不用传 img 参数。 img FormData 是 form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 id_num string 证号 name string 姓名 sex string 性别 name string 姓名 address string 地址 birth_date string 出生日期 issue_date string 初次领证日期 car_class string 准驾车型 valid_from string 有效期限起始日 valid_to string 有效期限终止日 official_seal string 印章文构 使用说明 接口限制 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用，次数限制为500次/天。 使用 Tips 此接口为后台接口，可基于自有业务承载情况，搭配小程序的拍照、相册选照等一起使用，即可完成身份证照片的采集、上传、识别、信息返回等流程，用于需要基于身份证、银行卡等实体卡或证，采集照片或文字信息等的业务场景。 图片说明 文件大小限制：小于2M 图片支持使用img参数实时上传，也支持使用img_url参数传送图片地址，由微信后台下载图片进行识别。type 有两种类型 拍摄图片样例 请求数据示例 示例1： curl http://api.weixin.qq.com/cv/ocr/drivinglicense?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN 示例2： curl -F ‘img=@test.jpg’“http://api.weixin.qq.com/cv/ocr/drivinglicense?access_token=ACCESS_TOCKEN” 返回数据示例 { "errcode": 0, "errmsg": "ok", "id_num": "660601xxxxxxxx1234", "name": "张三", "sex": "男", "nationality": "中国", "address": "广东省东莞市xxxxx号", "birth_date":...

ocr.businessLicense 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 本接口提供基于小程序的营业执照 OCR 识别 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cv/ocr/bizlicense?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 img_url string 是 要检测的图片 url，传这个则不用传 img 参数。 img FormData 是 form-data 中媒体文件标识，有filename、filelength、content-type等信息，传这个则不用传 img_url。 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode string 错误码 errmsg string 错误信息 reg_num string 注册号 serial string 编号 legal_representative string 法定代表人姓名 enterprise_name string 企业名称 type_of_organization string 组成形式 address string 经营场所/企业住所 type_of_enterprise string 公司类型 business_scope string 经营范围 registered_capital string 注册资本 paid_in_capital string 实收资本 valid_period string 营业期限 registered_date string 注册日期/成立日期 cert_position string 营业执照位置 img_size string 图片大小 使用说明 接口限制 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用，次数限制为500次/天。 使用 Tips 此接口为后台接口，可基于自有业务承载情况，搭配小程序的拍照、相册选照等一起使用，即可完成身份证照片的采集、上传、识别、信息返回等流程，用于需要基于身份证、银行卡等实体卡或证，采集照片或文字信息等的业务场景。 图片说明 文件大小限制：小于2M 返回字段仅包含当前营业执照图片中存在的字段，若对应字段不存在则不返回 拍摄图片样例 请求数据示例 示例1： curl https://api.weixin.qq.com/cv/ocr/bizlicense?img_url= ENCODE_URL&access_token=ACCESS_TOCKEN 示例2： curl -F ‘img=@test.jpg’“https://api.weixin.qq.com/cv/ocr/bizlicense?access_token=ACCESS_TOCKEN” 返回数据示例 { "errcode": 0, "errmsg": "ok", "reg_num": "123123",...