58 lines
1.2 KiB
Markdown
58 lines
1.2 KiB
Markdown
# Sms
|
|
|
|
sms method
|
|
|
|
- [/notify.Sms/Send](#notifysmssend)
|
|
- [/notify.Sms/Verify](#notifysmsverify)
|
|
|
|
## /notify.Sms/Send
|
|
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{
|
|
sign_name: "", // type<string>, 必传项
|
|
template_code: "", // type<string>, 必传项
|
|
phone: "", // type<string>, 必传项
|
|
paramters: {
|
|
"": ""
|
|
}, // map<string,string>
|
|
// 验证码相关
|
|
generate_code: false, // type<bool>, 是否生成验证码
|
|
expire_interval: "0", // type<int64>, 验证码缓存时间,单位:分钟,仅generate_code为true时会缓存,默认5分钟
|
|
code_width: "0", // type<int64>, 验证码长度,默认 4
|
|
code_key: "", // type<string>, template_code 模板中验证码的标识,默认code
|
|
has_black_list_filter: false, // type<bool>, 是否黑单过滤,默认不过滤
|
|
wihout_limit: false, // type<bool>, 忽略每天短信条数上线限制,默认不忽略
|
|
}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
// string request_id = 1;
|
|
biz_id: "", // type<string>
|
|
}
|
|
```
|
|
## /notify.Sms/Verify
|
|
|
|
|
|
|
|
### Request
|
|
```javascript
|
|
{
|
|
// string request_id = 1;
|
|
phone: "", // type<string>
|
|
code: "", // type<string>
|
|
}
|
|
```
|
|
|
|
### Reply
|
|
```javascript
|
|
{
|
|
pass: false, // type<bool>
|
|
}
|
|
```
|
|
|