NATSidentity.user.check检查标识符是否可用
Try it 面板需要启用 JavaScript。
检查手机号 / 邮箱 / 用户名是否已存在;注册前预检与前端即时提示使用。
Request Payload
消息格式:JSON
| Name | Data Type | Required | Description |
|---|---|---|---|
| identifier | string | Yes | 手机号 / 邮箱 / 用户名 |
type RequestBody = {
/** 手机号 / 邮箱 / 用户名 */
identifier: string
}{
"identifier": "chenlin"
}Response Payload
回复使用统一信封 {id, code, messages, result},其 result:
| Name | Data Type | Required | Description |
|---|---|---|---|
| exists | boolean | Yes | 该标识符是否已有账号 |
| channel | string | No | 标识符类型:phone / email / username(无法识别为空) |
type ResponseBody = {
/** 该标识符是否已有账号 */
exists: boolean
/** 标识符类型:phone / email / username(无法识别为空) */
channel?: string
}{
"exists": false,
"channel": "username"
}Response Code
回复使用统一信封 {id, code, messages, result},其 code 字段:
| code | Meaning | Notes |
|---|---|---|
| 0 | 成功 | 检查标识符是否可用 |
Examples
{ "identifier": "chenlin" }
{
"id": "01JD8SUR5N7W3Y0ZV",
"code": 0,
"messages": [],
"result": { "exists": false, "channel": "username" }
}