消息发送
发送短信验证码
描述
发送短信验证码。
特别注意: 发送短信除了默认的请求限流之外,对每个手机号的短信发送,另外流控限制,限制如下:
- 对每个手机号,每小时发送次数不超过 5 次
- 对每个手机号,每天发送次数不超过 10 次
特别注意: 每个开发者账号对于同一个手机号,同一时间只能存在一个验证码,重复发送的验证码只有第二个有效。如果您有多个应用需要集成短信验证,请申请多个开发者账号。
支持的模式
- client_credentials
请求方法
POST
请求地址
https://api.ecnu.edu.cn/api/v1/message/sms/vcode/send
请求参数
以 url query
方式传递参数
参数名 | 类型 | 备注 |
---|---|---|
phoneNumber | string | 手机号 |
返回参数
参数名 | 类型 | 备注 |
---|---|---|
phoneNumber | string | 手机号 |
bizId | string | 流水号 |
请求示例
curl -X POST -H "Authorization: Bearer bdb236f4e8366171f3fb86b009ad58fc" https://api.ecnu.edu.cn/api/v1/message/sms/vcode/send?phoneNumber=189****37
返回示例
json
{
"errCode": 0,
"errMsg": "success",
"requestId": "2205c2a8-cd62-4c32-96b4-7f8f6a9503bd",
"data": {
"phoneNumber": "18****537",
"bizId": "883******351^0"
}
}
校验短信验证码
描述
校验短信验证码,每个验证码在校验后即告失效
支持的模式
-client_credentials
请求方法
POST
请求地址
https://api.ecnu.edu.cn/api/v1/message/sms/vcode/check
请求参数
以 application/json
提交在 body
里
参数名 | 类型 | 备注 |
---|---|---|
phoneNumber | string | 手机号 |
vcode | string | 验证码 |
返回参数
无
请求示例
curl -X POST -H "Authorization: Bearer bdb236f4e8366171f3fb86b009ad58fc" -H "content-type: application/json" -d "{\"phoneNumber\":\"18*****537\",\"vcode\":\"862856\"}" https://api.ecnu.edu.cn/api/v1/message/sms/vcode/check
返回示例
json
{
"errCode": 0,
"errMsg": "success",
"requestId": "97b373f5-a349-4816-9456-f2488ebdeec7",
"data": null
}
查询短信发送状态
描述
查询短信发送状态
支持的模式
- client_credentials
请求方法
POST
请求地址
https://api.ecnu.edu.cn/api/v1/message/sms/status
请求参数
以 url query
方式传递参数
参数名 | 类型 | 备注 |
---|---|---|
sendData | string | 发送日期,YYYYMMDD 格式,如 20210922 |
phoneNumber | string | 手机号 |
bizId | string | 流水号,可从发送验证码的返回参数里获取 |
返回参数
参数名 | 类型 | 备注 |
---|---|---|
errCode | string | 错误码,DELIVERED 表示投递成功,其他详见错误码 |
receiveDate | string | 短信收到的时间 |
sendDate | string | 短信发送的时间 |
phoneNumber | string | 手机号 |
sendStatus | number发送状态,1等待回执,2发送失败,3发送成功 |
请求示例
curl -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183" "https://api.ecnu.edu.cn/api/v1/message/sms/status?sendDate=20210922&phoneNumber=189****537&bizId=50****7084^0"
返回示例
json
{
"errCode": 0,
"errMsg": "success",
"requestId": "ba3f0822-7ff2-4538-b5dd-cde2f42f7ee7",
"data": [{
"errCode": "DELIVERED",
"receiveDate": "2021-09-22 16:56:21",
"sendDate": "2021-09-22 16:56:17",
"phoneNumber": "189***537",
"sendStatus": 3
}]
}