# 设置小程序名称

调试诊断

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

接口英文名:setNickName

  • 调用本接口可以设置小程序名称,当名称没有命中关键词,则直接设置成功;当名称命中关键词,需提交证明材料,并需要审核。审核结果会向消息与事件接收 URL 进行事件推送
  • 使用过程中如遇到问题,可在开放平台服务商专区发帖交流

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/setnickname?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
nick_namestring昵称,不支持包含“小程序”关键字的昵称
id_cardstring身份证照片 mediaid,个人号必填
licensestring组织机构代码证或营业执照 mediaid,组织号必填
naming_other_stuff_1string其他证明材料 mediaid
naming_other_stuff_2string其他证明材料 mediaid
naming_other_stuff_3string其他证明材料 mediaid
naming_other_stuff_4string其他证明材料 mediaid
naming_other_stuff_5string其他证明材料 mediaid

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber返回码
errmsgstring错误信息
wordingstring材料说明
audit_idnumber审核单 id,通过用于查询改名审核状态

# 4. 注意事项

  • 改名次数将在自然年 1 月 1 日和微信认证审核通过后重置为 2 次。改名次数用尽后,可通过发起微信认证实现改名。

# 其他说明

# 名称审核结果事件推送

小程序改名的审核结果会向消息与事件接收 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>

# 5. 代码示例

请求示例

{
  "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,说明名称已直接设置成功,无需审核;

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
40007invalid media_id不合法的媒体文件 id
91001not fast register通过api注册的小程序才可调用该接口改名
91003invalid change stat改名状态不合法
91004invalid nickname昵称不合法
91005昵称 15 天主体保护
91007nickname used昵称已被占用
91008昵称命中 7 天侵权保护期
91009nickname need proof需要提交材料
91010其他错误
91011查不到昵称修改审核单信息查不到昵称修改审核单信息
91012其他错误
91013占用名字过多
91014diff master plus+号规则 同一类型关联名主体不一致
91015diff master原始名不同类型主体不一致
91016name more owner名称占用者 ≥2
91017other diff master plus+号规则 不同类型关联名主体不一致
91019小程序正在审核中小程序正在审核中
91028试用小程序不支持使用该接口更改名称
91029no rename quota可通过认证改名

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。