カスタムOTPコード配信

EngageLabプラットフォームで認証コードを生成するのではなく、お客様ご自身で生成した認証コードを送信したい場合は、このAPIを呼び出すことができます。

このAPIは、事前に生成された認証コードを送信するための専用APIであり、認証コード自体を生成する機能はありません。また、認証コード送信後に、そのコードを検証するための検証APIを呼び出す必要はありません。

EngageLabプラットフォームで認証コードを生成させたい場合は、EngageLab OTP Verification Code Delivery APIをご利用ください。

Endpoint

POST https://otp.api.engagelab.cc/v1/codes

Authentication

HTTPヘッダーにAuthorizationを追加し、HTTP Basic Authenticationを使用します。

              
              Authorization: Basic ${base64_auth_string}

            

上記のbase64_auth_stringは、次のアルゴリズムで生成します：base64(dev_key:dev_secret)

Request Example

Request Header

              
              POST /v1/codes HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Request Body

              
              {
  "to": "+6591234567",
  "code": "398210",
  "template": {
    "id": "test-template-1",
    "language": "default",
    "params": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

            

Request Parameters

リクエストオブジェクトはJSON形式で表現されるため、リクエストヘッダーにはContent-Type: application/jsonを含める必要があります。

paramsの説明

1. from_idなどのプリセットテンプレートフィールドについて、param_varsフィールドの値が指定されていない場合、メッセージ送信時にはテンプレート内であらかじめ設定されたfrom_idが使用されます。
2. param_varsフィールドの値が指定されている場合、たとえばparam_vars:{"from_id":"12345"}のように設定すると、メッセージ送信時にテンプレートのfrom_idは12345に置き換えられます。
3. テンプレート作成時に設定したテンプレートコンテンツ内のカスタム変数フィールドにも、param_varsを通じて値を割り当てます。たとえば、テンプレートコンテンツがHi {{name}}, your verify code is {{code}}である場合、割り当てパラメータparam_vars:{"name":"Bob"}が必要です。

Response Parameters

Successful Response

              
              {
  "message_id": "1725407449772531712",
  "send_channel": "sms"
}

            

返されるsend_channelの値は、メッセージが最終的にユーザーへ配信されるチャネルを示すものではなく、あくまで現在使用中のチャネルを示します。たとえば、テンプレート戦略でWhatsAppチャネルによる配信に失敗した場合にSMSチャネルで自動再試行するよう設定されている場合、APIレスポンスではwhatsappが返されます。その後、一定時間が経過して配信失敗が検出されると、システムはSMSチャネルで送信します。

Failed Response

HTTPステータスコードは4xxまたは5xxで、レスポンスボディには次のフィールドが含まれます。

              
              {
  "code": 5001,
  "message": "sms send fail"
}

            

Error Codes