添加小程序别名
收藏接口说明
小程序别名，用于用户在搜索中精准定位到该小程序，具有唯一性，了解详情。（另外页面添加方式可通过“小程序控制台-运营-流量配置-搜索”的页面添加。） 例如：小程序名称是【AB 电影社】，功能是线上购票，则别名可设置为【AB 电影票】。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/aweme/apps/v1/alias/create_alias/ |
| HTTP Method | POST |
| Scope | ma.alias.open |
| 权限要求 | 服务商代调用场景下，需商家授予运营管理权限集 小程序别名配置 |
请求参数
请求头
access-token必填String
当非服务商时，调用https://minigame.zijieapi.com/mgplatform/api/apps/v2/token生成的token
当服务商时，调用https://open.microapp.bytedance.com/openapi/v1/oauth/token生成的token
当服务商时，调用https://open.microapp.bytedance.com/openapi/v1/oauth/token生成的token
content-type必填String
示例：application/json
固定值"application/json"
Body
alias_word必填String
小程序别名
请求示例
curl --location --request POST 'https://open.douyin.com/aweme/apps/v1/alias/create_alias/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"alias_word":"我的小程序"}'
响应参数
Body
err_msg必填String
err_no必填Int32
示例：0
0表示成功
log_id必填String
示例：20231121203305587490xxxxxxxxxxx
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "", "log_id": "20231123151528931BC5537xxxx" }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28001003 | access_token无效 | 检查access_token合法性 |
| 200 | 28001005 | 系统内部错误 | 建议重试 |
| 200 | 28001006 | 网络调用错误 | 建议重试 |
| 200 | 28001007 | 参数不合法 | 检查参数合法性 |
| 200 | 28001008 | access_token过期 | 刷新或重新授权 |
| 200 | 28001018 | 应用未获得该能力 | 引导商家授予相关权限集 |
| 200 | 28005079 | 请求IP不在第三方应用IP地址白名单内 | 添加IP地址到白名单内或者配置白名单为空 |
