重置密码场景
典型场景
通过手机号重置密码场景。
接口功能
重置密码。
接口约束
该接口不需要认证。
调用方法
POST
URI
/controller/campus/api/v1/app/retrieve-password
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
x-org-id |
否 |
string |
0~128个字符。 |
- |
租户id |
- |
x-multi-region-name |
否 |
string |
0~128个字符。 |
- |
区域名称 |
- |
appClientId |
是 |
string |
0~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 终端唯一标识。 |
"******" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
retrievePwdInfo |
是 |
REFERENCE |
详细请参见表3。 |
重置密码请求参数。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
countryCode |
是 |
string |
0~32个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 国家码。 |
"0086" |
cellphone |
是 |
string |
0~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 手机号。 |
"123****900" |
verifyCode |
是 |
string |
6个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 验证码。 |
"01**01" |
newPwd |
是 |
string |
8~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 新密码。 |
"******" |
请求示例
POST /controller/campus/api/v1/app/retrieve-password HTTP/1.1 Host: 192.168.10.10:18008 Content-Type: application/json appClientId: ****** { "cellphone": "123****900", "verifyCode": "86**21", "countryCode":"0086", "newPwd":"" }
响应参数
返回状态码为200:重置密码的返回结果。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
result |
string |
0~10个字符。 |
- |
请求验证码返回结果。 |
"success" |
errorCode |
string |
0~10个字符。 |
- |
错误码。 |
"0" |
返回状态码为400:参数错误。
详细信息请参见实际响应消息体。
返回状态码为500:内部服务器错误。
详细信息请参见实际响应消息体。
响应示例
返回状态码为200:重置密码的返回结果。
HTTP/1.1 200 OK 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 { "result" : "success", "errorCode" : "0" }
返回状态码为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