文档首页/ iMasterCloud/ API参考/ API说明/ 统一认证服务/ 手机app接口/ 通过手机获取忘记密码验证码
更新时间：2025-09-24 GMT+08:00
查看PDF
分享

通过手机获取忘记密码验证码

典型场景

通过手机获取忘记密码验证码。

接口功能

通过手机获取忘记密码验证码。

接口约束

该接口不需要认证。

调用方法

POST

URI

/controller/campus/api/v1/app/verifycode/forgetpwd-phone

请求参数

表1 header参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

x-org-id

否

string

0~128个字符。

-

租户id

-

x-multi-region-name

否

string

0~128个字符。

-

区域名称

-

appClientId

是

string

0~128个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

终端唯一标识。

"******"
表2 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

verifyInfo

是

REFERENCE

详细请参见表3。

获取忘记密码验证码请求参数。

-
表3 AppVerifyCodeParam对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

identity

否

string

0~128个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

手机号或邮箱 0086-123****8900 或 xx@xxx.xx。

"0086-123****8900"

请求示例

HTTP的示例 
POST /controller/campus/api/v1/app/verifycode/forgetpwd-phone HTTP/1.1
Host: 192.168.10.10:18008
Content-Type: application/json
appClientId: ******
{
    "identity": "0086-123****8900"
}

响应参数

返回状态码为200：获取忘记密码验证码输出信息。

表4 SendVerifyCodeOut对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

result

string

0~10个字符。

-

发送结果。

"success"

errorCode

string

0~10个字符。

-

错误码。

"0"

remainderCount

int32

[0-10]

-

剩余获取验证码的次数（超过将禁用该功能一天）。

"0"

返回状态码为400：错误请求。

详细信息请参见实际响应消息体。

返回状态码为500：内部服务器错误。

详细信息请参见实际响应消息体。

响应示例

返回状态码为200：获取忘记密码验证码输出信息。

HTTP/1.1 200 OK
Date: Sat, 30 Jan 2021 11:40:48 GMT+33m 49s
Server: product only
Content-Type: application/json
{
   "result": "success",
   "errorCode": "0",
   "remainderCount": 4
}

返回状态码为400：错误请求。

HTTP/1.1 400 Bad Request
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

返回状态码为500：内部服务器错误。

HTTP/1.1 500 Internal Server Error
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
父主题： 手机app接口

相关文档