API_USER

查询 ( 批量查询 )

URL

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

HTTP请求方式

GET

参数说明

参数 类型 必须 说明
apiUser string API_USER
apiKey string API_KEY
emailType int API_USER的邮件类型
cType int API_USER的类型
domainName string API_USER绑定的域名

请求示例

https://api.sendcloud.net/apiv2/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 绑定的追踪域名
neteaseSender API_USER 绑定的网易诚信 Sender,默认值:空
unsubscribePage API_USER 绑定的退订页面,默认值:-1
click 是否开启点击追踪: 0(关闭), 1(开启)
open 是否开启阅读追踪: 0(关闭), 1(开启)
unsubscribe 是否开启取消订阅: 0(关闭), 1(开启)

返回值示例

{
    "statusCode": 200,
    "info": {
        "count": 1,
        "dataList": [{
            "name": "***",
            "cType": "非测试",
            "emailType": "触发",
            "domainName": "delong.com",
            "trackDomainName": "track.delong.com",
            "unsubscribePage": -1,
            "neteaseSender": "",
            "click": 1,
            "open": 1,
            "unsubscribe": 1
        }]
    },
    "message": "请求成功",
    "result": true
}

添加

URL

https://api.sendcloud.net/apiv2/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绑定的域名
open int 是否开启阅读追踪,取值:0(关闭),1(开启)
click int 是否开启点击追踪,取值:0(关闭),1(开启)
unsubscribe int 是否开启取消订阅,取值:0(关闭),1(开启)

请求示例

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

返回值说明

参数 说明
name API_USER 名称
cType API_USER 类型
emailType API_USER 的邮件类型
domainName API_USER 绑定的域名
trackDomainName API_USER 绑定的追踪域名
neteaseSender API_USER 绑定的网易诚信 Sender
unsubscribePage API_USER 绑定的退订页面,默认值:-1
click 是否开启点击追踪: 0(关闭), 1(开启)
open 是否开启阅读追踪: 0(关闭), 1(开启)
unsubscribe 是否开启取消订阅: 0(关闭), 1(开启)

返回值示例

{
    "statusCode": 200,
    "info": {
        "total": 1,
        "data": {
            "name": "***",
            "nameKey":"********",
            "cType": "非测试",
            "emailType": "触发",
            "domainName": "delong.com",
            "trackDomainName": "sctrack.sc.gg",
            "neteaseSender": "",
            "unsubscribePage": -1,
            "click": 1,
            "open": 1,
            "unsubscribe": 1
        }
    },
    "message": "请求成功",
    "result": true
}

修改

URL

https://api.sendcloud.net/apiv2/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绑定的追踪域名
open int 是否开启阅读追踪: 0(关闭), 1(开启)
click int 是否开启点击追踪: 0(关闭), 1(开启)
unsubscribe int 是否开启取消订阅: 0(关闭), 1(开启)

请求示例

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

返回值说明

参数 说明
name API_USER 名称
cType API_USER 类型
emailType API_USER 的邮件类型
domainName API_USER 绑定的域名
trackDomainName API_USER 绑定的追踪域名
neteaseSender API_USER 绑定的网易诚信 Sender,默认值:空
unsubscribePage API_USER 绑定的退订页面,默认值:-1
click 是否开启点击追踪: 0(关闭), 1(开启)
open 是否开启阅读追踪: 0(关闭), 1(开启)
unsubscribe 是否开启取消订阅: 0(关闭), 1(开启)

返回值示例

```json { "statusCode": 200, "info": { "data": { "name": "***", "cType": 1, "emailType": 0, "domainName": "delong.com", "trackDomainName": "track.delong.com", "unsubscribePage": -1, "neteaseSender": "", "click": 1, "open": 1, "unsubscribe": 1 } }, "message": "请求成功", "result": true }