Live Agent REST API 開発者ガイド

by user

on 28 марта 2017

Category: Documents

>> Downloads: 40

292

views

Report

Comments

Description

Download Live Agent REST API 開発者ガイド

Transcript

Live Agent REST API 開発者ガイド

Live Agent REST API 開発者ガ
イド
バージョン 37.0, Summer ’16
@salesforcedocs
最終更新日: 2016/04/22
本書の英語版と翻訳版で相違がある場合は英語版を優先するものとします。
© Copyright 2000–2016 salesforce.com, inc. All rights reserved. Salesforce およびその他の名称や商標は、salesforce.com,
inc. の登録商標です。本ドキュメントに記載されたその他の商標は、各社に所有権があります。
目次
第 1 章: Live Agent REST リソースの理解 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
第 2 章: Live Agent API エンドポイントを使用した要求の実行 . . . . . . . . . . . . . . . . . 2
第 3 章: 要求ヘッダー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
第 4 章: メッセージの long polling ループ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
第 5 章: Live Agent REST API リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Live Agent セッションを作成する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
SessionId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
チャット訪問者のセッションを作成する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
ChasitorInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
ResyncSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
ChasitorResyncState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
チャット活動を監視する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ChasitorNotTyping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ChasitorSneakPeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ChasitorTyping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ChatEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ChatMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
CustomEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
MultiNoun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
チャット訪問者の環境をカスタマイズする . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Breadcrumb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
VisitorId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
第 6 章: Live Agent REST API のリクエストボディ . . . . . . . . . . . . . . . . . . . . . . . . . . 25
第 7 章: Live Agent REST API のレスポンスボディ . . . . . . . . . . . . . . . . . . . . . . . . . . 30
第 8 章: Live Agent REST API のデータ型 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
第 9 章: 状況コードとエラー応答 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
第1章
Live Agent REST リソースの理解
Live Agent REST API を使用して、Live Agent をネイティブモバイルアプリケーション
に拡張します。
エディション
Visualforce に依存せずに、カスタマイズされたチャットウィンドウを開発できま
す。このガイドの REST リソースを使用することにより、単純な HTML 環境や
JavaScript 環境を越えてチャットウィンドウ機能を拡張できるため、会社独自の
アプリケーションにシームレスに統合できます。たとえば、会社の iOS、Android、
またはその他の Web アプリケーション内にカスタムウィンドウを構築できます。
使用可能なエディション:
Salesforce Classic
Live Agent を使用可能な組
織: 2012 年 6 月 14 日より
も後に作成された
Performance Edition および
Developer Edition の組織
Live Agent を使用可能なエ
ディション: Unlimited
Edition (Service Cloud 付属)
有料オプションで Live
Agent を使用可能なエディ
ション: Enterprise Edition
および Unlimited Edition
1
第2章
Live Agent API エンドポイントを使用し
た要求の実行
Live Agent サーバに対して要求を実行するには、Live Agent API エンドポイントを使用する必要があります。
Live Agent API エンドポイントは、組織の Live Agent セッションからデータにアクセスできるようにする一意の
URL です。
組織の Live Agent API エンドポイントを見つけるには、[設定] から [クイック検索] ボックスに「Live Agent の設
定」と入力し、[Live Agent の設定] を選択します。
新しい要求ごとに、hostname 変数を URL の API エンドポイントに置き換えます。
2
第3章
要求ヘッダー
各 Live Agent REST API リソースには、要求を実行するための 1 つ以上のヘッダーが必要です。
すべてのリソースが、使用可能なすべての要求ヘッダーを必要とするわけではありません。リソースごとに、
要求の実行に必要なヘッダーを指定します。
使用可能なヘッダーは次のとおりです。
ヘッダーの構文
説明
X-LIVEAGENT-API-VERSION
要求の Salesforce API バージョン。
X-LIVEAGENT-AFFINITY
システムで生成される ID。Live Agent サーバの Live Agent セッションを識
別するために使用されます。このアフィニティトークンは、SessionId
要求のレスポンスボディにあります。
X-LIVEAGENT-SESSION-KEY
Live Agent セッションに関連付けられた一意の ID。
メモ: セッションキーがあればチャットの潜在的な機密情報にア
クセスできるため、安全でないチャネルを介してセッションキー
を共有または送信しないでください。
X-LIVEAGENT-SEQUENCE
Live Agent サーバに送信したメッセージの順序。Live Agent サーバでの重
複メッセージの処理の回避に役立ちます。この数は、新しい要求ごと
に 1 つずつ増加していきます。
3
第4章
メッセージの long polling ループ
メッセージの long polling により、Live Agent セッションの Live Agent サーバで発生したイベントが通知されます。
要求を開始すると、待機中のすべてのメッセージがすぐにセッションに配信されます。待機中のメッセージが
ない場合、サーバとの接続は開いたままになります。メッセージがサーバで受信されるたびに、この接続に
よってメッセージが継続的に返されます。
セッションが期限切れになると、200 (「OK」) 応答コードと、残りのメッセージの配列が含まれるリソースを
受信します。サーバでメッセージが受信されなかった場合は、204 (「No Content」) 応答コードを受信します。
200 (「OK」) または 204 (「No Content」) 応答コードを受信したときは、すぐにもう一度 Messages 要求を実行
して、Live Agent サーバに登録されているメッセージの取得を継続します。
警告: メッセージループを続行するためにもう一度 Messages 要求を実行しない場合、Live Agent サーバ
のシステムタイムアウト後にセッションが終了します。
SessionId 要求の clientPollTimeout プロパティで指定されている秒数内に応答が受信されないときは、
サーバへのネットワーク接続でエラーが発生している可能性があるため、要求を終了する必要があります。
long polling ループを開始するには、Messages 要求を実行します。
関連トピック:
Messages
SessionId
状況コードとエラー応答
4
第5章
Live Agent REST API リソース
POST または GET 要求を実行するには、適切なパラメータまたはリクエストボディを使用して HTTP 要求を作成
して送信します。
Live Agent REST API 要求では、エージェントとチャット訪問者間の新しいチャットセッションを開始して、発生
するチャット活動を監視できます。
このセクションの内容:
Live Agent セッションを作成する
新しい Live Agent セッションを作成するには、SessionId 要求をコールする必要があります。
チャット訪問者のセッションを作成する
Live Agent REST API を使用して、チャット訪問者のセッションを作成または再確立するには、特定の要求を実
行する必要があります。
チャット活動を監視する
Live Agent 要求では、チャットセッション中に特定の活動がいつ発生したのかを指定します。
チャット訪問者の環境をカスタマイズする
Live Agent 訪問者の REST API リソースでは、カスタムモバイルアプリケーションで Live Agent を使用するチャッ
ト訪問者の環境を確立できます。
Live Agent セッションを作成する
新しい Live Agent セッションを作成するには、SessionId 要求をコールする必要があります。
このセクションの内容:
SessionId
新しい Live Agent セッションを確立します。SessionId 要求は、新しい Live Agent セッションを作成するた
びに最初の要求として必要になります。
SessionId
新しい Live Agent セッションを確立します。SessionId 要求は、新しい Live Agent セッションを作成するたびに
最初の要求として必要になります。
構文
URI
https://hostname/chat/rest/System/SessionId
5
Live Agent REST API リソース
チャット訪問者のセッションを作成する
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
GET
要求ヘッダー
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-API-VERSION
リクエストボディ
なし
要求パラメータ
なし
レスポンスボディ
SessionId 応答
関連トピック:
メッセージの long polling ループ
チャット訪問者のセッションを作成する
Live Agent REST API を使用して、チャット訪問者のセッションを作成または再確立するには、特定の要求を実行
する必要があります。
このセクションの内容:
ChasitorInit
チャット訪問者の新しいセッションを開始します。ChasitorInit 要求は、新しいチャットセッションの
最初の POST 要求として常に必要になります。
ResyncSession
セッションが中断され、元のサーバを使用できない場合に、新しいサーバで顧客のチャットセッションを
再確立します。
ChasitorResyncState
ResyncSession 要求の完了後にチャット訪問者の状態 (チャットの詳細を含む) を再確立します。
ChasitorInit
チャット訪問者の新しいセッションを開始します。ChasitorInit 要求は、新しいチャットセッションの最
初の POST 要求として常に必要になります。
6
Live Agent REST API リソース
ResyncSession
構文
URI
https://hostname/chat/rest/Chasitor/ChasitorInit
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
ChasitorInit 要求
レスポンスボディ
なし
ResyncSession
セッションが中断され、元のサーバを使用できない場合に、新しいサーバで顧客のチャットセッションを再確
立します。
この要求は、アフィニティトークンが Live Agent セッション用に変更されたことを示す 503 応答状況コードを受
信した場合にのみ行います。503 応答状況コードを受信した場合は、既存の着信要求または発信要求をすべて
キャンセルする必要があります。
発信要求に含まれるデータは、一時的に保存され、セッションが再確立されると再送信されます。
ResyncSession 要求の応答を受信したら、isValid 応答プロパティが true であればメッセージのポーリン
グを開始できます。
最初の応答は ChasitorSessionData メッセージです。このメッセージにはセッションが再確立されると復
元される、前のセッションのデータが含まれます。このメッセージを受信したら、503 応答状況コードを受信
したときにキャンセルされた既存のメッセージを送信できます。
構文
URI
https://hostname/chat/rest/System/ResyncSession
7
Live Agent REST API リソース
ChasitorResyncState
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
GET
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
要求パラメータ
名前
型
説明
SessionId
String
SessionId 要求のチャットセッション ID。
クエリパラメータ
なし
リクエストボディ
なし
レスポンスボディ
ResyncSession 応答
関連トピック:
状況コードとエラー応答
ChasitorSessionData
ChasitorResyncState
状況コードとエラー応答
ChasitorResyncState
ResyncSession 要求の完了後にチャット訪問者の状態 (チャットの詳細を含む) を再確立します。
構文
URI
https://hostname/chat/rest/Chasitor/ChasitorResyncState
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
8
Live Agent REST API リソース
チャット活動を監視する
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
ChasitorResyncState 要求
レスポンスボディ
なし
関連トピック:
ResyncSession
チャット活動を監視する
Live Agent 要求では、チャットセッション中に特定の活動がいつ発生したのかを指定します。
このセクションの内容:
ChasitorNotTyping
チャット訪問者がチャットウィンドウで入力していないことを示します。
ChasitorSneakPeek
プレビューで表示できたチャット訪問者のメッセージを提供します。
ChasitorTyping
チャット訪問者がチャットウィンドウでメッセージを入力していることを示します。
ChatEnd
チャット訪問者がチャットを終了したことを示します。
ChatMessage
チャット訪問者から送信されたチャットメッセージの本文を返します。
CustomEvent
チャット中にチャット訪問者からカスタムイベントが送信されたことを示します。
Messages
チャットセッション中にエージェントとチャット訪問者間で送信されたすべてのメッセージを返します。
MultiNoun
同時に複数のメッセージを送信する場合、複数の POST 要求を一括処理します。
9
Live Agent REST API リソース
ChasitorNotTyping
ChasitorNotTyping
チャット訪問者がチャットウィンドウで入力していないことを示します。
構文
URI
https://hostname/chat/rest/Chasitor/ChasitorNotTyping
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
なし
レスポンスボディ
なし
ChasitorSneakPeek
プレビューで表示できたチャット訪問者のメッセージを提供します。
構文
URI
https://hostname/chat/rest/Chasitor/ChasitorSneakPeek
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
10
Live Agent REST API リソース
ChasitorTyping
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
ChasitorSneakPeek 要求
レスポンスボディ
なし
ChasitorTyping
チャット訪問者がチャットウィンドウでメッセージを入力していることを示します。
構文
URI
https://hostname/chat/rest/Chasitor/ChasitorTyping
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
なし
11
Live Agent REST API リソース
ChatEnd
レスポンスボディ
なし
ChatEnd
チャット訪問者がチャットを終了したことを示します。
構文
URI
https://hostname/chat/rest/Chasitor/ChatEnd
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
ChatEndReason — ChatEndReason パラメータを要求のリクエストボディに含めて、チャットが終了し
た理由を指定します。このパラメータは必須です。例: {reason: “client”}。
応答プロパティ
attachedRecords — 添付レコード ID を含めます。次の Visualforce コンポーネントを使用して、事後チャッ
トページに添付レコード ID を表示できます: <apex:outputText
value=”{!$CurrentPage.parameters.attachedRecords}”/><br />。
ChatMessage
チャット訪問者から送信されたチャットメッセージの本文を返します。
構文
URI
https://hostname/chat/rest/Chasitor/ChatMessage
12
Live Agent REST API リソース
CustomEvent
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
ChatMessage 要求
レスポンスボディ
なし
CustomEvent
チャット中にチャット訪問者からカスタムイベントが送信されたことを示します。
構文
URI
https://hostname/chat/rest/Chasitor/CustomEvent
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
13
Live Agent REST API リソース
Messages
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
CustomEvent 要求
レスポンスボディ
なし
Messages
チャットセッション中にエージェントとチャット訪問者間で送信されたすべてのメッセージを返します。
Messages リソースの応答の完全なリストは、「Live Agent REST API Messages 応答オブジェクト」を参照して
ください。
構文
URI
https://hostname/chat/rest/System/Messages
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
GET
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
要求パラメータ
なし
クエリパラメータ
ack — ack クエリパラメータは、Live Agent サーバのメッセージをポーリングできるようにする順序メカニ
ズムです。Messages 要求を初めて実行すると、ack パラメータは –1 に設定されます。この値は、新しい
Messages 要求を送信するたびに 1 ずつ増加していきます。正しい順序でサーバからメッセージを受信す
るには、次に実行する要求の ack を前の応答で受信した値に更新する必要があります。
リクエストボディ
なし
レスポンスボディ
Messages 応答
14
Live Agent REST API リソース
Messages
このセクションの内容:
Live Agent REST API Messages 応答オブジェクト
Messages 要求では、エージェントと顧客のチャット中に発生したすべてのイベントを表すオブジェクト
の配列が返されます。
関連トピック:
メッセージの long polling ループ
Live Agent REST API Messages 応答オブジェクト
Messages 要求では、エージェントと顧客のチャット中に発生したすべてのイベントを表すオブジェクトの配
列が返されます。
チャット中に発生したイベントによっては、この要求で返される一意のレスポンスボディに複数のサブタイプ
が含まれる場合があります。
次に、Messages 応答の配列の構造の例を示します。
{
"messages":{
"type":"array",
"description":"The messages sent over the course of a chat.",
"items":{
"name":"Message",
"type":"object",
"properties": {
"type": {
"type":"string",
"description":"The type of message that was received.",
"required":true,
"version":29.0
},
"message": {
"type":"object",
"description":"A placeholder object for the message that was received.
Can return any of the responses available for the Messages request.",
"required":true,
"version":29.0
}
}
},
"required":true,
"version":29.0
},
"sequence":{
"type":"integer",
"description":"The sequence of the message as it was received over
the course of a chat.",
"required":true,
"version":29.0
}
}
15
Live Agent REST API リソース
Messages
このセクションの内容:
AgentDisconnect
エージェントがチャットから切断されたことを示します。
AgentNotTyping
エージェントがチャット訪問者にメッセージを入力していないことを示します。
AgentTyping
エージェントがチャット訪問者にメッセージを入力していることを示します。
ChasitorSessionData
チャット訪問者の現在のチャットセッションデータを返します。この要求は、ResyncSession 要求の送
信後にチャット訪問者のセッションデータを復元するために使用されます。
ChatEnded
チャットが終了したことを示します。
ChatEstablished
エージェントがチャット要求を受け入れて、訪問者とのチャットに参加していることを示します。
ChatMessage
エージェントからチャット訪問者に新しいチャットメッセージが送信されたことを示します。
ChatRequestFail
チャット要求が失敗したことを示します。
ChatRequestSuccess
チャット要求が成功し、対応可能なエージェントに転送されたことを示します。
ChatTransferred
チャットがエージェント間で転送されたことを示します。
CustomEvent
チャット中にエージェントからチャット訪問者にカスタムイベントが送信されたことを示します。
NewVisitorBreadcrumb
チャット訪問者が現在表示している Web ページの URL を示します。
QueueUpdate
チャットキュー内のチャット訪問者の位置が変更された場合に、チャットキュー内での訪問者の新しい位
置を示します。
AgentDisconnect
エージェントがチャットから切断されたことを示します。
メモ: エージェントはチャットから切断されましたが、チャットセッションはサーバ上でアクティブなま
まです。新しいエージェントは、チャット要求を受け入れてチャットを継続できます。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
16
Live Agent REST API リソース
Messages
レスポンスボディ
なし
応答プロパティ
なし
AgentNotTyping
エージェントがチャット訪問者にメッセージを入力していないことを示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
なし
応答プロパティ
なし
AgentTyping
エージェントがチャット訪問者にメッセージを入力していることを示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
なし
応答プロパティ
なし
ChasitorSessionData
チャット訪問者の現在のチャットセッションデータを返します。この要求は、ResyncSession 要求の送信後
にチャット訪問者のセッションデータを復元するために使用されます。
ChasitorSessionData 要求は、ResyncSession 要求の配信後に送信される最初のメッセージです。
メモ: 503 状況コードが発生した場合、このメッセージが処理されるまでメッセージは送信されません。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
17
Live Agent REST API リソース
Messages
レスポンスボディ
ChasitorSessionData 応答
関連トピック:
ResyncSession
状況コードとエラー応答
状況コードとエラー応答
ChatEnded
チャットが終了したことを示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
リクエストボディ
ChatEndReason — ChatEndReason パラメータを要求のリクエストボディに含めて、チャットが終了し
た理由を指定します。例: {reason: “client”}。
レスポンスボディ
なし
応答プロパティ
なし
ChatEstablished
エージェントがチャット要求を受け入れて、訪問者とのチャットに参加していることを示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
ChatEstablished 応答
関連トピック:
ChatRequestSuccess
ChatMessage
エージェントからチャット訪問者に新しいチャットメッセージが送信されたことを示します。
18
Live Agent REST API リソース
Messages
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
ChatMessage 応答
ChatRequestFail
チャット要求が失敗したことを示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
ChatRequestFail 応答
ChatRequestSuccess
チャット要求が成功し、対応可能なエージェントに転送されたことを示します。
メモ: ChatRequestSuccess 応答は、要求が対応可能なエージェントに転送されたことのみを示します。
ChatEstablished 応答が受信されるまで、チャットは受け入れられません。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
ChatRequestSuccess 応答
関連トピック:
ChatEstablished
ChatTransferred
チャットがエージェント間で転送されたことを示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
ChatTransferred 応答
19
Live Agent REST API リソース
MultiNoun
CustomEvent
チャット中にエージェントからチャット訪問者にカスタムイベントが送信されたことを示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
CustomEvent 応答
NewVisitorBreadcrumb
チャット訪問者が現在表示している Web ページの URL を示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
NewVisitorBreadcrumb 応答
QueueUpdate
チャットキュー内のチャット訪問者の位置が変更された場合に、チャットキュー内での訪問者の新しい位置を
示します。
構文
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
レスポンスボディ
QueueUpdate 応答
MultiNoun
同時に複数のメッセージを送信する場合、複数の POST 要求を一括処理します。
構文
URI
https://hostname/chat/rest/System/MultiNoun
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
20
Live Agent REST API リソース
チャット訪問者の環境をカスタマイズする
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
X-LIVEAGENT-AFFINITY
X-LIVEAGENT-SESSION-KEY
X-LIVEAGENT-SEQUENCE
要求パラメータ
なし
クエリパラメータ
なし
リクエストボディ
MultiNoun 要求
レスポンスボディ
なし
チャット訪問者の環境をカスタマイズする
Live Agent 訪問者の REST API リソースでは、カスタムモバイルアプリケーションで Live Agent を使用するチャット
訪問者の環境を確立できます。
このセクションの内容:
Settings
チャットセッションに関連付けられているLive Agentリリースのすべての設定情報を取得します。Settings
要求は、チャット訪問者のセッションを確立するための最初の要求として必要になります。
Availability
新しいチャット要求を受信できるチャットボタンを利用可能かどうかを示します。
Breadcrumb
訪問者がエージェントとチャットしているときに、ブレッドクラムの値をチャット訪問者が表示している
Web ページの URL に設定します。その後、エージェントはブレッドクラムの値を確認して、チャット訪問
者が表示しているページを特定できます。
VisitorId
チャット要求の開始時にチャット訪問者を追跡する一意の ID を生成して、Web ページ間を移動するときの
訪問者の活動を追跡します。
Settings
チャットセッションに関連付けられている Live Agent リリースのすべての設定情報を取得します。Settings
要求は、チャット訪問者のセッションを確立するための最初の要求として必要になります。
21
Live Agent REST API リソース
Availability
構文
URI
https://hostname/chat/rest/Visitor/Settings
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
GET
要求ヘッダー
X-LIVEAGENT-API-VERSION
要求パラメータ
なし
クエリパラメータ
org_id
Live Agent リリースと関連付けられた Salesforce 組織の ID
deployment_id
チャット要求が開始された Live Agent リリースの ID
Settings.buttonIds
設定情報を取得するためのチャットボタン ID の配列
Settings.updateBreadcrumb
訪問者が表示している Web ページの URL で、チャット訪問者の場所を更新するかどうかを示します
リクエストボディ
なし
レスポンスボディ
Settings 応答 (ページ 39)
Availability
新しいチャット要求を受信できるチャットボタンを利用可能かどうかを示します。
構文
URI
https://hostname/chat/rest/Visitor/Availability
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
22
Live Agent REST API リソース
Breadcrumb
HTTP メソッド
GET
要求ヘッダー
X-LIVEAGENT-API-VERSION
要求パラメータ
なし
クエリパラメータ
org_id
Live Agent リリースと関連付けられた Salesforce 組織の ID
deployment_id
チャット要求が開始された Live Agent リリースの 15 桁の ID
Availability.ids
利用可能かどうかを確認するオブジェクト ID の配列
リクエストボディ
なし
レスポンスボディ
Availability 応答
Breadcrumb
訪問者がエージェントとチャットしているときに、ブレッドクラムの値をチャット訪問者が表示している Web
ページの URL に設定します。その後、エージェントはブレッドクラムの値を確認して、チャット訪問者が表示
しているページを特定できます。
構文
URI
https://hostname/chat/rest/Visitor/Breadcrumb
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
POST
要求ヘッダー
X-LIVEAGENT-API-VERSION
要求パラメータ
なし
クエリパラメータ
なし
23
Live Agent REST API リソース
VisitorId
リクエストボディ
Breadcrumb 要求
レスポンスボディ
なし
VisitorId
チャット要求の開始時にチャット訪問者を追跡する一意の ID を生成して、Web ページ間を移動するときの訪問
者の活動を追跡します。
構文
URI
https://hostname/chat/rest/Visitor/VisitorId
適用開始バージョン
このリソースは API バージョン 29.0 以降で使用できます。
形式
JSON
HTTP メソッド
GET
要求ヘッダー
X-LIVEAGENT-API-VERSION
要求パラメータ
なし
クエリパラメータ
org_id
Salesforce 組織 ID
deployment_id
チャット要求が開始された Live Agent リリースの ID
リクエストボディ
なし
レスポンスボディ
VisitorId 応答
24
第6章
Live Agent REST API のリクエストボディ
POST または GET 要求を実行するには、クエリパラメータを渡すか、JSON 形式のリクエストボディを作成しま
す。リクエストボディに他の 1 つ以上のリクエストボディをネストさせることができます。各リクエストボ
ディには、固有の要求プロパティを含めることができます。
Breadcrumb
要求プロパティ
プロパティ名
型
説明
使用可能なバージョ
ン
location
String
チャット訪問者が表示している 29.0
Web ページの URL。
リクエストボディ
"location":{
"type":"string",
"description":"The current location or URL of the visitor",
"required":true,
"version":29.0
}
ChasitorInit
要求プロパティ
プロパティ名
型
説明
organizationId
String
チャット訪問者の Salesforce 組織 29.0
ID。
deploymentId
String
チャットが開始されたリリース 29.0
の ID。
buttonId
String
チャットが開始されたボタンの 29.0
ID。
sessionId
String
チャット訪問者のLive Agentセッ 29.0
ション ID。
25
使用可能なバージョ
ン
Live Agent REST API のリクエストボディ
プロパティ名
型
説明
使用可能なバージョ
ン
userAgent
String
チャット訪問者のブラウザユー 29.0
ザエージェント。
language
String
チャット訪問者の話す言語。
29.0
screenResolution String
チャット訪問者のコンピュータ 29.0
画面の解像度。
visitorName
String
チャット訪問者のカスタム名。 29.0
prechatDetails
CustomDetail オブジェクチャット訪問者から提供された 29.0
トの配列
prechatEntities
buttonOverrides
事前チャット情報。
Entity オブジェクトの配チャット訪問者がチャットを開 29.0
列
始したときに作成されるレコー
ド。
String の配列
チャット要求の再転送ルールを 29.0
上書きするボタン。
receiveQueueUpdates Boolean
チャット訪問者がキューの位置 29.0
の更新を受信するか (true)、否
か (false) を示します。
Boolean
チャット要求が POST 要求を介し 29.0
て正常に実行されたか (true)、
否か (false) を示します。
isPost
リクエストボディ
{
organizationId: "00DD0000000JVXs",
deploymentId: "572D000000000J6",
buttonId: "573D000000000OC",
agentId: "005B0000000F3b2",
doFallback: true,
sessionId: "5503f854-0203-4324-8ed5-f793a367426f",
userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36",
language; "en-US",
screenResolution: "2560x1440"
visitorName: "Jon A."
prechatDetails: [
{
label: "E-mail Address",
value: "[email protected]",
transcriptFields: [
"c__EmailAddress"
],
26
Live Agent REST API のリクエストボディ
displayToAgent: true
}
],
buttonOverrides: [
"573D000000000OD"
],
receiveQueueUpdates: true,
isPost: true
}
ChasitorResyncState
要求プロパティ
プロパティ名
型
説明
使用可能なバージョン
organizationId
String
チャット訪問者の Salesforce 組織
ID。
29.0
リクエストボディ
{
organizationId: "00DD0000000JVXs"
}
ChasitorSneakPeek
要求プロパティ
プロパティ名
型
説明
使用可能なバージョン
position
integer
チャットのプレビューの更新の位置。
29.0
text
String
チャット訪問者がチャットウィンドウのテ 29.0
キスト入力領域に入力しているテキスト。
リクエストボディ
{
position: 3,
text: "Hi there."
}
27
Live Agent REST API のリクエストボディ
ChatMessage
要求プロパティ
プロパティ名
型
説明
使用可能なバージョン
text
String
チャット訪問者からエージェントへのメッセージ 29.0
のテキスト。
リクエストボディ
{
text: "I have a question about my account."
}
CustomEvent
要求プロパティ
プロパティ名
型
説明
使用可能なバージョン
type
String
発生したカスタムイベントのタイプ。エージェント側 29.0
のイベントリスナーを追加するために使用されます。
data
String
エージェントに送信されたイベントに関連するデー
タ。
29.0
リクエストボディ
{
type: "PromptForCreditCard",
data: "Visa"
}
MultiNoun
要求プロパティ
名前
型
nouns
NounWrapper MultiNoun 要求で一括処理される名詞オブジェ 29.0
オブジェク
トの配列
説明
使用可能なバージョ
ン
クトとそのプロパティの配列。
28
Live Agent REST API のリクエストボディ
リクエストボディ
{
nouns: [
{
prefix: "Chasitor",
noun: "ChatMessage",
object: {
text: "Goodbye"
}
},
{
prefix: "Chasitor",
noun: "ChatEnd",
object: {}
}
]
}
29
第7章
Live Agent REST API のレスポンスボディ
Live Agent REST API リソースへの要求では、応答コードが返されます。リソース要求の実行が成功すると、JSON
形式でレスポンスボディが返される場合もあります。
Availability
応答プロパティ
プロパティ名
型
説明
results
Result オブジェクトの
エージェントやチャット 29.0
ボタンに対応する
Salesforce ID と、新しい
チャット要求を受信でき
るかどうかのリスト。
配列
使用可能なバージョン
レスポンスボディ
{
"results":{
"type":"array",
"description":"List of ids and their availability",
"items":{
"name":"result",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The id of the entity",
"required":true,
"version":29.0
},
"isAvailable":{
"type":"boolean",
"description":"Whether or not the entity is available for chat",
"required":true,
"version":29.0
}
}
},
"required":true,
"version":29.0
}
}
30
Live Agent REST API のレスポンスボディ
ChasitorSessionData
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
queuePosition
integer
29.0
チャットキュー内の
チャット訪問者の位置。
geoLocation
GeoLocation オブジェク要求が開始された IP アド 29.0
ト
レスに基づく、チャット
訪問者の場所。
url
String
チャット訪問者がアクセ 29.0
スしている URL。
oref
String
チャット要求の開始元の 29.0
URL。
postChatUrl
String
29.0
チャットの終了後に
チャット訪問者がリダイ
レクトされる URL。
sneakPeekEnabled
Boolean
29.0
チャットを受け入れた
エージェントのプレ
ビューが有効になってい
るかどうか。
chatMessages
TranscriptEntry オブ
29.0
agent.js ファイルと
chasitor.js ファイルで同期
するチャットメッセージ
の構造。
ジェクトの配列
レスポンスボディ
{
queuePosition: 1,
geoLocation: {
countryCode: "US",
countryName: "United States of America",
region: "CA",
city: "San Francisco",
organization: Salesforce.com,
latitude: 37.793880,
longitude: -122.395114
},
url: "http://yoursite",
oref: "http://www.google.com?q=yoursite",
postChatUrl: "http://yoursite/postchat",
sneakPeekEnabled: true,
31
Live Agent REST API のレスポンスボディ
chatMessages: [
{
type: "Agent",
name: "Andy L.",
content: "Hello, how can I help you?",
timestamp: 1376596367548,
sequence: 1
},
{
type: "Chasitor",
name: "Jon A.",
content: "I have a question for you.",
timestamp: 1376596349132
sequence: 2
}
]
}
ChasitorIdleTimeoutWarningEvent
応答プロパティ
プロパティ名
型
説明
idleTimeoutWarningEvent String
使用可能なバージョン
警告のトリガ時またはク 35.0
リア時にサーバに通知し
ます。使用できる値は、
triggered と cleared
です。
ChatEstablished
応答プロパティ
プロパティ名
型
説明
name
String
チャットに参加している 29.0
エージェントの名前。
userId
String
チャットに参加している 29.0
エージェントのユーザ
ID。
sneakPeekEnabled
Boolean
29.0
チャットを受け入れた
エージェントのプレ
ビューが有効になってい
るかどうか。
32
使用可能なバージョン
Live Agent REST API のレスポンスボディ
プロパティ名
型
説明
使用可能なバージョン
chasitorIdletimeout
ChasitorIdleTimeoutSettings 訪問者のアイドルタイム 35.0
アウトの設定。
レスポンスボディ
{
name: "Andy L.",
userId: "f1dda237-57f8-4816-b8e8-59775f1e44c8",
sneakPeekEnabled: true
}
ChatMessage
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
name
String
チャットに参加している 29.0
エージェントの名前。
text
String
エージェントがチャット 29.0
訪問者に送信したチャッ
トメッセージのテキス
ト。
レスポンスボディ
{
name: "Andy L."
text: "Hello, how can I help you?"
}
ChatRequestFail
応答プロパティ
プロパティ名
型
説明
reason
String
チャット要求が失敗した 29.0
理由 (どのエージェントも
チャットすることができ
なかった、内部エラーが
発生したなど)。
33
使用可能なバージョン
Live Agent REST API のレスポンスボディ
プロパティ名
型
説明
使用可能なバージョン
postChatUrl
String
29.0
チャットの終了後に
チャット訪問者がリダイ
レクトされる事後チャッ
トページの URL。
レスポンスボディ
{
reason: "Unavailable",
postChatUrl: "http://yoursite/postChat"
}
ChatRequestSuccess
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
queuePosition
integer
29.0
チャットキュー内の
チャット訪問者の位置。
geoLocation
GeoLocation オブジェク要求が開始された IP アド 29.0
ト
レスに基づく、チャット
訪問者の場所。
url
String
チャット訪問者がアクセ 29.0
スしている URL。
oref
String
チャット要求の開始元の 29.0
URL。
postChatUrl
String
29.0
チャットの終了後に
チャット訪問者がリダイ
レクトされる URL。
customDetails
CustomDetail オブジェチャット要求が開始され 29.0
visitorId
クトの配列
たリリースのカスタム詳
細。
String
チャット訪問者の ID。
レスポンスボディ
"{
queuePosition: 1,
geoLocation: {
34
29.0
Live Agent REST API のレスポンスボディ
countryCode:"US",
countryName: "United States of America",
region: "CA",
city: "San Francisco",
organization: Salesforce.com,
latitude: 37.793880,
longitude: -122.395114
},
url: "http://yoursite",
oref: "http://www.google.com?q=yoursite",
postChatUrl: "http://yoursite/postchat",
customDetails: [
{
label: "E-mail Address",
value: "[email protected]",
transcriptFields: [
"c__EmailAddress"
],
displayToAgent: true
}
],
visitorId: "acd47048-bd80-476e-aa33-741bd5cb05d3"
}"
ChatTransferred
応答プロパティ
プロパティ名
型
説明
name
String
チャットの転送先のエー 29.0
ジェントの名前。
userId
String
チャット訪問者の ID。
sneakPeekEnabled
Boolean
チャットの転送先のエー 29.0
ジェントのプレビューが
有効になっているかどう
か。
chasitorIdletimeout
ChasitorIdleTimeoutSettings 訪問者のアイドルタイム 35.0
アウトの設定。
レスポンスボディ
{
name: "Ryan S.",
userId: "edacfa56-b203-43d5-9e1b-678278b61263",
35
使用可能なバージョン
29.0
Live Agent REST API のレスポンスボディ
sneakPeekEnabled: false
}
CustomEvent
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
type
String
発生したカスタムイベン 29.0
トのタイプ。チャット訪
問者側のイベントリス
ナーを追加するために使
用されます。
data
String
チャット訪問者に送信さ 29.0
れたイベントに関連する
データ。
レスポンスボディ
{
type: "CreditCardEntered",
data: "5105105105105100"
}
Messages
応答プロパティ
プロパティ名
型
説明
messages
Message オブジェクトの
チャット中に送信された 29.0
メッセージ。
配列
sequence
integer
チャット中に受信した
メッセージの順序。
レスポンスボディ
{
messages: [
{
type: "ChatEstablished",
message: {
name: "Andy L.",
36
使用可能なバージョン
29.0
Live Agent REST API のレスポンスボディ
userId: "f1dda237-57f8-4816-b8e8-59775f1e44c8",
sneakPeekEnabled: true
}
}
],
sequence: 1
}
NewVisitorBreadcrumb
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
location
String
チャット訪問者が表示し 29.0
ている Web ページの
URL。
レスポンスボディ
{
location: "http://yoursite/page2"
}
QueueUpdate
応答プロパティ
プロパティ名
型
説明
position
integer
29.0
チャットキュー内の
チャット訪問者の更新さ
れた位置。
レスポンスボディ
{
position: 3
}
37
使用可能なバージョン
Live Agent REST API のレスポンスボディ
ResyncSession
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
isValid
Boolean
セッションが有効か
(true)、否か (false) を
示します。
29.0
key
String
古いセッションが再確立 29.0
された後の新しいセッ
ションのセッション
キー。
affinityToken
String
今後のすべての要求の
ヘッダーで渡される、
セッションのアフィニ
ティトークン。
29.0
レスポンスボディ
{
isValid: true,
key: "dd19849c-26df-4e21-b4cf-3aada410f35d",
affinityToken: "73061fa0"
}
SessionId
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
id
String
新しいセッションのセッ
ション ID。
29.0
key
String
新しいセッションのセッ
ションキー。
29.0
affinityToken
String
今後のすべての要求のヘッ 29.0
ダーで渡される、セッショ
ンのアフィニティトーク
ン。
clientPollTimeout integer
Messages 要求の実行期限 29.0
(秒数)。この期限内に実行
38
Live Agent REST API のレスポンスボディ
プロパティ名
型
説明
使用可能なバージョン
しないと、Messages long
polling ループがタイムアウ
トして終了します。
レスポンスボディ
{
id: "241590f5-2e59-44b5-af89-9cae83bb6947",
key:
"f6c1d699-84c7-473f-b194-abf4bf7cccf8!b65b13c7-f597-4dd2-aa3a-cbe01e69f19c",
affinityToken: "73061fa0"
clientPollTimeout: "30"
}
Settings
応答プロパティ
プロパティ名
型
説明
pingrate
number
Live Agent 訪問者セッション 29.0
を維持するために訪問者が
サーバに ping する必要のあ
る頻度。
contentServerUrl String
buttons
使用可能なバージョン
コンテンツサーバの URL。 29.0
button オブジェクトの配 Settings 要求の実行時に 29.0
列
指定した、チャットボタン
とその設定情報のリスト。
レスポンスボディ
{
"pingRate":{
"type":"number",
"description":"The rate at which the visitor should ping the server to
maintain presence",
"required":true,
"version":29.0
},
"contentServerUrl":{
"type":"string",
"description":"The content server URL",
"required":true,
"version":29.0
},
39
Live Agent REST API のレスポンスボディ
"buttons":{
"type":"array",
"description":"The list of buttons",
"items":{
"name":"button",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The id of the button",
"required":true,
"version":29.0
},
"type":{
"type":"string",
"description":"The type of the button",
"required":true,
"version":29.0,
"enum":["Standard","Invite","ToAgent"]
},
"endpointUrl":{
"type":"string",
"description":"The custom chat window url of the button",
"required":false,
"version":29.0
},
"prechatUrl":{
"type":"string",
"description":"The prechat url of the button",
"required":false,
"version":29.0
},
"language":{
"type":"string",
"description":"The language setting of the button",
"required":false,
"version":29.0
},
"isAvailable":{
"type":"boolean",
"description":"Whether or not the button is available for chat",
"required":true,
"version":29.0
},
/* Invite related settings */
"inviteImageUrl":{
"type":"string",
"description":"The image of the button",
"required":false,
"version":29.0
},
"inviteImageWidth":{
"type":"number",
40
Live Agent REST API のレスポンスボディ
"description":"The width of the button image",
"required":false,
"version":29.0
},
"inviteImageHeight":{
"type":"number",
"description":"The height of the button image",
"required":false,
"version":29.0
},
"inviteRenderer":{
"type":"string",
"description":"The animation option of the invite",
"required":false,
"version":29.0,
"enum":["Slide","Fade","Appear","Custom"]
},
"inviteStartPosition":{
"type":"string",
"description":"The start position of the animation",
"required":false,
"version":29.0,
"enum":["TopLeft","TopLeftTop","Top","TopRightTop","TopRight",
"TopRightRight","Right","BottomRightRight","BottomRight",
"BottomRightBottom","Bottom","BottomLeftBottom","BottomLeft",
"BottomLeftLeft","Left","TopLeftLeft"]
},
"inviteEndPosition":{
"type":"string",
"description":"The end position of the animation",
"required":false,
"version":29.0,
"enum":["TopLeft","Top","TopRight","Left","Center","Right","BottomLeft","Bottom","BottomRight"]
},
"hasInviteAfterAccept":{
"type":"boolean",
"description":"Whether or not invite will trigger after accepting",
"required":false,
"version":29.0
},
"hasInviteAfterReject":{
"type":"boolean",
"description":"Whether or not invite will trigger after rejecting",
"required":false,
"version":29.0
},
"inviteRejectTime":{
"type":"number",
41
Live Agent REST API のレスポンスボディ
"description":"The auto reject setting of the invite",
"required":false,
"version":29.0
},
"inviteRules":{
"type":"object",
"description":"The rules of the invite",
"required":false,
"version":29.0
}
/* Invite related settings */
}
},
"required":true,
"version":29.0
}
}
VisitorId
応答プロパティ
プロパティ名
型
説明
使用可能なバージョン
sessionId
String
新しいセッションのセッ
ション ID。
29.0
レスポンスボディ
"sessionId":{
"type":"string",
"description":"The session id of the visitor",
"required":true,
"version":29.0
}
関連トピック:
状況コードとエラー応答
42
第8章
Live Agent REST API のデータ型
Live Agent REST API リソースへの要求では、応答コードが返されます。リソース要求の実行が成功すると、JSON
形式でレスポンスボディが返される場合もあります。一部のレスポンスボディは、独自のプロパティを含む
データ型を返します。エンティティまたは項目の名前を参照するすべてのプロパティ値では大文字と小文字が
区別されます。
Button
プロパティ
プロパティ名
型
説明
必須
使用可能なバージョ
ン
id
String
チャットボタンオ
ブジェクトの ID。
TRUE
29.0
type
String
ボタンの種類。有
効な値は、次のと
おりです。
TRUE
29.0
• Standard
• Invite
• ToAgent
endpointUrl
String
チャットボタンに FALSE
割り当てられたカ
スタムチャット
ウィンドウの URL。
29.0
prechatUrl
String
ボタンに割り当て FALSE
られた事前チャッ
トフォームの URL。
29.0
language
String
チャットボタンの
デフォルト言語。
29.0
isAvailable
Boolean
このチャットボタ TRUE
ンが新しいチャッ
ト要求の受信に利
用可能か (true)、
否か (false) を指定
します。
43
FALSE
29.0
Live Agent REST API のデータ型
プロパティ名
型
説明
必須
使用可能なバージョ
ン
inviteImageUrl
String
自動招待の静的画
像リソースへの
URL。
FALSE
29.0
自動チャット招待 FALSE
の画像の幅 (ピクセ
ル単位)。
29.0
自動チャット招待 FALSE
の画像の高さ (ピク
セル単位)。
29.0
自動チャット招待
に割り当てられた
アニメーションオ
プション。有効な
値は、次のとおり
です。
FALSE
29.0
FALSE
29.0
(自動チャット招待
専用)
inviteImageWidth number
(自動チャット招待
専用)
inviteImageHeight number
(自動チャット招待
専用)
inviteRenderer
String
(自動チャット招待
専用)
• Slide
• Fade
• Appear
• Custom
inviteStartPosition String
(自動チャット招待
専用)
自動チャット招待
のアニメーション
が開始される位
置。有効な値は、
次のとおりです。
• TopLeft
• TopLeftTop
• Top
• TopRightTop
• TopRight
• TopRightRight
• Right
• BottomRightRight
• BottomRight
• BottomRightBottom
• Bottom
• BottomLeftBottom
• BottomLeft
44
Live Agent REST API のデータ型
プロパティ名
型
説明
必須
使用可能なバージョ
ン
FALSE
29.0
顧客が前のチャッ FALSE
ト招待を受諾した
後に、自動チャッ
ト招待を再度送信
できるか (true)、
否か (false) を指定
します。
29.0
顧客が前のチャッ FALSE
ト招待を辞退した
後に、自動チャッ
ト招待を再度送信
できるか (true)、
否か (false) を指定
します。
29.0
招待が顧客の画面
に表示されてから
自動的に却下され
るまでの秒数。
FALSE
29.0
カスタム Apex クラ FALSE
スで定義された、
29.0
• BottomLeftLeft
• Left
• TopLeftLeft
inviteEndPosition String
(自動チャット招待
専用)
自動チャット招待
のアニメーション
が開始される位
置。有効な値は、
次のとおりです。
• TopLeft
• Top
• TopRight
• Left
• Center
• Right
• BottomLeft
• Bottom
• BottomRight
hasInviteAfterAccept Boolean
(自動チャット招待
専用)
hasInviteAfterReject Boolean
(自動チャット招待
専用)
inviteRejectTime number
(自動チャット招待
専用)
inviteRules (自動 Object
チャット招待専用)
45
Live Agent REST API のデータ型
プロパティ名
型
説明
必須
使用可能なバージョ
ン
必須
使用可能なバージョ
ン
自動チャット招待
の動作を制御する
カスタムルール。
CustomDetail
プロパティ
プロパティ名
型
説明
label
String
詳細のカスタマイズ TRUE
された表示ラベル。
29.0
value
String
詳細のカスタマイズ TRUE
された値。
29.0
チャットトランスク TRUE
リプトの顧客の詳細
が保存される項目の
名前。
29.0
Boolean
カスタマイズされた FALSE
詳細をエージェント
に表示するか
(true)、否か
(false) を指定しま
す。
29.0
プロパティ名
型
説明
使用可能なバージョ
ン
entityName
String
検索または作成する TRUE
レコード。
29.0
showOnCreate
Boolean
レコードが作成され FALSE
た後にそれを表示す
るか (true)、否か
29.0
transcriptFields String の配列
displayToAgent
Entity
プロパティ
必須
46
Live Agent REST API のデータ型
プロパティ名
型
説明
必須
使用可能なバージョ
ン
(false) を指定しま
す。
linkToEntityName String
詳細のリンク先のレ FALSE
コードの名前。
29.0
linkToEntityField String
詳細のリンク先のレ FALSE
コード内の項目。
29.0
saveToTranscript String
レコードの保存先の FALSE
トランスクリプト項
目の名前。
29.0
entityFieldsMaps EntityFieldsMaps オブ
レコードの詳細の関 TRUE
連付け先の項目。
29.0
使用可能なバージョ
ン
ジェクトの配列
EntityFieldsMaps
プロパティ
プロパティ名
型
説明
必須
fieldName
String
詳細の関連付け先の TRUE
項目の名前。
29.0
label
String
詳細のカスタマイズ TRUE
された表示ラベル。
29.0
doFind
Boolean
項目 fieldName を TRUE
使用して、一致する
レコードを検索する
か (true)、否か
(false) を指定しま
す。
29.0
isExactMatch
Boolean
項目 fieldName に TRUE
完全一致する項目が
あるレコードのみを
検索するか (true)、
否か (false) を指定
します。
29.0
doCreate
Boolean
レコードが存在しな TRUE
い場合に項目
29.0
47
Live Agent REST API のデータ型
プロパティ名
型
説明
必須
使用可能なバージョ
ン
必須
使用可能なバージョ
ン
fieldName に基づ
いてレコードを作成
するか (true)、否か
(false) を指定しま
す。
GeoLocation
プロパティ
プロパティ名
型
説明
countryCode
String
チャット訪問者の場 TRUE
所に対応する ISO
3166-1 alpha-2 国コー
ド。
29.0
countryName
String
チャット訪問者の場 TRUE
所に関連付けられた
国の名前。
29.0
region
String
チャット訪問者の場 FALSE
所に関連付けられた
主要な行政区画 (都
道府県など)。
29.0
city
String
チャット訪問者の場 FALSE
所に関連付けられた
市区郡の名前。
29.0
organization
String
チャット訪問者の場 FALSE
所に関連付けられた
組織の名前。
29.0
latitude
number
チャット訪問者の場 FALSE
所に関連付けられた
緯度。
29.0
longitude
number
チャット訪問者の場 FALSE
所に関連付けられた
経度。
29.0
48
Live Agent REST API のデータ型
Message
プロパティ
プロパティ名
型
説明
必須
使用可能なバー
ジョン
type
String
受信されたメッセージの種
別。
TRUE
29.0
message
Object
受信されたメッセージのプ TRUE
レースホルダオブジェクト。
Messages 要求で使用できる
任意の応答を返すことができ
ます。
29.0
使用可能なバー
ジョン
NounWrapper
プロパティ
プロパティ名
型
説明
必須
prefix
String
リソースのプレフィックス。 TRUE
29.0
noun
String
リソースの名前。
29.0
data
String
リソースに投稿するデータ。 FALSE
29.0
プロパティ名
型
説明
使用可能なバー
ジョン
id
String
エージェントまたはチャット TRUE
ボタンの Salesforce ID。
29.0
isAvailable
Boolean
Salesforce ID id に関連付けら TRUE
れたエンティティが、新しい
チャット要求の受信に使用で
きるか (true)、否か (false)
を指定します。
29.0
TRUE
Result
プロパティ
必須
49
Live Agent REST API のデータ型
TranscriptEntry
プロパティ
プロパティ名
型
説明
必須
type
String 型の列挙
チャットトランスクリプトの TRUE
メッセージの種別。有効な値
は、次のとおりです。
使用可能なバー
ジョン
29.0
• Agent: エージェントから
チャット訪問者へのメッ
セージ
• Chasitor: チャット訪問
者からエージェントへの
メッセージ
• OperatorTransferred:
チャットを別のエージェ
ントに転送するための要
求
name
String
チャットメッセージを送信し TRUE
たユーザの名前。
29.0
content
String
メッセージの本文。
TRUE
29.0
timestamp
number
メッセージの送信日時。
TRUE
29.0
sequence
number
チャットで受信したメッセー TRUE
ジの順序。
29.0
関連トピック:
状況コードとエラー応答
50
第9章
状況コードとエラー応答
各要求では、要求が成功したかどうかを示す状況コードまたはエラー応答が返されます。
エラーが発生した場合、または応答が正常な場合のどちらでも、応答ヘッダーには HTTP コードが含まれ、レ
スポンスボディには通常、次の情報が含まれます。
• HTTP 応答コード
• HTTP 応答コードに付随するメッセージ
HTTP 応答コード
説明
200
「OK」成功コードです。
202
POST 要求の「Accepted」成功コードです。
204
メッセージ要求の「No Content」成功コードです。メッセージループの一部として要求を
再送信する必要があります。
400
要求が実行されませんでした。通常、JSON のボディに含まれるエラーが原因です。
403
セッションが無効であるため、要求が却下されました。
404
要求されたリソースが見つかりませんでした。URI のエラーを確認します。
405
Request-Line に指定されたメソッドは、URI に指定されたリソースには許可されていませ
ん。
500
Live Agent サーバ内でエラーが発生したため、要求を完了できませんでした。カスタマー
サポートにお問い合わせください。
503
アフィニティトークンが変更されました。ResyncSession 要求を実行して、新しいア
フィニティトークンおよびセッションキーを取得した後、ChasitorSessionData 要求
を実行して、新しいセッション内でチャット訪問者のデータを再確立する必要がありま
す。
関連トピック:
メッセージの long polling ループ
ResyncSession
ChasitorSessionData
Live Agent REST API のレスポンスボディ
Live Agent REST API のデータ型
ResyncSession
ChasitorSessionData
51