第三方平台
接口说明

修改 webview 域名

接口介绍

该接口用于第三方应用为授权小程序修改业务域名(webview 域名)。

请求

基本信息

基本
HTTP URLhttps://open.microapp.bytedance.com/openapi/v1/microapp/app/modify_webview_domain
HTTP MethodPOST
权限要求授权小程序授予基本信息设置权限

查询参数

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

请求体(json)

参数名参数类型是否必须备注
actionstringadd 添加,delete 删除,set 覆盖,get 获取
webviewArray<string>action 为 get 可不填

请求体示例

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

响应

响应体

参数名参数类型备注
errnoint错误码
messagestring错误信息
dataArray<string>

响应体示例

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

注意

  • action 为 get 时, data 里面才有内容,否则无 data 字段。
  • action 不是 get 时,入参中的 webview 域名需要在第三方应用的 webview 域名列表内或者是第三方应用 webview 域名的子域名。所以建议提前在第三方平台设置好 webview 域名。
  • 接口会对入参中的域名进行去重处理,所以有时候即使传了参数还是可能会报 40026(至少传递一个要被操作的域名类型)错误。

错误码

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