# 修改头像
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:setHeadImage
调用本接口可以修改小程序的头像。
示例示意图:

使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/account/modifyheadimage?access_token=ACCESS_TOKEN
# 云调用
调用方法:basicInfo.modifyHeadImage
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:3、30
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| head_img_media_id | string | 是 | 头像素材 media_id |
| x1 | string | 是 | 裁剪框左上角 x 坐标(取值范围:[0, 1]) |
| y1 | string | 是 | 裁剪框左上角 y 坐标(取值范围:[0, 1]) |
| x2 | string | 是 | 裁剪框右下角 x 坐标(取值范围:[0, 1]) |
| y2 | string | 是 | 裁剪框右下角 y 坐标(取值范围:[0, 1]) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 返回码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
- 小程序头像每个月固定的修改次数上限;一年内可申请修改5次;
- 图片格式只支持:BMP、JPEG、JPG、GIF、PNG,大小不超过 2M
- 实际头像始终为正方形
# 其他说明
head_img_media_id:media_id 临时素材 media_id 通过调用“临时素材管理接口”获取 . 调用如下接口时请使用第三方平台接口调用令牌authorizer_access_token。请注意:这里需使用authorizer_access_token调用以下接口获取的media_id(小程序AccessToken、公众号AccessToken、第三方平台令牌component_access_token调用以下接口获取的media_id都不行!)才能用到head_img_media_id参数值中,否则会报错40007
# 5. 代码示例
请求示例
{
"head_img_media_id": "mI-4E_sFh_2X3g-qmTIWD83RT78ytI1_6VfgFp_A3-Y2U5T_nLl3nm1xYTafFJ8p",
"x1": "0",
"y1": "0",
"x2": "0.7596899224806202",
"y2": "0.49"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
| 40007 | invalid media_id | 不合法的媒体文件 id |
| 40009 | invalid image size | 图片尺寸太大 |
| 40097 | invalid args | 参数错误 |
| 41006 | media_id missing | 缺少 media_id 参数 |
| 46001 | media data no exist | 不存在媒体数据,media_id 不存在 |
| 47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。 |
| 53202 | modify avatar quota limit exceed | 本月头像修改次数已用完 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。