AppPush
WebPush
WhatsApp
Email
SMS
OTP
短信拦截
最新更新：2023-08-11
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
此代码块在浮窗中显示
HTTP 请求方法
GET
GET
此代码块在浮窗中显示
Header
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | Basic base64(sms_user:sms_key) |
查询参数说明
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| offset | int | 否 | 偏移位置，[0-]，默认为0 |
| limit | int | 否 | 查询个数，[0-100]，默认为100 |
| phone | string | 否 | 手机号 |
| start_date | string | 是 | 开始日期，格式为 yyyy-MM-dd |
| end_date | string | 是 | 结束日期，格式为 yyyy-MM-dd |
提示：
查询间隔的天数在 start_date 和 end_date 之间不能超过 90 天。
请求示例
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>>"
此代码块在浮窗中显示
返回值说明
| 参数 | 描述 |
|---|---|
| phone | 手机号 |
| bounce_type | 短信拦截的状态 |
| msg_type | 短信类型，2 表示国际短信 |
| bounce_time | 短信拦截时间 |
| expire_time | 短信拦截失效时间 |
| reason | 短信拦截原因 |
bounce_type 对应的类型代码及其描述
| 退信类型 | 描述 |
|---|---|
| 500 | 发送失败，号码不存在 |
| 510 | 发送失败，号码停机 |
| 520 | 发送失败，号码在黑名单中 |
| 530 | 发送失败，号码忙线 |
| 540 | 发送失败，号码无应答 |
| 550 | 发送失败，模板内容被拦截 |
| 560 | 发送失败，移动终端错误 |
| 570 | 发送失败，号码不在服务区 |
| 580 | 发送失败，移动终端关机 |
| 590 | 发送失败，其他原因 |
| 410 | 全局拦截列表 |
| 411 | 自定义全局拦截列表 |
| 420 | 本地拦截列表 |
| 421 | 自定义本地拦截列表 |
| 430 | 取消订阅 |
| 440 | 关键词过滤 |
| 450 | 变量替换错误 |
| 460 | 变量长度超过限制 |
| 470 | 编码异常（注意：编码异常与460合并，现在470表示频率超限） |
| 480 | 不支持的发送类型 |
返回值示例
响应成功
HTTP 状态码: 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": "自定义本地拦截列表"
}
],
"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": "自定义本地拦截列表"
}
],
"total": 1,
"count": 1
}
此代码块在浮窗中显示
删除
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
此代码块在浮窗中显示
HTTP 请求方法
DELETE
DELETE
此代码块在浮窗中显示
Content-type
application/json
application/json
此代码块在浮窗中显示
Header
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | Basic base64(sms_user:sms_key) |
请求体参数说明
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| phone | string | 是 | 电话号码 |
| start_date | string | 是 | 开始日期，格式为 yyyy-MM-dd |
| end_date | string | 是 | 结束日期，格式为 yyyy-MM-dd |
提示：
查询间隔的天数在 start_date 和 end_date 之间不能超过 90 天。
请求示例
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>>"
此代码块在浮窗中显示
返回值说明
| 参数 | 描述 |
|---|---|
| count | 删除的拦截数量 |
返回值示例
响应成功
HTTP 状态码: 200
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
响应错误
HTTP 状态码: 401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
