发送邮箱验证码
功能介绍
发送邮箱验证码
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v4/user/email-verify-code
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
|
否 |
String |
参数解释: 邮箱。 取值范围: 字符串长度不少于1,不超过1000。 |
verify_code |
否 |
String |
参数解释: 验证码。 取值范围: 字符串长度不少于1,不超过1000。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
参数解释: 发送邮箱验证码结果。 取值范围: 字符串长度不少于1,不超过1000。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
POST https://{endpoint}/v4/user/email-verify-code { "email" : "11@email.com" }
响应示例
状态码:201
OK
{ "result" : "Verification Code Sent" }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
201 |
OK |
401 |
Unauthorized |
错误码
请参见错误码。