# 配置小程序业务域名
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
modifyJumpDomain
# 功能描述
- 授权给第三方的小程序,其业务域名只可以为在第三方平台账号中配置的小程序业务域名,当小程序通过第三方发布代码上线后,小程序原先自己配置的业务域名将被删除,只保留第三方平台的域名,所以第三方平台在代替小程序发布代码之前,需要调用接口为小程序添加业务域名。
- 使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 注意事项
- 需要先将业务域名登记到第三方平台的小程序业务域名中,才可以调用接口进行配置。
- 为授权的小程序配置域名时支持配置子域名,例如第三方登记的业务域名如为 qq.com,则可以直接将 qq.com 及其子域名(如 xxx.qq.com)也配置到授权的小程序中。如此类推,例如第三方登记的业务域名如为 xxx.qq.com,则可以直接将 xxx.qq.com 及其子域名(如 yyy.xxx.qq.com)也配置到授权的小程序中。
- 最多可以添加300个业务域名。
- 仅支持https
- 业务域名中不能含有端口号
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/setwebviewdomain?access_token=ACCESS_TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:18
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用authorizer_access_token |
action | string | 否 | 操作类型,如果没有指定 action,则默认将第三方平台登记的小程序业务域名全部添加到该小程序 |
webviewdomain | array<string> | 否 | 小程序业务域名,当 action 参数是 get 时不需要此字段 |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 返回码 |
errmsg | string | 错误信息 |
# 其他说明
# action 可选值
可选值 | 说明 |
---|---|
add | 添加 |
delete | 删除 |
set | 覆盖 |
get | 获取 |
# 调用示例
示例说明: 设置业务域名
# 请求数据示例
{
"action": "add",
"webviewdomain": ["https://www.qq.com", "https://m.qq.com"]
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok"
}
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
89019 | webview domain not change | 业务域名无更改,无需重复设置 |
89020 | open's webview domain is null! Need to set open's webview domain first! | 尚未设置小程序业务域名,请先在第三方平台中设置小程序业务域名后在调用本接口 |
89021 | request domain is not open's webview domain! | 请求保存的域名不是第三方平台中已设置的小程序业务域名或子域名 |
89231 | not support single | 个人小程序不支持调用 setwebviewdomain 接口 |
89029 | 业务域名数量超过限制,最多可以添加300个业务域名 |