# 快速配置小程序服务器域名
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:modifyServerDomainDirectly
- 该接口用于配置小程序服务器域名,不再需要先将域名配置到第三方平台,可通过该接口直接进行配置到授权小程序。但是,配置成功后,需要发布上线后才会真正生效通过该接口配置的域名。另外,开发者可通过接口获取发布后生效服务器域名列表看生效情况
- 使用之前请详细查看代开发的小程序域名配置说明
- 使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/modify_domain_directly?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:18
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| action | string | 是 | 操作类型 |
| requestdomain | array | 是 | request 合法域名;当 action 是 get 时不需要此字 |
| wsrequestdomain | array | 是 | socket 合法域名;当 action 是 get 时不需要此字段 |
| uploaddomain | array | 是 | uploadFile 合法域名;当 action 是 get 时不需要此字段 |
| downloaddomain | array | 是 | downloadFile 合法域名;当 action 是 get 时不需要此字段 |
| udpdomain | array | 是 | udp 合法域名;当 action 是 get 时不需要此字段 |
| tcpdomain | array | 是 | tcp 合法域名;当 action 是 get 时不需要此字段 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
- 由于该接口是直接为小程序账号配置服务器域名,所以相关的规则限制对齐普通小程序,详情可查看小程序网络使用说明
- 由于当前有两种方式可以为第三方代开发小程序配置域名,在调用该接口之前,请先查看详细的业务逻辑说明,以免出现误操作。详情可查看代开发的小程序域名配置说明
- 使用该接口为一个小程序配一次即可,下次审核代码不用重复set配置之前已配置过的域名 (之前通过该API配置的旧域名上线成功后不要重新set,否则需要重新发布生效,如需新增用add) ,与在mp的配置一样。 如需add,先get获取目前配置的域名,再根据业务需要新增此次需要配置的新域名,不需要再增加已存在的域名;delete前也可以先get获取下,再操作delete。
使用说明:
1、由于一个小程序账号的域名可以通过公众平台配置、可以通过modify_domain接口配置,也可以通过该接口进行配置;但如果是通过modify_domain接口配置的域名会在发布环节做一些处理
2、因此,为了方便开发者更好理解不同渠道配置的域名最后生效的效果是如何的,可通过get_effective_domain接口获取“effective_domaian”信息,确保无误之后再进行代码发布操作。
# 其他说明
# action 可选值
| 可选值 | 说明 |
|---|---|
| add | 添加 |
| delete | 删除 |
| set | 覆盖 |
| get | 获取 |
# 5. 代码示例
请求示例
{
"action": "add",
"requestdomain": [
"https://www.qq.com",
"https://www.qq.com"
],
"wsrequestdomain": [
"wss://www.qq.com",
"wss://www.qq.com"
],
"uploaddomain": [
"https://www.qq.com",
"https://www.qq.com"
],
"downloaddomain": [
"https://www.qq.com",
"https://www.qq.com"
],
"udpdomain": [
"udp://melody.weixin.melody.com"
],
"tcpdomain": [
"tcp://melody.weixin.melody.com"
]
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 0 | ok | ok |
| 45082 | need icp license for the url domain | |
| 85015 | 该账号不是小程序账号 | 该账号不是小程序账号 |
| 85016 | exceed valid domain count | 域名数量超限制 |
| 86100 | invalid url protocol | 该URL的协议头有误 |
| 86101 | 不支持配置api.weixin.qq.com | |
| 86102 | 每个月只能修改50次,超过域名修改次数限制 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。