カスタムメッセージ配信

OTP プラットフォームですでにカスタムテンプレートコンテンツを作成している場合は、この API を呼び出してカスタムメッセージコンテンツを送信できます。

Endpoint

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

Authentication

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

              
              Authorization: Basic ${base64_auth_string}

            

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

Request Format

Request Headers

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

            

Request Body

              
              {
  "to": "+6591234567",
  "template": {
    "id": "test-template-1",
    "params": {
      "code": "codevalue",
      "var1": "value1"
    }
  }
}

            

Request Parameters

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

params に関する注意事項

1. {{brand_name}}、{{ttl}}、{{pwa_url}} などのプリセットテンプレート変数は渡す必要はありません。システムが、テンプレート作成時に指定された内容に自動的に置き換えます。
2. テンプレートタイプが認証コードの場合は、{{code}} 変数を渡す必要があります。渡さない場合はエラーが返されます。
3. テンプレートコンテンツに、テンプレート作成時に定義したカスタム変数フィールドが含まれている場合は、それらについても params を通じて値を設定する必要があります。たとえば、テンプレートコンテンツが Hi {{name}}, your verify code is {{code}} の場合、params: {"name":"Bob"} というパラメータを設定する必要があります。

Request Examples

1. カスタム認証コードを送信する

              
              {
  "to": "+6591234567",
  "template": {
    "id": "code-template",
    "params": {
      "code": "123456"
    }
  }
}

            

2. カスタム通知コンテンツを送信する

              
              {
  "to": "+6591234567",
  "template": {
    "id": "notification-template",
    "params": {
      "order": "123456"
    }
  }
}

            

3. カスタムマーケティングコンテンツを送信する

              
              {
  "to": ["+6591234567"],
  "template": {
    "id": "marketing-template",
    "params": {
      "name": "EngageLab",
      "promotion": "30%"
    }
  }
}

            

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