Initial commit
This commit is contained in:
45
reference/goedge 文档/SMSSenderService.md
Normal file
45
reference/goedge 文档/SMSSenderService.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# SMSSenderService
|
||||
> 短信发送服务
|
||||
|
||||
---
|
||||
|
||||
## sendSMS
|
||||
> 发送短信
|
||||
|
||||
- 角色:`admin`
|
||||
- HTTP:`POST https://backend.dooki.cloud/SMSSenderService/sendSMS`
|
||||
- RPC:`rpc sendSMS(SendSMSRequest) returns (SendSMSResponse);`
|
||||
|
||||
**请求对象 (`SendSMSRequest`)**
|
||||
|
||||
```json
|
||||
{
|
||||
"mobile": "string // 手机号",
|
||||
"body": "string // 内容",
|
||||
"code": "string // 验证码",
|
||||
"type": "string // 渠道类型:webHook ...",
|
||||
"paramsJSON": "bytes // 参数"
|
||||
}
|
||||
```
|
||||
|
||||
**响应对象 (`SendSMSResponse`)**
|
||||
|
||||
```json
|
||||
{
|
||||
"isOk": "bool // 是否成功",
|
||||
"result": "string // 发送返回内容,只有失败时才会有数据"
|
||||
}
|
||||
```
|
||||
|
||||
**调用示例**
|
||||
|
||||
```bash
|
||||
curl -X POST "https://backend.dooki.cloud/SMSSenderService/sendSMS" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-Edge-Access-Token: <YOUR_TOKEN>" \
|
||||
-d '{
|
||||
...
|
||||
}'
|
||||
```
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user