域名

用户需要在 SendCloud 中配置发信域名才能正常的发送邮件.

你可以使用 API 进行域名的查询, 添加, 修改操作

---

查询 ( 批量查询 )

通过此接口查询域名的基本信息

URL

https://api.sendcloud.net/apiv2/domain/list

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
name	string	否	域名名称. 多个 name 用 ; 分隔
type	int	否	域名类型: 0 (测试域名), 1(普通域名)
verify	string	否	域名验证值. 举例: verify=1, 查询验证值为 1 的域名; verify 为 ">22", 查询验证值大于等于 22 的域名; verify为 "<12", 查询验证值小于等于 12 的域名

说明

域名的验证值 代表 SendCloud 检查用户域名配置是否通过的返回值. SendCloud 会要求用户按照 发送设置 -> 域名 的指引来配置域名记录. 下表是由返回值计算配置项是否通过的方法:

类型	计算	说明
dkim	verify & 1 == 1	dkim 配置通过
spf	verify & 2 == 2	spf 配置通过
mx	verify & 4 == 4	mx 配置通过
dmarc	verify & 32 ==32	dmarc 配置通过

举例:

verify = 0  | 没有配置项通过
verify = 3  | dkim, spf 配置通过
verify = 7 | dkim, spf, mx 配置通过
verify = 38 | spf, dmarc, mx 配置通过
verify = 39 | dkim, spf, mx, dmarc 配置通过

请求示例

https://api.sendcloud.net/apiv2/domain/list?apiUser=***&apiKey=***&name=ifaxin.com

返回值说明

参数	说明
name	域名名称
type	域名类型
verify	域名验证值
spf.domain	此域名 SPF 的主机记录
spf.value	此域名 SPF 的需配置值
dkim.domain	此域名 DKIM 的主机记录
dkim.value	此域名 DKIM 的需配置值
mx.domain	此域名 MX 的主机记录
mx.value	此域名 MX 的需配置值
dmarc.domain	此域名 Dmarc 的主机记录
dmarc.value	此域名 Dmarc 的需配置值
gmtCreated	域名创建时间
gmtUpdated	域名修改时间
ipType	0：共享， 1 ：独立

返回值示例

{
  "result": true,
  "statusCode": 200,
  "message": "请求成功",
  "info": {
    "dataList": [
      {
        "name": "***",
        "type": "普通",
        "verify": 30,
        "spf.domain": "***",
        "spf.value": "v=spf1 include:spf.sendcloud.org ~all",
        "dkim.domain": "***",
        "dkim.value": "k=rsa;p=***",
        "mx.domain": "***",
        "mx.value": "***",
        "dmarc.domain": "***",
        "dmarc.value": "***",
        "gmtCreated": "2014-11-01 22:41:52",
        "gmtUpdated": "2015-09-25 10:56:06",
        "ipType":0
      }
    ],
    "count": 1
  }
}

---

添加

通过此接口添加域名

URL

https://api.sendcloud.net/apiv2/domain/add

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
name	string	是	域名名称

说明

1. 域名名称不能含有 `sendcloud`, `ifaxin`
2. 域名名称长度不能超过 250 个字符
3. 同一个用户最多能添加 5 个域名

请求示例

https://api.sendcloud.net/apiv2/domain/add?apiUser=***&apiKey=***&name=mail.liubida.cn

返回值说明

返回符合条件所有域名信息.

参数	说明
name	域名名称
type	域名类型
verify	域名验证值
spf.domain	此域名 SPF 的主机记录
spf.value	此域名 SPF 的需配置值
dkim.domain	此域名 DKIM 的主机记录
dkim.value	此域名 DKIM 的需配置值
mx.domain	此域名 MX 的主机记录
mx.value	此域名 MX 的需配置值
dmarc.domain	此域名 Dmarc 的主机记录
dmarc.value	此域名 Dmarc 的需配置值
gmtCreated	域名创建时间
gmtUpdated	域名修改时间

返回值示例

{
    "statusCode": 200,
    "info": {
        "data": {
            "name": "test01.shanshan.cn",
            "type": "普通",
            "verify": 30,
            "spf.domain": "test01.shanshan.cn",
            "spf.value": "v=spf1 include:spf.sendcloud.org -all",
            "dkim.domain": "mail._domainkey.test01.shanshan.cn",
            "dkim.value": "k=rsa;p=***",
            "mx.domain": "test01.shanshan.cn",
            "mx.value": "mx.sendcloud.org",
            "dmarc.domain": "_dmarc.test01.shanshan.cn",
            "dmarc.value": "v=DMARC1;p=reject;ruf=mailto:dmarc@test01.shanshan.cn;rua=mailto:dmarc_report@test01.shanshan.cn",
            "gmtCreated": "2014-11-01 22:41:52",
            "gmtUpdated": "2015-09-25 10:56:06"         
        }
    },
    "message“: "请求成功",
    "result": true
}

---

修改

通过此接口修改域名

URL

https://api.sendcloud.net/apiv2/domain/update

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
name	string	是	域名名称
newName	string	是	新域名名称

说明

已有配置项验证通过的域名不能修改

请求示例

https://api.sendcloud.net/apiv2/domain/update?apiUser=***&apiKey=***&name=mail.liubida.cn&name=email.liubida.cn

返回值说明

返回符合条件所有域名信息.

参数	说明
name	域名名称
type	域名类型
verify	域名验证值
spf.domain	此域名 SPF 的主机记录
spf.value	此域名 SPF 的需配置值
dkim.domain	此域名 DKIM 的主机记录
dkim.value	此域名 DKIM 的需配置值
mx.domain	此域名 MX 的主机记录
mx.value	此域名 MX 的需配置值
dmarc.domain	此域名 Dmarc 的主机记录
dmarc.value	此域名 Dmarc 的需配置值
gmtCreated	域名创建时间
gmtUpdated	域名修改时间

返回值示例

{
    statusCode: 200,
    info: {
        data: {
            "name": "***",
            "type": "普通",
            "verify": 30,
            "spf.domain": "***",
            "spf.value": "v=spf1 include:spf.sendcloud.org -all",
            "dkim.domain": "***",
            "dkim.value": "k=rsa;p=***",
            "mx.domain": "***",
            "mx.value": "***",
            "dmarc.domain": "***",
            "dmarc.value": "***",
            "gmtCreated": "2014-11-01 22:41:52",
            "gmtUpdated": "2015-09-25 10:56:06"
        }
    },
    message: "请求成功",
    result: true
}

---

验证

通过此接口验证域名（数据每5min更新一次）

URL

https://api.sendcloud.net/apiv2/domain/checkConfig

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
name	string	否	域名名称. 多个 name 用 ; 分隔

说明

返回已有域名的配置是否通过

请求示例

https://api.sendcloud.net/apiv2/domain/checkConfig?apiUser=***&apiKey=***&name=mail.liubida.cn

返回值说明

返回符合条件所有域名信息.

参数	说明
name	域名名称
type	域名类型
MX	MX是否配置通过
SPF	SPF是否配置通过
DKIM	DKIM是否配置通过
DMARC	DMARC是否配置通过
isConfigSucess	域名是否配置成功
message	验证结果

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "dataList": [
            {
                "name": "zhouwj.cn",
                "isConfigSuccess": true,configInfo: {
                    "MX": true,
                    "SPF": true,
                    "DKIM": true,
                    "DMARC": false
                },
                "message": "可使用",
                "type": 0
            }
        ]
    }
}