首次驗證

最新更新:2024-06-17

1. 前置準備

要使用 EngageLab OTP 實現 驗證碼的生成、發送與驗證,在使用前,開發者需要做以下前置準備:

1.1 配置範本

根據創建 OTP 範本這個文件指引,配置 EngageLab OTP 發送的範本名稱、範本ID、品牌名稱、一次性密碼長度、一次性密碼的失效時間等信息。

EngageLab OTP 範本創建

1.2 創建 API 金鑰

使用 EngageLab OTP API 生成驗證碼或者驗證的時候,需要創建一個 API Basic鑒權金鑰,可以根據創建OTP API 金鑰這個文件指引創建。

EngageLab OTP API金鑰查看

2. 正式發送

你可以選擇2種方式發送你的第一條 EngageLab OTP 驗證消息:

2.1 網站後台發送

  • 2.1.1 生成並發送驗證碼 登入 EngageLab網站後台,進入[API調試]->[OTP發送]菜單頁,在頁面上依次填入已創建好的 API 金鑰目標手機號碼或者郵箱地址範本ID以及範本語言

EngageLab OTP API發送網站

在上述信息填寫完成後,點擊發出OTP請求,即可生成一條驗證碼,並發送給指定的目標手機號碼或者郵箱地址

如果請求成功,可以在下方的Response提示框中看到響應的發送通道和message_id:

EngageLab OTP API發送成功網站

如果請求失敗,可以在下方的Response提示框中看到具體的錯誤碼與錯誤信息:

EngageLab OTP API發送失敗網站

發送成功後,點擊歷史記錄中的消息詳情,查看生成的一次性密碼以及 message_id 。

EngageLab OTP 消息生命週期

  • 2.1.2 校驗驗證碼 登入 EngageLab網站後台,進入[API調試]->[OTP驗證]菜單頁,在頁面上依次填入已創建好的 API 金鑰、`

message_id、以及生成的一次性密碼,填寫完成後,點擊驗證 OTP 請求`按鈕即可:

EngageLab OTP API發送失敗網站

2.2 API 對接

通過代碼對接 EngageLab OTP 的API介面,具體可以參考以下2份文件:

3. 查看歷史記錄

發送成功後,可以在【歷史記錄】頁面查看範本名稱、發送時間、發送目標、消息狀態以及預估費用等信息,具體查看方法請參考文件:EngageLab OTP 歷史記錄

EngageLab OTP 消息歷史記錄

在文档中心打开
Contact Sales