SMS Interception

---

Query

URL

https://api.sendcloud.net/smsapi/bounce/list

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
smsUser	string	是	smsUser
start	Integer	否	查询起始位置, 取值区间 [0-], 默认为 0
limit	Integer	否	查询个数, 取值区间 [0-100], 默认为 100
signature	string	是	数字签名, 合法性验证
phone	string	否	手机号
days	string	*	过去 days 天内的统计数据 (days=1表示今天)
startDate	string	*	开始日期, 格式为yyyy-MM-dd
endDate	string	*	结束日期, 格式为yyyy-MM-dd

提示:

1. 获取统计数据时, 必须指定时间区间. 即 startDate 与 endDate 的组合 或者 days 参数 需二者取一
2. 查询的天数不超过 100

Request Example

https://api.sendcloud.net/smsapi/bounce/list?smsUser=***&days=***&signature=***

Returned value description

parameter	description
bounceType	短信拦截的状态
bounceTypeDesc	短信拦截的描述
currTime	短信拦截时间
expireTime	短信拦截失效时间
msgType	短信类型
phone	手机号
reason	短信拦截原因

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "查询成功",
    "info": {
        "total": 2,
        "count": 2,
        "voList": [{
            "bounceType": 510,
            "bounceTypeDesc": "停机",
            "currTime": "2018-11-07 07:01:30",
            "expireTime": "2018-11-07 08:01:30",
            "msgType": 0,
            "phone": "18802002140",
            "reason": "",
            "userId": 0
        }, {
            "bounceType": 421,
            "bounceTypeDesc": "局部自定义黑名单",
            "currTime": "2018-10-23 14:07:27",
            "expireTime": "2038-10-23 14:07:27",
            "msgType": 0,
            "phone": "13361967600",
            "reason": "",
            "userId": 0
        }]
    }
}

---

Delete

URL

https://api.sendcloud.net/smsapi/bounce/delete

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
smsUser	string	是	smsUser
signature	string	是	数字签名, 合法性验证
phone	string	是	手机号
msgType	string	否	默认 0:国内短信 2.国际短信
days	string	*	过去 days 天内的统计数据 (days=1表示今天)
startDate	string	*	开始日期, 格式为yyyy-MM-dd
endDate	string	*	结束日期, 格式为yyyy-MM-dd

Request Example

https://api.sendcloud.net/smsapi/smsContactList/save?smsUser=***&phone=***&days=***&signature=***

Returned value example

{
    "result": true,
    "statusCode": 200,
    "message": "删除成功",
    "info": {
        "total": 1
    }
}