修改服务器域名

我的收藏

接口介绍

该接口用于第三方小程序应用为授权小程序修改服务器域名（request、socket、upload、download 域名）。

请求

基本信息

基本
`HTTP URL`	`https://open.microapp.bytedance.com/openapi/v1/microapp/app/modify_server_domain`
`HTTP Method`	`POST`
`权限要求`	授权小程序授予基本信息设置权限

查询参数

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

请求体（json）

参数名	参数类型	是否必须	备注
`action`	`string`	是	add 添加，delete 删除，set 覆盖，get 获取
`request`	`Array<string>`	否	action 为 get 可不填
`socket`	`Array<string>`	否	action 为 get 可不填
`upload`	`Array<string>`	否	action 为 get 可不填
`download`	`Array<string>`	否	action 为 get 可不填

请求体示例

{
  "action": "add",
  "request": ["www.xxx.com", "www.xxx.com"]
}

响应

响应体

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

响应体示例

{
  "errno": 0,
  "message": "success",
  "data": {
    "request": ["www.xxx.com", "www.xxx.com"],
    "socket": ["www.xxx.com", "www.xxx.com"],
    "upload": ["www.xxx.com", "www.xxx.com"],
    "download": ["www.xxx.com", "www.xxx.com"]
  }
}

注意：

action 为 get 时， data 里面的 request，socket，upload，download 列表才有内容，否则无 data 字段。
action 不是 get 时，入参中的服务器域名需要在第三方小程序应用的服务器域名列表内或者是第三方小程序应用服务器域名的子域名。
接口会对入参中的域名进行去重处理，所以有时候即使传了参数还是可能会报 40026（至少传递一个要被操作的域名类型）错误。

错误码

错误码	message
40001	参数错误
40003	找不到相关第三方小程序应用
40004	找不到相关授权小程序
40020	第三方小程序应用 authorizer_access_token 不正确或者已过期
40023	域名不是第三方小程序应用已设置的域名或子域名
40024	域名数量超过限制，最多设置 20 个
40026	至少传递一个要被操作的域名类型
40027	域名不能包含协议，不能是 IP 地址，不支持端口
40028	无法删除域名，请确认授权小程序已经添加了域名
40036	授权小程序未授予该接口对应的权限

上一篇：补充服务类目资质信息

下一篇：修改 webview 域名