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

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

概要
チャット REST API の使用開始
要求ヘッダー
メッセージの long polling ループ
チャットセッションのキュー内の順番ではなく予想待ち時間の使用 (ベータ)
チャット REST API リソース
チャット REST API のリクエストボディ
チャット REST API のレスポンスボディ
チャット REST API のデータ型
状況コードとエラー応答
PDF

チャット REST API のリクエストボディ

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

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

メモ

ChasitorInit

要求プロパティ
プロパティ名 型 説明 使用可能なバージョン
organizationId String チャット訪問者の Salesforce 組織 ID。 29.0
deploymentId String チャットが開始されたリリースの ID。 29.0
buttonId String チャットが開始されたボタンの ID。 29.0
agentId String エージェントへのチャットの直接転送要求のエージェントの ID。通常のチャット要求では、この項目を空にしておきます。 29.0
doFallback Boolean agentId がある場合、フォールバックモードを指定します。値が false の場合、チャットセッションを特定のエージェントに転送し直すように試みます。値が true の場合、まずチャットセッションを特定のエージェントに転送し直すように試みますが、そのエージェントが対応できない場合、次のボタンへの転送を試みます。 29.0
sessionId String チャット訪問者のチャットセッション 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 オブジェクトの配列 EntityFieldsMaps で何が有効にされたかに応じて、作成されたレコード、検索されたレコード、またはその両方。 29.0
buttonOverrides String の配列
ボタンの上書きは転送対象の順序付きリストで、buttonId、agentId、doFallback モードを上書きします。使用可能な選択肢は次のとおりです。
  • buttonId — 通常の転送
  • agentId — エージェントへの直接転送 (フォールバックなし)
  • agentId_buttonId — エージェントへの直接転送 (ボタンへのフォールバックあり)

これらの選択肢の 1 つ以上をリストできます。順序により転送対象の順序が決まります。2 番目、3 番目の対象は前回の対象が失敗した場合のみ実行されます。

 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                        entityFieldMaps: [
17                           {
18                                entityName: "Contact",
19                                fieldName: "Email",
20                                isFastFillable: false,
21                                isAutoQueryable: true,
22                                isExactMatchable: true
23                           }
24                        ],
25                        transcriptFields: [
26                                "c__EmailAddress"
27                        ],
28                        displayToAgent: true
29                }             
30        ],
31        prechatEntities: [],
32        buttonOverrides: [
33                "573D000000000OD"
34        ],
35        receiveQueueUpdates: true,
36        isPost: true
37}

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}