この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

チャット REST API の使用開始

チャット REST API を使用して、チャットセッションを開始、確認、終了する方法について説明します。

従来のチャット製品はメンテナンス専用モードになり、新機能の作成を継続することはできません。引き続き使用可能ですが、新しいチャットチャンネルを実装することは推奨しておりません。代わりにアプリ内および Web のメッセージングにより顧客とのコミュニケーションを最新化できます。メッセージングによって、人気の高い多数のチャット機能に加えて、いつでも再開可能な非同期の会話が利用可能になります。

メモ

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

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

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

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

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

1GET https://hostname/chat/rest/System/SessionId/

次の要求ヘッダーを使用します。

X-LIVEAGENT-AFFINITY
X-LIVEAGENT-API-VERSION

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

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

1{
2        queuePosition: 1,
3        estimatedWaitTime: 120,
4        geoLocation: {
5                countryCode:"US",
6                countryName: "United States of America",
7                region: "CA",
8                city: "San Francisco",
9                organization: Salesforce,
10                latitude: 37.793880,
11                longitude: -122.395114
12        },
13        url: "http://yoursite",
14        oref: "http://www.google.com?q=yoursite",
15        postChatUrl: "http://yoursite/postchat",
16        customDetails: [
17                {
18                        label: "E-mail Address",
19                        value: "jon@example.com",
20                        transcriptFields: [
21                                 "c__EmailAddress"
22                         ],
23                        displayToAgent: true
24                }                        
25
26        ],
27        visitorId: "acd47048-bd80-476e-aa33-741bd5cb05d3"
28}

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

1{
2        name: "Andy L.",
3        userId: "f1dda237-57f8-4816-b8e8-59775f1e44c8",
4        sneakPeekEnabled: true
5}

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

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

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

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

1https://hostname/chat/rest/Chasitor/ChatEnd

次の要求ヘッダーを使用します。

X-LIVEAGENT-AFFINITY
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE

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

1DELETE https://hostname/chat/rest/System/SessionId/X-LIVEAGENT-SESSION-KEY

次の要求ヘッダーを使用します。

X-LIVEAGENT-AFFINITY
X-LIVEAGENT-API-VERSION

チャット REST API 開発者ガイド

チャット REST API の使用開始

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

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

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

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