Bounces API

Last updated:2023-08-10

Emails that are returned due to certain specific reasons, such as non-existent email addresses, will be added to the bounce list. The addresses on the list will no longer receive email communications. You can query these email addresses in the bounce list.

Query

URL

https://email.api.engagelab.cc/v1/bounces
          https://email.api.engagelab.cc/v1/bounces

        
This code block in the floating window

HTTP Request Method

GET
          GET

        
This code block in the floating window

Header

Header Type Required Description
Authorization String true Basic base64(api_user:api_key)

Query Parameter Description

Parameter Type Required or not Description
email string yes Email address, e.g, 22@gmail.com

Request Example:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/bounces?email=1@2.com'
          curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/bounces?email=1@2.com'

        
This code block in the floating window

Returned Value Description

Parameter Description
email Email address
reason Bounce reason
bounce_time Timestamp of when the bounce occurred
expire_time Expiration time for bounce interception

Returned Value Example:

{ "result": [ { "email": "xjmfc@example.com", "reason": "Mailbox not found. http://service.mail.qq.com/cgi-bin/help?subtype=1&&id=20022&&no=1000728", "bounce_time": "2016-02-01T14:53:20+0800", "expire_time": "2021-07-09T00:59:37+0800" } ], "count": 1, "total": 1 }
          {
  "result": [
    {
      "email": "xjmfc@example.com",
      "reason": "Mailbox not found. http://service.mail.qq.com/cgi-bin/help?subtype=1&&id=20022&&no=1000728",
      "bounce_time": "2016-02-01T14:53:20+0800",
      "expire_time": "2021-07-09T00:59:37+0800"
    }
  ],
  "count": 1,
  "total": 1
}

        
This code block in the floating window
在文档中心打开