更新时间:2024-04-29 GMT+08:00

发送短信/邮件验证码

描述

该接口提供发送验证码的功能,服务器收到请求,发送验证码到邮箱或者短信并返回结果。用户在前台界面通过滑块验证后,再进行发送验证码操作。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/usg/acs/verifycode/send

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Content-Type

String

Header

Body的媒体格式

样例:application/json; charset=UTF-8

X-Request-Id

String

Header

请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。

Accept-Language

String

Header

语言参数,默认为中文zh-CN, 英文为en-US。

sendMethod

String

Body

验证码发送方式。

user类型是用户真实账号时必选;如果没有选择的话,优先短信方式。

  • sms:短信方式
  • email:邮件方式

token

String

Body

访问Token字符串。通过校验滑块验证码接口获取。

user

String

Body

用户身份信息(手机号码或邮箱账号或用户真实账号)。

说明:

必须和发送滑块验证码时带的用户身份信息相同。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

bindEmail

String

如果通过邮箱发送验证码,则该字段携带用户绑定的邮箱账号(邮箱账号经过处理,屏蔽中间几位,如tes****ount@huawei.com)。

bindPhone

String

如果通过手机发送验证码,则该字段携带该用户绑定的手机号(手机号经过处理,屏蔽中间几位,如+86181****2345)。

expire

Integer

过期时间,单位:秒。

请求消息示例

POST /v1/usg/acs/verifycode/send
Connection: keep-alive 
Content-Type: application/json 
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) 

{
    "token": "R7PE9vsaEUHjiLsraWTF3WQhmBet16SbI",
    "user": "+86136********"
}

响应消息示例

HTTP/1.1 200  
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8 
Connection: keep-alive 
Pragma: No-cache 
Cache-Control: no-cache 
http_proxy_id: c94f64967745b0670c299c0688479078 

{
    "expire":180,
    "bindPhone":"+8618*********",
    "bindEmail":null
}

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心