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

Live Agent REST API のリクエストボディ

POST または GET 要求を実行するには、クエリパラメータを渡すか、JSON 形式のリクエストボディを作成します。リクエストボディに他の 1 つ以上のリクエストボディをネストさせることができます。各リクエストボディには、固有の要求プロパティを含めることができます。

ChasitorInit

要求プロパティ
プロパティ名 説明 使用可能なバージョン
organizationId String チャット訪問者の Salesforce 組織 ID。 29.0
deploymentId String チャットが開始されたリリースの ID。 29.0
buttonId String チャットが開始されたボタンの ID。 29.0
sessionId String チャット訪問者の Live Agent セッション ID。 29.0
userAgent String チャット訪問者のブラウザユーザエージェント。 29.0
language String チャット訪問者の話す言語。 29.0
screenResolution String チャット訪問者のコンピュータ画面の解像度。 29.0
visitorName String チャット訪問者のカスタム名。 29.0
prechatDetails CustomDetail オブジェクトの配列 チャット訪問者から提供された事前チャット情報。 29.0
prechatEntities Entity オブジェクトの配列 チャット訪問者がチャットを開始したときに作成されるレコード。 29.0
buttonOverrides String の配列 チャット要求の再転送ルールを上書きするボタン。 29.0
receiveQueueUpdates Boolean チャット訪問者がキューの位置の更新を受信するか (true)、否か (false) を示します。 29.0
isPost Boolean チャット要求が POST 要求を介して正常に実行されたか (true)、否か (false) を示します。 29.0
リクエストボディ
1{
2        organizationId: "00DD0000000JVXs",
3        deploymentId: "572D000000000J6",
4        buttonId: "573D000000000OC",
5        agentId: "005B0000000F3b2",
6        doFallback: true,
7        sessionId: "5503f854-0203-4324-8ed5-f793a367426f",
8        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",
9        language; "en-US",
10        screenResolution: "2560x1440"
11        visitorName: "Jon A."
12        prechatDetails: [
13                {
14                        label: "E-mail Address",
15                        value: "jon@example.com",
16                        transcriptFields: [
17                                "c__EmailAddress"
18                        ],
19                        displayToAgent: true
20                }             
21        ],
22        buttonOverrides: [
23                "573D000000000OD"
24        ],
25        receiveQueueUpdates: true,
26        isPost: true
27}

ChasitorResyncState

要求プロパティ
プロパティ名 説明 使用可能なバージョン
organizationId String チャット訪問者の Salesforce 組織 ID。 29.0
リクエストボディ
1{
2        organizationId: "00DD0000000JVXs"
3}

ChasitorSneakPeek

要求プロパティ
プロパティ名 説明 使用可能なバージョン
position integer チャットのプレビューの更新の位置。 29.0
text String チャット訪問者がチャットウィンドウのテキスト入力領域に入力しているテキスト。 29.0
リクエストボディ
1{
2        position: 3,
3        text: "Hi there."
4}

ChatMessage

要求プロパティ
プロパティ名 説明 使用可能なバージョン
text String チャット訪問者からエージェントへのメッセージのテキスト。 29.0
リクエストボディ
1{
2        text: "I have a question about my account."
3}

CustomEvent

要求プロパティ
プロパティ名 説明 使用可能なバージョン
type String 発生したカスタムイベントのタイプ。エージェント側のイベントリスナーを追加するために使用されます。 29.0
data String エージェントに送信されたイベントに関連するデータ。 29.0
リクエストボディ
1{
2        type: "PromptForCreditCard",
3        data: "Visa"
4}

MultiNoun

要求プロパティ
名前 説明 使用可能なバージョン
nouns NounWrapper オブジェクトの配列 MultiNoun 要求で一括処理される名詞オブジェクトとそのプロパティの配列。 29.0
リクエストボディ
1{
2        nouns: [
3                {
4                        prefix: "Chasitor",
5                        noun: "ChatMessage",
6                        object: {
7                                text: "Goodbye"
8                        }
9                },
10                {
11                        prefix: "Chasitor",
12                        noun: "ChatEnd",
13                        object: {}
14                }
15        ]
16}