版本更新说明

版本号: 2.0.0

版本号	修改点说明	变更日期
2.0.1	增加获取开通业务价格（注是您代理成本及我司直接售价）	2022-10-14

公共分类

1、检查邮局是否可以注册

基本信息

Path： /mail/?act=check

Method： GET

接口描述：

used:true 允许开通

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	west.cn	域名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ used	boolean	非必须		是否允许开通

2、开通企业邮局

基本信息

Path： /mail/?act=create

Method： GET

接口描述：

{
  "result": 200,
  "clientid": "2021010509542353232",
  "data": {
    "domain": "westly.com",
    "buydate": "2021-01-05 09:54:23",
    "expiredate": "2021-02-05 09:54:23",
    "status": 2
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	west.cn	邮箱域名
passwd	是	passwd	邮局密码
alreadypay	是	1	开通月份。必须大于3个月
postnum	是	5	用户数>5
extend_disksize	否	0	额外增加个人网盘（默认5G/用户）
extend_sharedisk	否	0	额外增加企业网盘(默认10G)
extend_tempdisk	否	0	额外增加中转网盘(默认50G)
ppricetemp	是	100	开通价格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ domain	string	非必须		邮局名称
├─ buydate	string	非必须		开通时间
├─ expiredate	string	非必须		到期时间
├─ status	number	非必须		邮局状态（2为正常）

3、企业邮局续费

基本信息

Path： /mail/?act=renew

Method： GET

接口描述：

{
  "result": 200,
  "clientid": "2021010510133024376",
  "data": {
    "domain": "westly.com",
    "buydate": "2021-01-05 09:54:23",
    "expiredate": "2021-08-05 09:54:23",
    "status": 2,
  "postnum":5
  }

}

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	west.com	企业邮局
alreadypay	是	3	最低3个月
ppricetemp	是	100	续费价格，只用作比对成本

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ domain	string	非必须
├─ buydate	string	非必须
├─ expiredate	string	非必须
├─ status	number	非必须
├─ postnum	number	非必须

4、企业邮局升级

基本信息

Path： /mail/?act=upgrade

Method： GET

接口描述：

{
  "result": 200,
  "clientid": "2021010510212005600",
  "data": {
    "domain": "westly.com",
    "buydate": "2021-01-05 09:54:23",
    "expiredate": "2021-08-05 09:54:23",
    "status": 2
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	west.com	邮局域名
postnum	是	10	用户数
ppricetemp	是	10	升级费用

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ domain	string	非必须		邮局
├─ buydate	string	非必须		开通时间
├─ expiredate	string	非必须		到期时间
├─ status	number	非必须		状态
├─ postnum	number	必须		用户数

5、云邮局暂停/恢复

基本信息

Path： /mail/?act=status

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	west.com	邮局域名
status	是	0/1	0恢复1暂停

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ domain	string	非必须
├─ buydate	string	非必须
├─ expiredate	string	非必须
├─ status	number	非必须
├─ postnum	number	非必须

6、获取企业邮局信息

基本信息

Path： /mail/?act=info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	westly.com	企业邮局内容

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ domain	string	非必须		邮局域名
├─ proid	string	非必须		产品型号
├─ buydate	string	非必须		开通时间
├─ expiredate	string	非必须		到期时间
├─ passwd	string	非必须		密码
├─ status	number	非必须		状态
├─ free	boolean	非必须		false-基础版,true=专业版
├─ postsize	number	非必须		邮箱大小(单位G)
├─ postnum	number	非必须		邮箱帐号
├─ disksize	number	非必须		人个网盘(G)
├─ sharedisk	number	非必须		共享网盘单位G，默认值:邮局用户数×1G
├─ tempdisk	number	非必须		中转站单位G，默认值:10G

7、修改邮局密码

基本信息

Path： /mail/?act=chgpwd

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	westly.com	企业邮局内容
passwd	是	xxxxx

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须

8、同步数据

基本信息

Path： /mail/?act=syn

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
para	是	域名/编号	域名/编号 为编号时查询此编号后100个邮局

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object []	非必须			item 类型: object
├─ domain	string	必须		邮箱帐号
├─ proid	string	必须		型号
├─ buydate	string	必须		开通时间
├─ expiredate	string	必须		到期时间
├─ passwd	null,string	必须		密码
├─ status	number	必须		状态
├─ free	boolean	必须		true:基础版 false专业版
├─ postsize	null,number	必须		邮箱大小
├─ postnum	null,number	必须		帐号数量
├─ disksize	null,number	必须		人个网盘 单位G，默认值:5G
├─ sharedisk	null,number	必须		共享网盘默认值:邮局用户数×1G
├─ tempdisk	null,number	必须		中转站单位G，默认值:10G

9、检查邮局密码是否合格

基本信息

Path： /mail/?act=checkpwd

Method： GET

接口描述：

{
  "result": 200,
  "clientid": "2021012020081502927",
  "data": {
    "isused": true,
    "msg": "通过"
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	west.cn	域名
passwd	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ isused	boolean	非必须		是否允许
├─ msg	string	非必须

10、获取邮局开通价格

基本信息

Path： /mail/?act=getprice

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
postnum	是	5	用户数>5
alreadypay	是	3	开通月份。必须大于3个月
extend_disksize	是	0	额外个人网盘
extend_tempdisk	是	0	额外中转网盘
extend_sharedisk	是	0	额外企业网盘

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ postsize	string	非必须		0为不限
├─ tempdisk	string	非必须		中转网盘
├─ disksize	string	非必须		个人网盘
├─ sharedisk	number	非必须		企业网盘
├─ freepricedis	string	非必须		折扣
├─ needprice	number	非必须		成本价
├─ costprice	number	非必须		售价
├─ postnum	number	非必须		用户数
├─ alreadypay	number	非必须		时间(月)
├─ extend_disksize	string	非必须		额外个人网盘
├─ extend_tempdisk	string	非必须		额外中转网盘
├─ extend_sharedisk	string	非必须		额外企业网盘
├─ firstbuy	number	非必须		是否首次购买

11、获取邮局域名备案码

基本信息

Path： /mail/?act=beiancode

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	west.cn	邮箱 域名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object []	非必须			item 类型: object
├─ code	string	非必须		备案码
├─ status	string	非必须		0：可用，>=1已使用

12、获取邮局升级价格

基本信息

Path： /mail/?act=upgradeprice

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	test.com	邮局 域名
postnum	是	5	用户数>5
extend_disksize	是	0	额外个人网盘
extend_tempdisk	是	0	额外中转网盘
extend_sharedisk	是	0	额外企业网盘

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ needprice	number	非必须		我司扣费
├─ costprice	number	非必须		不打折费用

13、获取邮局续费价格

基本信息

Path： /mail/?act=renewprice

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
domain	是	test.com	邮局 域名
alreadypay	是	1	续费时间（月）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	number	非必须
clientid	string	非必须
data	object	非必须
├─ needprice	number	非必须		我司扣费
├─ costprice	number	非必须		不打折费用