# 设置第三方平台服务器域名
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：modifyThirdpartyServerDomain
本接口用于配置第三方平台小程序服务器域名。
授权给第三方代开发的小程序，其服务器域名只可以为在第三方平台账号中配置的小程序服务器域名。即调用接口设置小程序服务器域名之前可以调本接口先进行第三方平台小程序服务器域名配置。
使用过程中如遇到问题，可在开放平台服务商专区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/component/modify_wxa_server_domain?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口仅支持第三方平台使用 component_access_token 自己调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，可使用 component_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| action | string | 是 | 操作类型。可选值请看下文 |
| wxa_server_domain | string | 否 | 最多可以添加1000个服务器域名，以;隔开。注意：域名不需带有http:// 等协议内容，也不能在域名末尾附加详细的 URI 地址，严格按照类似 www.qq.com 的写法。 |
| is_modify_published_together | boolean | 否 | 是否同时修改“全网发布版本的值”。（false：只改“测试版”；true：同时改“测试版”和“全网发布版”）省略时，默认为false。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 返回码 |
| errmsg | string | 错误信息 |
| published_wxa_server_domain | string | 目前生效的 “全网发布版”第三方平台“小程序服务器域名”。如果修改失败，该字段不会返回。如果没有已发布的第三方平台，该字段也不会返回。 |
| testing_wxa_server_domain | string | 目前生效的 “测试版”第三方平台“小程序服务器域名”。如果修改失败，该字段不会返回 |
| invalid_wxa_server_domain | string | 未通过验证的域名。如果不存在未通过验证的域名，该字段不会返回。 |
# 4. 注意事项
每月只可修改申请50次。
# 其他说明
# action 可选值
| 可选值 | 说明 |
|---|---|
| add | 添加 |
| delete | 删除 |
| set | 覆盖 |
| get | 获取 |
# 5. 代码示例
# 5.1 POST 数据示例 1
请求示例
{
"action": "get"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_server_domain": "www.qq.com;wx.qq.com",
"testing_wxa_server_domain": "www.qq.com;wx.qq.com",
}
# 5.2 POST 数据示例 2
请求示例
{
"action": "set",
"is_modify_published_together": false,
"wxa_server_domain": "www.qq.com;wx.qq.com"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_server_domain": "www.qq.com;wx.qq.com",
"testing_wxa_server_domain": "www.qq.com;wx.qq.com",
}
# 5.3 POST 数据示例 3
请求示例
{
"action": "add",
"is_modify_published_together": true,
"wxa_server_domain": "www.qq.com;wx.qq.com"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_server_domain": "www.qq.com;wx.qq.com",
"testing_wxa_server_domain": "www.qq.com;wx.qq.com",
}
# 5.4 POST 数据示例 4
请求示例
{
"action": "delete",
"is_modify_published_together": false,
"wxa_server_domain": "www.qq.com;wx.qq.com"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_server_domain": "www.qq.com;wx.qq.com",
"testing_wxa_server_domain": "www.qq.com;wx.qq.com",
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40039 | invalid url size | 不合法的 URL 长度 |
| 40052 | invalid action name | |
| 45104 | reach max domain quota limit | 每个月只可以修改50次，超次数了 |
| 61028 | 第三方平台未发布 | 第三方平台未发布 |
| 65316 | domain count reach limit | 该公众号的菜单设置了过多的域名外跳（最多跳转到 3 个域名的链接） |
| 9410016 | 存在无效域名。具体原因见errmsg（可能有多种原因）。 |
# 7. 适用范围
本接口支持「第三方平台」账号类型调用。其他账号类型如无特殊说明，均不可调用。