API_USER

API_USER 是用户在 SendCloud 中发信的验证帐号.

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

---

查询 ( 批量查询 )

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

URL

https://api2.sendcloud.net/api/apiuser/list

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
emailType	int	否	API_USER 的邮件类型: 0(触发), 1(批量)
cType	int	否	API_USER 的类型: 0(测试), 1(普通)
domainName	string	否	API_USER 绑定的域名名称

请求示例

https://api2.sendcloud.net/api/apiuser/list?apiUser=***&apiKey=***&emailType=1&domainName=mail.liubida.cn 

返回值说明

参数	说明
name	API_USER 名称
cType	API_USER 类型
emailType	API_USER 的邮件类型
domainName	API_USER 绑定的域名
trackDomainName	API_USER 绑定的追踪域名
click	是否开启点击追踪: 0(关闭), 1(开启)
open	是否开启阅读追踪: 0(关闭), 1(开启)
unsubscribe	是否开启取消订阅: 0(关闭), 1(开启)

|

返回值示例

{
    statusCode: 200,
    info: {
        count: 1,
        dataList: [{
            name: "***",
            cType: "non-test",
            emailType: "Trigger",
            domainName: "delong.com",
            click: 1,
            open: 1,
            unsubscribe: 1,
            trackDomainName: "track2.sendcloud.net"
        }]
    },
    message: "request was successful",
    result: true
}

---

添加

通过此接口添加 API_USER

URL

https://api2.sendcloud.net/api/apiuser/add

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
name	string	是	API_USER 的名称
emailType	int	是	API_USER 的邮件类型: 0(触发), 1(批量)
domainName	string	是	API_USER 绑定的域名名称
trackDomainName	string	否	API_USER 绑定的追踪域名,默认:track2.sendcloud.net
unsubscribePageId	int	否	退订页面ID (登录到web创建)
open	int	否	是否开启阅读追踪: 0(关闭), 1(开启). 默认: 关闭
click	int	否	是否开启点击追踪: 0(关闭), 1(开启). 默认:关闭
unsubscribe	int	否	是否开启取消订阅: 0(关闭), 1(开启). 默认: 开启

说明

1. 取消订阅追踪(unsubscirbe), 系统对于 免费用户 会强制开启.
2. 当 trackDomainName 为系统默认追踪域名（ track2.sendcloud.net）时，阅读追踪 和点击追踪不能开启。

请求示例

https://api2.sendcloud.net/api/apiuser/add?apiUser=***&apiKey=***&name=liubida&emailType=1&domainName=mail.liubida.cn 

返回值说明

参数	说明
name	API_USER 名称
nameKey	API_KEY 名称
cType	API_USER 类型
emailType	API_USER 的邮件类型
domainName	API_USER 绑定的域名
trackDomainName	API_USER 绑定的追踪域名
click	是否开启点击追踪
open	是否开启阅读追踪
unsubscribe	是否开启取消订阅

返回值示例

{
    statusCode: 200,
    info: {
        data: {
            name: "***",
            nameKey:"********",
            cType: "non-test",
            emailType: "Trigger",
            domainName: "delong.com",
            click: 1,
            open: 1,
            unsubscribe: 1,
            trackDomainName: "track2.sendcloud.net"
        }
    },
    message: "Request successful",
    result: true
}

---

修改

通过此接口修改 API_USER

URL

https://api2.sendcloud.net/api/apiuser/update

HTTP请求方式

post    

参数说明

参数	类型	必选	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
name	string	是	API_USER 的名称
newName	string	否	新 API_USER 的名称
domainName	string	否	API_USER 绑定的域名名称
trackDomainName	string	否	API_USER 绑定的追踪域名
unsubscribePageId	int	否	退订页面ID
open	int	否	是否开启阅读追踪: 0(关闭), 1(开启)
click	int	否	是否开启点击追踪: 0(关闭), 1(开启)
unsubscribe	int	否	是否开启取消订阅: 0(关闭), 1(开启)

说明

1. 取消订阅追踪(unsubscirbe), 系统对于 免费用户 会强制开启。
2. 当 trackDomainName 为系统默认追踪域名（ track2.sendcloud.net）时，阅读追踪 和点击追踪不能开启。

请求示例

curl -d 'apiUser=***&apiKey=***&name=scsd&newName=scsd1' https://api2.sendcloud.net/api/apiuser/update

返回值说明

参数	说明
name	API_USER
cType	0 测试 1 非测试
emailType	API_USER 的邮件类型: 0(触发), 1(批量)
domainName	API_USER 绑定的域名
trackDomainName	API_USER 绑定的追踪域名
click	是否开启阅读追踪: 0(关闭), 1(开启)
open	是否开启点击追踪: 0(关闭), 1(开启)
unsubscribe	是否开启取消订阅: 0(关闭), 1(开启)

返回值示例

{
    statusCode: 200,
    info: {        
        data: {
            name: "***",
            cType: 1,
            emailType: 0
            domainName: "delong.com",
            trackDomainName: "track.delong.com",
            click: 1,
            open: 1,
            unsubscribe: 1
        }
    },
    message: "request was successful",
    result: true
}