MOMpro平台文档
云天梯测试导入说明
协同模块操作说明
消息配置模块文档
登录接口文档
发送登录验证码
扫一扫登录
第三方单点登录配置
系统图标接口文档
-
+
首页
发送登录验证码
d# MOMpro 发送登录验证码 ## 接口描述 用于发送登录验证码 当系统提示新环境登录时,需要携带`captchaId`参数 当系统提示短信验证码发送次数已达上限时,需要等待第二天才能再次发送 看板端和app端以及MOMpro浏览器端不需要进行验证,需要传入`type`参数,传入值分别为`kanban`,`app`,`MOMproBrowser` ### 前置条件 1. 用户已经注册且绑定手机号 2. 系统管理员已经在系统参数中配置了短信发送服务 `[Sys Sms Parameter]`,若未配置,则无法发送短信 3. (可选)系统管理员已经在系统参数中配置了短信验证码发送上限 `[Sys Phone Sms Limit]`,默认不限制 > [Sys Sms Parameter] 参数目前只能发送验证码短信 > [Sys Phone Sms Limit] 频率限制只限制登录验证码接口频率(个人中心的绑定手机号的发送频率未做上限限制) ## Authentication - 无需认证 ## POST 发送登录短信 POST /orbit/security/captcha/sms > 请求参数说明 ### 请求参数说明 |Name|Location|Type|Required|Description| |---|---|---|---|---| |body|body|object| no |none| |» phone|body|string| yes |手机号| |» captchaId|body|string| no |验证码id| |» type|body|string| no |登录类型:MOMproBrowser,kanban,app 目前登录类型为kanban,app,MOMproBrowser时,不需要验证码,其他需要验证码| > 请求参数示例 ```json { "phone": "13888888888", "captchaId": "5a8b76d7-3f14-472f-925d-b9af8e952720", "type": "kanban" } ``` > 返回体示例 > 成功 ```json { "code": 200, "message": "success", "data": null } ``` ```json { "code": 1001, "message": "手机号错误", "data": null } ``` ```json { "code": 1001, "message": "发送频率过高,请稍后再试", "data": null } ``` ```json { "code": 1114, "message": "新环境登录,请进行验证", "data": null } ``` ```json { "code": 1115, "message": "短信验证码发送次数已达上限,请稍后再试", "data": null } ```
接口文档
HL0457
2024年1月24日 13:59
分享
上一篇
下一篇
目录
微信扫一扫
复制链接
手机扫一扫进行分享
复制链接
下载Markdown文件