Delivery Response

Query

List of email status.

You can check status of your emails in this list.

URL

https://api2.sendcloud.net/api/data/emailStatus

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
email	string	no	recipient address
emailIds	string	no	emailId will be returned after an email was sent with api successfully; addresses are separated by semicolons, e.g. emailIds=a;b;c
labelId	string	no	label ID corresponding to the created label
labelName	string	no	label Name corresponding to the created label
days	string	*	stats in the past [days] days ( [days] =1 means today); cannot be more than 30 days
startDate	string	*	format of start date is yyyy-MM-dd，interval between start and end date cannot be more than 30 days
endDate	string	*	format of end date is yyyy-MM-dd，interval between start and end date cannot be more than 30 days
apiUserList	string	no	multiple apiUsers, separated by semicolons, e.g. apiUserList=a;b;c
start	string	no	start position, [0-], defaults to 0
limit	int	no	amount, [0-100],defaults to 100
status	string	no	status
subStatus	string	no	multiple subStatus , separated by semicolons, e.g. subStatus=a;b;c

Tips:

1. With designated time span, your search should be within the period. Note: start_date and end_date, or [days] is required.
2. Time span cannot be longer than 3 days.
3. 100 records is defaulted for each search. You need to specify limit and start if the records exceeds 100.
4. Each query record will be cached for 10 minutes.
5. This interface restricts each user account to call the interface 3000 times per minute. Beyond this frequency, the interface returns {"result": false, "statuscode": 50000, "message": "interface frequency limited", "info": {}}
6. Status parameter values: 1, 4, 5 and 18 (corresponding to the status of delivered, invalid email, soft bounce and sending)
7. When labelId and labelName are provided at the same time, the labelId is preferred for accurate query; Fuzzy query with labelName when only labelName is provided

subStatus	subStatusDesc
401	Blacklist
402	Unsubscribe
403	Server error
404	Format error
405	IP rejection
406	Not Exist
407	Junk mail
408	Rejection
409	Others
503	Soft bounce-Server error
505	Soft bounce-IP rejection
506	Soft bounce-Not Exist
507	Soft bounce-Spam rejection
508	Soft bounce-Rejection
509	Soft bounce-Others

Request Example:

https://api2.sendcloud.net/api/data/emailStatus?apiUser=***&apiKey=***&days=2&emailIds=***;***

Returned Value Description

status	subStatus	subStatusDesc
delivery	null	null
Invalid Mail-Platform Blacklist	401	SendCloud Blacklist
Invalid Mail - Unsubscribe	402	Unsubscribe
Invalid Mail - Server Unreachable	403	Server Unreachable
Invalid mail - address format error	404	address format error
invalid mail-other	405	IP, domain name rejected
Invalid mail - address does not exist	406	Address does not exist
Invalid Mail - Spam	407	spam
Invalid Mail - Sender / Recipient Rejected	408	Sender/Recipient Rejected
invalid mail-other	409	Other
soft bounce	503	Soft bounce-Server error
soft bounce	505	Soft bounce-IP rejection
soft bounce	506	Soft bounce-Not Exist
soft bounce	507	Soft bounce-Spam rejection
soft bounce	508	Soft bounce-Rejection
soft bounce	509	Soft bounce-Others
Request	null	null

Description

1. The corresponding substatus of invalid mail is 4xx, and the invalid subclass substatusdesc is divided into 9 sub categories; The corresponding substatus of soft return is 5xx, and the soft return subclass substatusdesc is divided into 6 sub categories

Returned Value Example

{
    "result":true,
    "statusCode":200,
    "message":"request was successful",
    "info":{
        "total":"2",
        "voListSize":2,
        "voList":[
            {
                "status":"Invalid Mail - Server Unreachable",
                "emailId":"1659283204215_01_31338_6255.sg-10_1_255_122-inbound0$123@test.com",
                "apiUser":"ops",
                "recipients":"123@test.com",
                "requestTime":"2022-08-01 00:00:04",
                "modifiedTime":"2022-08-01 00:02:10",
                "sendLog":"服务器不可达(Cannot establish SMTP connection)",
                "taskName":null,
                "mailingStatus":null,
                "subStatus":403,
                "softStatus":null,
                "timeStr":null,
                "event":null,
                "receiver":"123@test.com",
                "message":null,
                "email":"123@test.com",
                "name":null,
                "phone":null,
                "subStatusDesc":"Server Unreachable"
            },
            {
                "status":"soft bounce",
                "emailId":"1659510170530_01_5967_898.sg-10_1_255_121-inbound0$te@bau.de",
                "apiUser":"ops",
                "recipients":"te@bau.de",
                "requestTime":"2022-08-03 15:02:50",
                "modifiedTime":"2022-08-03 15:11:47",
                "sendLog":"邮箱地址不存在(resolver.adr.recipientnotfound)",
                "taskName":null,
                "mailingStatus":null,
                "subStatus":506,
                "softStatus":null,
                "timeStr":null,
                "event":null,
                "receiver":"te@bau.de",
                "message":null,
                "email":"te@bau.de",
                "name":null,
                "phone":null,
                "subStatusDesc":"Soft bounce-Not Exist"
            }
        ]
    }
}