POST api/CommApi/VerifyCode
校验验证码(短信、图片),每个资源ID只能被正确校验1次,注意一个资源ID最多只能被校验10次
Request Information
URI Parameters
None.
Body Parameters
VerifyCodeRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| resID |
资源ID |
string |
Required |
| code |
要验证的数据 |
string |
Required |
| AccessKey |
(必填)基础token,RSA公钥加密(填充模式:RSA_PKCS1_OAEP_PADDING)>base64 |
string |
None. |
| SysTarget |
(必填)终端设备,WXMiniProgram=4,WX=1,ANDROID=2,IOS=3 |
integer |
None. |
| UserToken |
用户token-在指定拉取用户信息时需要提供 |
string |
None. |
| Timestamp |
(必填)时间戳,数据格式:yyyyMMddHHmmss |
string |
None. |
| Sign |
(必填)签名。步骤:1、将所有不为空字段的入参key转成大写(不含Sign)以字典序拼凑成URL键值对 2、将key=AccessKey(未RSA加密)加入到第1步拼成的字符串末尾进行MD5加密并转大写,即可得到签名 |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"resID": "sample string 1",
"code": "sample string 2",
"AccessKey": "sample string 3",
"SysTarget": 4,
"UserToken": "sample string 5",
"Timestamp": "sample string 6",
"Sign": "sample string 7"
}
application/xml, text/xml
Sample:
<VerifyCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenApi.Models.DTO"> <AccessKey xmlns="http://schemas.datacontract.org/2004/07/OpenApi.Models">sample string 3</AccessKey> <Sign xmlns="http://schemas.datacontract.org/2004/07/OpenApi.Models">sample string 7</Sign> <SysTarget xmlns="http://schemas.datacontract.org/2004/07/OpenApi.Models">4</SysTarget> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/OpenApi.Models">sample string 6</Timestamp> <UserToken xmlns="http://schemas.datacontract.org/2004/07/OpenApi.Models">sample string 5</UserToken> <code>sample string 2</code> <resID>sample string 1</resID> </VerifyCodeRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VerifyCodeResult| Name | Description | Type | Additional information |
|---|---|---|---|
| result |
校验结果 |
boolean |
None. |
| text |
状态文本 |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"result": true,
"text": "sample string 2"
}
application/xml, text/xml
Sample:
<VerifyCodeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenApi.Models.DTO"> <result>true</result> <text>sample string 2</text> </VerifyCodeResult>