通知 API
イベントの予約に関する自動メッセージを送信することで、業務を簡素化し、効果的に規模を拡大しましょう
Notifications APIを使用すると、Rapid APIとの連携をこれまで以上に緊密に行うことができます。ご予約の変更により、お客様のビジネスや業務に影響が生じる可能性がある場合、通知APIがその変更の詳細を、影響を受けるすべての関係者に直接通知いたします。メッセージは、エージェント、ベンダー、およびRapid API自体によって送信されることがあります。つまり、コールセンターの担当者が変更を加えた場合や、ベンダーが予約をキャンセルした場合、お客様に通知が届きます。同様に、APIによる新規予約の作成が正常に完了した場合、通知が届きます。この通知を活用して、社内システムとの整合性を維持することができます。
注: Lodging APIでは、エージェント、ベンダー、およびRapid API. CarおよびActivities APIでは、現在agent-initiatedでの予約変更に対応しており、まもなくRapid API内および当社のベンダーによる変更にも対応する予定です。
通知APIは、お客様のビジネスとのシームレスな連携を可能にし、他のパートナーやカスタマーサポートサービスを補完するものです。Rapid API, に新機能や機能を追加していくにつれ、ユーザーの皆様の利便性を高めるため、新しい通知イベントの種類も追加していく予定です。
イベントスキーマと詳細
すべての POST 通知イベントが下記のスキーマに従います。さまざまなイベントに新しいイベントタイプが加えられるため、この構成は変更されることがあります。
| オブジェクト | 説明 |
|---|---|
event_id | 各イベントの一意の識別子。 |
event_type | どのイベントが通知のきっかけとなったかを示します。この値はメッセージのハンドリングとルーティングに使用できます。詳細についてはイベントタイプのリストを参照してください。 |
event_time | イベント通知のタイプスタンプ (協定世界時)。 |
itinerary_id | 影響を受ける予約の旅程 ID。 |
email | 影響を受ける旅程に関連付いているお客様のメールアドレス。 |
message | 通知イベントに関する情報。itinerary.message.received型のイベントの場合、ここにはベンダーメッセージの実際のテキストが含まれます。他のすべてのイベントタイプでは、静的な、人間にとってわかりやすいイベントの説明 (英語) になります。 |
affiliate_reference_id | 影響を受ける予約のアフィリエイト参照 ID。 |
topic_tags | イベントのトピックタグ。これらは itinerary.message.received タイプのイベントでのみ提供されます。これは、当社の分析により、メッセージの本文に含まれている可能性があると判断されたタグの一覧です。>> 施設 のメッセージタグについて詳しくはこちら |
line_of_business | 当該イベントが属する事業分野です。設定可能な値:cars、flights、activities、およびpackages(properties は近日公開予定です)。このフィールドは、すべてのイベントタイプに適用されるわけではありません。注: このフィールドは現在、Rapid Car、Flight、およびActivities APIで利用可能です。Rapid Lodging APIにはまだ組み込まれていません。 |
file_name | 「file_name」フィールドを使用することで、パートナーは、その会話に正しいファイルが添付されていることを確認することができます。注: このフィールドは、Conversation APIを通じて送信された添付ファイルにのみ適用されます。 |
各通知は、JSON形式のメッセージ本文を含むHTTPS POST リクエストです。
注: 各イベントタイプごとに個別に有効化を行わないと、その種類の通知を受け取ることはできません。新しい通知イベントタイプを有効にする場合は、サポートにお問い合わせください。
サポートされているイベントタイプ
「Rapid Notifications」サービスでは、以下のイベントについて、事前の通知メッセージを提供いたします。Rapidの各事業部門によって、対応しているイベントは異なります。
API の詳細
このページで通知関連のエンドポイント定義を調べてから、API Explorer または別のテストソフトウェアを使用して、例とスキーマ定義が実際の出力とどのように比較されるかを理解します。また、当社の通知APIとの連携をテストするためにご利用いただける「通知テスター」もご用意しております。