# 快速设置小程序服务器域名

  • 该接口用于配置小程序服务器域名,不再需要先将域名配置到第三方平台,可通过该接口直接进行配置到授权小程序。但是,配置成功后,需要提交代码或者发布上线后才会真正生效通过该接口配置的域名。
  • 使用之前请详细查看代开发的小程序域名配置说明
  • 使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

注意:

使用说明:

1、由于一个小程序帐号的域名可以通过公众平台配置、可以通过modify_domain接口配置,也可以通过改接口进行配置;但如果是通过modify_domain接口配置的域名会在发布环节做一些处理

2、因此,为了方便开发者更好理解不同渠道配置的域名最后生效的效果是如何的,可通过get_effective_domain接口获取“effective_domaian”信息,确保无误之后再进行代码发布操作。

# 请求地址

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

# 请求参数说明

参数 类型 必填 说明
access_token string 第三方平台接口调用令牌authorizer_access_token
action string 操作类型
requestdomain string array request 合法域名;当 action 是 get 时不需要此字段
wsrequestdomain string array socket 合法域名;当 action 是 get 时不需要此字段
uploaddomain string array uploadFile 合法域名;当 action 是 get 时不需要此字段
downloaddomain string array downloadFile 合法域名;当 action 是 get 时不需要此字段
udpdomain string array udp 合法域名;当 action 是 get 时不需要此字段
tcpdomain string array tcp 合法域名;当 action 是 get 时不需要此字段

# action 可选值

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

POST 数据示例:

{
  "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 number 返回码
errmsg string 错误信息

返回结果示例:


{
    "errcode": 0,
    "errmsg": "ok"
}

# 返回码说明

errcode errmsg 说明
0 ok 成功
85015 该账号不是小程序账号
86100 invalid url protocol 该 URL 的协议头有误
45082 need icp license for the url domain 域名需要 icp 备案,否则无法添加
86101 不支持配置api.weixin.qq.com
85016 exceed valid domain count 域名数量超限制
86102 每个月只能修改50次,超过域名修改次数限制
其他错误码 请查看全局错误码