Przeglądaj źródła

docs: 更新接口说明文档

weijianghai 2 lat temu
rodzic
commit
5e9c414991

+ 30 - 0
doc/开发测试文档/接口文档/短信黑名单接口说明文档.md

@@ -12,6 +12,36 @@ Content-Type: application/json
 }
 ```
 
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": "成功",
+  "data": {
+    "querySuccess": true,
+    "queryMessage": "当前在黑名单",
+    "queryResult": {
+      "reason": "1",
+      "startTime": "20220702173144",
+      "endTime": "20220801173144",
+      "describe": "主叫流量:达到加黑阈值100条/3600秒,最低被叫用户数0;安全系数1.0,实际发送100,实际被叫用户数100",
+      "allowToDel": true
+    }
+  }
+}
+```
+
+### 返回参数说明
+<table>
+    <tr><td>querySuccess</td><td>是否在黑</td></tr>
+    <tr><td>queryMessage</td><td>在黑情况:(1)无加黑记录(2)曾在黑名单,已解黑(3)当前在黑名单</td></tr>
+    <tr><td>reason</td><td>入黑名单原因</td></tr>
+    <tr><td>startTime</td><td>开始时间</td></tr>
+    <tr><td>endTime</td><td>结束时间</td></tr>
+    <tr><td>describe</td><td>命中策略说明</td></tr>
+    <tr><td>allowToDel</td><td>是否允许解黑</td></tr>
+</table>
+
 ## 接口2: 黑名单解除接口
 
 - 本地访问 18631137650