SendCloud

# 发件人管理

# 创建发件人

URL:

https://api2.sendcloud.net/marketing/senders
1

Method: POST

Content-Type: application/json; charset=utf-8

Request-Headers:

Header Type Required Description
Authorization string true Bearer Token

Body-Parameters:

Parameter Type Required Description
fromName string true 发信人名称
email string true 发信人地址，必须为邮箱格式，域名后缀必须为 domainName
domainName string true 域名(配置通过)
apiUserName string true ApiUser 名称

说明：

  1. domainName和apiUserName需是对应关系

Request-Example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/senders --data '{
  "fromName": "令狐大侠",
  "email": "xjmfc@126.com",
  "domainName": "126.com",
  "apiUserName": "test_abc"
}'
1
2
3
4
5
6

Response-Success

HttpStatus: 201

Response:

{
    "senderId": 36
}
1
2
3

Response-Error:

{
    "status":401,
    "error":{
        "parameter":"",
        "message":"Unauthorized"
    }
}
1
2
3
4
5
6
7

# 删除发件人

URL:

https://api2.sendcloud.net/marketing/senders/{senderId}
1

Method: DELETE

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Request-Headers:

Header Type Required Description
Authorization string true token

Path-parameters:

Parameter Type Required Description
senderId integer true 发件人 ID

Request-Example:

curl -X DELETE -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/senders/857
1

Response-Success

HttpStatus: 204

Response:

{}
1

Response-Error:

{
    "status":401,
    "error":{
        "parameter":"",
        "message":"Unauthorized"
    }
}
1
2
3
4
5
6
7

# 更新发件人

URL:

https://api2.sendcloud.net/marketing/senders/{senderId}
1

Method: PATCH

Content-Type: application/json; charset=utf-8

Request-Headers:

Header Type Required Description
Authorization string true Bearer Token

Path-parameters:

Parameter Type Required Description
senderId integer true 发件人 ID

Body-Parameters:

Parameter Type Required Description
fromName string false 发信人名称
email string false 发信人地址，必须为邮箱格式，域名后缀必须为 domainName
domainName string false 域名(配置通过)
apiUserName string false ApiUser 名称

提示:

  1. fromName、email、domainName、domainName 一旦传值，不能为空字符串、特殊字符 null 。

Request-Example:

curl -X PATCH -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/senders/37 --data '{
  "fromName": "令狐大侠",
  "email": "xjmfc@126.com",
  "domainName": "test.com",
  "apiUserName": "test_abc"
}'
1
2
3
4
5
6

Response-Success:

HttpStatus: 200

Response

{
    "id": 37,
    "userId": 99229,
    "name": "pso12t*",
    "email": "post@ddd.linuxshell.work",
    "domainId": 101632,
    "categoryId": 778601,
    "createTime": "2022-05-24 14:04:19",
    "updateTime": "2022-05-24 15:35:09",
    "createTimeFmt": null,
    "updateTimeFmt": null
}
1
2
3
4
5
6
7
8
9
10
11
12

Response-Error:

{
    "status":401,
    "error":{
        "parameter":"",
        "message":"Unauthorized"
    }
}
1
2
3
4
5
6
7

# 发件人详情

URL:

https://api2.sendcloud.net/marketing/senders/{senderId}
1

Method: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Request-Headers:

Header Type Required Description
Authorization string true Bearer Token

Path-parameters:

Parameter Type Required Description
senderId integer true 发件人 ID

Request-Example:

curl -X GET -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/senders/1
1

Response-Success

HttpStatus: 200

Response:

{
"id":21,
"userId":100249,
"name":"huangli",
"email":"huangli@legendnovel.com",
"domainId":101877,
"domainName":"legendnovel.com",
"categoryId":778774,
"categoryName":"huangli_1221",
"createTimeFmt":null
}
1
2
3
4
5
6
7
8
9
10
11

Response-Error:

{
    "status":401,
    "error":{
        "parameter":"",
        "message":"Unauthorized"
    }
}
1
2
3
4
5
6
7

# 发件人列表

URL:

https://api2.sendcloud.net/marketing/senders
1

Method: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Request-Headers:

Header Type Required Description
Authorization string true Bearer Token

Query-Parameters:

Parameter Type Required Description
count integer false 查询个数， 取值区间 [1-100]， 默认为 10
offset integer false 查询起始位置， 取值区间 [0-]， 默认为 0

Request-Example:

curl -X GET -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/senders?offset=0&count=10
1

Response-Parameters:

Parameters Type Description
list object[] 发送者列表
└─id integer 发件人 ID
└─userId integer 用户 ID
└─name string 发送者名称
└─email string 发送者地址
└─domainId integer 域名 ID
└─domainName string 域名名称
└─categoryId integer ApiUser ID
└─categoryName string APIUSER 名称
└─createTimeFmt string 创建时间
total integer 记录总数

Response-Success

HttpStatus: 200

Response:

{
  "list": [
    {
      "id": 1,
      "userId": 15,
      "name": "令狐大侠",
      "email": "xjmfc@126.com",
      "domainId": 8,
      "domainName": "m5201314.com",
      "categoryId": 229,
      "categoryName": "xjm_batch",
      "createTimeFmt": "ufm4fb"
    }
  ],
  "total": 541
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Response-Error:

{
    "status":401,
    "error":{
        "parameter":"",
        "message":"Unauthorized"
    }
}
1
2
3
4
5
6
7
Last Updated: 2025/03/25 10:38:59

任务管理

创建发件人
删除发件人
更新发件人
发件人详情
发件人列表