# 修改头像
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
# 接口说明
# 接口英文名
setHeadImage
# 功能描述
调用本接口可以修改小程序的头像。
示例示意图:
使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 注意事项
- 小程序头像每个月固定的修改次数上限;一年内可申请修改5次;
- 图片格式只支持:BMP、JPEG、JPG、GIF、PNG,大小不超过 2M
- 实际头像始终为正方形
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/account/modifyheadimage?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.basicInfo.modifyHeadImage
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:3、30、61
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用authorizer_access_token |
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]) |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 返回码 |
errmsg | string | 错误信息 |
# 其他说明
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
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
{
"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"
}
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
40007 | invalid media_id | 不合法的媒体文件 id |
40097 | invalid args | 参数错误 |
41006 | media_id missing | 缺少 media_id 参数 |
46001 | media data no exist | 不存在媒体数据,media_id 不存在 |
47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。 |
40009 | invalid image size | 图片尺寸太大 |
53202 | modify avatar quota limit exceed | 本月头像修改次数已用完 |