SMS Bounces

Last updated:2023-08-11

URL

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

        
This code block in the floating window

HTTP Request Method

GET
          GET

        
This code block in the floating window

Request-Headers

Header Type Required or not Description
Authorization string true Basic base64(sms_user:sms_key)

Query Parameter Description

Parameter Type Required Description
offset Integer no offset position, [0-], defaults to 0
limit Integer no amount, [0-100],defaults to 100
phone string no phone number
start_date string yes start_date, formatted with yyyy-MM-dd
end_date string yes end_date, formatted with yyyy-MM-dd

Tips

The number of days in the query interval between start_date and end_date cannot exceed 90 days.

Request Example

curl -X GET "https://sms.api.engagelab.cc/v1/bounces" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl -X GET "https://sms.api.engagelab.cc/v1/bounces" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

        
This code block in the floating window

Returned Value Description

Parameter Description
phone phone number
bounce_type bounce type
msg_type SMS type, 2 represents international SMS
bounce_time bounce time
expire_time expire time
reason bounce reason

bounce_type the corresponding type code and its description

Bounce_Type Description
500 Sending failure, number nonexistent
510 Sending failure, number out of service
520 Sending failure, number in blacklist
530 Sending failure, busy line
540 Sending failure, no answer
550 Sending failure, template content intercepted
560 Sending failure, mobile terminal error
570 Sending failure, mobile not in service
580 Sending failure, mobile powered off
590 Sending failure, other reasons
410 Global interception list
411 Customize global interception list
420 Local interception list
421 Customize local interception list
430 Unsubscribe
440 Keyword filtering
450 Variable replacement error
460 Variable length exceeds limit
470 Encoding exception (Note: Encoding exceptions merged with 460, now 470 represents frequency exceeds limit)
480 Unsupported sending type

Returned Value Example

Response-success

HTTP Status: 200

{ "result": [ { "phone": "008613681312917", "bounce_type": 421, "bounce_time": "2023-08-04T16:47:02+0800", "expire_time": "2023-08-08T00:00:00+0800", "msg_type": 2, "reason": "Customize local interception list" } ], "total": 1, "count": 1 }
          {
    "result": [
        {
            "phone": "008613681312917",
            "bounce_type": 421,
            "bounce_time": "2023-08-04T16:47:02+0800",
            "expire_time": "2023-08-08T00:00:00+0800",
            "msg_type": 2,
            "reason": "Customize local interception list"
        }
    ],
    "total": 1,
    "count": 1
}

        
This code block in the floating window

Delete

URL

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

        
This code block in the floating window

HTTP Request Method

DELETE
          DELETE

        
This code block in the floating window

Content-type

application/json
          application/json

        
This code block in the floating window

Request-Headers

Header Type Required Description
Authorization string true Basic base64(sms_user:sms_key)

Body Parameter Description

Parameter Type Required Description
phone string yes phone number
start_date string yes start_date, formatted with yyyy-MM-dd
end_date string yes end_date, formatted with yyyy-MM-dd

Tips

The number of days in the query interval between start_date and end_date cannot exceed 90 days.

Request Example

curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces" --data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}' --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces" 
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

        
This code block in the floating window

Returned Value Description

Parameter Description
count amount of deleted bounces

Returned Value Example

Response-success

HTTP Status: 200

{ "count": 1 }
          {
    "count": 1
}

        
This code block in the floating window

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          {
    "code": 30000,
    "message": "Unauthorized."
}

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