カスタムOTP送信

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

このAPIは事前に生成された認証コードを送信するために特化しており、自身でコードを生成することはありません。認証コードを送信した後、検証のために認証APIを呼び出す必要はありません。

EngageLabプラットフォームで認証コードを生成したい場合は、EngageLab OTP Code Delivery APIを呼び出してください。

エンドポイント

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

認証

検証にはHTTP Basic Authenticationを使用します。HTTPヘッダーにAuthorizationを追加してください：

              
              Authorization: Basic ${base64_auth_string}

            

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

リクエスト例

リクエストヘッダー

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

            

リクエストボディ

              
              {
    "to": "+8618701235678",
    "code":"398210",
    "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"
}

            

エラーコード