Udesk通話イベントプッシュ機能をご利用いただきありがとうございます。

基本の使い方

ステップ1：プッシュするフィールドの設定

Udeskカスタマーサービスシステムの管理者アカウントでログインし、管理センター -> コールセンター -> その他の設定 -> 通話イベントプッシュに移動し、プッシュスイッチをオンにして、プッシュアドレスを入力してください。

ステップ2：通話イベントプッシュの使用

プッシュアドレスを設定すると、通話イベント発生時に自動的にプッシュがトリガーされます。

通話イベントプッシュ

プッシュのタイミング

1. 着信（発信）開始

2. 通話確立（顧客/オペレーター応答）

3. 通話終了

4. 通話完了

プッシュパラメータ説明

パラメータ名	説明	タイプ
call_id	call_id（同一顧客の一連の通話を一意に識別するID）	String
conversation_id	conversation_id（現在の通話のID）	Int
timestamp	時間	String
nick_name	顧客名	String
customer_phone	顧客電話番号	String
mobile_area	地域	String
display_number	中継番号	String
workflow	通話タイプ（in：着信、out_callback: 双方向コールバック、 out_direct:ダイレクト発信、out_auto: 自動発信）	String
from_agent_id	ソース（高度な通話時の前のオペレーターID）	Int
call_result	通話結果（詳細説明一）	String
is_leave_message	ボイスメールの有無（ボイスメールは通話録音内）	Boolean
total_time	通話時間（秒）	Int
record_url	通話録音URL	String
survey	満足度評価	String
outline_phone_number	発信電話番号	String
agent_id	オペレーターID	Int
customer_ring_at	顧客側着信時間（例：2018-03-22 11:48:05 +0800）	String
agent_ring_at	オペレーター側着信時間	String
customer_answer_at	顧客応答時間	String
agent_answer_at	オペレーター応答時間	String
customer_hangup_at	顧客側通話終了時間	String
agent_hangup_at	オペレーター側通話終了時間	String
agent_email	オペレーターのメールアカウント	String
agent_nick_name	オペレーター名	string
category	高度な通話タイプ（詳細説明二）	String
task_name	タスク	String
queue_statue	待機状態	String
queue_time	待機時間	Int
dtmf	DTMFキー	String
device_info	デバイスタイプ	String
drop_side	通話終了側	String
defeat_cause	発信失敗理由（詳細説明三）	String
multi_ring_count	順次呼び出し	Int
relevant_agent	関連オペレーター	文字配列
task_id	自動発信タスクID	Int
queue_overflow	オーバーフロー待機列統計	String
ivr_time	IVR時間(s)	Int
ivr_variables	IVR変数（詳細説明四）	String
ivr_record_urls	IVR録音URL	Array
ticket_numbers	生成されたチケット番号（詳細説明五）	Array
lang	言語	String
is_blocked	ブラックリストに登録されているか	Boolean
level	レベル	String
description	説明	String
organization_name	会社	String
owner_name	責任者	String
owner_group_name	責任グループ	String
note_id	業務記録のID	Int
note_content	業務記録の件名	String
note_custom_fields	業務記録カスタムフィールド（詳細説明六）	Array
note_template_id	業務記録テンプレートID	Int
note_template_name	業務記録テンプレート名	String
questionnaire_id	アンケートID	Int
questionnaire_contents	アンケート内容	Hash
callout_tasks	手動発信タスク（詳細説明七）	Array
occasion	プッシュタイミング説明（詳細説明八）	String
biz_id	カスタム通話ID（通話コンポーネントと連携して使用）	String
customer_id	顧客ID	Long
customer_token	顧客open_api_token	String
customer_web_token	顧客web_token	String
customer_sdk_token	顧客sdk_token	String
weixin_openids	WeChat公式アカウント顧客ID	Array
user_group_id	オペレーターグループID	Int
user_group_name	オペレーターグループ名	String
call_start_at	通話開始時間	String
ring_time	呼び出し時間（秒）	Int
agent_tags	オペレータータグ	Array
created_at	作成時間	String

詳細説明一：通話結果（"顧客未応答"、"顧客応答"、"話中"、"電源オフ"、"オペレーター未応答"、"オペレーター拒否"、"オペレーター応答"、"顧客即時終了"、"顧客側終了"、"待機タイムアウト"、"待機放棄"、"待機列未選択"、"外線応答"、"外線未応答"）

詳細説明二："normal"=> 通常通話； "transfer"=> 転送； "transfer_outline"=> 外線転送； "consult"=>相談； "consult_outline"=>相談（外線）； "three_party"=>三者通話； "three_party_outline"=>三者通話（外線）； "listening"=>モニタリング； "barge_in"=>リーダー強制割り込み； "substitute"=>リーダー強制切断

詳細説明三： 発信失敗理由は個別に有効化する必要があります。Udeskにお問い合わせください。詳細は以下の通りで、最終的な戻り値は name フィールドです。

詳細説明四： IVR変数は、インテリジェントルーティングで設定され、通話記録に保存されたIVR変数です。戻り値の形式：（"ivr_variables": "aa:11,bb:22"）

詳細説明五： 生成されたチケット番号は、通話中に作成されたチケット番号で、複数のチケットが存在する可能性があります。戻り値の形式：（"ticket_numbers": ["#12","#13"]）

詳細説明六： 業務記録カスタムフィールドは、この通話記録に対応する業務記録のカスタムフィールドの集合です。戻り値の形式：（"note_custom_fields": [ { "id": "TextField_73", "name": "テスト日付", "value": "2019-08-09" }]）
注意：削除されたカスタムフィールドは返されません。

詳細説明七： 手動発信タスクは、この通話が発信タスクから開始されたことを示し、複数の発信タスクにこの番号が含まれている可能性があります。戻り値の形式：（"callout_tasks": [{"id": 85,"name": "発信タスク1"},{"id": 86,"name": "発信タスク2"}]）

id	name	alias	description
1	電源オフ	power off	電源オフ
2	空番号	does not exist	空番号
3	サービス停止	out of service	サービス停止
4	通話中	hold on	通話中
5	ユーザー拒否	not convenient	ユーザー拒否
6	接続不可	is not reachable	接続不可
7	サービス一時停止	not in service	サービス一時停止
8	ユーザー取り込み中	busy now	ユーザー取り込み中
9	ダイヤル方法が正しくない	not a local number	ダイヤル方法が正しくない
10	着信制限	barring of incoming	着信制限
11	転送失敗	forwarded	転送失敗
12	回線混雑	line is busy	回線混雑
13	応答なし	not answer	応答なし
14	料金未払い	defaulting	料金未払い
15	応答不可	cannot be connected	応答不可
16	番号変更	number change	番号変更
17	回線障害	line fault	回線が発信できない（例：SIMカードの料金未払い）
18	後でかけ直す	redial later	各種「後でかけ直してください」の案内

詳細説明八：プッシュタイミングは、このプッシュのトリガーイベントを示します。着信、発信、および高度な通話でそれぞれ異なりますが、各通話には必ず"end"プッシュが1つ含まれます。現在、"agent_lock"（オペレーターロック）プッシュは、順次呼び出しなどの理由により、カスタマーサポートに個別に有効化を依頼する必要があります。フィールドの詳細は以下の通りです：

値	タイミング
begin	自動発信開始
agent_answer	発信コールバックオペレーター応答
customer_answer	発信コールバック顧客応答
enqueue_succ	着信待機列入り成功
agent_lock	オペレーターロック（現在、このプッシュは個別に有効化が必要）
agent_incall	オペレーター通話開始
agent_breakout	割り当てオペレーター未応答
transfer_succ	転送成功
transfer_failed	転送失敗
consult_succ	相談成功
consult_failed	相談失敗
listening_succ	モニタリング成功
listening_failed	モニタリング失敗
third_party_succ	三者通話成功
third_party_failed	三者通話失敗
interpose_succ	強制割り込み成功
interpose_failed	強制割り込み失敗
substitute_succ	インターセプト成功
substitute_failed	インターセプト失敗
whisper_succ	密語成功
whisper_failed	密語失敗
hangup	通話のいずれかが終了
end	通話終了
end_info	高度な通話情報

プッシュ値の例

{
    "call_id": "8097f59e-0ba7-1111-b6c0-7f70c7a5a962",
    "conversation_id": 54093,
    "agent_ring_at": null,
    "agent_answer_at": null,
    "agent_hangup_at": "2019-07-24T15:23:14.000+08:00",
    "customer_ring_at": "2019-07-24T15:21:41.000+08:00",
    "customer_answer_at": "2019-07-24T15:21:56.000+08:00",
    "customer_hangup_at": "2019-07-24T15:23:17.000+08:00",
    "timestamp": "2019-07-24 15:23:17 +0800",
    "nick_name": "テスト顧客18",
    "mobile_area": "北京 北京",
    "workflow": "out_direct",
    "category": "normal",
    "from_agent_id": null,
    "call_result": "顧客応答",
    "is_leave_message": false,
    "total_time": 81,
    "survey": "未評価",
    "record_url": "https://xxxx",
    "outline_phone_number": null,
    "agent_id": 1941,
    "agent_email": "demo@udesk.cn",
    "agent_nick_name": "テストオペレーター01",
    "task_name": null,
    "queue_statue": null,
    "queue_time": null,
    "dtmf": "",
    "device_info": "ウェブ電話",
    "drop_side": "オペレーター",
    "defeat_cause": null,

    "multi_ring_count": 0,
    "relevant_agent": ["demo2"],
    "task_id": null,
    "queue_overflow": "オーバーフローなし",
    "ivr_time": null,
    "ivr_variables": null,
    "ivr_record_urls": [
      {
        "id": 50107001,
        "ivr_record_url": "https://pro-ccrecords.kefutoutiao.com/linapp/cc_recordings/20200604114352_8b16c1a0-941d-47c0-9fa8-86a302021d50_8b16c1a0-941d-47c0-9fa8-86a302021d50.wav?OSSAccessKeyId=bPexlr6MCcadDhfu&Expires=1622778259&Signature=e6OcyIoJ6AbUM9X7soj%2Bux9VJJg%3D"
      }
    ],
    "ticket_numbers": ["#12","#13"],
    "lang": "ko",
    "is_blocked": true,
    "level": "vip",
    "description": "テスト顧客18の説明",
    "organization_name": "ACMILAN",
    "owner_name": "demo",
    "owner_group_name": "一二三",
    "note_id": 113973,
    "note_content": "件名1",
    "customer_id": 1122333211,
    "customer_token": "2lakjer32aw34r123l",
    "customer_web_token": "la9df234jasdfqw3",
    "customer_sdk_token": "lasdf234ala23234",

    "weixin_openids": ["weixin_openids1", "weixin_openids2"],
    "note_custom_fields": [
    {
    "id": "TextField_286",
    "name": "zgh-単行テキスト",
    "value": "zgh-単行テキスト"
    },
    {
    "id": "TextField_287",
    "name": "zgh-日付",
    "value": "2019-07-24"
    },
    {
    "id": "TextField_288",
    "name": "zgh-時間",
    "value": "15:21:35"
    },
    {
    "id": "TextField_289",
    "name": "zgh-日時",
    "value": "2019-07-24 15:21"
    },
    {
    "id": "TextField_291",
    "name": "zgh-正の整数",
    "value": "111"
    },
    {
    "id": "TextField_292",
    "name": "zgh-リンク",
    "value": "https://baidu.com"
    },
    {
    "id": "TextField_293",
    "name": "zgh-複数行テキスト",
    "value": "zgh-複数行テキスト"
    },
    {
    "id": "TextField_294",
    "name": "zgh-地理的位置",
    "value": "地理的位置"
    },
    {
    "id": "TextField_33405",
    "name": "嘉雲数値",
    "value": "123"
    },
    {
    "id": "SelectField_257",
    "name": "10項目カスケード",
    "value": [
    "北京市",
    "海淀区",
    "知春路"
    ]
    },
    {
    "id": "SelectField_364",
    "name": "zgh-ドロップダウンリスト",
    "value": [
    "zgh-ドロップダウンリスト-オプション2"
    ]
    },
    {
    "id": "SelectField_366",
    "name": "zgh-ラジオボタン",
    "value": [
    "zgh-ラジオボタン-オプション2"
    ]
    },
    {
    "id": "SelectField_367",
    "name": "zgh-チェックボックス",
    "value": [
    "zgh-チェックボックス-オプション1",
    "zgh-チェックボックス-オプション2"
    ]
    }
    ],
    "note_template_id": 114,
    "note_template_name": "デフォルト業務記録",
    "questionnaire_id": "13",
    "questionnaire_contents": { "あなたはどんな動物が好きですか？": "小青", "あなたはどんな都市が好きですか？": "北京; 上海; 天津; 重庆", "あなたは今年何歳ですか？": "", "お正月は実家に帰りますか？": "帰らない" },
    "callout_tasks": [
    {
    "id": 1301,
    "name": "アウトバウンドタスク1"
    }
    ],
    "occasion": "end",
    "biz_id": null,
    "customer_phone": "1388888888",
    "display_number": "0211234567",
    "call_start_at": "2022-03-03 14:27:10",
    "ring_time": 17,
    "agent_tags": ["カスタマーサポートタグ", "show case"],
    "created_at": "2022-03-03 17:12:42"

    }

通話イベントプッシュタイミングの例

順次呼び出し、高度な通話の場合、プッシュされる件数は通話状況の複雑さによって異なります。実際の occasion を基準としてください。ただし、各通話には必ず1件だけ occasion が "end" のプッシュがあり、通話が完全に終了したことを示します。 再試行機能を有効にしている場合、同じ conversation_id に対して occasion が "end" のプッシュが既に受信済みであれば、その後のプッシュは以前失敗した後の再試行によるプッシュです。

1. 一般的な発信

一般的な場合、occasion は順に以下のようになります："agent_answer"; "customer_answer"; "hangup"; "end"。 "end" は通話全体の終了を示します（プッシュには通話時間などの重要な情報が含まれます）。

2. 一般的な着信

一般的な場合、occasion は順に以下のようになります："enqueue_succ"; "agent_lock"(機能有効化後); "agent_incall"; "hangup"; "end"。 "end" は通話全体の終了を示します（プッシュには満足度評価、通話時間などの重要な情報が含まれます）。