接口介绍

该接口用于第三方小程序应用为授权小程序修改名称。

请求

基本信息

基本
HTTP URL
HTTP Method
POST
权限要求
授权小程序授予基本信息设置权限

查询参数

参数名
参数类型
是否必须
备注
component_appid
string
第三方小程序应用 appid
authorizer_access_token
string
授权小程序接口调用凭据

请求体(json)

参数名
参数类型
是否必须
备注
new_name
string
授权小程序准备修改的名称
material_file_path
string
小程序名称审核材料路径
注意:
1. 如果调用小程序名称检测接口,返回 21006 错误,则必须先调用代授权小程序上传资源接口上传证明。
2. 需要使用代授权小程序上传资源接口返回的路径才可以,接口调用时入参 material_type 字段为 3,否则报错。

请求体示例

{ "new_name": "XXX", "material_file_path": "xxxx/xxxx" }

响应

响应体

参数名
参数类型
备注
errno
int
错误码
message
string
错误信息

响应体示例

{ "errno": 0, "message": "success" }

错误码

错误码
message
20105
当前小程序/小游戏修改次数已用完
21000
修改名称失败,请稍后再试
21001
名字只能包含大小写字母、数字和中文,最后一位可以是 +,长度为 4-20,一个汉字算两个字符
21003
名称已存在,请修改后重试
21004
当前小程序名称修改正在审核
21005
当前名称包含敏感词汇,请修改
21006
你申请的名称涉及品牌或商标,请更换名称或提供加盖公司公章的《商标注册证》,否则可能审核不通过
22007
小程序主体认证未完成
40001
参数错误
40003
找不到相关第三方小程序应用
40004
找不到相关授权小程序
40020
第三方小程序应用 authorizer_access_token 不正确或者已过期
40033
获取不到上传的材料,请确认文件路径正确
40036
授权小程序未授予该接口对应的权限

修改名称审核结果通知

修改名称审核结果出来之后,会自动触发消息发送,然后开放平台服务器会向第三方小程序应用的【消息与事件接收 URL】以 HTTP POST 方式推送相应授权小程序的修改名称的审核结果。
POST 数据示例:
{ "Nonce": "4464221", "TimeStamp": "1535551395", "Encrypt": "Encrypt Message xxxxxxxx", "MsgSignature": "ba394c04acece6c2c0edee058c5dddf82474b8ee" }
其中 Encrypt 字段需要解密,解密详情见消息推送及加解密说明部分。解密后消息格式如下:
{ "AppId": "授权小程序的appid", "TpAppId": "第三方小程序应用appid", "EventTime": "2019-01-14 12:45:10", "Event": "MODIFY_APP_NAME", "ModifyAppNameResults": { "advice": "", "reason": "小程序名称格式不符合规范", "status": 0 } }
消息体字段含义如下:
参数名
参数类型
备注
AppId
string
授权小程序 appid
TpAppId
string
第三方小程序应用 appid
EventTime
string
推送事件时间
Event
string
推送事件类型
ModifyAppNameResults
object
修改名称的审核结果
advice
string
如果被拒,修改建议
reason
string
如果被拒,被拒原因
status
number
0 或 1,0 代表不通过,1 代表通过

名称重置通知

补充:如果授权小程序长时间(30 天)未提交版本且未上线,名称会被重置。这时会自动触发消息发送,然后开放平台服务器会向第三方小程序应用的【消息与事件接收 URL】以 HTTP POST 方式推送相应授权小程序的名称重置的通知。
POST 数据示例:
{ "Nonce": "4464221", "TimeStamp": "1535551395", "Encrypt": "Encrypt Message xxxxxxxx", "MsgSignature": "ba394c04acece6c2c0edee058c5dddf82474b8ee" }
其中 Encrypt 字段需要解密,解密详情见消息推送及加解密说明部分。解密后消息格式如下:
{ "AppId": "授权小程序的appid", "TpAppId": "第三方小程序应用appid", "EventTime": "2019-01-14 12:45:10", "Event": "APP_NAME_RESET_NOTIFICATION", "AppNameResetNotification": "您好,您管理的小程序「%s」由于长时间未提交版本审核,名称已经被重置为「名称过期%s」。如需修改,请前往配置页面重新填写名称。" }