邮局开放API文档

API列表

POST 查询服务列表

POST /mailcloud/qqy/query

{
    "domainName": "wj",
    "startTime": "2024-03-01",
    "overTime": "2024-03-31",
    "state": "01"
}

请求参数 - POST 查询服务列表

名称	位置	类型	必选	说明
domainName	body	string	否	域名模糊查询
startTime	body	string	否	到期日期起始值，格式yyyy-MM-dd
overTime	body	string	否	到期日期结束值，格式yyyy-MM-dd
state	body	string	否	服务状态：00-待绑定，01-服务期，02-续费期，03-已过期

{
    "status": true,
    "code": "200",
    "res": {
        "data": [
            {
                "domainName": "wjzyy12.com",
                "agentCode": "agent5648685",
                "serviceCode": "M_QQY92735042459118",
                "mailType": "bz",
                "spaceSize": 365,
                "userCount": 8,
                "cloudSize": 10,
                "fileSize": 20,
                "startTime": "2023-03-23",
                "endTime": "2024-03-23",
                "buyTime": "2023-03-23",   
                "state": "01",             
                "userEmail": "wujun@xinnet.com"
            }
        ],
        "totalCount": 1
    }
}

返回结果 - POST 查询服务列表

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 查询服务列表

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	[object]	true	none	返回参数
»» totalCount	integer	true	none	服务列表总数
»» data	[object]	true	none	服务列表
»»» domainName	string	false	none	域名
»»» agentCode	string	false	none	用户编号
»»» serviceCode	string	false	none	服务编号
»»» mailType	string	false	none	产品类型：bz-全球邮标准版，wm-全球邮外贸版，pro-全球邮pro版
»»» spaceSize	integer	false	none	单用户空间，单位GB
»»» userCount	integer	false	none	用户数
»»» cloudSize	integer	false	none	云盘空间，单位GB
»»» fileSize	integer	false	none	归档空间，单位GB
»»» state	string	false	none	服务状态：00-待绑定，01-服务期，02-续费期，03-已过期
»»» startTime	string	false	none	服务开通时间，格式yyyy-MM-dd，无该属性表示服务状态为待绑定
»»» endTime	string	false	none	服务到期时间，格式yyyy-MM-dd
»»» buyTime	string	false	none	服务购买时间，格式yyyy-MM-dd
»»» userEmail	string	false	none	联系人邮箱

POST 获取服务详情

POST /mailcloud/qqy/get

请求参数 - POST 获取服务详情

{
    "domainName": "wj-dlqqy-01.com"
}

请求参数 - POST 获取服务详情 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名

{
    "status": true,
    "code": "200",
    "res": {
        "domainName": "wj-dlqqy-01.com",
        "agentCode": "agent5648685",
        "serviceCode": "QQY81427839242435",
        "mailType": "bz",
        "spaceSize": 365,
        "userCount": 10,
        "cloudSize": 10,
        "fileSize": 0,
        "state": "01", 
        "startTime": "2024-05-20",
        "endTime": "2026-05-20",
        "buyTime": "2024-05-20",               
        "userEmail": "wujun@xinnet.com",
        "status": "0"
    }
}

返回结果 - POST 获取服务详情

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取服务详情

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	[object]	true	none	返回参数
»» domainName	string	false	none	域名
»» agentCode	string	false	none	用户编号
»» serviceCode	string	false	none	服务编号
»» mailType	string	false	none	产品类型：bz-全球邮标准版，wm-全球邮外贸版，pro-全球邮pro版
»» spaceSize	integer	false	none	单用户空间，单位GB
»» userCount	integer	false	none	用户数
»» cloudSize	integer	false	none	云盘空间，单位GB
»» fileSize	integer	false	none	归档空间，单位GB
»» state	string	false	none	服务状态：00-待绑定，01-服务期，02-续费期，03-已过期
»» startTime	string	false	none	服务开通时间，格式yyyy-MM-dd，无该属性表示服务状态为待绑定
»» endTime	string	false	none	服务到期时间，格式yyyy-MM-dd
»» buyTime	string	false	none	服务购买时间，格式yyyy-MM-dd
»» userEmail	string	false	none	联系人邮箱
»» status	string	false	none	锁定状态：0-未锁定，1-锁定

POST 获取新开价格

POST /mailcloud/qqy/getBuyPrice

请求参数 - POST 获取新开价格

{
    "mailType": "bz",
    "userCount": 5,
    "timeAmount": 1
}

请求参数 - POST 获取新开价格 2

名称	位置	类型	必选	说明
mailType	body	string	是	产品类型：bz-全球邮标准版，wm-全球邮外贸版，pro-全球邮pro版
userCount	body	integer	是	用户数，最小值5
timeAmount	body	integer	是	时长，单位年，范围1-10

{
    "status": true,
    "code": "200",
    "res": 1000.0
}

返回结果 - POST 获取新开价格

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取新开价格

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	number	true	none	价格

POST 获取续费价格

POST /mailcloud/qqy/getRenewPrice

请求参数 - POST 获取续费价格

{
    "domainName": "wj-dlqqy-01.com",
    "timeAmount": 1
}

请求参数 - POST 获取续费价格 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
timeAmount	body	integer	是	时长，单位年，范围1-10

{
    "status": true,
    "code": "200",
    "res": 2000.0
}

返回结果 - POST 获取续费价格

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取续费价格

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	number	true	none	价格

POST 获取扩容价格

POST /mailcloud/qqy/getExpandPrice

请求参数 - POST 获取扩容价格

{
    "domainName": "wj-dlqqy-01.com",
    "userCount": 1,
    "cloudSize": 1,
    "fileSize": 1
}

请求参数 - POST 获取扩容价格 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
userCount	body	integer	否	扩容用户数（增量）
cloudSize	body	integer	否	扩容云盘空间数（增量），单位10GB（1代表10GB）
fileSize	body	integer	否	扩容归档空间数（增量），单位10GB（1代表10GB）

{
    "status": true,
    "code": "200",
    "res": 480.0
}

返回结果 - POST 获取扩容价格

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取扩容价格

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	number	true	none	价格

POST 获取升级价格

POST /mailcloud/qqy/getUpgradePrice

请求参数 - POST 获取升级价格

{
    "domainName": "wj-dlqqy-01.com",
    "newMailType": "wm"
}

请求参数 - POST 获取升级价格 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
newMailType	body	string	是	新产品类型：wm-全球邮外贸版，pro-全球邮pro版

注：bz可以升级到wm或pro，wm只能升级到pro

{
    "status": true,
    "code": "200",
    "res": 0.0
}

返回结果 - POST 获取升级价格

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取升级价格

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	number	true	none	价格

POST 能否新开(能否开通)

POST /mailcloud/qqy/canBuy

请求参数 - POST 能否新开(能否开通)

{
    "domainName": "wj-dlqqy-01.com"
}

请求参数 - POST 能否新开(能否开通) 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名

{
    "status": true,
    "code": "200",
    "res": true
}

返回结果 - POST 能否新开(能否开通)

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 能否新开(能否开通)

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	boolean	true	none	能否新开：true-能，false-不能
» msg	string	false	none	不能新开的原因

注：当新开的autoOpen参数为true(默认)时，本接口在新开前调用，否则在开通前调用。

POST 新开(购买)

POST /mailcloud/qqy/buy

请求参数 - POST 新开(购买)

# 自动开通
{
    "mailType": "bz",
    "userCount": 5,
    "timeAmount": 1,
    "domainName": "wj-dlqqy-02.com",
    "companyName": "wj",
    "userEmail": "wujun@xinnet.com"
}
# 非自动开通
{
    "mailType": "bz",
    "userCount": 5,
    "timeAmount": 1,
    "autoOpen": false
}

请求参数 - POST 新开(购买) 2

名称	位置	类型	必选	说明
mailType	body	string	是	产品类型：bz-全球邮标准版，wm-全球邮外贸版，pro-全球邮pro版
userCount	body	integer	是	用户数，最小值5
timeAmount	body	integer	是	时长，单位年，范围1-10
autoOpen	body	boolean	否	是否自动开通：true-自动开通，false-非自动开通，默认为true
domainName	body	string	否	域名，当autoOpen为true时，必选
companyName	body	string	否	公司名称，默认为用户编号
userEmail	body	string	否	联系邮箱，默认为注册用户时填写的邮箱

# 自动开通
{
    "status": true,
    "code": "200",
    "res": {
        "serviceCode": "QQY86679656246617",
        "adminPassword": "n9n4k5n4"
    }
}
# 非自动开通：
{
    "status": true,
    "code": "200",
    "res": {
        "serviceCode": "QQY95137236185709"
    }
}

返回结果 - POST 新开(购买)

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 新开(购买)

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	[object]	true	none	返回参数
»» serviceCode	string	true	none	服务编号
»» adminPassword	string	false	none	管理员密码，非自动开通时无该属性

注：开通后，管理员账号固定为：admin@，示例：admin@wj-dlqqy-02.com

POST 开通(绑定域名)

POST /mailcloud/qqy/open

请求参数 - POST 开通(绑定域名)

{
    "domainName": "wj-dlqqy-02.com",
    "serviceCode": "QQY43575781329919",
    "companyName": "wj",
    "userEmail": "wujun@xinnet.com"
}

请求参数 - POST 开通(绑定域名) 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
serviceCode	body	string	是	服务编号
companyName	body	string	否	公司名称，默认为用户编号
userEmail	body	string	否	联系邮箱，默认为注册用户时填写的邮箱

{
    "status": true,
    "code": "200",
    "res": {
        "adminPassword": "f6w3d8c9"
    }
}

返回结果 - POST 开通(绑定域名)

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 开通(绑定域名)

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	[object]	true	none	返回参数
»» adminPassword	string	false	none	管理员密码

注：开通后，管理员账号固定为：admin@，示例：admin@wj-dlqqy-02.com

POST 续费

POST /mailcloud/qqy/renew

请求参数 - POST 续费

{
    "domainName": "wj-dlqqy-01.com",
    "timeAmount": 1
}

请求参数 - POST 续费 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
timeAmount	body	integer	是	时长，单位年，范围1-10

{
    "status": true,
    "code": "200"
}

返回结果 - POST 续费

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 续费

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 扩容

POST /mailcloud/qqy/expand

请求参数 - POST 扩容

{
    "domainName": "wj-dlqqy-01.com",
    "userCount": 1,
    "cloudSize": 1,
    "fileSize": 1
}

请求参数 - POST 扩容 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
userCount	body	integer	否	扩容用户数（增量）
cloudSize	body	integer	否	扩容云盘空间数（增量），单位10GB（1代表10GB）
fileSize	body	integer	否	扩容归档空间数（增量），单位10GB（1代表10GB）

注：userCount、cloudSize、fileSize至少有一个不为空

{
    "status": true,
    "code": "200"
}

返回结果 - POST 扩容

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 扩容

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 升级

POST /mailcloud/qqy/upgrade

请求参数 - POST 升级

{
    "domainName": "wj-dlqqy-01.com",
    "newMailType": "wm"
}

请求参数 - POST 升级 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
newMailType	body	string	是	新产品类型：wm-全球邮外贸版，pro-全球邮pro版

注：bz可以升级到wm或pro，wm只能升级到pro

{
    "status": true,
    "code": "200"
}

返回结果 - POST 升级

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 升级

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 减容

POST /mailcloud/qqy/reduce

请求参数 - POST 减容

{
    "domainName": "wj-dlqqy-01.com",
    "userCount": 1,
    "cloudSize": 1,
    "fileSize": 1
}

请求参数 - POST 减容 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
userCount	body	integer	否	减容用户数（增量）
cloudSize	body	integer	否	减容云盘空间数（增量），单位10GB（1代表10GB）
fileSize	body	integer	否	减容归档空间数（增量），单位10GB（1代表10GB）

注1：userCount、cloudSize、fileSize至少有一个不为空；注2：userCount与cloudSize不允许同时减容

{
    "status": true,
    "code": "200"
}

返回结果 - POST 减容

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 减容

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 注销

POST /mailcloud/qqy/delete

请求参数 - POST 注销

{
    "domainName": "wj-dlqqy-01.com"
}

请求参数 - POST 注销 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名

{
    "status": true,
    "code": "200"
}

返回结果 - POST 注销

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 注销

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 变更主域名

POST /mailcloud/qqy/updateDomainName

请求参数 - POST 变更主域名

{
    "domainName": "wj-dlqqy-01.com",
    "newDomainName":"wj-dlqqy-01-gai1.com"
}

请求参数 - POST 变更主域名 2

名称	位置	类型	必选	说明
domainName	body	string	是	旧域名
newDomainName	body	string	是	变更后新域名

{
    "status": true,
    "code": "200"
}

返回结果 - POST 变更主域名

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 变更主域名

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 添加域别名

POST /mailcloud/qqy/addDomainAlias

请求参数 - POST 添加域别名

{
    "domainName": "wjqqy-auto01.com",
    "domainAlias": "wjqqy-auto01-b1.com"
}

请求参数 - POST 添加域别名 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
domainAlias	body	string	是	域别名

注1：最多支持添加5个域别名；注2：只支持添加英文域别名；注3：请先进行域别名所有权验证，通过域名解析平台添加cname别名记录，格式如下： abc.域名 cname abc.global-mail.cn 例如：abc.test.com cname abc.global-mail.cn 一般cname别名解析生效时间不超过48小时，如果添加过解析仍然验证不通过，请稍后重试。

{
    "status": true,
    "code": "200"
}

返回结果 - POST 添加域别名

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 添加域别名

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 删除域别名

POST /mailcloud/qqy/deleteDomainAlias

请求参数 - POST 删除域别名

{
    "domainName": "wjqqy-auto01.com",
    "domainAlias": "wjqqy-auto01-b1.com"
}

请求参数 - POST 删除域别名 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
domainAlias	body	string	是	域别名

{
    "status": true,
    "code": "200"
}

返回结果 - POST 删除域别名

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 删除域别名

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 获取域别名

POST /mailcloud/qqy/getDomainAlias

请求参数 - POST 获取域别名

{
    "domainName": "wjqqy-auto01.com"
}

请求参数 - POST 获取域别名 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名

{
    "status": true,
    "code": "200",
    "res": [
        "wjqqy-auto01-b1.com"
    ]
}

返回结果 - POST 获取域别名

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取域别名

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	array	true	none	域别名数组

POST 获取管理员账号

POST /mailcloud/qqy/getAdminAccounts

请求参数 - POST 获取管理员账号

{
    "domainName": "wjqqy-auto01.com"
}

请求参数 - POST 获取管理员账号 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名

{
    "status": true,
    "code": "200",
    "res": [
        "admin@wjqqy-auto01.com",
        "sysadmin@wjqqy-auto01.com"
    ]
}

返回结果 - POST 获取管理员账号

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取管理员账号

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态：true-成功，false-失败
» code	string	true	none	返回code：200-成功，400-失败
» res	array	true	none	管理员账号数组

POST 重置管理员密码

POST /mailcloud/qqy/resetAdminPassword

请求参数 - POST 重置管理员密码

{
    "domainName": "wjqqy-auto01.com",
    "password": "123456",
    "adminAccount": "admin"
}

请求参数 - POST 重置管理员密码 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名
password	body	string	是	新密码明文
adminAccount	body	string	否	管理员账号(@前面部分)，默认为admin

{
    "status": true,
    "code": "200"
}

返回结果 - POST 重置管理员密码

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 重置管理员密码

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 锁定

POST /mailcloud/qqy/lock

请求参数 - POST 锁定

{
    "domainName": "wj-dlqqy-01.com"
}

请求参数 - POST 锁定 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名

{
    "status": true,
    "code": "200"
}

返回结果 - POST 锁定

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 锁定

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

POST 解锁

POST /mailcloud/qqy/unlock

请求参数 - POST 解锁

{
    "domainName": "wj-dlqqy-01.com"
}

请求参数 - POST 解锁 2

名称	位置	类型	必选	说明
domainName	body	string	是	域名

{
    "status": true,
    "code": "200"
}

返回结果 - POST 解锁

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 解锁

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态：true-成功，false-失败
» code	string	true	none		返回code：200-成功，400-失败

Last modified: 25 April 2026