{"info":{"_postman_id":"1d7e4813-2652-433a-9c98-56e1884ac427","name":"BPCC Mobile/Web Messaging API v2 (JA)","description":"<html><head></head><body><p>Bright Pattern Contact Center（BPCC）モバイル/Web メッセージング API v2は、開発者がチャットや音声によるインタラクションをモバイルデバイスやサードパーティ製アプリケーションと連携できるようにするRESTful APIです。BPCC モバイル/Web メッセージング API v2は、既存の<a href=\"https://documenter.getpostman.com/view/6735877/T1LHGpBY\">モバイル/Web メッセージング API v1</a>をさらに拡張したもので、Bright Pattern Contact Centerを基盤とするコンタクトセンターとの高度なチャット、音声、ビデオ通信を行う、顧客向けのモバイル、Web、メッセージングアプリケーションなど、リッチ・コンタクト・エクスペリエンスを提供するアプリケーションの開発にご使用いただけます。</p>\n<h2 id=\"機能\">機能</h2>\n<p>v1 APIに含まれるすべてのメソッドおよびイベントに加え、Mobile/Web Messaging API v2には以下の機能が含まれています：</p>\n<ul>\n<li>「<strong>Mobile Notification Subscription</strong>」メソッドによる、Apple Push Notificationサービス（iOS）およびFirebase Cloud Messagingプッシュ通知（AndroidおよびiOS）のサポート</li>\n<li>特定のCRMケースオブジェクトにリンクされたすべてのチャットセッションのトランスクリプトをまとめて返す「<strong>Get Case History</strong>」メソッド</li>\n<li>「<strong>Close Case</strong>」メソッド：クライアントアプリケーションからのリクエストにより、チャットセッションに関連付けられたケースを閉じるようにします</li>\n<li><strong>Get Version</strong>メソッド：サーバーで使用されているBright Pattern Contact Centerのバージョンを返します。</li>\n<li>チャットセッションのメッセージが配信されたか、または既読になったことを示すサーバーおよびクライアントイベント</li>\n<li>チャットセッションのケースが設定されたかどうかを示すサーバーイベント</li>\n</ul>\n<h2 id=\"メモ\">メモ</h2>\n<p>BPCC Mobile/Web メッセージング API v2 のエンドポイントプレフィックスは、以下の通りです。</p>\n<p><strong>https://[tenant_url]/clientweb/api/v2/</strong></p>\n<h1 id=\"5a6lgh6kqt6icf\">対象読者</h1>\n<p>このドキュメントは、Bright Pattern Contact Center ベースのコンタクトセンター向けのカスタムアプリケーションを開発するIT担当者および開発者を対象としています。このドキュメントの読者は、Web およびモバイルアプリケーション開発に関する専門知識に加え、コンタクトセンターの運用およびその運用に関わるリソースについて十分な理解を有していることが前提となります。</p>\n<h1 id=\"44k144oz44ox44or44ki44ox44oq44kx44o844k344on44oz\">サンプルアプリケーション</h1>\n<p>Bright Pattern では、顧客向けのリッチ・コンタクト・エクスペリエンスを提供するアプリケーションのサンプルソースコードを提供しています。このソースコードは、社内アプリケーション開発の参考として使用したり、組織の顧客向けモバイルアプリケーションやWebアプリケーションに直接組み込んだりすることができます。</p>\n<p>Webチャットアプリケーションについては、Contact Center Administratorアプリケーションの<a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/MessagingChat\">メッセージ送信/チャットシナリオエントリー</a>ページにある<strong>クライアントアプリケーション</strong>ボタンをクリックすることで、ソースコードをダウンロードできます。</p>\n<p>モバイルアプリケーションについては、<a href=\"https://bugfocus.zendesk.com/home\">Bright Pattern カスタマーサクセス管理</a>にサービスリクエストを送信することで、ソースコードを取得できます。</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"対象読者","slug":"5a6lgh6kqt6icf"},{"content":"サンプルアプリケーション","slug":"44k144oz44ox44or44ki44ox44oq44kx44o844k344on44oz"}],"owner":"58450950","collectionId":"1d7e4813-2652-433a-9c98-56e1884ac427","publishedId":"2sBYB4Lmkc","public":true,"customColor":{"highlight":"FF6C37","right-sidebar":"303030","top-bar":"FFFFFF"},"publishDate":"2026-09-29T10:20:34.000Z"},"item":[{"name":"概要","item":[],"id":"95425717-1b52-4bda-8e76-7c0212814d01","description":"<h1 id=\"リクエスト例\">リクエスト例</h1>\n<p>以下は、APIリクエストの例です：</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>URL: https://yourcompany.brightpattern.com/clientweb/api/v2/chats?tenantUrl=yourcompany.brightpattern.com\nMethod: POST\nAuthorization: MOBILE-API-140-327-PLAIN appId=\"test\", clientId=\"123\"\nContent-Type: application/json; charset=UTF-8\nUser-Agent: MobileClient\n{\n    \"phone_number\":\"3001\",\n    \"parameters\": {\n        \"first_name\":\"John\",\n        \"last_name\":\"Lee\"\n        }\n}\n\n</code></pre><h1 id=\"クライアント認証エレメント\">クライアント認証エレメント</h1>\n<p>以下のエレメントはクライアント認証に使用され、すべてのクライアントリクエストで指定する必要があります：</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Element</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>tenantUrl</td>\n<td>コンタクトセンターを識別します。これは、ログイン後に「Contact Center Administrator」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応します。</td>\n</tr>\n<tr>\n<td>appId</td>\n<td>アプリケーションを特定のシナリオに関連付けるために使用される、メッセージ送信/チャットシナリオエントリーの一意の識別子です。</td>\n</tr>\n<tr>\n<td>clientId</td>\n<td>クライアントアプリケーションの一意の識別子です。モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。これはモバイルアプリケーションによって生成される必要があり、各クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が WebChat に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</td>\n</tr>\n<tr>\n<td>User-Agent</td>\n<td>クライアントインターフェースのタイプを指定します。Webアプリケーションの場合、ブラウザの種類によって決定されます。モバイルアプリケーションの場合、このパラメータは常に<strong>MobileClient</strong>に設定する必要があります。</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"追加情報\">追加情報</h1>\n<p>元の仕様（RFC 2616）に準拠した意味を持つ標準的なHTTP応答コードについては、本ドキュメントでは扱いません。そのような応答の仕様については、<a href=\"http://www.ietf.org/rfc/rfc2616.txt\">http://www.ietf.org/rfc/rfc2616.txt</a>のセクション10を参照してください。本文書では、元の仕様からの説明が異なる（例えば、定義がより狭義である、または意味が異なる）レスポンスコードのみを規定しています。</p>\n<p><strong>注</strong>：クライアントアプリケーションは、一度に1つのアクティブな通信セッションしか持つことができません。</p>\n<h1 id=\"エラー本文\">エラー本文</h1>\n<p>レスポンスステータスコードがエラーを示している場合、サーバーはエラーに関する詳細情報を提供するために、JSON形式のレスポンス本文を返します：<br />{\"error_code\": \"エラーコード\", \"error_message\":\"エラーメッセージ\"}</p>\n<h2 id=\"認証エラー\">認証エラー</h2>\n<p>以下に、認証に関連するエラーコードの可能な値と、認証を必須とするすべてのリクエストに共通するエラーメッセージのリストを示します。</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>error_code</th>\n<th>error_message</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1000</td>\n<td>tenantUrl が存在しないか、無効です</td>\n</tr>\n<tr>\n<td>2000</td>\n<td>認証ヘッダーがありません</td>\n</tr>\n<tr>\n<td>2001</td>\n<td>認証パラメータのフォーマットが不正です</td>\n</tr>\n<tr>\n<td>2002</td>\n<td>認証スキームが不正です</td>\n</tr>\n<tr>\n<td>2003</td>\n<td>認証パラメータが欠落しています：appId</td>\n</tr>\n<tr>\n<td>2004</td>\n<td>認証パラメータが欠落しています：clientId</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"その他のエラー\">その他のエラー</h2>\n<p>以下に、その他のエラーコードおよびエラーメッセージの可能な値のリストを示します。</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>error_code</th>\n<th>error_message</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>3000</td>\n<td>アプリケーション固有 id がないか、無効です</td>\n</tr>\n<tr>\n<td>5000</td>\n<td>タイムアウト - チャットサーバーの応答に時間がかかりすぎました</td>\n</tr>\n<tr>\n<td>5001</td>\n<td>チャット接続を承認するサーバーが利用可能ではありません</td>\n</tr>\n<tr>\n<td>5003</td>\n<td>JSONリクエスト本文のデコード中にエラーが発生しました：{JSON例外メッセージ}</td>\n</tr>\n<tr>\n<td>5004</td>\n<td>チャットサーバーとの接続が切断されました</td>\n</tr>\n<tr>\n<td>5005</td>\n<td>チャットセッションが見つかりません</td>\n</tr>\n<tr>\n<td>5006</td>\n<td>モバイル起動ポイント（アプリケーション）が見つかりません</td>\n</tr>\n<tr>\n<td>5500</td>\n<td>[内部サーバーエラーメッセージ]</td>\n</tr>\n<tr>\n<td>5501</td>\n<td>アップロードサイズの上限を超過しました</td>\n</tr>\n<tr>\n<td>5502</td>\n<td>ファイルが見つかりません</td>\n</tr>\n<tr>\n<td>5509</td>\n<td>同一セッションに対する同時ポーリングリクエストが多すぎます</td>\n</tr>\n<tr>\n<td>5511</td>\n<td>イベントがありません</td>\n</tr>\n<tr>\n<td>5558</td>\n<td>[ファイル操作のエラーメッセージ]</td>\n</tr>\n<tr>\n<td>5955</td>\n<td>指定されていないサーバーエラー</td>\n</tr>\n<tr>\n<td>5601</td>\n<td>このセッションに対してケースが指定されていません。</td>\n</tr>\n<tr>\n<td>5602</td>\n<td>CRMサーバーからエラーが返されました。</td>\n</tr>\n<tr>\n<td>5603</td>\n<td>パラメータが多すぎます。</td>\n</tr>\n</tbody>\n</table>\n</div>","event":[{"listen":"prerequest","script":{"id":"d1cc90b6-0ba9-4be7-90d0-f24a8d7dd67b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"35750d2b-5d25-4070-885f-1410bca28a72","type":"text/javascript","exec":[""]}}],"_postman_id":"95425717-1b52-4bda-8e76-7c0212814d01"},{"name":"メソッド","item":[{"name":"Check Availability","id":"abd7cba0-4a19-4f75-9f6c-be48d68446bb","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""},{"key":"User-Agent","type":"text","value":"MobileClient"}],"url":"https://<tenant_url>/clientweb/api/v2/availability?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、関連付けられた<a href=\"https://help.brightpattern.com/latest:Contact-center-administrator-guide/ScenarioEntries/MessagingChat/ja\">メッセージ送信/チャットシナリオエントリー</a>の構成済みの営業時間に関する利用可能状態を返します。オプションで、<a href=\"https://help.brightpattern.com/latest:Faq/Metrics/ja#How_is_EWT_Calculated.3F\">予測待機時間（EWT）</a>（秒単位）が返される場合がありますが、サーバーに EWT 値を推定するのに十分なデータがない場合は、この情報が欠落する可能性があります。なお、この API では、実際にログインしているエージェントがいるかどうかについては確認されません。</p>\n<h1 id=\"ステータスの意味\">ステータスの意味</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>ステータス名</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>利用可能</td>\n<td>要求されたサービスが利用可能です。</td>\n</tr>\n<tr>\n<td>notAvailable：</td>\n<td>要求されたサービスを提供するオフィスは現在閉まっています。</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200 成功</td>\n<td>：シナリオエントリーの現在のステータス／EWT（オプション）を返します</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス禁止</td>\n</tr>\n<tr>\n<td>503</td>\n<td>サービス利用不可</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","availability"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「Contact Center Administrator」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"f24a10f1-360a-4533-b4ed-e20161be3fdb","name":"Check Availability Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/availability?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","availability"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"chat\": \"available\",\n    \"ewt\": \"3\"\n}"}],"_postman_id":"abd7cba0-4a19-4f75-9f6c-be48d68446bb"},{"name":"Expected Parameters","id":"284eaed0-f873-4f4b-9e23-a0bd30d4dada","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\"","description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://<tenant_url>/clientweb/api/v2/parameters?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、期待されるパラメータの配列を返します。これらのパラメータはオプションです。例えば、リクエストされたチャットセッションを処理するのに最も適したエージェントを検索したり、エージェントに対してユーザー情報を表示したりするために使用できます。これらのパラメータは、最初に <a href=\"https://help.brightpattern.com/latest:Contact-center-administrator-guide/ScenarioEntries/MessagingChat/ja\">「メッセージ送信/チャット」シナリオエントリー</a> を通じて、このモバイルアプリケーションがコンタクトセンターと通信する際に、初期設定として指定されています。</p>\n<p>現在、以下のパラメータタイプがサポートされています：</p>\n<ul>\n<li>PHONE</li>\n<li>TEXT</li>\n<li>EMAIL</li>\n<li>FIRST_NAME</li>\n<li>LAST_NAME</li>\n<li>ACCOUNT</li>\n<li>COMPANY</li>\n</ul>\n<h1 id=\"返り値\">返り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>クライアントアプリケーションから送信される可能性のあるパラメータの名前と型を含む application/json</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","parameters"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、お客様のコンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合など）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"16bee312-0302-4d6a-9ee7-cd348a9b60a5","name":"Expected Parameters Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/parameters?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","parameters"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"parameters\":[\r\n        {\r\n            \"<name>\":\"<type>\"\r\n        },\r\n        \"...\"\r\n    ]\r\n}"}],"_postman_id":"284eaed0-f873-4f4b-9e23-a0bd30d4dada"},{"name":"Request Chat","id":"a9279095-a345-4187-a352-ff5fa76327e4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"POST","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーを一意に識別する識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションを一意に識別する識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""},{"key":"Content","value":"application/json","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"phone_number\":\"<phone number for callback, if necessary>\",\r\n    \"from\":\"<propagated into scenario variable $(item.from)>\",\r\n    \"parameters\":{\r\n        \"parameter_1\":\"value_1\",\r\n        \"...\",\r\n        \"parameter_n\":\"value_n\"\r\n    }\r\n}"},"url":"https://<tenant_url>/clientweb/api/v2/chats?tenantUrl=<tenantUrl>","description":"<p>このメソッドはチャットセッションを開始します。このメソッドでは、<a href=\"https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest#6406fca1-894a-4b9b-82a9-284135e63d73\">期待されるパラメータ</a>の値の全部または一部を指定し、モバイル端末の電話番号を含める場合もあります。<a href=\"https://help.brightpattern.com/latest:Contact-center-administrator-guide/ScenarioEntries/MessagingChat/ja\">シナリオエントリーの設定</a>によっては、チャットリクエストがエージェントに配信されるとすぐに、指定された番号へのコールバックが自動的に開始される場合があります。</p>\n<p><strong>メモ</strong>:</p>\n<ul>\n<li>この特定のクライアントに関連付けられた既存のチャットセッションが現在存在する場合、「Request Chat」メソッドは、そのチャットセッションのIDおよびパラメータを返すことがあります。例えば、クライアントアプリがチャットセッションを作成した後、そのセッションが閉じたりクラッシュしたりしたものの、サーバー上でセッションがタイムアウトする前に再起動された場合などが挙げられます。</li>\n<li>_「is_new_chat」_レスポンス属性は、チャットが新規セッションか既存セッションかを示します。クライアントアプリケーションはこれらを異なる方法で処理します（例：既存セッションの場合、アプリはセッション履歴を要求し、前の内容を表示することがあります）。</li>\n<li>関連するモバイル／ウェブシナリオエントリーが自動コールバック用に設定されていない場合でも、エージェントはこの番号を使用して、エージェント自身の判断で、あるいはモバイルユーザーからのチャットメッセージで依頼があった場合に、手動でモバイルユーザーに電話をかけることができます。</li>\n<li>_「from」_パラメータは、デバイスの所有者の名前または電話番号を指定するために使用できます。これは、シナリオ変数 <em>$(item.from)</em> に格納されます。</li>\n<li><em>parameters</em> 属性で返されるパラメータは、シナリオ変数 <a href=\"https://help.brightpattern.com/latest:Scenario-builder-reference-guide/Reference/VariablesandExpressions/Variables/ja#.24.28item.externalChatData.29\">$(item.externalChatData)</a> に伝達されます。</li>\n<li>オプションとして、<a href=\"https://help.brightpattern.com/latest:Faq/Metrics/ja#How_is_EWT_Calculated.3F\">EWT (予測待機時間)</a> （秒単位）を返すことも可能ですが、サーバーに EWT 値を推定するのに十分なデータがない場合、この値が欠落することがあります。これは、厳格な JSON シリアライゼーションを採用しているクライアントにとって重要となる可能性があります（つまり、この属性が欠落していると、クライアントアプリが JSON のデシリアライズに失敗する可能性があります）。</li>\n</ul>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>チャットセッションのプロパティ（コンテンツタイプ：application/json）</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>503</td>\n<td>サービス利用不可</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"a763f8c6-3493-455e-8b1b-628f798d4d4f","name":"Request Chat Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"phone_number\": \"16508888888\",\r\n    \"from\": \"51.18.205.152\",\r\n    \"parameters\": {\r\n        \"FIRST_NAME\": \"Aiden\",\r\n        \"LAST_NAME\": \"Bookbinder\"\r\n    }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats?tenantUrl=yourcompany","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats"],"query":[{"key":"tenantUrl","value":"yourcompany"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"state\": \"ivr\",\n    \"ewt\": \"0\",\n    \"chat_id\": \"d6c1adc2-385b-42e5-9e0a-1883c2bc5f81\",\n    \"is_new_chat\": true,\n    \"phone_number\": \"16508888888\"\n}"}],"_postman_id":"a9279095-a345-4187-a352-ff5fa76327e4"},{"name":"Mobile Notification Subscription","id":"fc605da6-d70f-42c3-9054-57fefedf7206","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true,"user-agent":true}},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<Unique app identifier>\", clientId=\"<Unique client ID>\" "},{"key":"User-Agent","type":"text","value":"MobileClient"}],"body":{"mode":"raw","raw":"// For Apple Push Notification service (APNs):\r\n{\r\n    \"ios_apns_device_token\": \"<iOS APNs device token>\",\r\n    \"ios_app_bundle_id\": \"<iOS app ID>\"\r\n}\r\n// For Apple Firebase:\r\n{\r\n    \"ios_firebase_device_token\": \"<Firebase token>\"\r\n}\r\n//For Android Firebase:\r\n{\r\n    \"android_firebase_device_token\": \"<Firebase token>\"\r\n}"},"url":"https://<tenant_url>/clientweb/api/v2/chats/:chatId/notifications?tenantUrl=<tenant URL>","description":"<p>このメソッドは、チャットセッションのモバイル通知の登録またはキャンセルをクライアントアプリケーションがリクエストするためのものです。</p>\n<h1 id=\"メモ\">メモ</h1>\n<ul>\n<li>このメソッドは、<strong>Request Chat</strong> メソッドを呼び出した<strong>後に</strong>呼び出す必要があります（つまり、このメソッドに必須の <em>chatId</em> の値は、Request Chat メソッドで返されます）。</li>\n<li>また、デバイストークンが変更された際にも、このメソッドを呼び出す必要があります。</li>\n<li>クライアントアプリケーションは、この API メソッドを使用して、モバイル通知の受信を停止することもできます。</li>\n</ul>\n<p>JSON 本文を空（{}）にして呼び出すことで、クライアントアプリケーションはモバイル通知の受信を停止することもできます。</p>\n<h1 id=\"リクエストパラメータ\">リクエストパラメータ</h1>\n<p>モバイルアプリケーションは、アプリケーションの\nオペレーティングシステムおよび使用される通知フレームワークに応じて、以下のパラメータのいずれかを指定します。</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ名</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ios_apns_device_token</td>\n<td>ネイティブ APNs を使用する iOS アプリケーション</td>\n</tr>\n<tr>\n<td>ios_app_bundle_id</td>\n<td>ネイティブ APNs を使用する iOS デバイスの場合、このパラメータは必須であり、APNs トピックとして使用されます</td>\n</tr>\n<tr>\n<td>ios_firebase_device_token</td>\n<td>Firebase 通知を使用する iOS アプリケーション</td>\n</tr>\n<tr>\n<td>android_firebase_device_token</td>\n<td>Firebase 通知を使用する Android アプリケーション</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>設定済みのサービス名と現在のステータス</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>406</td>\n<td>受け入れ不可：パラメータが多すぎます／「メッセージング／チャット」エントリに対応する通知が設定されていません</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats",":chatId","notifications"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、お客様のコンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenant URL>"}],"variable":[{"description":{"content":"<p>現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、そのレスポンス本文に含まれます。</p>\n","type":"text/plain"},"type":"any","value":"<chat ID>","key":"chatId"}]}},"response":[{"id":"ad264171-ce5d-4439-9007-57f6a206b2bf","name":"Mobile Notification Subscription","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User-Agent","type":"text","value":"MobileClient"}],"body":{"mode":"raw","raw":"{\r\n    \"ios_apns_device_token\": \"<iOS APNs device token>\",\r\n    \"ios_app_bundle_id\": \"<iOS app ID>\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/notifications?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","notifications"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com","type":"text"}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"fc605da6-d70f-42c3-9054-57fefedf7206"},{"name":"Get Active Chat","id":"2ca665be-5d72-4547-bab9-0c6ba1f254ac","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、各クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://<tenant_url>/clientweb/api/v2/chats/active?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、アクティブなチャットセッションのプロパティを返します。オプションで、<a href=\"https://help.brightpattern.com/latest:Faq/Metrics/ja#How_is_EWT_Calculated.3F\">EWT (予測待機時間)</a> （秒単位）が返される場合がありますが、サーバーがEWT値を推定するのに十分なデータを持っていない場合は、この情報が欠落している可能性があります。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>チャットセッションのプロパティ（コンテンツタイプ：application/json）</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats","active"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されない場合など）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"0e11acc0-58bb-4238-8d32-6b7fca49c003","name":"Get Active Chat Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/active?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats","active"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"chat_id\":\"<chat ID>\",\r\n    \"state\":\"<queued|connected|ivr>\",\r\n    \"ewt\":\"<estimated wait time for a chat in state queued>\",\r\n    \"phone_number\":\"<phone number that will be used for callback>\"\r\n}"}],"_postman_id":"2ca665be-5d72-4547-bab9-0c6ba1f254ac"},{"name":"Send Events","id":"178da895-16ec-412f-bc8f-ff306e9c6022","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\"","description":"<p>appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.</p>\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"events\":[\n        \"<array of new chat events from server>\"\n    ]\n}"},"url":"https://<tenant_url>/clientweb/api/v2/chats/:chatId/events?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、クライアントからサーバー側へイベントを送信します。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>成功</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>400</td>\n<td>不正なリクエスト</td>\n</tr>\n<tr>\n<td>403</td>\n<td>アクセス禁止</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"パラメーター\">パラメーター</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Location</th>\n<th>Key</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>header</code></td>\n<td><code>Content-Type</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code>header</code></td>\n<td><code>Authorization</code></td>\n<td>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</td>\n</tr>\n<tr>\n<td><code>header</code></td>\n<td><code>User-Agent</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code>query</code></td>\n<td><code>tenantUrl</code></td>\n<td>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。また、この変数により、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td><code>chatId</code></td>\n<td>現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、そのレスポンス本文として返されます。</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats",":chatId","events"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>Identifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[{"description":{"content":"<p>The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.</p>\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"69177f84-a874-4292-ad9e-d68764cff3cf","name":"Send Events Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User-Agent","type":"text","value":"MobileClient"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n “events”: [<array of chat events>\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/events?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","events"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"178da895-16ec-412f-bc8f-ff306e9c6022"},{"name":"Get Chat History","id":"7bd46d96-74a9-4395-84a7-6a483e4f7104","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\"","description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://<tenant_url>/clientweb/api/v2/chats/:chatId/history?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、現在のセッションにおけるすべての<a href=\"https://help.brightpattern.com/latest:Api/ja\">クライアントイベント</a>およびすべての<a href=\"https://help.brightpattern.com/latest:Api/ja\">サーバーイベント</a>を返します。複数のイベントオブジェクトが返される場合がありますが、各イベントの<em>timestamp</em>属性を使用することで、正しいメッセージの順序を復元できます。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>チャットイベントの配列（コンテンツタイプ：application/json）</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats",":chatId","history"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[{"description":{"content":"<p>現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、その本文として返されます。</p>\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"e5cf665d-dc79-4c79-a401-a5c9a802f0e8","name":"Get Chat History Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/history?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","history"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"events\":[\r\n        \"<array of chat events>\"\r\n    ]\r\n}"}],"_postman_id":"7bd46d96-74a9-4395-84a7-6a483e4f7104"},{"name":"Get New Chat Events","id":"564c7dc5-5577-42da-baf7-8214aea5e192","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの各組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://<tenant_url>/clientweb/api/v2/chats/:chatId/events?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、現在のセッションにおける新規のチャットイベントを返します。新規のイベントがない場合、サーバーはタイムアウト期間中（つまり、約5～15秒間）、リクエストをアクティブな状態に保つことができます。 前のリクエストがアクティブな状態のまま、クライアントが新規のイベントを取得するために別のリクエストを送信した場合、サーバーはエラー400（Bad Request）を返します。</p>\n<h1 id=\"returns\">Returns</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>チャットイベントの配列（コンテンツタイプ：application/json）</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"errors\">Errors</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n<tr>\n<td>429</td>\n<td>リクエストが多すぎます</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats",":chatId","events"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数により、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[{"description":{"content":"<p>現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、その本文に返されます。</p>\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"9faecc10-cd11-4f12-95d0-9914d02e9e2e","name":"Get New Chat Events Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/events?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","events"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"events\":[\r\n        \"<array of chat events>\"\r\n    ]\r\n}"}],"_postman_id":"564c7dc5-5577-42da-baf7-8214aea5e192"},{"name":"Upload File","id":"e7021678-d3c2-43ed-96c8-27cf5470ebea","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\"","description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"<p>The file or text to be uploaded</p>\n","type":"file","src":"/C:/Users/Lenovo/Desktop/important_file.txt"}]},"url":"https://<tenant_url>/clientweb/api/v2/files?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、ファイルをサーバーにアップロードします。ファイルの最大サイズは25 MBです。サーバーには最大1000個のファイルが保存されます。新しく受信したファイルは、最も古いファイルを上書きします。このメソッドは、例えば、クライアントのモバイルアプリケーションからコンタクトセンターのエージェントへ画像を送信する際などに使用できます。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>chat_session_file メッセージで使用するファイル ID（コンテンツタイプ：application/json）</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>400</td>\n<td>不正なリクエスト</td>\n</tr>\n<tr>\n<td>403</td>\n<td>アクセス禁止</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","files"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターの識別子を識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"cdb06c18-857f-470c-b3c3-57132b9d90e5","name":"Upload File Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","src":"/C:/Users/Lenovo/Desktop/important_file.txt"}]},"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/files?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","files"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"file_id\":\"file ID to use in chat_session_file message\"\r\n}"}],"_postman_id":"e7021678-d3c2-43ed-96c8-27cf5470ebea"},{"name":"Get File","id":"472169ef-8976-4cea-bf2a-69c6e8d739c2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":[]},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""}],"url":"https://<tenant_url>/clientweb/api/v2/chats/:chatId/files/:fileId","description":"<p>このメソッドは、受け取ったファイルIDを使用して、サーバーからファイルをダウンロードします。サーバーイベント「Chat Session File」をご参照ください。</p>\n<h1 id=\"returns\">Returns</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>ファイルのコンテンツタイプ</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"errors\">Errors</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats",":chatId","files",":fileId"],"host":["<tenant_url>"],"query":[{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[{"description":{"content":"<p>現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、そのレスポンス本文に含まれます。</p>\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"description":{"content":"<p>ダウンロードするファイルのファイルID</p>\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"839de99c-22a2-4be9-8ada-26a5977fb59b","name":"Get File Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/files/:fileId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","files",":fileId"],"query":[{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"},{"key":"fileId","value":"e1f234c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"File content type"}],"_postman_id":"472169ef-8976-4cea-bf2a-69c6e8d739c2"},{"name":"Get Agent Profile Photo","id":"6313bed7-deff-44d4-83cf-046b9ec76452","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""}],"url":"https://<tenant_url>/clientweb/api/v2/chats/:chatId/profilephotos/:partyId","description":"<p>このメソッドは、指定されたエージェントのプロフィール写真をダウンロードします。</p>\n<h1 id=\"リクエスト本文\">リクエスト本文</h1>\n<p>リクエスト本文には、現在のチャットセッションに参加しているエージェントのパーティ ID を指定します。</p>\n<p>注： パーティ ID は、チャットイベント（https://{host:port}/clientweb/api/v1/chats/{chatId}/events?tenantUrl={tenantUrl}) でポーリングされます）とともに提供されます。たとえば、<em>chat_session_party_joined</em> のイベントメッセージに <em>party_ID</em> が含まれています。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>ファイルのコンテンツタイプ</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","chats",":chatId","profilephotos",":partyId"],"host":["<tenant_url>"],"query":[],"variable":[{"description":{"content":"<p>現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際のレスポンス本文で返されます。</p>\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"description":{"content":"<p>現在のチャットセッションにおけるエージェントのパーティID</p>\n","type":"text/plain"},"type":"any","value":"","key":"partyId"}]}},"response":[{"id":"789167c1-9395-4362-8106-8da7c531e1ab","name":"Get Agent Profile Photo Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/profilephotos/:partyId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","profilephotos",":partyId"],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"},{"key":"partyId","value":"e5f23c35-ffec-4dcb-8f7f-755b6395a6dd"}]}},"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"File content type"}],"_postman_id":"6313bed7-deff-44d4-83cf-046b9ec76452"},{"name":"Get ICE servers","id":"cc429408-d564-46b5-94f8-9f729bee03a1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""},{"key":"User-Agent","type":"text","value":"MobileClient"}],"url":"https://<tenant_url>/clientweb/api/v2/iceservers?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、チャットに音声・映像セッションを追加できるように、ブラウザに提供する設定済みのICEサーバーのリストを返します。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>成功：ICEサーバーの情報を含むJSONレスポンス</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","iceservers"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数により、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"8f05c2e6-7b68-47c3-91d7-22113ae0f672","name":"Get ICE servers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://<tenant_url>/clientweb/api/v2/iceservers?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["<tenant_url>"],"path":["clientweb","api","v2","iceservers"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"servers\":[{\r\n    \"url\": \"<url>\",\r\n    \"username\": \"<(optional) username>\",\r\n    \"credential\": \"<(optional) password>\"\r\n  }]\r\n}\r\n"}],"_postman_id":"cc429408-d564-46b5-94f8-9f729bee03a1"},{"name":"Get Chat Widget Configuration","id":"065e52c9-535c-46cd-96a9-d641ea329fee","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの各組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<app_id>\", clientId=\"WebChat\""},{"key":"User-Agent","type":"text","value":"MobileClient"}],"url":"https://<tenant_url>/clientweb/api/v2/configuration?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、起動ポイントのチャットウィジェットの設定を返します。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>成功：ICE サーバーの情報を含む JSON レスポンス</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","configuration"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"7a4824aa-d89e-43ab-ad50-1e7fcbc56457","name":"Get Chat Widget Configuration","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcontactcenter.brightpattern.com/clientweb/api/v2/configuration?tenantUrl=yourcontactcenter.brightpattern.com","protocol":"https","host":["yourcontactcenter","brightpattern","com"],"path":["clientweb","api","v2","configuration"],"query":[{"key":"tenantUrl","value":"yourcontactcenter.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"widgets\":[\r\n     {\r\n       \"name\": \"<widget name>\",\r\n       \"urls\":[\"<url>\", …],\r\n       \"definition\": {\r\n         \"contact_tab\":{\r\n           \"enabled\": true|false,\r\n           \"location\": \"top_left|top_middle|top_right\r\n                       |right_top|right_middle|right_bottom\r\n                       |bottom_left| bottom_middle|bottom_right\r\n                       |left_top|left_middle|left_bottom\",\r\n           \"color\": \"<color>\",\r\n           \"bg_color\": \"color\",\r\n           \"font\": {\r\n             \"family\": \"<font family>\",\r\n             \"size\": \"<font size>\",\r\n             \"style\": \"<font style>\",\r\n             \"weight\": \"<font weight>\"   \r\n           },\r\n           \"agents_available_msg\": \"<msg>\",\r\n           \"agents_not_available_msg\": \"<msg>\",\r\n           \"out_of_hours_msg\": \"<msg>\",\r\n           \"show_ewt_out_of_hours\": true|false  \r\n         }\r\n       },\r\n\t    \"styles\":{\r\n\t\t    \"style1\":{\r\n                \"contentMargin\" : {\r\n                    \"margin\": \"\"\r\n                },\r\n                \"titleFont\" : {\r\n                    \"font-family\": \"\",\r\n                    \"font-style\": \"\",\r\n                    \"font-size\": \"\",\r\n                    \"font-weight\": \"\"\t\r\n                },\r\n                \"contactTabFont\" : {\r\n                    \"font-family\": \"\",\r\n                    \"font-style\": \"\",\r\n                    \"font-size\": \"\",\r\n                    \"font-weight\": \"\"\t\r\n                },\r\n                \"systemMessage\" : {\r\n                    \"background-color\": \"\"\r\n                },\r\n                \"agentMessage\" : {\r\n                    \"background-color\": \"\"\r\n                },\r\n                \"widgetBorder\" : {\r\n                    \"border\": \"1px solid etc...\",\r\n                    \"border-radius\": \"\"\r\n                },\r\n                \"contactTabBorder\": {\r\n                    \"border\": \"1px solid etc...\",\r\n                    \"border-radius\": \"\"\r\n                },\r\n                \"widgetBackground\" {\r\n                    \"background\": \"url(img.png) #fff repeat-y\"        \r\n                },\r\n                \"baseFont\": {\r\n                    \"font-family\": \"\",\r\n                    \"font-style\": \"\",\r\n                    \"font-size\": \"\",\r\n                    \"font-weight\": \"\",\r\n                    \"color\": \"\"\r\n                },    \r\n                \"dialogShadow\": {\r\n                    \"box-shadow\":\"\"\r\n                }    \r\n            }\r\n        } \r\n     }\r\n  ]\r\n}\r\n"}],"_postman_id":"065e52c9-535c-46cd-96a9-d641ea329fee"},{"name":"Get Case History","id":"9b73dce6-c69a-475d-a1f7-6ff2b3b3fcae","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの各組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<Unique app identifier>\", clientId=\"<Unique client ID>\" "},{"key":"User","type":"text","value":"MobileClient"}],"url":"https://<tenant_url>/clientweb/api/v2/casehistory?tenantUrl=<tenant URL>","description":"<p>このメソッドは、特定のCRMケースオブジェクトに関連付けられているすべてのチャットセッション（すなわち、チャットスレッド）の統合されたトランスクリプトを返します。なお、このリクエストは <em>chat_session_case_set</em> サーバーイベントを受信した後にのみ実行してください。シナリオでケースが指定されていない場合、リクエストはエラーを返します。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>成功：application/json</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス拒否</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n<tr>\n<td>406</td>\n<td>受け入れ不可：シナリオでケースが指定されていなかった場合</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","casehistory"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターの識別子を識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenant URL>"}],"variable":[]}},"response":[{"id":"93f58937-4709-4a78-8a81-cab5b876138d","name":"Get Case History","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User","type":"text","value":"MobileClient"}],"url":{"raw":"https://yourcontactcenter.brightpattern.com/clientweb/api/v2/casehistory?tenantUrl=yourcontactcenter.brightpattern.com","protocol":"https","host":["yourcontactcenter","brightpattern","com"],"path":["clientweb","api","v2","casehistory"],"query":[{"key":"tenantUrl","value":"yourcontactcenter.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"sessions\": [\r\n        {\r\n            \"chat_id\":\"<session 1 ID>\",\r\n            \"created_time\":<Unix timestamp in seconds>,\r\n            \"events\":<array of events from this chat session>\r\n        },\r\n        ...\r\n        {\r\n            \"chat_id\":\"<session 4 ID>\",\r\n            \"created_time\":<Unix timestamp in seconds>,\r\n            \"events\":<array of events from this chat session>\r\n        },\r\n        ...     \r\n    ]\r\n}"}],"_postman_id":"9b73dce6-c69a-475d-a1f7-6ff2b3b3fcae"},{"name":"Close Case","id":"4e171ac6-d549-4709-b329-a4e9b48427c9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"POST","header":[{"description":"<p>appId は、メッセージ送信/チャットシナリオエントリーを一意に識別する識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションを一意に識別する識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"<Unique app identifier>\", clientId=\"<Unique client ID>\" "},{"key":"User-Agent","type":"text","value":"MobileClient"}],"url":"https://<tenant_url>/clientweb/api/v2/closecase?tenantUrl=<tenant URL>","description":"<p>このメソッドは、チャットセッションに関連付けられたケースをクローズするよう、クライアントアプリケーションにリクエストを送信します。なお、このリクエストは、<em>chat_session_case_set</em> サーバーイベントを受信した後にのみ実行してください。シナリオでケースが指定されていない場合、リクエストはエラーを返します。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>ケースが正常にクローズされました</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>403</td>\n<td>アクセス禁止</td>\n</tr>\n<tr>\n<td>404</td>\n<td>見つかりません</td>\n</tr>\n<tr>\n<td>406</td>\n<td>受け入れ不可：シナリオでケースが指定されていませんでした</td>\n</tr>\n<tr>\n<td>500</td>\n<td>サーバーエラー：ケースが指定されていますが、クローズできません（つまり、CRMサーバーからエラー応答が返されました）</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","closecase"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に相当します。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenant URL>"}],"variable":[]}},"response":[{"id":"3ed74165-7849-471b-9f47-782c6c7831a7","name":"Close Case","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/closecase?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","closecase"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"4e171ac6-d549-4709-b329-a4e9b48427c9"},{"name":"Get Version","id":"b472fa2f-b1ae-4c89-a07e-b903115c2ee8","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"<Unique app identifier>\", clientId=\"<Unique client ID>\" ","description":"<p>appId は、メッセージ送信/チャットシナリオエントリーを一意に識別する識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションを一意に識別する識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。</p>\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://<tenant_url>/clientweb/api/v2/version?tenantUrl=<tenantUrl>","description":"<p>このメソッドは、サーバーのBright Pattern Contact Centerソフトウェアのバージョンを返します。これは、情報提供の目的で使用できます（たとえば、アプリケーションウィンドウの下部や情報ダイアログウィンドウにバージョン番号を表示したり、クライアントアプリケーションのログでサーバーのバージョンを確認したりする場合などです）。 なお、このメソッドは Mobile/Web Messaging API v1 では利用できません。</p>\n<h1 id=\"戻り値\">戻り値</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>OK：成功</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"エラー\">エラー</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>コード</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>404</td>\n<td>Not Found：たとえば、v2エンドポイントの代わりに既存のMobile/Web Messaging API v1エンドポイントが呼び出された場合など</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["clientweb","api","v2","version"],"host":["<tenant_url>"],"query":[{"description":{"content":"<p>コンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。</p>\n","type":"text/plain"},"key":"tenantUrl","value":"<tenantUrl>"}],"variable":[]}},"response":[{"id":"9d8c9df2-0abd-4b3f-9474-3a33fa123d20","name":"Get Version","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/version?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","version"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"server_version\": \"5.5.6.12345 (Stable)\"\n}"}],"_postman_id":"b472fa2f-b1ae-4c89-a07e-b903115c2ee8"}],"id":"dc5b2b3c-1753-43e6-94a2-0cb844e9a0aa","_postman_id":"dc5b2b3c-1753-43e6-94a2-0cb844e9a0aa","description":""},{"name":"イベント","item":[{"name":"クライアント向けイベント","item":[],"id":"d30d6c61-0efe-4895-bcb1-3605a0e5c209","description":"<h1 id=\"chat_session_message\">chat_session_message</h1>\n<p>このイベントには、新規のチャットメッセージが含まれています。</p>\n<h2 id=\"パラメータ\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>msg_id</td>\n<td>メッセージの一意の識別子で、以下のフォーマット（chatId:messageNumber）で指定されます</td>\n</tr>\n<tr>\n<td>msg</td>\n<td>メッセージのコンテンツ</td>\n</tr>\n<tr>\n<td>channel</td>\n<td>チャットチャンネル（例：Web、Twitter、WhatsApp など）</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_message\",\n    \"msg_id\": \"&lt;message id&gt;\",\n    \"msg\": \"&lt;chat message&gt;\",\n    \"channel\": \"chat channel&gt;\n}\n</code></pre>\n<h1 id=\"chat_session_message_delivered\">chat_session_message_delivered</h1>\n<p>モバイルアプリケーションは、相手からメッセージを受信した際に、このイベントを送信します。</p>\n<h2 id=\"パラメータ-1\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ref_msg_id</td>\n<td>配信されたメッセージの一意の識別子</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-1\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_message_delivered\",\n    \"ref_msg_id\": \"&lt;message id&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_message_read\">chat_session_message_read</h1>\n<p>ユーザーがメッセージを既読にした際、モバイルアプリケーションはこのイベントを送信します。</p>\n<h2 id=\"パラメータ-2\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ref_msg_id</td>\n<td>既読となったメッセージの一意の識別子</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-2\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_message_read\",\n    \"ref_msg_id\": \"&lt;message id&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_typing\">chat_session_typing</h1>\n<p>このイベントは、クライアントアプリケーションのユーザーが文字入力を開始した際に送信されます。</p>\n<h2 id=\"フォーマット-3\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_typing\"\n}\n</code></pre>\n<h1 id=\"chat_session_not_typing\">chat_session_not_typing</h1>\n<p>このイベントは、クライアントアプリケーションのユーザーが入力を停止した際に送信されます。</p>\n<h2 id=\"フォーマット-4\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_not_typing\"\n}\n</code></pre>\n<h1 id=\"chat_session_form_data\">chat_session_form_data</h1>\n<p>このイベントには、サーバーが_イベント「chat_session_form_show」_経由で要求したデータが含まれています。</p>\n<h2 id=\"フォーマット-5\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_form_data\",\n    \"form_request_id\": \"&lt;form request ID from the corresponding server event&gt;\",\n    \"form_name\": \"&lt;form name&gt;\",\n    \"data\": {\n        \"param1\": \"value1\",\n        …\n        }\n}\n</code></pre>\n<h1 id=\"chat_session_secure_form_data\">chat_session_secure_form_data</h1>\n<p>このイベントには、イベント「_chat_session_secure_form_show」_経由でサーバーから要求されたデータが含まれています。</p>\n<h2 id=\"フォーマット-6\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_secure_form_data\",\n    \"form_request_id\": \"&lt;form request ID from the corresponding server event&gt;\",\n    \"form_name\": \"&lt;form name&gt;\",\n    \"data\": {\n        \"param1\": \"value1\",\n        …\n        }\n}\n</code></pre>\n<h1 id=\"chat_session_secure_form_cancel\">chat_session_secure_form_cancel</h1>\n<p>このイベントは、セキュアフォームがキャンセルされたことを通知するために、サーバーから、またはサーバーへ送信されます。</p>\n<h2 id=\"フォーマット-7\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_secure_form_cancel\",\n    \"form_request_id\": \"&lt;form request ID from the corresponding server event&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_end\">chat_session_end</h1>\n<p>このイベントは、チャットセッションを終了させます。</p>\n<h2 id=\"フォーマット-8\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_end\"\n}\n</code></pre>\n<h1 id=\"chat_session_disconnect\">chat_session_disconnect</h1>\n<p>このイベントは、現在のチャット会話を終了しますが、セッションは開いたままにします（つまり、シナリオによってコントロールされた状態を維持します）。サーバーから追加の情報（例：アンケートフォームなど）が返される可能性がある場合は、<em>chat_session_end</em> の代わりにこのメッセージを使用できます。</p>\n<h2 id=\"フォーマット-9\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_disconnect\"\n}\n</code></pre>\n<h1 id=\"chat_session_signaling\">chat_session_signaling</h1>\n<p>このイベントは、クライアントからサーバーへのWebRTCシグナリングメッセージを格納するためのコンテナメッセージです。これらのメッセージは、チャットセッションの履歴には保存されません。</p>\n<h2 id=\"パラメータ-3\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>msg_id</td>\n<td>メッセージの一意の識別子で、以下のフォーマット（chatId:messageNumber）で表されます</td>\n</tr>\n<tr>\n<td>chatId</td>\n<td>クライアントのチャットリクエストに対してサーバーが返す、チャットセッションの一意の識別子</td>\n</tr>\n<tr>\n<td>messageNumber</td>\n<td>チャット交換における当該メッセージの順序番号</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-10\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_signaling\",\n    \"msg_id\": \"&lt;message id&gt;\",\n    \"destination_party_id\": \"&lt;agent party id&gt;\",\n    \"data\": \"&lt;signaling message&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_file\">chat_session_file</h1>\n<p>このイベントは、クライアントがサーバーにファイルをアップロードしたことを通知するものです。</p>\n<h2 id=\"パラメータ-4\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>msg_id</td>\n<td>以下のフォーマット（chatId:messageNumber）で表される、メッセージの一意の識別子です。</td>\n</tr>\n<tr>\n<td>chatId</td>\n<td>クライアントからのチャットリクエストに対してサーバーから返される、チャットセッションの一意の識別子</td>\n</tr>\n<tr>\n<td>messageNumber</td>\n<td>チャットでのやり取りにおける、指定されたメッセージの順序番号</td>\n</tr>\n<tr>\n<td>fileId</td>\n<td>アップロードされたファイルを識別します</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-11\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_file\",\n    \"msg_id\": \"&lt;message id&gt;\",\n    \"file_type\": \"&lt;image|attachment&gt;\",\n    \"file_id\": \"&lt;file id&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_location\">chat_session_location</h1>\n<p>このイベントには、新規の地理的位置メッセージが含まれています。</p>\n<h2 id=\"パラメータ-5\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>msg_id</td>\n<td>メッセージの一意の識別子で、以下のフォーマットで指定されます（chatId:messageNumber）</td>\n</tr>\n<tr>\n<td>url</td>\n<td>地図のURL（オプション）</td>\n</tr>\n<tr>\n<td>latitude</td>\n<td>位置情報の緯度</td>\n</tr>\n<tr>\n<td>longitude</td>\n<td>位置情報の経度</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-12\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_location\",\n    \"msg_id\": \"&lt;message id&gt;\"\n    \"url\": \"&lt;map URL (optional)&gt;\",\n    \"latitude\": \"&lt;latitude&gt;\",\n    \"longitude\": \"&lt;longitude&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_navigation\">chat_session_navigation</h1>\n<p>このイベントは、クライアントから、そのウェブページのロケーション（つまり、ページ名またはURL）とともに送信されます。</p>\n<h2 id=\"パラメータ-6\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>msg_id</td>\n<td>メッセージの一意の識別子で、以下のフォーマットとなります（chatId:messageNumber）</td>\n</tr>\n<tr>\n<td>title</td>\n<td>ページのタイトル</td>\n</tr>\n<tr>\n<td>page</td>\n<td>ページ名またはページのURL</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-13\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_navigation\",\n    \"msg_id\": \"&lt;message id&gt;\",\n    \"title\": \"&lt;page title&gt;\",\n    \"page\": \"&lt;page name or page url&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_cobrowsing_rejected\">chat_session_cobrowsing_rejected</h1>\n<p>このイベントは、ユーザーがブラウザ共有セッションを拒否したことをサーバーに通知します。</p>\n<h2 id=\"フォーマット-14\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_cobrowsing_rejected\"\n}\n</code></pre>\n<h1 id=\"chat_session_cobrowsing_started\">chat_session_cobrowsing_started</h1>\n<p>このイベントは、ユーザーがブラウザ共有セッションを承認して開始したことをサーバーに通知します。</p>\n<h2 id=\"フォーマット-15\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_cobrowsing_started\",\n    \"provider_type\": \"&lt;Name of chat co-browsing provider&gt;\",\n    \"cobrowsing_url\": \"&lt;URL of the co-browsing session&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_cobrowsing_ended\">chat_session_cobrowsing_ended</h1>\n<p>このイベントは、ユーザーがブラウザ共有セッションを終了したことをサーバーに通知します。</p>\n<h2 id=\"フォーマット-16\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_cobrowsing_ended\"\n}\n</code></pre>\n","event":[{"listen":"prerequest","script":{"id":"d72c9c06-5477-40dc-99cb-ec0b9b6e444c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96a44854-e3ec-400c-96bc-5a8a784a4db4","type":"text/javascript","exec":[""]}}],"_postman_id":"d30d6c61-0efe-4895-bcb1-3605a0e5c209"},{"name":"サーバーイベント","item":[],"id":"cf7b32a4-f252-43b7-83b8-183b956f899f","description":"<h1 id=\"chat_session_status\">chat_session_status</h1>\n<p>このイベントは、チャットセッションの現在の状態を更新します。状態が「失敗」の場合、クライアントアプリケーションは、そのチャットセッションがもはや存在しないとみなします。</p>\n<h2 id=\"フォーマット\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_status\",\n    \"state\": \"queued|connecting|connected|failed|completed\",\n    \"ewt\": \"&lt;estimated waiting time for queued status&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_ended\">chat_session_ended</h1>\n<p>このイベントは、チャットセッションが正常に終了したことを示します（例：エージェントによってチャットセッションが閉じられた場合など）。クライアントアプリケーションは、そのチャットセッションがもはや存在しないとみなします。</p>\n<h2 id=\"フォーマット-1\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_ended\"\n}\n</code></pre>\n<h1 id=\"chat_session_party_joined\">chat_session_party_joined</h1>\n<p>このイベントは、新規の参加者（つまり、新規のエージェント）がチャットセッションに参加したことを示します。 </p>\n<h2 id=\"パラメータ\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>party_id</td>\n<td>サーバー側におけるチャット参加者の固有識別子です。このチャットセッションを処理する参加者（エージェント）ごとに、個別の識別子が生成されます。</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-2\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_party_joined\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"first_name\": \"&lt;party first name&gt;\",\n    \"last_name\": \"&lt;party last name&gt;\",\n    \"display_name\": \"&lt;party display name&gt;\",\n    \"type\": \"&lt;scenario|external|internal&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in milliseconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_party_left\">chat_session_party_left</h1>\n<p>このイベントは、既存の参加者のうち1人（例：エージェント）がチャットセッションから退出したことを示します。</p>\n<h2 id=\"パラメータ-1\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>party_id</td>\n<td>サーバー側におけるチャットセッションの一意の識別子です。このチャットセッションを処理する各参加者（例：エージェント）に対して、個別の識別子が生成されます。</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-3\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_party_left\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in milliseconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_message\">chat_session_message</h1>\n<p>このイベントには、新規のチャットメッセージが含まれています。</p>\n<h2 id=\"パラメータ-2\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>msg_id</td>\n<td>このメッセージを送信した当事者の固有の識別子</td>\n</tr>\n<tr>\n<td>party_id</td>\n<td>サーバー側のチャットセッションの一意の識別子です。このチャットセッションを処理する各当事者（例：エージェント）ごとに、個別の識別子が生成されます。なお、当事者 ID は常にチャット ID と一致します（つまり、チャットセッション履歴の一部としてイベントを受信した場合）。</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-4\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_message\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"msg_id\": \"&lt;message id&gt;\",\n    \"msg\": \"&lt;chat message&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in milliseconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_message_delivered\">chat_session_message_delivered</h1>\n<p>クライアントアプリケーションから送信されたメッセージを、エージェントまたはチャット内の他の参加者が受信した際、モバイルアプリケーションはこのイベントを受信します。</p>\n<h2 id=\"パラメータ-3\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ref_msg_id</td>\n<td>送信されたメッセージの一意の識別子</td>\n</tr>\n<tr>\n<td>party_id</td>\n<td>メッセージが配信された相手の固有識別子</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-5\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_message_delivered\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"ref_msg_id\": \"&lt;message id&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_message_read\">chat_session_message_read</h1>\n<p>クライアントアプリケーションから送信されたメッセージを、チャットのエージェントまたは他の参加者が既読した際、モバイルアプリケーションはこのイベントを受信します。</p>\n<h2 id=\"パラメータ-4\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ref_msg_id</td>\n<td>既読となったメッセージの一意の識別子</td>\n</tr>\n<tr>\n<td>party_id</td>\n<td>メッセージが既読になった相手の固有識別子</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-6\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_message_read\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"ref_msg_id\": \"&lt;message id&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_typing\">chat_session_typing</h1>\n<p>このイベントは、エージェントが入力を開始した際に送信されます。</p>\n<h2 id=\"パラメータ-5\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>party_id</td>\n<td>サーバー側におけるチャット参加者の一意の識別子です。このチャットセッションを扱う各参加者（例：エージェント）ごとに、個別の識別子が生成されます。</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-7\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_typing\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_not_typing\">chat_session_not_typing</h1>\n<p>このイベントは、エージェントが入力を停止した際に送信されます。</p>\n<h2 id=\"パラメータ-6\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>party_id</td>\n<td>サーバー側におけるチャット参加者の固有識別子です。このチャットセッションを処理する各参加者（例：エージェント）に対して、個別の識別子が生成されます。</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-8\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_not_typing\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_form_show\">chat_session_form_show</h1>\n<p>このイベントは、あらかじめ定義されたフォームを介してクライアントアプリケーションからユーザーの入力をリクエストするために送信されます。通常、クライアントアプリケーションは、指定されたフォームをユーザーに表示し、入力されたデータをイベント <em>chat_session_form_data</em> 経由で送信し返すことになっています。</p>\n<h2 id=\"フォーマット-9\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_form_show\",\n    \"form_request_id\": \"&lt;request ID that will be used by the client application to associate the response&gt;\",\n    \"form_name\": \"&lt;predefined form name known to the client application&gt;\",\n    \"form_timeout\": \"form timeout\",\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_secure_form_show\">chat_session_secure_form_show</h1>\n<p>このイベントは、クライアントアプリケーションに対し、ユーザーに安全な事前定義済みのフォームを表示し、入力されたデータをイベント <em>chat_session_secure_form_data</em> 経由で送信するよう通知するために送信されます。</p>\n<h2 id=\"フォーマット-10\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_secure_form_show\",\n    \"form_request_id\": \"&lt;request ID that will be used by the client application in chat_session_secure_form_data&gt;\",\n    \"form_id\": \"&lt;Form ID&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_timeout_warning\">chat_session_timeout_warning</h1>\n<p>このイベントは、クライアントアプリケーションのユーザーに対して指定されたテキストを表示するよう要求するために送信されます。通常、非アクティブ時の警告メッセージを表示するために使用されます。</p>\n<h2 id=\"フォーマット-11\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_timeout_warning\",\n    \"msg\": \"&lt;warning text&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in milliseconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_inactivity_timeout\">chat_session_inactivity_timeout</h1>\n<p>このイベントは、ユーザーの非アクティブ状態によるチャットセッションの終了を示し、ユーザーに表示するテキストを提供します。クライアントアプリケーションは、チャットセッションがもはや存在しないとみなします。</p>\n<h2 id=\"フォーマット-12\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_inactvity_timeout\",\n    \"msg\": \"&lt;inactivity timeout text&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in milliseconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_signaling\">chat_session_signaling</h1>\n<p>このイベントは、サーバーからクライアントへの WebRTC シグナリングメッセージを格納するコンテナメッセージです。これらのメッセージは、チャットセッションの履歴には保存されません。</p>\n<h2 id=\"フォーマット-13\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_signaling\",\n    \"msg_id\": \"&lt;message id&gt;\",\n    \"data\": \"&lt;signaling message&gt;\"\n    \n}\n</code></pre>\n<h1 id=\"chat_session_file\">chat_session_file</h1>\n<p>このイベントは、クライアントへファイルが送信されていることを通知するものです。クライアントは、<em>file_id</em> パラメータを使用してファイルをダウンロードできます。</p>\n<h2 id=\"パラメータ-7\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>party_id</td>\n<td>サーバー側のチャットセッションを一意に識別する識別子です。このチャットセッションを処理する各当事者（エージェント）ごとに、個別の識別子が生成されます。</td>\n</tr>\n<tr>\n<td>msg_id</td>\n<td>対応するメッセージの一意の識別子</td>\n</tr>\n<tr>\n<td>partyId</td>\n<td>メッセージを送信した参加者の一意の識別子</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-14\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_file\",\n    \"party_id\": \"&lt;party id&gt;\",\n    \"msg_id\": \"&lt;message id&gt;\",\n    \"file_id\": \"&lt;file id&gt;\",\n    \"file_type\": \"&lt;image|attachment&gt;\",\n    \"timestamp\": \"&lt;event time in Unix format&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_location\">chat_session_location</h1>\n<p>このイベントには、新規の位置情報メッセージが含まれています。</p>\n<h2 id=\"パラメータ-8\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>msg_id</td>\n<td>メッセージの一意の識別子</td>\n</tr>\n<tr>\n<td>url</td>\n<td>マップURL（オプション）</td>\n</tr>\n<tr>\n<td>latitude</td>\n<td>位置情報の緯度</td>\n</tr>\n<tr>\n<td>longitude</td>\n<td>位置情報の経度</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-15\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_location\",\n    \"msg_id\": \"&lt;message id&gt;\"\n    \"url\": \"&lt;map url (optional)&gt;”,\n    \"latitude\": “&lt;latitude&gt;”,\n    \"longitude\": “&lt;longitude&gt;”,\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_cobrowsing_requested\">chat_session_cobrowsing_requested</h1>\n<p>このイベントは、ブラウザ共有セッションをリクエストするためにクライアントアプリケーションに送信されます。</p>\n<h2 id=\"フォーマット-16\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_cobrowsing_requested\",\n    \"msg_id\": \"&lt;message id&gt;\"\n}\n</code></pre>\n<h1 id=\"chat_session_case_set\">chat_session_case_set</h1>\n<p>シナリオでチャットセッションのCRMケースIDが指定されている場合、モバイルアプリケーションはこのイベントを受信します。ケースが設定されると、モバイルアプリケーションは<strong>Get Case History</strong>メソッドおよび<strong>Close Case</strong>メソッドを使用できるようになります。</p>\n<h2 id=\"パラメータ-9\">パラメータ</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>パラメータ</th>\n<th>説明</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>case_id</td>\n<td>CRMケースのID</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"フォーマット-17\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"event\": \"chat_session_case_set\",\n    \"case_id\": \"&lt;message id&gt;\",\n    \"timestamp\": \"&lt;UTC timestamp in seconds&gt;\"\n}\n</code></pre>\n","event":[{"listen":"prerequest","script":{"id":"74c849cc-8ae0-4a9b-a06a-13cb0c6808f2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5fde3b8e-ea0e-4835-b73a-eed8dc565869","type":"text/javascript","exec":[""]}}],"_postman_id":"cf7b32a4-f252-43b7-83b8-183b956f899f"},{"name":"シグナリングメッセージの種類","item":[],"id":"a064f189-76db-4176-8ae1-a0f586a8e2bd","description":"<h1 id=\"コールの依頼\">コールの依頼</h1>\n<p>このメッセージは、WebRTCコールをリクエストするためにクライアントから送信されます。</p>\n<h2 id=\"フォーマット\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"type\": \"REQUEST_CALL”,\n    \"offerVideo\": \"true|false\"\n}\n</code></pre>\n<h1 id=\"コール拒否\">コール拒否</h1>\n<p>このメッセージは、要求されたコールを拒否したことを示すために、サーバーから送信されます。</p>\n<h2 id=\"フォーマット-1\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"type\": \"CALL_REJECTED\",\n    \"reason_code\": \"&lt;reject reason code&gt;\",\n    \"reason\": \"TBD\"\n}\n</code></pre>\n<h1 id=\"コールのオファー\">コールのオファー</h1>\n<p>このメッセージは、WebRTCセッションを開始するためにサーバーから送信されます。</p>\n<h2 id=\"フォーマット-2\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"type\": \"OFFER_CALL\",\n    \"offerVideo\": \"true|false\",\n    \"sdp\": \"&lt;session description string\"\n}\n</code></pre>\n<h1 id=\"コールの応答\">コールの応答</h1>\n<p>このメッセージは、サーバーによって開始された WebRTC セッションを確認するために、クライアントから送信されます。</p>\n<h2 id=\"フォーマット-3\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"type\": \"ANSWER_CALL\",\n    \"sdp\": \"&lt;session description string&gt;\"\n}\n</code></pre>\n<h1 id=\"ice-候補\">ICE 候補</h1>\n<p>このメッセージは、ICE候補の説明を伴って、クライアントまたはサーバーから送信されます。</p>\n<h2 id=\"フォーマット-4\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"type\": \"ICE_CANDIDATE\",\n    \"sdpMid\": \"&lt;candidate id&gt;\",\n    \"sdpMLineIndex\": \"&lt;candidate index&gt;\",\n    \"candidate\": \"&lt;candidate description&gt;\"\n}\n</code></pre>\n<h1 id=\"コール終了\">コール終了</h1>\n<p>このメッセージは、現在の WebRTC セッションを終了するために、クライアントまたはサーバーから送信されます。</p>\n<h2 id=\"フォーマット-5\">フォーマット</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"type\": \"END_CALL\"\n}\n</code></pre>\n","event":[{"listen":"prerequest","script":{"id":"3c7d9f11-fb79-410e-bf4c-10a40256a510","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b3ae99e1-3474-415a-b397-907c5d5363af","type":"text/javascript","exec":[""]}}],"_postman_id":"a064f189-76db-4176-8ae1-a0f586a8e2bd"}],"id":"2003bb58-9ed4-486e-bb50-371498153b84","_postman_id":"2003bb58-9ed4-486e-bb50-371498153b84","description":""}],"event":[{"listen":"prerequest","script":{"id":"42861ac3-c1e1-4150-99b4-abb75c0edf6c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c81a7100-fa8d-458b-99e2-edeb82a4f26a","type":"text/javascript","exec":[""]}}]}