固定发件人

发件人为用户配置mailfrom、from使用。 ​
你可以使用 API 进行查询,添加,更新,删除操作。 ​


查询发件人

URL

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

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
apiUser string API_USER
apiKey string API_KEY
start int 查询起始位置,取值区间 [0-],默认为 0
limit int 查询个数, 取值区间 [0-100],默认为 100

请求示例

https://api.sendcloud.net/apiv2/sender/list?apiUser=***&apiKey=***

返回值说明

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "total": 9,
        "dataList": [
            {
                "id": 212,
                "categoryId": 251561,
                "receivingDomain": "all",
                "fromStatus": 1,
                "from": "",
                "mailfromStatus": 1,
                "mailfrom": "",
                "categoryName": "HuAng",
                "createTime": "2023-03-15 18:28:41",
                "updateTime": "2023-03-15 18:28:41"
            }
        ],
        "count": 1
    }
}


添加发件人

URL

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

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
apiUser string API_USER
apiKey string API_KEY
categoryName string 指定API_USER,all 代表所有API_USER
receivingDomain string 收件域名,比如 qq.com,163.com;多个收件域名用逗号隔开,不传参或不传值则为全部域名
fromStatus int 0(不设置),1(实际值),2(固定值),默认值1
from string 1.fromStatus=0,from 不填写

2.fromStatus=1,则实际值是传入的 from 的前缀。例如 API传入from=notice@sc.gg ,系统将使用 notice@sendingDomain作为from发信,from 不填写

3.fromStatus=2,则 from将以 固定值@sendingDomain 组成 email地址,from 为必填

mailfromStatus int 0(不设置),1(去代发),2(固定值),默认值1
mailfrom string 1.mailfromStatus=0,则 mailfrom 将以 随机串@sendingDomain 组成 email地址,maiFrom 不填写

2.mailfromStatus=1,则 mailFrom 跟随from值,可去除代发,maiFrom 不填写

3.mailfromStatus=2,则 mailFrom 将以 固定值@sendingDomain 组成 email地址,maiFrom 为必填

说明:

1、当 fromStatus=0,mailfromStatus 必须为2;当 fromStatus=1,mailfromStatus 可以为0或1、2

请求示例

https://api.sendcloud.net/apiv2/sender/add?apiUser=***&apiKey=***&domainName=qq.com&categoryName=zhouwj_test_batch&sender=111

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "data": [
            {
                "id": 215,
                "categoryId": 0,
                "receivingDomain": "127.com",
                "fromStatus": 1,
                "from": "",
                "mailfromStatus": 2,
                "mailfrom": "xiao2",
                "categoryName": "all",
                "createTime": "2023-03-16 14:47:24",
                "updateTime": "2023-03-16 14:47:24"
            }
        ]
    }
}

删除发件人

URL

https://api.sendcloud.net/apiv2/sender/delete

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
apiUser string API_USER
apiKey string API_KEY
id int sender ID

请求示例

https://api.sendcloud.net/apiv2/sender/delete?apiUser=***&apiKey=***&domainName=qq.com&categoryName=zhouwj_test_batch&sender=111

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "count": 1
    }
}