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

LiveChatButton

訪問者がチャットユーザとのチャットを要求できるボタンを表します。このオブジェクトは、API バージョン 24.0 以降で使用できます。

サポートされているコール

create()query()update()retrieve()

項目

項目名 詳細
Animation
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
自動チャット招待が画面に表示される場合に使用されるアニメーションの種別。自動チャット招待専用です。API バージョン 29.0 以降で使用できます。
AutoGreeting
textarea
プロパティ
Create、Filter、Nillable、Sort
説明
チャットセッションを開始するとエージェントから訪問者に自動的に送信されるテキスト。

LiveChatButton オブジェクトの AutoGreeting 項目の挨拶メッセージは、LiveChatUserConfig オブジェクトの AutoGreeting 項目の個人ユーザの挨拶メッセージを上書きします。

メモ

ChasitorIdleTimeout
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
顧客がエージェントのメッセージに応答しない場合にチャットがタイムアウトするまでの時間。
ChasitorIdleTimeoutWarning
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
顧客がエージェントのメッセージに応答しない場合に警告が表示され、タイマーが減算し始めるまでの時間。この値は、ChasitorIdleTimeout 値より小さくする必要があります (30 秒以下を推奨)。
ChatPageId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
カスタムのチャットウィンドウコードを含むカスタム Visualforce ページのレコード ID。
CustomAgentName
string
プロパティ
Create、Filter、Group、Nillable、Sort
説明
ボタンに関連付けられたエージェントのカスタム名。API バージョン 29.0 以降で使用できます。

LiveChatButton オブジェクトの CustomAgentName 項目にあるカスタムエージェント名によって、LiveChatUserConfig オブジェクトの CustomAgentName 項目にある個人ユーザのカスタムエージェント名は上書きされます。

メモ

DeveloperName
string
プロパティ
Create、Filter、Group、Sort
説明
API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更は登録者の組織で反映されます。

大規模データセットを作成する場合、必ず各レコードの一意の DeveloperName を指定してください。DeveloperName が指定されていないと、Salesforce で各レコードの DeveloperName を生成している間にパフォーマンスが低下する可能性があります。

メモ

HasQueue
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
エージェントがチャット可能になるまで受信チャット要求のキューを許可するかどうかを決定します。
InviteEndPosition
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
自動チャット招待のアニメーションが終了する画面上の位置。

カスタムアニメーションを使用する場合は、自動チャット招待の終了位置を選択する必要はありません。

メモ

自動チャット招待専用です。API バージョン 29.0 以降で使用できます。

InviteImageId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
自動チャット招待に表示される静的画像リソースのレコード ID。自動チャット招待専用です。API バージョン 29.0 以降で使用できます。
InviteStartPosition
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
自動チャット招待のアニメーションが開始する画面上の位置。

カスタムアニメーションを使用する場合は、自動チャット招待の開始位置を選択する必要はありません。

メモ

自動チャット招待専用です。API バージョン 29.0 以降で使用できます。

IsActive
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
自動チャット招待の場合、自動チャット招待が有効であるかどうかということと、顧客に送信できるか (true)、否か (false) を指定します。チャットボタンの場合、これはデフォルトで true に設定されています。
Language
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
チャットの言語。
MasterLabel
string
プロパティ
Create、Filter、Group、Sort
説明
チャットボタンの表示ラベル。
NumberOfReroutingAttempts
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
すべてのエージェントがチャット要求を拒否した場合に、対応可能なエージェントにチャット要求を再転送できる回数を指定します。
OfflineImageId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
ボタンがオフライン (無効) である場合に表示される静的画像リソースのレコード ID。
OnlineImageId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
ボタンがオンライン (有効) である場合に表示される静的画像リソースのレコード ID。
OptionsHasChasitorIdleTimeout
boolean
プロパティ
Create、Filter
説明
顧客のタイムアウトが有効になっているかどうかを示します。
OptionsHasInviteAfterAccept
boolean
プロパティ
Create、Filter
説明
顧客が以前の自動チャット招待を受諾したか (true)、辞退した (false) 後に、その顧客に自動チャット招待を送信できるかどうかを指定します。自動チャット招待専用です。API バージョン 29.0 以降で使用できます。
OptionsHasInviteAfterReject
boolean
プロパティ
Create、Filter
説明
顧客が以前の自動チャット招待を辞退したか (true)、受諾した (false) 後に、その顧客に自動チャット招待を送信できるかどうかを指定します。自動チャット招待専用です。API バージョン 29.0 以降で使用できます。
OptionsHasRerouteDeclinedRequest
boolean
プロパティ
Create、Filter
説明
すべての対応可能なエージェントから拒否されたチャット要求を、対応可能なエージェントに再転送する必要があるか (true)、否か (false) を指定します。
OptionsIsAutoAccept
boolean
プロパティ
Create、Filter
説明
チャット要求を割り当てられたエージェントが、チャット要求を自動的に受け入れる必要があるか (true)、否か (false) を指定します。[[チャット] ボタンおよび自動招待] で、RoutingTypeMostAvailable または LeastActive に設定されている場合。API バージョン 30.0 以降で使用できます。
OptionsIsInviteAutoRemove
boolean
プロパティ
Create、Filter
説明
特定の時間が経過した後に、自動チャット招待を画面から自動的に削除するか (true)、否か (false) を指定します。自動チャット招待専用です。API バージョン 29.0 以降で使用できます。
OverallQueueLength
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
キューが許可されたチャット要求の最大数。
PerAgentQueueLength
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
必要なスキルを有する各エージェントに対してキューが許可されるチャット要求の最大数。
PostchatPageId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
チャットが終了したときに表示されるカスタム Visualforce ページのレコード ID。
PostchatUrl
string
プロパティ
Create、Filter、Group、Nillable、Sort
説明
チャットが終了したときのユーザの移動先 URL。
PrechatFormPageId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
チャット開始前に表示されるカスタム Visualforce ページのレコード ID。
PrechatFormUrl
string
プロパティ
Create、Filter、Group、Nillable、Sort
説明
チャットが開始する前のユーザの移動先 URL。
PushTimeout
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
次に対応可能なエージェントに転送するまでに、エージェントがチャット要求への回答に費やすことのできる秒数。
QueueId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
このチャットボタンに使用されるキューのレコード ID。
RoutingConfigurationId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
このチャットボタンに使用されるルーティング設定のレコード ID。
RoutingType
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
チャット要求がエージェントに転送される方法。値は次のとおりです。
  • Choice — 受信チャット要求が Salesforce コンソールの Live Agent のキューに追加され、必要なスキルを有するすべてのエージェントがアクセスできます。
  • Least Active — 受信チャットが、必要なスキルを有し、アクティブなチャット数が最少のエージェントに転送されます。
  • Most Available — 受信チャットが、必要なスキルを持ち、参加可能なチャット数とアクティブなチャットセッション数の差が最大のエージェントに転送されます。たとえば、エージェント A と B のどちらも参加可能チャット数が 5 で、エージェント A はアクティブなチャットセッションが 3 つ、エージェント B はアクティブなセッションが 1 つの場合、受信チャットはエージェント B に転送されます。
  • Omni — チャットはオムニチャネルキューを使用して転送されます。
SiteId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
静的リソースとカスタム Visualforce ページの読み込みに使用されるサイトのレコード ID。
SkillId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
受信チャット要求を転送するために使用されるスキルのレコード ID。チャットボタンに複数のスキルを関連付けるには、SkillId 項目の 1 つのスキルを参照してから、残りのスキルの LiveChatButtonSkill 結合オブジェクトを使用します。
TimeToRemoveInvite
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
自動招待が自動的に削除されるまで画面に留まる秒数。自動チャット招待専用です。API バージョン 29.0 以降で使用できます。
Type
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
顧客に表示される要素の種別 (チャットボタンか自動招待のいずれか)。
WindowLanguage
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
標準チャットウィンドウに使用される言語。カスタムチャットウィンドウは、ユーザのブラウザの言語を使用します。

使用方法

このオブジェクトを使用して、チャットボタンと自動チャット招待をクエリおよび管理します。