# 设置第三方平台业务域名
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
modifyThirdpartyJumpDomain
# 功能描述
本接口用于配置第三方平台小程序业务域名。
配置业务域名时,需要将校验文件放置在域名根目录下,例如wx.qq.com,并确保可以访问该文件。可以通过获取第三方小程序业务域名的校验文件接口获取检验文件。
授权给第三方代开发的小程序,其业务域名只可以为在第三方平台账号中配置的小程序业务域名。即调用接口设置小程序业务域名之前可以调本接口先进行第三方平台小程序业务域名配置。
使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/component/modify_wxa_jump_domain?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用component_access_token |
action | string | 是 | 操作类型。可选值请看下文 |
wxa_jump_h5_domain | string | 否 | 最多可以添加200个小程序业务域名,以;隔开。注意:域名不需带有http:// 等协议内容,也不能在域名末尾附加详细的 URI 地址,严格按照类似 www.qq.com 的写法。 |
is_modify_published_together | boolean | 否 | 是否同时修改“全网发布版本的值”。(false:只改“测试版”;true:同时改“测试版”和“全网发布版”)省略时,默认为false。 |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 返回码 |
errmsg | string | 错误信息 |
published_wxa_jump_h5_domain | string | 目前生效的 “全网发布版”第三方平台“小程序业务域名”。如果修改失败,该字段不会返回。如果没有已发布的第三方平台,该字段也不会返回。 |
testing_wxa_jump_h5_domain | string | 目前生效的 “测试版”第三方平台“小程序业务域名”。如果修改失败,该字段不会返回 |
invalid_wxa_jump_h5_domain | string | 未通过验证的域名。如果不存在未通过验证的域名,该字段不会返回。 |
# 调用示例
示例说明: POST 数据示例 1:
# 请求数据示例
{
"action": "get"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
"testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}
示例说明: POST 数据示例 2:
# 请求数据示例
{
"action": "set",
"is_modify_published_together": false,
"wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
"testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}
示例说明: POST 数据示例 3:
# 请求数据示例
{
"action": "add",
"is_modify_published_together": true,
"wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
"testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}
示例说明: POST 数据示例 4:
# 请求数据示例
{
"action": "delete",
"is_modify_published_together": false,
"wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"published_wxa_jump_h5_domain": "www.qq.com;wx.qq.com",
"testing_wxa_jump_h5_domain": "www.qq.com;wx.qq.com"
}
# 错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
61028 | 第三方平台未发布 | 第三方平台未发布 |
65316 | domain count reach limit 第三方平台业务域名配置已达200个 | 第三方平台小程序业务域名最多200个,不能再新增了,只能删除旧的不使用的域名再新增。 |
9410016 | 存在无效域名。具体原因见errmsg(可能有多种原因)。 | |
40052 | invalid action name | action值有误 |
40039 | invalid url size | 不合法的 URL 长度 |