# 配置小程序服务器域名

调试工具

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

modifyServerDomain

# 功能描述

授权给第三方的小程序，其服务器域名只可以为在第三方平台账号中配置的小程序服务器域名，当小程序通过第三方平台发布代码上线后，小程序原先自己配置的服务器域名将被删除，只保留第三方平台的域名，所以第三方平台在代替小程序发布代码之前，需要调用接口为小程序添加第三方平台自身的域名。
使用过程中如遇到问题，可在开放平台服务商专区发帖交流

# 注意事项

需要先将域名登记到第三方平台的小程序服务器域名中，才可以调用接口进行配置。
Request域名、Socket域名、Uploadfile域名、Download域名、Udp域名、tcp的设置数量均最大支持200个
每月可提交修改申请50次
可以配置端口，如 https://myserver.com:8080，但是配置后只能向 https://myserver.com:8080 发起请求。如果向 https://myserver.com、https://myserver.com:9091 等 URL 请求则会失败。
域名必须经过 ICP 备案
不支持填写ip地址，要用域名
api.weixin.qq.com 不能被配置为服务器域名

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/wxa/modify_domain?access_token=ACCESS_TOKEN

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：18
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用authorizer_access_token
action	string	是	操作类型
requestdomain	array<string>	是	request 合法域名；当 action 是 get 时不需要此字段
wsrequestdomain	array<string>	是	socket 合法域名；当 action 是 get 时不需要此字段
uploaddomain	array<string>	是	uploadFile 合法域名；当 action 是 get 时不需要此字段
downloaddomain	array<string>	是	downloadFile 合法域名；当 action 是 get 时不需要此字段
udpdomain	array<string>	是	udp 合法域名；当 action 是 get 时不需要此字段
tcpdomain	array<string>	是	tcp 合法域名；当 action 是 get 时不需要此字段

# 返回参数

属性	类型	说明
errcode	number	返回码
errmsg	string	错误信息
requestdomain	array<string>	request 合法域名
wsrequestdomain	array<string>	socket 合法域名
uploaddomain	array<string>	uploadFile 合法域名
downloaddomain	array<string>	downloadFile 合法域名
udpdomain	array<string>	udp 合法域名
tcpdomain	array<string>	tcp 合法域名
invalid_requestdomain	array<string>	request 不合法域名
invalid_wsrequestdomain	array<string>	socket 不合法域名
invalid_uploaddomain	array<string>	uploadFile 不合法域名
invalid_downloaddomain	array<string>	downloadFile 不合法域名
invalid_udpdomain	array<string>	udp 不合法域名
invalid_tcpdomain	array<string>	tcp 不合法域名
no_icp_domain	array<string>	没有经过icp备案的域名

# 其他说明

# action 操作类型可选值

可选值	说明
add	添加
delete	删除
set	覆盖
get	获取

# 调用示例

示例说明: 设置服务器域名

# 请求数据示例


{
  "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": 85303,
    "errmsg": "no domain to modify after filtered, please confirm the domain has been set in miniprogram or open, and follows the rule of domains. Besides, please confirm all domains have ICP licenses",
    "requestdomain": [],
    "wsrequestdomain": [],
    "uploaddomain": [],
    "downloaddomain": [],
    "udpdomain": [],
    "tcpdomain": [],
    "invalid_requestdomain": [],
    "invalid_wsrequestdomain": [
        "wss://melody.weixin.melody44.com"
    ],
    "invalid_uploaddomain": [
        "https://melody.weixin.melody33.com"
    ],
    "invalid_downloaddomain": [],
    "invalid_udpdomain": [
        "udp://melody.weixin.melody22.com"
    ],
    "invalid_tcpdomain": [
        "tcp://melody.weixin.melody22.com"
    ],
    "no_icp_domain": [
        "https://melody.weixin.melody.com:443"
    ]

# 错误码

错误码	错误码取值	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
40014	invalid access_token	不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口
85015	该账号不是小程序账号	该账号不是小程序账号
85017	no domain to modify after filtered please confirm the domain has been set in miniprogram or open	域名输入为空，或者没有新增域名，请确认小程序已经添加了域名或该域名是否没有在第三方平台添加
85018	域名没有在第三方平台设置
85301	no domain to modify after filtered, please confirm the domain has been set in miniprogram or open, and follows the rule of domains；存在 “不符合域名规则的域名”导致无修改。
85302	o domain to modify after filtered, please confirm all domains have ICP licenses；存在 “ 缺少ICP备案的域名”导致无修改
85303	no domain to modify after filtered, please confirm the domain has been set in miniprogram or open, and follows the rule of domains. Besides, please confirm all domains have ICP licenses；同时存在“不符合域名规则的域名”以及“ 缺少ICP备案的域名”导致无修改。