更新时间:2025-07-08 GMT+08:00
分享

发送验证码

功能介绍

发送验证码。

URI

POST /v1/{project_id}/users/{user_id}/verification-code

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,您可以从获取项目ID中获取。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

user_id

String

参数解释

用户ID。

约束限制

不涉及

取值范围

仅支持字母、数字、下划线和中划线,长度为[1-128]个字符。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

method

String

参数解释

认证方式:sms,email,vmfa。

约束限制

不涉及

取值范围

支持sms、email、vmfa,长度为[1-128]个字符。

默认取值

不涉及

响应参数

状态码:200

OK

请求示例

发送验证码,发送方式为email

https://{endpoint}/v1/{project_id}/users/{user_id}/verification-code

{
  "method" : "email"
}

响应示例

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档