# 获取发布后生效业务域名列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getEffectiveJumpDomain
- 该接口用于获取通过旧接口以及新接口配置的业务域名在发布上线后真实生效的域名列表。
- 使用之前请详细查看代开发的小程序域名配置说明
- 使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/get_effective_webviewdomain?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:18
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| mp_webviewdomain | array | 通过公众平台配置的服务器域名列表 |
| third_webviewdomain | array | 通过第三方平台接口modifyJumpDomain 配置的业务域名 |
| direct_webviewdomain | array | 通过modifyJumpDomainDirectly接口配置的业务域名列表 |
| effective_webviewdomain | array | 最后提交代码或者发布上线后生效的域名列表 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
POST https://api.weixin.qq.com/wxa/get_effective_webviewdomain?access_token=COMPONENT_ACCESS_TOKEN
返回示例
{
"errcode": 0,
"errmsg": "ok",
"mp_webviewdomain": [
"https://a.b.howielu.top",
"https://developers.weixin.qq.com",
"https://melody2.howielu.top/"
],
"third_webviewdomain": [
"https://a.b.howielu.top",
"https://developers.weixin.qq.com",
"https://melody2.howielu.top/"
],
"direct_webviewdomain": [
"https://melody2.howielu.top/"
],
"effective_webviewdomain": [
"https://a.b.howielu.top",
"https://developers.weixin.qq.com",
"https://melody2.howielu.top/"
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。