2230-发送短信验证码
1. 接口功能
向请求中的手机号发送随机验证码。(短信内容模板可定制)
2. 报文结构
请求报文:
报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 |
---|---|---|---|---|
TxCode | R | NOT NULL | N1..4 | 交易类型 |
InstitutionID | R | NOT NULL | ANS1..8 | 机构编号 |
TxSN | R | NOT NULL | ANS1..32 | 交易流水号 |
PhoneNumber | R | NOT NULL | N1..11 | 手机号 |
SMSContentCode | O | NOT NULL | N1.32 | 短信内容模板编码 若不填默认"120" |
Remark | O | ANS0..256 | 备注 |
短信验证码默认模板:短信模板编码SMSContentCode为120
模板内容:【@label@】您的手机验证码为:@verifyCode@,请于@expired@分钟内输入验证,请妥善保管,防止泄露。如非本人操作,请忽略信息无需理会!
响应报文:
报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 |
---|---|---|---|---|
Code | R | NOT NULL | N1..6 | 响应代码 |
Message | R | NOT NULL | ANS1..256 | 响应消息 |
TxCode | C | NOT NULL | ANS1..4 | 交易类型 |
InstitutionID | C | NOT NULL | ANS1..8 | 机构编号 |
TxSN | C | NOT NULL | ANS1..32 | 交易流水号 |
TraceNo | C | NOT NULL | ANS1..32 | 交易跟踪号 |
ResponseCode | C | NOT NULL | N0..4 | 通道响应代码 |
ResponseMessage | C | NOT NULL | ANS0..256 | 通道响应消息 |
Status | C | NOT NULL | N2 | 请求状态: 10-未受理 20-已受理 |
3.报文样例:
[!TIP] (测试数据不校验数据真实性,默认为验证结果为匹配,若验证其他结果,可查看“总体规范-6.1.2.4 Remark 备注”)
请求报文(InstitutionID由中金分配):
{
"SmsContentCode":"120",
"TxCode":"2230",
"InstitutionID":"XXXXXX",
"TxSN":"202301131118142776723420372",
"PhoneNumber":"18846439987",
"Remark":""
}
响应报文:
{
"Status":"20",
"ResponseCode":"2000",
"TxCode":"2230",
"Message":"SUCCESS",
"InstitutionID":"XXXXXX",
"TxSN":"202301131118142776723420372",
"ResponseMessage":"SUCCESS",
"Code":"2000",
"TraceNo":"2301131118281911112011371"
}
该文档未解决您的疑问?
查看常见问题