Skip to main content
MoEngage Push API を使用すると、プッシュ通知をトリガーできます。高スループットのトランザクションおよびマーケティングのユースケース向けに設計されており、複雑なターゲティングロジックと、受信者ごとの高度なパーソナライズをサポートしています。
特定のユースケースに対応する API を選択してください。
  • トランザクション: システムによってトリガーされるイベント（OTP、ステータス更新など）には、Push API を使用します。
  • 非トランザクション: マーケティング、プロモーション、ブロードキャストメッセージには、Push Campaigns API の使用を強く推奨します。
この API は次の用途に使用します。
  • セグメントをターゲティング: すべてのユーザーまたは事前定義された特定のセグメントに通知を送信します。
  • 個人をターゲティング: Email、Mobile Number、Unique ID などの一意の属性を使用して、単一のユーザーにリーチします。
  • 大規模なパーソナライズ: Jinja テンプレートを使用して、ユーザー固有のデータを通知ペイロードに動的に挿入します。

​
API バージョン

MoEngage は、セキュリティを強化し、IP ホワイトリストのサポートを含むより詳細なレート制限を提供するために、Send Push Notification エンドポイントの v2.1 を導入しました。エンドポイントには 2 つのバージョンがあります。
v2.1 に対応するには、appId と signature をリクエストボディから移動し、X-MOE-APPKEY ヘッダーと X-MOE-PushAPI-Signature ヘッダーとして送信します。その他のリクエストボディのフィールドとレスポンスの構造はすべて変わりません。ヘッダーの完全なリファレンスについては Push API を、v2 エンドポイントの詳細については Push API（レガシー） を参照してください。

​
よくある質問

いいえ、MoEngage Push API は現在、サイレント（データのみの）通知をサポートしていません。
はい、ベーシックテンプレートは、サポートされているプラットフォームでテキストをフォーマットするための標準的な HTML タグをサポートしています。
ペイロード内に fallback オブジェクトを指定できます。パーソナライズのロジックが失敗した場合（ユーザー属性が存在しない場合など）、システムは代わりにフォールバックコンテンツを自動的に送信します。
targetUserAttributes オブジェクトで、attribute フィールドを PUSH_ID に設定し、attributeValue としてデバイストークンを指定します。
v2.1 では、IP ホワイトリストのサポートを含め、セキュリティとレート制限が強化されています。appId と signature をリクエストボディから X-MOE-APPKEY ヘッダーと X-MOE-PushAPI-Signature ヘッダーに移動し、X-MOE-Query-Type ヘッダーを追加しています。その他のリクエストボディのフィールドとレスポンスの構造は v2 から変更されていません。MoEngage は、すべての新規連携で v2.1 を推奨しています。レガシーの v2 エンドポイントは、既存の連携で引き続き完全にサポートされます。

​
Postman コレクション

API を簡単にテストできるようにしています。