OTP送信

このインターフェースは、EngageLabプラットフォームによって認証コードを生成し、テンプレートで指定されたチャネル戦略に従って配信するために使用されます。

EngageLabプラットフォームを使用せずに認証コードを自分で生成したい場合は、EngageLab OTPカスタム認証コード配信インターフェースを呼び出すことができます。

エンドポイント

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

認証

HTTP基本認証を使用します。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": "+8618701235678",
    "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がフォールバックチャネルとして設定されている場合、このインターフェースはwhatsappを値として返します。一定時間後に配信が失敗した場合、システムはSMSチャネルを使用してメッセージを送信します。

失敗レスポンス

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

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

            

エラーコード