Bright Pattern Contact Center Mobile/Web Messaging API v1 は、開発者がチャットや音声によるやり取りをモバイルデバイスやサードパーティ製アプリケーションと連携できるようにする RESTful API です。このAPIは、Bright Pattern Contact Centerを基盤とするコンタクトセンターとの高度なチャット、音声、ビデオ通信を行う、顧客向けのモバイルおよびWebアプリケーションなど、リッチ・コンタクト・エクスペリエンスを提供するアプリケーションの開発に使用いただけます。
\nこのドキュメントは、Bright Pattern Contact Center を基盤とするコンタクトセンター向けのカスタムアプリケーションを開発する IT 担当者および開発者を対象としています。このドキュメントの読者は、Web およびモバイルアプリケーション開発に関する専門知識に加え、コンタクトセンターの運用およびその運用に関わるリソースについて確かな理解を持っていることが想定されています。
\nBright Patternでは、顧客向けの機能豊富な連絡先アプリケーションのサンプルソースコードを提供しています。このソースコードは、社内でのアプリケーション開発の参考として使用したり、組織の顧客向けモバイルアプリケーションやWebアプリケーションに直接組み込んだりすることができます。
\nWebチャットアプリケーションについては、コンタクトセンター管理者アプリケーションの メッセージング/チャットシナリオエントリー ページにある「クライアントアプリケーション」ボタンをクリックすることで、ソースコードをダウンロードできます。
\nモバイルアプリケーションについては、Bright Pattern カスタマーサクセス管理 にサービスリクエストを送信することでソースコードを取得できます。
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"対象読者","slug":"5a6lgh6kqt6icf"},{"content":"サンプルアプリケーション","slug":"44k144oz44ox44or44ki44ox44oq44kx44o844k344on44oz"}],"owner":"58450950","collectionId":"872b606e-1e35-4366-ac17-c879c6d20f39","publishedId":"2sBYB4LmuQ","public":true,"customColor":{"highlight":"FF6C37","right-sidebar":"303030","top-bar":"FFFFFF"},"publishDate":"2026-09-29T10:20:27.000Z"},"item":[{"name":"概要","item":[],"id":"fa2df1e1-5438-4a5a-b0de-ac64021b8fe5","description":"以下は、APIリクエストの例です：
\nURL: https://yourcontactcenter.brightpattern.com/clientweb/api/v1/chats?tenantUrl=yourcontactcenter.brightpattern.com\n\nMethod: POST\n\nAuthorization: MOBILE-API-140-327-PLAIN appId=\"test\", clientId=\"123\"\n\nContent-Type: application/json; charset=UTF-8\n\nUser-Agent: MobileClient\n\n{\n \"phone_number\":\"3001\",\n \"parameters\": {\n \"first_name\":\"John\",\n \"last_name\":\"Lee\"\n }\n}\n以下のエレメントはクライアント認証に使用され、すべてのクライアントリクエストで指定する必要があります：
\n元の仕様（RFC 2616）に準拠した意味を持つ標準的なHTTP応答コードについては、本文書では扱いません。そのような応答の仕様については、セクション10（http://www.ietf.org/rfc/rfc2616.txt）を参照してください。本文書では、元の仕様（RFC 2616）との説明が異なる（例えば、定義がより狭義である、または意味が異なる）レスポンスコードのみを規定しています。
\nなお、クライアントアプリケーションは、一度に1つのアクティブな通信セッションしか持つことができません。
\nレスポンスステータスコードがエラーを示している場合、サーバーはエラーに関する詳細情報を提供するために、JSON形式のレスポンス本文を返します：\n{\"error_code\": \"エラーコード\", \"error_message\":\"エラーメッセージ\"}
\n以下に、認証を必須とするすべてのリクエストに共通する、認証関連のエラーコードおよびエラーメッセージの可能な値のリストを示します。
\n以下に、その他のエラーコードおよびエラーメッセージの可能な値のリストを示します。
\n","event":[{"listen":"prerequest","script":{"id":"54ba443f-cbf5-4147-9dab-ae82a573d594","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"64fa67e9-1954-40cd-a59d-166cf088b319","type":"text/javascript","exec":[""]}}],"_postman_id":"fa2df1e1-5438-4a5a-b0de-ac64021b8fe5"},{"name":"メソッド","item":[{"name":"Check Availability","id":"c77c76db-d0fa-4281-93f2-ef4c3196a143","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"appId は、メッセージ送信/チャットシナリオエントリーを一意に識別する識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。 clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://このメソッドは、関連付けられたメッセージ送信/チャットシナリオエントリーに設定された営業時間の可用性ステータスを返します。オプションで、予測待機時間（EWT）（秒単位）が返される場合がありますが、サーバーにEWT値を推定するのに十分なデータがない場合は、この情報が欠落する可能性があります。なお、このAPIでは、実際にログインしているエージェントがいるかどうかは確認されません。
\nコンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合など）。
\n","type":"text/plain"},"key":"tenantUrl","value":"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの各組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://このメソッドは、期待されるパラメータの配列を返します。これらのパラメータはオプションです。例えば、リクエストされたチャットセッションを処理するのに最も適したエージェントを検索したり、エージェント向けにユーザー情報を表示したりするために使用できます。これらのパラメータは、最初に メッセージ送信/チャットシナリオエントリー を通じて指定され、このシナリオエントリーを介してこのモバイルアプリケーションがコンタクトセンターと通信します。
\n現在、以下のパラメータタイプがサポートされています：
\nコンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。
\n","type":"text/plain"},"key":"tenantUrl","value":"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.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"このメソッドはチャットセッションを開始します。このメソッドでは、 期待されるパラメータのすべてまたは一部の値を指定し、モバイル端末の電話番号が含まれる場合もあります。 シナリオエントリーの設定によっては、チャットリクエストがエージェントに配信されるとすぐに、指定された番号へのコールバックが自動的に開始される場合があります。
\nメモ:
\nIdentifies 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).
\n","type":"text/plain"},"key":"tenantUrl","value":"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"このメソッドは、アクティブなチャットセッションのプロパティを返します。オプションで、EWT (予測待機時間)（秒単位）が返される場合がありますが、サーバーに EWT 値を推定するのに十分なデータがない場合は、この値が欠落している可能性があります。
\nコンタクトセンターを識別します。これは、ログイン後に「Contact Center Administrator」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。
\n","type":"text/plain"},"key":"tenantUrl","value":"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"raw","raw":"{\r\n “events”: [このメソッドは、クライアントからサーバー側へイベントを送信します。
\nコンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合など）。
\n","type":"text/plain"},"key":"tenantUrl","value":"現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、その本文に返されます。
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"0b60b413-e8a7-4206-bc8e-45f6a76d07f2","name":"Send Events Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"appId は、メッセージ送信/チャットシナリオエントリーを一意に識別する識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアント・アプリケーションを一意に識別する識別子です。これは、モバイル・アプリケーションの特定のインスタンス（つまり、特定のモバイル端末）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://このメソッドは、現在のセッションにおけるすべてのクライアントイベントおよびすべてのサーバーイベントを返します。複数のイベントオブジェクトが返されることがあり、各イベントのtimestamp属性を使用することで、正しいメッセージの順序を復元できます。
\nコンタクトセンターを識別します。これは、ログイン後に「Contact Center Administrator」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。
\n","type":"text/plain"},"key":"tenantUrl","value":"現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、そのレスポンス本文として返されます。
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"05dd9d49-4306-4c02-86b1-8c0d0162e724","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/v1/chats/:chatId/history?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v1","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 \"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"このメソッドは、現在のセッションにおける新規のチャットイベントを返します。新規のイベントがない場合、サーバーはタイムアウト期間中（つまり、約5～15秒間）、リクエストをアクティブな状態に保つことができます。前のリクエストがアクティブな状態のまま、クライアントが新規イベントを取得するために別のリクエストを送信した場合、サーバーはエラー400（Bad Request）を返します。
\nコンタクトセンターを識別します。これは、ログイン後に「Contact Center Administrator」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に相当します。また、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合など）。
\n","type":"text/plain"},"key":"tenantUrl","value":"現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、その本文として返されます。
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"8d6b2cc4-ec2a-49b2-848e-443e1b2611ef","name":"Get New Chat Events Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"The file or text to be uploaded
\n","type":"file","src":"/C:/Users/Lenovo/Desktop/important_file.txt"}]},"url":"https://このメソッドは、ファイルをサーバーにアップロードします。ファイルの最大サイズは25 MBです。サーバーには最大1000個のファイルが保存されます。新しく受信したファイルは、最も古いファイルと置き換えられます。このメソッドは、例えば、クライアントのモバイルアプリケーションからコンタクトセンターのエージェントへ画像を送信する場合などに使用できます。
\nコンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。
\n","type":"text/plain"},"key":"tenantUrl","value":"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"このメソッドは、受け取ったファイルIDを使用して、サーバーからファイルをダウンロードします。サーバーイベント「Chat Session File」をご参照ください。
\n現在のチャットセッションIDです。この変数の値は、「Request Chat」メソッドの呼び出しが成功した際、そのレスポンス本文として返されます。
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"description":{"content":"ダウンロードするファイルのファイルID
\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"6af8780c-48d1-4e6d-847d-1a4864b8d837","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/v1/chats/:chatId/files/:fileId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v1","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":"e379d5d8-2da2-444f-9185-397a76964118"},{"name":"Get Agent Profile Photo","id":"faa85891-95a0-4f13-8ebb-9200a6fe22cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"appId は、メッセージ送信/チャットシナリオエントリーを一意に識別する識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションを一意に識別する識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"このメソッドは、指定されたエージェントのプロフィール写真をダウンロードします。
\nリクエスト本文には、現在のチャットセッションに参加しているエージェントのパーティーIDを指定します。
\n注： パーティーIDは、チャットイベント（https://{host:port}/clientweb/api/v1/chats/{chatId}/events?tenantUrl={tenantUrl}) でポーリングされます）とともに提供されます。たとえば、chat_session_party_joined のイベントメッセージに party_ID が含まれています。
\n現在のチャットID
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"description":{"content":"現在のチャットセッションのエージェントのパーティーID
\n","type":"text/plain"},"type":"any","value":"","key":"partyId"}]}},"response":[{"id":"3d491b92-78bc-4e95-8faa-4f231f2bebe2","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/v1/chats/:chatId/profilephotos/:partyId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v1","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":"faa85891-95a0-4f13-8ebb-9200a6fe22cd"},{"name":"Get ICE servers","id":"84dbf3d5-3570-4b39-9709-668441e2c106","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。 これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://このメソッドは、チャットに音声・映像セッションを追加できるように、ブラウザに提供する設定済みのICEサーバーのリストを返します。
\nコンタクトセンターを識別します。これは、ログイン後に「Contact Center Administrator」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストがテナントのドメインに送信されていない場合などです）。
\n","type":"text/plain"},"key":"tenantUrl","value":"appId は、メッセージ送信/チャットシナリオエントリーの一意の識別子であり、アプリケーションを特定のシナリオに関連付けるために使用されます。 clientId は、クライアントアプリケーションの一意の識別子です。これは、モバイルアプリケーションの特定のインスタンス（つまり、特定のモバイルデバイス）の通信セッションを識別するために使用されます。これはモバイルアプリケーションによって生成される必要があり、クライアントアプリケーションとデバイスの組み合わせごとに一意である必要があります。clientId が「WebChat」に設定されている場合、クライアントの識別には HTTP クッキーが使用されます。
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://このメソッドは、起動ポイントのチャットウィジェットの設定を返します。
\nコンタクトセンターを識別します。これは、ログイン後に「コンタクトセンター管理者」アプリケーションの右上隅に表示される、コンタクトセンターのドメイン名に対応しています。さらに、この変数を使用することで、サービスプロバイダーは特定のテナントを指定することができます（つまり、リクエストが当該テナントのドメインに送信されていない場合などです）。
\n","type":"text/plain"},"key":"tenantUrl","value":"chat_session_message には、新規のチャットメッセージが含まれています。
\n{\n \"event\": \"chat_session_message\",\n \"msg_id\": \"<message id>\",\n \"msg\": \"<chat message>\",\n \"channel\": \"chat channel>\n}\nchat_session_typing は、クライアントアプリケーションのユーザーが文字入力を開始したときに送信されます。
\n{\n \"event\": \"chat_session_typing\"\n}\nchat_session_not_typing は、クライアントアプリケーションのユーザーが文字入力を停止したときに送信されます。
\n{\n \"event\": \"chat_session_not_typing\"\n}\nchat_session_form_data には、イベント chat_session_form_show 経由でサーバーから要求されたデータが含まれます。
\n{\n \"event\": \"chat_session_form_data\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\",\n \"form_name\": \"<form name>\",\n \"data\": {\n \"param1\": \"value1\",\n …\n }\n}\nchat_session_secure_form_data には、イベント chat_session_secure_form_show 経由でサーバーから要求されたデータが含まれています。
\n{\n \"event\": \"chat_session_secure_form_data\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\",\n \"form_name\": \"<form name>\",\n \"data\": {\n \"param1\": \"value1\",\n …\n }\n}\nchat_session_secure_form_cancel は、セキュアフォームをキャンセルするためのものです。
\n{\n \"event\": \"chat_session_secure_form_cancel\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\"\n}\nchat_session_end は、チャットセッションを終了します。
\n{\n \"event\": \"chat_session_end\"\n}\nchat_session_disconnect は、現在のチャット会話を終了させますが、セッション自体は開いたままにします（つまり、シナリオによってコントロールされた状態を維持します）。このメッセージは、サーバーから追加の情報（例：アンケートフォーム）が返されることが予想される場合に、chat_session_end の代わりに使用できます。
\n{\n \"event\": \"chat_session_disconnect\"\n}\nchat_session_signaling は、クライアントからサーバーへの WebRTC シグナリングメッセージを格納するためのコンテナメッセージです。これらのメッセージは、チャットセッションの履歴には保存されません。
\n{\n \"event\": \"chat_session_signaling\",\n \"msg_id\": \"<message id>\",\n \"destination_party_id\": \"<agent party id>\",\n \"data\": \"<signaling message>\"\n}\nchat_session_file は、クライアントがサーバーにファイルをアップロードしたことを通知します。
\n{\n \"event\": \"chat_session_file\",\n \"msg_id\": \"<message id>\",\n \"file_type\": \"<image|attachment>\",\n \"file_id\": \"<file id>\"\n}\nchat_session_location には、新規の地理的位置メッセージが含まれています。
\n{\n \"event\": \"chat_session_location\",\n \"msg_id\": \"<message id>\"\n \"url\": \"<map URL (optional)>\",\n \"latitude\": \"<latitude>\",\n \"longitude\": \"<longitude>\"\n}\nchat_session_navigation は、そのウェブページの場所（ページ名または URL）とともにクライアントから送信されます
\n{\n \"event\": \"chat_session_navigation\",\n \"msg_id\": \"<message id>\",\n \"title\": \"<page title>\",\n \"page\": \"<page name or page url>\"\n}\nchat_session_cobrowsing_rejected は、ユーザーがブラウザ共有セッションを拒否したことをサーバーに通知するためのものです。
\n{\n \"event\": \"chat_session_cobrowsing_rejected\"\n}\nchat_session_cobrowsing_started は、ユーザーがブラウザ共有セッションを承認し、開始したことをサーバーに通知するためのものです。
\n{\n \"event\": \"chat_session_cobrowsing_started\",\n \"provider_type\": \"<Name of chat co-browsing provider>\",\n \"cobrowsing_url\": \"<URL of the co-browsing session>\"\n}\nchat_session_cobrowsing_ended は、ユーザーがブラウザ共有セッションを終了したことをサーバーに通知するためのものです。
\n{\n \"event\": \"chat_session_cobrowsing_ended\"\n}\nchat_session_status は、チャットセッションの現在の状態を更新します。状態が「失敗」の場合、クライアントアプリケーションは、そのチャットセッションがもはや存在しないとみなすものとします。
\n{\n \"event\": \"chat_session_status\",\n \"state\": \"queued|connecting|connected|failed|completed\",\n \"ewt\": \"<estimated waiting time for queued status>\"\n}\nchat_session_ended は、チャットセッションが正常に終了したことを示します（例：エージェントによってチャットセッションが閉じられた場合など）。クライアントアプリケーションは、そのチャットセッションがもはや存在しないとみなすものとします。
\n{\n \"event\": \"chat_session_ended\"\n}\nchat_session_party_joined は、新規の参加者（新規のエージェント）がチャットセッションに参加したことを示します。
\n{\n \"event\": \"chat_session_party_joined\",\n \"party_id\": \"<party id>\",\n \"first_name\": \"<party first name>\",\n \"last_name\": \"<party last name>\",\n \"display_name\": \"<party display name>\",\n \"type\": \"<scenario|external|internal>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_party_left は、既存の参加者のうち1人（エージェント）がチャットセッションを退出したことを示します。
\n{\n \"event\": \"chat_session_party_left\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_messageには、新規のチャットメッセージが含まれます。
\n{\n \"event\": \"chat_session_message\",\n \"party_id\": \"<party id>\",\n \"msg_id\": \"<message id>\",\n \"msg\": \"<chat message>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_typingは、エージェントが入力を開始した際に送信されます。
\n{\n \"event\": \"chat_session_typing\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_not_typingは、エージェントが入力を停止した際に送信されます。
\n{\n \"event\": \"chat_session_not_typing\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_form_showは、クライアントアプリケーションからのユーザー入力を、あらかじめ定義されたフォーム経由で入力するようリクエストするために送信されます。通常、クライアントアプリケーションは、指定されたフォームをユーザーに表示し、入力されたデータをイベントchat_session_form_data経由で送信し戻すことになっています。
\n{\n \"event\": \"chat_session_form_show\",\n \"form_request_id\": \"<request ID that will be used by the client application to associate the response>\",\n \"form_name\": \"<predefined form name known to the client application>\",\n \"form_timeout\": \"form timeout\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_secure_form_show は、クライアントアプリケーションに対し、ユーザーに安全な事前定義済みのフォームを表示し、入力されたデータをイベント chat_session_secure_form_data 経由で送信するよう通知するために送信されます。
\n{\n \"event\": \"chat_session_secure_form_show\",\n \"form_request_id\": \"<request ID that will be used by the client application in chat_session_secure_form_data>\",\n \"form_id\": \"<Form ID>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_timeout_warning は、クライアントアプリケーションのユーザーに対して指定されたテキストを表示するよう要求するために送信されます。通常、これは非アクティブ時の警告メッセージを表示するために使用されます。
\n{\n \"event\": \"chat_session_timeout_warning\",\n \"msg\": \"<warning text>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_inactivity_timeout は、ユーザーの非アクティブ状態によるチャットセッションの終了を示し、ユーザーに表示されるテキストを提供します。クライアントアプリケーションは、チャットセッションがもはや存在しないものとみなすものとします。
\n{\n \"event\": \"chat_session_inactvity_timeout\",\n \"msg\": \"<inactivity timeout text>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_signalingは、サーバーからクライアントへのWebRTCシグナリングメッセージを格納するコンテナメッセージです。これらのメッセージは、チャットセッション履歴には保存されません。
\n{\n \"event\": \"chat_session_signaling\",\n \"msg_id\": \"<message id>\",\n \"data\": \"<signaling message>\"\n \n}\nchat_session_fileは、クライアントにファイルが送信されていることを通知します。クライアントは、file_idパラメータを使用してファイルをダウンロードできます。
\n{\n \"event\": \"chat_session_file\",\n \"party_id\": \"<party id>\",\n \"msg_id\": \"<message id>\",\n \"file_id\": \"<file id>\",\n \"file_type\": \"<image|attachment>\",\n \"timestamp\": \"<event time in Unix format>\"\n}\nchat_session_location には、新規の位置情報メッセージが含まれます。
\n{\n \"event\": \"chat_session_location\",\n \"msg_id\": \"<message id>\"\n \"url\": \"<map url (optional)>”,\n \"latitude\": “<latitude>”,\n \"longitude\": “<longitude>”,\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_cobrowsing_requested は、ブラウザ共有セッションをリクエストするためにクライアント アプリケーションに送信されます。
\n{\n \"event\": \"chat_session_cobrowsing_requested\",\n \"msg_id\": \"<message id>\"\n}\nこのメッセージは、WebRTCコールをリクエストするためにクライアントから送信されます。
\n{\n \"type\": \"REQUEST_CALL”,\n \"offerVideo\": \"true|false\"\n}\nこのメッセージは、要求されたコールが拒否されたことを示すために、サーバーから送信されます。
\n{\n \"type\": \"CALL_REJECTED\",\n \"reason_code\": \"<reject reason code>\",\n \"reason\": \"TBD\"\n}\nこのメッセージは、WebRTCセッションを開始するためにサーバーから送信されます。
\n{\n \"type\": \"OFFER_CALL\",\n \"offerVideo\": \"true|false\",\n \"sdp\": \"<session description string\"\n}\nこのメッセージは、サーバーによって開始されたWebRTCセッションを確認するために、クライアントから送信されます。
\n{\n \"type\": \"ANSWER_CALL\",\n \"sdp\": \"<session description string>\"\n}\nこのメッセージは、ICE候補の説明とともに、クライアントまたはサーバーから送信されます。
\n{\n \"type\": \"ICE_CANDIDATE\",\n \"sdpMid\": \"<candidate id>\",\n \"sdpMLineIndex\": \"<candidate index>\",\n \"candidate\": \"<candidate description>\"\n}\nこのメッセージは、現在のWebRTCセッションを終了するために、クライアントまたはサーバーから送信されます。
\n{\n \"type\": \"END_CALL\"\n}\n