第三方平台
第三方平台概述
创建第三方平台
常见问题排查指南

修改小程序名称

为授权小程序修改名称

请求地址

POST   https://open.microapp.bytedance.com/openapi/v1/microapp/app/modify_app_name

 

Query 参数

参数名参数类型是否必须备注
component_appidstring第三方平台的 appid
authorizer_access_tokenstring授权小程序的接口调用令牌

Body 参数(json)

参数名参数类型是否必须备注
new_namestring授权小程序准备修改的名称
material_file_pathstring如果调用 小程序名称检测 接口,返回 21006 错误,则必须先调用 上传图片材料 接口上传证明。
另外,需要使用 上传图片材料 接口返回的路径才可以,否则报错。

Body 参数示例

{
  "new_name": "XXX",
  "material_file_path": "thirdparty/${tpAppId}/${prefix}/${hash}"
}

 

返回值

参数名参数类型备注
errnoint错误码
messagestring错误信息

返回值示例

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

错误码

错误码message
21000修改名称失败,请稍后再试
21001名字只能包含大小写字母、数字和中文,最后一位可以是 +,长度为 4-20,一个汉字算两个字符
21003名称已存在,请修改后重试
21004当前小程序名称修改正在审核
21005当前名称包含敏感词汇,请修改
21006当前名称包含品牌或商标名称,请修改或提交相关材料
40033获取不到上传的图片材料,请确认文件路径正确

 

修改名称审核结果通知

修改名称审核结果出来之后,会自动触发消息发送,然后第三方应用会收到由第三方服务器推送的相应授权小程序的修改名称的审核结果。

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
  }
}

消息体字段含义如下:

参数名参数类型备注
AppIdstring授权小程序的 appid
TpAppIdstring第三方平台的 appid
EventTimestring推送事件时间
Eventstring推送事件类型
ModifyAppNameResultsobject修改名称的审核结果
advicestring如果被拒,修改建议
reasonstring如果被拒,被拒原因
statusstring0 或 1,0 代表不通过,1 代表通过

 

名称重置通知

补充:如果授权小程序长时间(30 天)未提交版本且未上线,名称会被重置。这时会自动触发消息发送,然后第三方应用会收到由第三方服务器推送的相应授权小程序的名称重置的通知。

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」。如需修改,请前往配置页面重新填写名称。"
}
点击纠错
评价此篇文档