第一次验证
最新更新:2024-06-17
1. 前置准备
要使用 EngageLab OTP 实现 验证码的生成、发送与验证,在使用前,开发者需要做以下前置准备:
1.1 配置模板
按照创建 OTP 模板这个文档指引,配置 EngageLab OTP 发送的模板名称、模板ID、品牌名称、一次性密码长度、一次性密码的失效时间等信息。
1.2 创建 API 密钥
用 EngageLab OTP API 生成验证码或者验证的时候,需要创建一个 API Basic鉴权密钥,可以按照创建OTP API 密钥这个文档指引创建。
2. 正式发送
你可以选择2种方式发送你的第一条 EngageLab OTP 验证消息:
2.1 网站后台发送
- 2.1.1 生成并发送验证码
登录 EngageLab网站后台,进入[API调试]->[OTP发送]菜单页,在页面上依次填入已创建好的 API 密钥
、目标手机号码或者邮箱地址
、模板ID
以及模板语言
:
在上述信息填写完成后,点击发出OTP请求
,即可生成一条验证码,并发送给指定的目标手机号码或者邮箱地址
。
如果请求成功,可以在下方的Response
提示框中看到响应的发送通道和message_id:
如果请求失败,可以在下方的Response
提示框中看到具体的错误码与错误信息:
发送成功后,点击历史记录中的消息详情,查看生成的一次性密码
以及 message_id 。
- 2.1.2 校验验证码
登录 EngageLab网站后台,进入[API调试]->[OTP验证]菜单页,在页面上依次填入已创建好的 API 密钥
、message_id
、以及生成的一次性密码
,填写完成后,点击验证 OTP 请求
按钮即可:
2.2 API 对接
通过代码对接 EngageLab OTP 的API接口,具体可以参考以下2份文档:
3. 查看历史记录
发送成功后,可以在【历史记录】页面查看模板名称、发送时间、发送目标、消息状态以及预估费用等信息,具体查看方法请参考文档:EngageLab OTP 历史记录