微信小程序 小程序搜索·imageSearch
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 数据包
| 属性 | 类型 | 说明 |
|---|---|---|
| errCode | string | 错误码 |
| errMsg | string | 错误信息 |
| items | Array.<Object> | 搜索结果列表 |
errCode 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| 0 | 成功 |
items 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| title | string | 小程序商品页面标题 |
| imgUrl | string | 小程序商品页面主图url |
| price | string | 小程序商品页面价格 |
| path | string | 小程序商品页面地址 |
异常
Object
抛出的异常
| 属性 | 类型 | 说明 |
|---|---|---|
| errCode | string | 错误码 |
| errMsg | string | 错误信息 |
errCode 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| -1 | 系统繁忙，此时请开发者稍候再试 | |
| 41005 | 获取图片数据失败，请检查图片数据格式 |