# 设置小程序名称
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
setNickName
# 功能描述
- 调用本接口可以设置小程序名称,当名称没有命中关键词,则直接设置成功;当名称命中关键词,需提交证明材料,并需要审核。审核结果会向消息与事件接收 URL 进行事件推送。
- 使用过程中如遇到问题,可在开放平台服务商专区发帖交流
# 注意事项
- 改名次数将在自然年 1 月 1 日和微信认证审核通过后重置为 2 次。改名次数用尽后,可通过发起微信认证实现改名。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/setnickname?access_token=ACCESS_TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:30、61
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用authorizer_access_token |
nick_name | string | 是 | 昵称,不支持包含“小程序”关键字的昵称 |
id_card | string | 是 | 身份证照片 mediaid,个人号必填 |
license | string | 是 | 组织机构代码证或营业执照 mediaid,组织号必填 |
naming_other_stuff_1 | string | 否 | 其他证明材料 mediaid |
naming_other_stuff_2 | string | 否 | 其他证明材料 mediaid |
naming_other_stuff_3 | string | 否 | 其他证明材料 mediaid |
naming_other_stuff_4 | string | 否 | 其他证明材料 mediaid |
naming_other_stuff_5 | string | 否 | 其他证明材料 mediaid |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 返回码 |
errmsg | string | 错误信息 |
wording | string | 材料说明 |
audit_id | number | 审核单 id,通过用于查询改名审核状态 |
# 其他说明
# 素材相关说明
# 名称审核结果事件推送
小程序改名的审核结果会向消息与事件接收 URL 推送相关通知。
# 名称审核结果事件推送说明
参数 | 类型 | 字段描述 |
---|---|---|
nickname | string | 需要更改的昵称 |
ret | number | 审核结果 2:失败,3:成功 |
reason | string | 审核失败的驳回原因 |
推送内容解密后的示例:
<xml>
<ToUserName><![CDATA[gh_fxxxxxxxa4b2]]></ToUserName>
<FromUserName><![CDATA[odxxxxM-xxxxxxxx-trm4a7apsU8]]></FromUserName>
<CreateTime>1488800000</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[wxa_nickname_audit]]></Event>
<ret>2</ret>
<nickname>昵称</nickname>
<reason>驳回原因</reason>
</xml>
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
{
"nick_name": "XXX公司",
"id_card": "3LaLzqiTrQcD20DlX_o-OV1",
"license": "3LaLzqiTrQcD20DlX_o-OV22231",
"naming_other_stuff_1": "3LaLzqiTrQcD20DlX_o-OV1-
nlYMu7sdVAL7SV2PrxVyjZFZZmB3O6LPGaYXlZWq",
"naming_other_stuff_2": "",
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"wording": "",
"audit_id": 12345
}
注意: 若接口未返回 audit_id,说明名称已直接设置成功,无需审核;
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
91001 | not fast register | 通过api注册的小程序才可调用该接口改名 |
91003 | invalid change stat | 改名状态不合法 |
91004 | invalid nickname | 昵称不合法 |
91005 | 昵称 15 天主体保护 | |
91007 | nickname used | 昵称已被占用 |
91008 | 昵称命中 7 天侵权保护期 | |
91009 | nickname need proof | 需要提交材料 |
91010 | 其他错误 | |
91011 | 查不到昵称修改审核单信息 | 查不到昵称修改审核单信息 |
91012 | 其他错误 | |
91013 | 占用名字过多 | |
91014 | diff master plus | +号规则 同一类型关联名主体不一致 |
91015 | diff master | 原始名不同类型主体不一致 |
91016 | name more owner | 名称占用者 ≥2 |
91017 | other diff master plus | +号规则 不同类型关联名主体不一致 |
40007 | invalid media_id | 不合法的媒体文件 id |
91019 | 小程序正在审核中 | 小程序正在审核中 |
91028 | 试用小程序不支持使用该接口更改名称 | |
91029 | no rename quota | 可通过认证改名 |