zhangqijia / Pro2dProtoBuffers

Commit a439e9db29d7c7e746046b53ceda0408f78f76ad

Authored by zhangqijia
1 parent 869cd96b

fix: 添加白名单接口的文档

Showing 1 changed file with 24 additions and 0 deletions   Show diff stats
Inline Side-by-side
doc/account.md
  Show/Hide comments   View file @a439e9d
... ... @@ -111,3 +111,27 @@ $ curl --request POST 'http://192.168.0.206:8080/v1/sms' \
111 111 ```shell
112 112 {"code":0,"message":"success"}
113 113 ```
  114 +
  115 +## 白名单 [/addwblist]
  116 +1. 说明:研发提供的接口必须遵循以下协议
  117 +2. 请求方式:POST 提交表单
  118 +3. 请求参数:(以参数有就传)
  119 +
  120 +| 参数 | 类型 | 是否必须 | 备注 |
  121 +|--------| --- | --- |----------------|
  122 +| record | string | Y | 1,黑名单，2，其他 白名单 |
  123 +
  124 +最后参数组合示例为:
  125 +```test
  126 +record=2&uid=90001
  127 +```
  128 +
  129 +请求示例：
  130 +```shell
  131 +$ curl --request POST 'http://127.0.0.1:1112/v1/addwblist' \
  132 +--data 'record=2&uid=90002'
  133 +```
  134 +返回结果:
  135 +```shell
  136 +{"code":0,"message":"success"}
  137 +```
... ...