发送短信验证码
功能介绍
发送短信验证码。
URI
POST /api/v2/sdk/sms/send
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
该字段内容填为“application/json;charset=utf8”。 |
|
X-operating-sys-version |
是 |
String |
调用方操作系统版本，该参数只用来记录日志，不做校验。例如：Android 10。 |
|
X-device-fingerprint |
是 |
String |
调用方设备指纹，该参数只用来记录日志，不做校验。例如：156aysdna213sc50。 |
|
X-device-ip |
否 |
String |
调用方IP，该参数只用来记录日志，不做校验。例如：10.10.10.1。 |
|
X-agent |
是 |
String |
用户Agent信息，该参数只用来记录日志，例如：Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36。 |
|
X-L |
否 |
String |
用于国际化语言设置，支持中文和英文。例如：zh。 |
|
X-client-id |
是 |
String |
应用标识，注册应用后分配的ClientId。该值可参考通用信息获取。 |
|
X-tenant-id |
否 |
String |
租户id，ISV应用调用则为必填，需要将{domain_name}换成ISV通用域名{common_domain}，请求Header参数中需要指定对应租户的tenant_id，并将X-client-id换成ISV应用模板的client_id。
说明：
此参数只用于ISV应用，当前该应用暂未开放，若需要，请提交工单申请开通。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
mobile |
是 |
String |
手机号，只能由数字组成，且长度为11位。 |
|
type |
是 |
String |
短信发送的场景，该参数用来设置在以下哪种场景下收到验证码。 枚举值：
|
|
captcha_token |
是 |
String |
图形验证码校验通过的凭证。该参数获取方式参考校验图形验证码。 |
响应参数
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误详情。 |
请求示例
发送短信验证码，给指定手机号12345678901用于绑定手机号，图形验证码校验通过凭证为71d******635---{"x":237.0,"y":5.0}。
POST https://{domain_name}/api/v2/sdk/sms/send
X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21
{
"mobile": "12345678901",
"type": "BIND_MOBILE_SMS",
"captcha_token": "71d******635---{\"x\":237.0,\"y\":5.0}"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
参数无效。 |
错误码
请参见错误码。
