モバイル／Web メッセージング API v2 概要
Bright Pattern モバイルSDKにより、Bright Pattern モバイル／Webメッセージング API v2の利用が簡素化されます。このAPIでは、さまざまなチャネル（Webチャット、SMS、メッセンジャーサービスなど）にわたるチャット、音声、ビデオ通信をサポートしています。以下に、このAPIで利用可能なメソッドのリストを示します。APIに関する詳細な情報については、Postman上のドキュメントをご参照ください。
インタラクション前のメソッド
以下のメソッドは、インタラクションを開始する前に呼び出すことを想定しています。
利用可能状況の確認 (GET)
このメソッドは、関連するシナリオエントリーが利用可能かどうかを示します。また、EWT（推定待ち時間）を提供する場合もあります。
ICEサーバーの取得 (GET)
このメソッドは、チャットに音声・映像セッションを追加できるよう、ブラウザに提供する設定済みのICEサーバーのリストを返します。
チャットウィジェットの設定の取得 (GET)
このメソッドは、起動ポイントのチャットウィジェットの設定を返します。
バージョンの取得 (GET)
このメソッドは、サーバーのBright Pattern Contact Centerソフトウェアのバージョンを返します。この情報は、参考情報として使用できます。
インタラクション関連のメソッド
以下のメソッドは、インタラクションを開始したり、既存のインタラクションに関する情報を提供したりするためのものです。
チャットのリクエスト (POST)
このメソッドは、新規のチャットセッションを開始するか、既存のセッションのパラメータを返します。このメソッドは最初に呼び出す必要があります。
モバイル通知の登録 (POST)
このメソッドは、チャットセッションのモバイル通知を購読またはキャンセルするための、クライアントアプリケーションからのリクエストです。
期待されるパラメータ (GET)
このメソッドは、関連するシナリオエントリーの想定パラメータを返します。
アクティブなチャットの取得 (GET)
このメソッドは、アクティブなチャットセッションのプロパティを返します。
イベントの送信 (POST)
このメソッドは、クライアントからサーバー側へ、新規のチャットイベントの配列を送信します。
チャット履歴の取得 (GET)
このメソッドは、現在のセッションに関するすべてのクライアントイベントおよびすべてのサーバーイベントを返します。複数のイベントオブジェクトが返される場合があります。
新規チャットイベントの取得 (GET)
このメソッドは、現在のセッションの新規チャットイベントを返します。
ファイルのアップロード (POST)
このメソッドは、指定されたファイルをサーバーにアップロードします。
ファイルの取得 (GET)
このメソッドは、受け取ったファイルIDを使用して、サーバーから指定されたファイルをダウンロードします。
エージェントのプロフィール写真の取得 (GET)
このメソッドは、指定されたエージェントのプロフィール写真をダウンロードします。
ケース履歴の取得 (GET)
このメソッドは、特定のCRMケースオブジェクトに関連付けられているすべてのチャットセッションのトランスクリプト（つまり、チャットスレッド）をまとめて返します。
ケースのクローズ (POST)
このメソッドは、チャットセッションに関連付けられたケースを閉じるためのクライアントアプリケーションのリクエストを呼び出します。
イベント
Mobile/Web Messaging API v2には、さまざまなクライアントおよびサーバーイベントが含まれています。これらのイベントは、インタラクションに関する具体的な情報を伝達します。さらに、WebRTCベースのインタラクション（つまり、ブラウザベースのコールやビデオ通話）については、シグナリングメッセージタイプのイベントも含まれています。
詳細については、Postman上のBright Pattern Mobile/Web Messaging API v2のドキュメントをご参照ください。
APIの使用上の注意事項
アプリケーションの開発にあたっては、以下の点にご注意ください。
一般事項
- クライアントアプリケーションは、一度に1つのアクティブな通信セッションしか保持できません。
インタラクション前のメソッド
- 「Check Availability」メソッドは、「Request Chat」メソッドの前に呼び出すことができます。このメソッドは、インタラクションを開始したり、既存のインタラクションを検出したりすることはありません。
- また、APIでは実際にログインしているエージェントがいるかどうかは確認されませんので、ご注意ください。
インタラクション関連のメソッド
- 「Request Chat」メソッドは、その他すべてのインタラクション関連のメソッドよりも先に呼び出す必要があります。このメソッドは、新規のチャットセッションを開始するか、またはこの特定のクライアントに関連付けられた既存のチャットセッションが存在する場合、そのIDとパラメータを返します（例：クライアントアプリがチャットセッションを作成し、それが閉じられたりクラッシュしたりした後、サーバー側でセッションがタイムアウトする前に再起動された場合など）。
- `parameters`属性で返されるパラメータは、シナリオ変数$(item.externalChatData)に反映されます。
- アプリでプッシュ通知を使用する予定の場合（つまり、Mobile Notification Subscriptionメソッドを呼び出す場合）、アプリを作成する際には、Apple Push Notification Service（APNs）および／またはFirebase Cloud Messaging（FCM）プラットフォームを使用する必要があります。
- APN証明書および／またはFCMサーバーキーは、Bright Pattern Contact Center環境から顧客へ通知を送信できるようにするため、コンタクトセンター管理者アプリケーションの「シナリオエントリー > メッセージ送信/チャット > モバイル」タブのセクションに追加する必要があります。
- このメソッドは、Request Chatメソッドを呼び出した後に呼び出す必要があります（つまり、このメソッドの必須パラメータであるchatIdの値は、Request Chatメソッドで返されます）。
- さらに、デバイストークンが変更された際にも、このメソッドを呼び出す必要があります。
- 「Get Case History」メソッドについては、このリクエストはchat_session_case_setサーバーイベントを受信した後にのみ実行してください。シナリオでケースが特定されていない場合、リクエストはエラーを返します。