OTP配信

OTP配信 API は、EngageLab プラットフォームを通じて認証コードを生成し、テンプレートで指定されたチャネル戦略に従って配信します。

EngageLab プラットフォームを使用せずに認証コードを自分で生成したい場合は、EngageLab OTP Custom Verification Code Delivery API を呼び出すことができます。

Endpoint

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

認証

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

              
              Authorization: Basic ${base64_auth_string}

            

base64_auth_string の生成アルゴリズムは次のとおりです: base64(dev_key:dev_secret)

リクエスト例

リクエストヘッダー

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

            

リクエストボディ

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

            

リクエストパラメーター

リクエストオブジェクトは 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"} が必要です。

レスポンスパラメーター

成功レスポンス

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

            

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

失敗レスポンス

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

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

            

Error Codes