用于使得 Cumquat 生成并发送一个验证码。此验证码可用于敏感操作二步验证,在一定 Session 有效期内可重复激活。
接口地址
/user/send-verification-code
请求
请求方式:POST
请求格式:Body, application/json
请求参数:
Json 节点 | 类型 | 允许空或必填 | 示例值 | 备注 |
---|---|---|---|---|
object | json object | |||
– username | string | 必填 | AwaBlack | 用户名,用于邮件参数 |
– email | string | 必填 | [email protected] | 邮件发送目标 |
– activity | string | 必填 | 创建实例权限组 | 标注验证码用途 |
– type | string | 必填 | email | email (电子邮件)或sms (短信) |
响应
响应格式:application/json
响应内容:
Json 节点 | 类型 | 示例值 | 备注 |
---|---|---|---|
object | json object | ||
– code | float | 1001.2 | 内建响应码 |
– message | string | 验证码处于发送队列中。 | 可读响应消息 |
响应示例:
{ code: 1001.2, message: "验证码处于发送队列中。" }