发送验证码
功能介绍
客户注册时，如果填写了手机号，可以向对应的手机发送注册验证码，校验信息的正确性。使用个人银行卡方式进行实名认证时，通过该接口向指定的手机发送验证码。
接口约束
该接口只允许使用合作伙伴AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/bases/verificationcode/send
请求消息
请求参数
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
receiver_type |
是 |
Integer |
[1] |
发送验证码的类型： 1：发送短信验证码 |
|
timeout |
否 |
Integer |
[1-3000] |
发送验证码的超时时间。 此参数不携带或携带值为null时，采用系统默认超时时间10分钟。 此参数值超过60时，取值固定为5分钟。 单位：分钟。 |
|
mobile_phone |
是 |
String |
最大长度：32 |
指定发送验证码的手机号。 目前系统只支持中国手机号。 示例：13XXXXXXXXX |
|
lang |
否 |
String |
最大长度：16 |
根据该参数的取值选择发送短信验证码的语言。
此参数不携带或携带值为空串或携带值为null时，取默认值zh-cn。 |
|
scene |
否 |
Integer |
- |
验证码使用的场景，目前支持如下场景：
此参数不携带或携带值为null时，默认值为“29”；不支持携带值为空串。 |
|
customer_id |
否 |
String |
最大长度：64 |
客户账号ID。您可以调用查询客户列表接口获取customer_id。 当scene=18时此参数必填；除此之外此参数非必填，不携带或携带值为空串或携带值为null时均不做处理。 |
请求示例
POST https://bss.myhuaweicloud.com/v2/bases/verificationcode/send HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "receiver_type":1, "timeout": 5, "mobile_phone":"188****8888", "lang":"en-us", "scene": 18, "customer_id": "a0d736359ada40aab6502d1a828c1809" }
响应消息
响应参数
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
error_code |
String |
最大长度：16 |
状态码。具体请参考状态码。只有失败才会返回这个参数。 |
|
error_msg |
String |
最大长度：1024 |
错误描述信息。只有失败才会返回这个参数。 |
响应示例
HTTP/1.1 204 No Content Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time
状态码
- 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
- 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。
|
HTTP状态码 |
错误码 |
错误描述 |
|---|---|---|
|
400 |
CBC.0100 |
参数错误。 |
|
400 |
CBC.99000035 |
非合作伙伴子客户。 |
|
400 |
CBC.99004002 |
生成验证码失败。 |
|
400 |
CBC.99004003 |
验证码生成成功但发送失败。 |
|
400 |
CBC.99004005 |
手机号为空/格式不合法。 |
|
400 |
CBC.99004015 |
发送验证码次数已达到上限（15次/小时，60次/天）。 |
|
401 |
CBC.0154 |
token非法/过期。 |
|
403 |
CBC.0151 |
访问拒绝。 |
|
500 |
CBC.0999 |
其他错误。 |
