接口路径(新):http://api.okayapi.com/api/App/Sms/AliyunSendSms
接口路径(旧):http://api.okayapi.com/?s=App.Sms.AliyunSendSms
接口描述: 通过阿里云的SendSms发送短信,使用前请进入小白开放平台-阿里云短信配置。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
PhoneNumbers | String | Required | 接收短信的手机号码。国内短信:11位手机号码,例如15951955195。国际/港澳台消息:国际区号+号码,例如85200000000。 | ||
SignName | String | Required | 短信签名名称。可在阿里云控制台签名管理页面签名名称一列查看。例如:阿里云 | ||
TemplateCode | String | Required | 短信模板ID。可在阿里云控制台模板管理页面模板CODE一列查看。例如:SMS_153055065 | ||
TemplateParam | ArrayJSON Format | Optaion | 短信模板变量对应的实际值,JSON格式。例如:{"code":"1111"} |
请求:
{OKAYAPI_API_HOST}/?s=App.Sms.AliyunSendSmsPhoneNumbers=15988888888&SignName=小白开放平台&TemplateCode=SMS_153055065&TemplateParam={"name":"xxx"}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"Message":"OK",
"RequestId":"2184201F-BFB3-446B-B1F2-C746B7BF0657",
"BizId":"197703245997295588^0",
"Code":"OK"
},
"msg": "小白开放接口:App.Sms.AliyunSendSmsPhoneNumbers"
}
KEY | Type | Description |
---|---|---|
操作码,0成功,1失败 | err_code | |
BizId | String | 发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态。 |
Code | String | 请求状态码。返回OK代表请求成功。其他错误码详见错误码列表。 |
Message | String | 状态码的描述。 |
RequestId | String | 请求ID。 |
接口路径(新):http://api.okayapi.com/api/App/Sms/AliyunQuerySendDetails
接口路径(旧):http://api.okayapi.com/?s=App.Sms.AliyunQuerySendDetails
接口描述: 通过阿里云的QuerySendDetails接口查看短信发送记录和发送状态。使用前请进入小白开放平台-阿里云短信配置。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
CurrentPage | Int | Optaion | 1 | MIN: 1 | 分页查看发送记录,指定发送记录的的当前页码。 |
PageSize | Int | Optaion | 10 | MIN: 1;MAX: 50 | 分页查看发送记录,指定每页显示的短信记录数量。取值范围为1~50。 |
PhoneNumber | String | Required | 接收短信的手机号码。格式:
| ||
SendDate | String | Required | 短信发送日期,支持查询最近30天的记录。格式为yyyyMMdd,例如20181225。 |
请求:
{OKAYAPI_API_HOST}/?s=App.Sms.AliyunQuerySendDetails&CurrentPage=1&PageSize=10&PhoneNumber=15988888888&SendDate=20190913&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"TotalCount": 1,
"Message": "OK",
"RequestId": "A95CF705-FADF-4EA9-884E-BB2F31E85BB5",
"SmsSendDetailDTOs": {
"SmsSendDetailDTO": [
{
"SendDate": "2019-09-13 17:26:45",
"SendStatus": 3,
"ReceiveDate": "2019-09-13 17:26:51",
"ErrCode": "DELIVERED",
"TemplateCode": "SMS_174022468",
"Content": "【小白开放平台】认证通知:尊敬的xxx,您的个人认证已经通过!",
"PhoneNum": "15988888888"
}
]
},
"Code": "OK"
},
"msg": "小白开放接口:App.Sms.AliyunQuerySendDetails"
}
KEY | Type | Description |
---|---|---|
操作码,0成功,1失败 | err_code | |
Code | String | 请求状态码。返回OK代表请求成功。其他错误码详见错误码列表。 |
Message | String | 状态码的描述。 |
RequestId | String | 请求ID。 |
SmsSendDetailDTOs | Object | 短信发送明细。 |
TotalCount | String | 短信发送总条数。 |
接口路径(新):http://api.okayapi.com/api/App/Sms/CheckSmsCaptcha
接口路径(旧):http://api.okayapi.com/?s=App.Sms.CheckSmsCaptcha
接口描述: 校验前请先购买并调用Supplier.YesApi.SendSmsCatpcha接口发送短信验证码。验证码将在15分钟内有效,可尝试5次,成功校验的失败。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
mobile | String | Required | MIN: 11;MAX: 11 | 国内手机号,11位 | |
code | String | Required | MIN: 4;MAX: 6 | 4位到6位的数字验证码 |
// 请求
{OKAYAPI_API_HOST}/?s=App.Sms.CheckSmsCaptcha&mobile=13800138000&code=1234&app_key={你的app_key}&sign={动态签名}
// 返回
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": "小白开放接口:App.Sms.CheckSmsCaptcha"
}
// 成功后再次请求,则会提示失败,如:
{
"ret": 200,
"data": {
"err_code": 1,
"err_msg": "验证码不存在"
},
"msg": "小白开放接口:App.Sms.CheckSmsCaptcha"
}
补充,收到的验证码短信内容格式如下:
【YesApi】您的验证码${code},该验证码15分钟内有效,请勿泄漏于他人!
KEY | Type | Description |
---|---|---|
操作码,0成功,1验证码不存在,2验证码已过期,3验证码已失效(失败次数过多),4验证码错误 | err_code |
Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Apr/25/2024 09:17:31