# 图片智能裁剪

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:imgAiCrop

本接口用于对图片主体区域进行智能识别和裁剪

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/cv/img/aicrop?access_token=ACCESS_TOKEN&img_url=IMG_URL

# 云调用

  • 调用方法:img.aiCrop

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:117

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOCKEN接口调用凭证,可使用 access_tokenauthorizer_access_token
img_urlstringENCODE_URL要检测的图片 url,传这个则不用传 img 参数。

# 请求体 Request Payload

参数名类型必填说明
imgformdata图片文件,小于2M
ratiosstring宽高比;如果提供多个宽高比,请以英文逗号“,”分隔,最多支持5个宽高比

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
resultsobjarray智能裁剪结果
img_sizeobject图片大小

# Res.results(Array) Object Payload

智能裁剪结果

参数名类型说明
crop_leftnumber左上角x
crop_topnumber左上角y
crop_rightnumber右下角x
crop_bottomnumber右下角y

# Res.img_size Object Payload

图片大小

参数名类型说明
wnumber宽度
hnumber高度

# 4. 注意事项

  1. 支持使用img参数实时上传,也支持使用img_url参数传送图片地址,由微信后台下载图片进行识别。
  2. ratios参数为可选,如果为空,则算法自动裁剪最佳宽高比;如果提供多个宽高比,请以英文逗号“,”分隔,最多支持5个宽高比
  3. 文件大小限制:小于2M 图片

# 5. 代码示例

# 5.1 上传文件请求

请求示例

curl -F 'img=@test.jpg' -F 'ratios=1,2.35' 'http://api.weixin.qq.com/cv/img/aicrop?access_token=ACCESS_TOCKEN'

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "results": [
    {
      "crop_left": 112,
      "crop_top": 0,
      "crop_right": 839,
      "crop_bottom": 727
    },
    {
       "crop_left": 0,
       "crop_top": 205,
       "crop_right": 965,
       "crop_bottom": 615
   }
  ],
  "img_size": {
    "w": 966,
    "h": 728
  }
}

# 5.2 上传链接请求

请求示例

curl -F 'ratios=1,2.35' "http://api.weixin.qq.com/cv/img/aicrop?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN"

返回示例

{
    "errcode": 0, 
    "errmsg": "ok", 
    "results": [ //智能裁剪结果
        {
            "crop_left": 112, 
            "crop_top": 0, 
            "crop_right": 839, 
            "crop_bottom": 727
        }, 
        {
            "crop_left": 0, 
            "crop_top": 205, 
            "crop_right": 965, 
            "crop_bottom": 615
        }
    ], 
    "img_size": { //图片大小
        "w": 966, 
        "h": 728
    }
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
-1system error系统错误
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
101000invalid image url图片URL错误
101002invalid image data图片数据无效

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
小程序公众号服务号
仅认证 仅认证
  • ✔:该账号可调用此接口
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;