getState

エージェントの現在の状態およびインタラクションに関する情報を取得します。getState は、コマンド GET_STATE とともにコールバック関数を使用し、エージェントの状態およびインタラクションデータを要求します。

getState を使用するには、エージェントがエージェントデスクトップにログインしている必要があります。本仕様のユースケースセクションを参照してください。

リクエスト

構文

window.bpspat.api.getState(コールバック) コールバック = function(data) { }

パラメータ

パラメータ	入力	説明
コールバック	関数	APIメソッドのリクエストが完了した際に実行されるJavaScriptメソッドです

レスポンス

以下は、getState を呼び出した際に返される可能性のあるレスポンスの例です。状態が変更されるたびに、ログには更新されたエージェントの状態が表示されます：

ログ... {"command":"STATE_CHANGED","data":{"agent_id":"jeffery.lozada","status":"受付可能","理由":""}} {"command":"STATE_CHANGED","data":{"agent_id":"jeffery.lozada","status":"受付不可","理由":"受付不可"}} {"command":"GET_STATE","data":{"agent_id":"jeffery.lozada","interactions":[{"item_id":"5B07EFE4-0658-45E0-AA6E-23AA042C1F0E","screenpop_data":{}}],"status":"受付可能","理由":""},"request_id":"2"}

レスポンスフィールド

名前	データ型	説明	例
agent_id	文字列	エージェントのユーザー名	"john.smith"
ステータス	文字列	エージェントの状態	"準備完了ではありません"
理由	文字列	受付不可の理由	「昼食」
やり取り	配列	以下のデータ項目を含むインタラクションデータのリストです	"item_id":"5B07EFE4-0658-45E0-AA6E-23AA042C1F0E","screenpop_data":{}
item.id	文字列	インタラクション id	"5B07EFE4-0658-45E0-AA6E-23AA042C1F0E"
global_id	文字列	グローバルインタラクションid (GIID)	"0CB4F48D-C4D8-4C9F-94F5-770AD5002C40"
phone_number	文字列	ダイヤルされた電話番号（内線番号または完全な番号）	"1012"
recording_url	文字列	通話録音のURL	"/msgplayback?tenant_id=1F64161D-C1C4-4A57-8DC4-B6B2ED7412C8&rtp_processor_id=7C0DCA41-F507-42B9-9D40-0E3B9F302B9F&メッセージ=recordings/<テナント>.brightpattern.com/2019-02-09/72E82ED8-769D-4267-85D3-EC890D653240&key_id=D811EFBA-5F8A-4AE5-A80C-8F07B7372BEF&CRC=aaadd10b9dbee5e52dcf60fe104982dd"
request_id	number	getStateリクエストを実行した回数を示します	「3」（例：エージェントのステータス情報をリクエストするのは今回で3回目です）
サービス	文字列	やり取りを処理するサービスの名前	「メンテナンス更新」
screenpop_data	文字列	スクリーンポップに表示される情報
attached_data	オブジェクト	コールに添付されたデータ

< 前へ | 次へ >