チャット REST API の使用開始

チャット API エンドポイントの取得

チャット API エンドポイントは、組織のチャットセッションからデータにアクセスできるようにする一意の URL です。組織のチャット API エンドポイントを見つける手順は、次のとおりです。

1. [設定] で、[クイック検索] ボックスに「チャットの設定」と入力して、[チャットの設定] を選択します。
2. チャット API エンドポイントからホスト名を取得します。ホスト名は、URL の末尾から「/chat/rest/」を除いたもので、たとえば「https://yourChatApiEndpoint.com」のようになります。チャット API エンドポイントの hostname をこの URL に置き換えます。

チャットセッションの開始

新しいチャットセッションを開始するには、SessionId 要求を送信します。hostname をチャット API エンドポイントから取得した URL で置き換えます。

チャットセッションが開始されたことの確認

ChatRequestSuccess 応答は、チャットセッションが開始されたことを通知します。

次に、ChatEstablished の応答を待ちます。この応答によって、エージェントがチャットセッションを受け入れたことが通知されます。

これで、たとえば Messages 要求を送信可能になりました。後続の要求を送信する前に、ChatRequestSuccess と ChatEstablished の応答を受信するまで待機します。そうしないと、API が Null ポインタ例外をスローし、500 エラーを返します。

チャットセッションの終了

ChatEnd 要求を送信するか、DELETE SessionId 要求を送信すると、チャットセッションが終了します。どちらの要求種別でも、X-LIVEAGENT-SESSION-KEY は、終了する必要があるチャットセッションの一意の ID です。

ChatEnd 要求は次のとおりです。

SessionId 要求は次のとおりです。