エージェントステータス指標API

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

ZohoVoice REST API

認証

ヘッダーキー	説明
Authorization *	Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept *	application/jsonに設定します。

OAuthドキュメント

エージェントのオンラインステータス監査の取得

このAPIでは、指定した期間におけるエージェントのステータス詳細を取得できます。

スコープ：ZohoVoice.agents.READ

メソッド：GET

URL：https://voice.zoho.com/rest/json/zv/metrics/statusaudit/list

パラメーター。

キー	型	説明
from	数値	開始位置
size	数値	ログ数
fromEpoch*	long	エポックミリ秒単位のタイムスタンプ
toEpoch*	long	エポックミリ秒単位のタイムスタンプ
agentIds*	文字列	担当者ID
sortField	文字列	並べ替えの基準となるステータス（On Call、Offline、On Break、Available、Busy、Working Time のいずれか）
sortMetric	文字列	並べ替えの基準となる指標（avg、sum、min、max のいずれか）
sortOrder	文字列	asc、desc
tz*	文字列	タイムゾーン
excludeDays	文字列	除外する曜日の一覧。1は月曜日、7は日曜日を表します。区切り文字は不要です例：週末を除外するには、67を指定します
excludeStatus	文字列	除外するステータスの一覧。カンマ区切りで指定します例：Offline と Break を除外するには、On Break,Offlineを指定します

レスポンス。

{
'code': '200',
'list': {
'agentStatus': [
{

'previousResult': {

'agent_id': '3029000000002015',

'previous_action_time': 1728976200110,

'agentEmail': 'janice@ジルカー.com',

'current_action_time': 1728977814592,

'agentName': 'Jan',

'triggered_by_username': 'Jan',

'triggered_by': 'User',

'duration': 1614482,

'triggered_by_medium': 'Web',

'triggered_by_zuid': '67560001',

'current_status': 'Available',

'zsoid': '67560292',

'triggered_reason': '',

'previous_status': 'Offline'

'agent_id': '3029000000002015',

'agentEmail': 'janice@ジルカー.com',

'agentName': 'Jan',

'dates': [

{

'hits': [

{

'agent_id': '3029000000002015',

'previous_action_time': 1728977814592,

'agentEmail': 'janice@ジルカー.com',

'triggered_reason_desc': 'Automatic Check In',

'current_action_time': 1729056300109,

'agentName': 'Jan',

'triggered_by': 'Zoho Voice',

'duration': 78485517,

'triggered_by_medium': '',

'triggered_by_zuid': '',

'current_status': 'Available',

'logid': '6prJk5IB_xciauz1XOy0',

'zsoid': '67560292',

'triggered_reason': 'Agent Schedule',

'previous_status': 'Available'

{

'agent_id': '3029000000002015',

'previous_action_time': 1729056300109,

'agentEmail': 'janice@ジルカー.com',

'current_action_time': 1729061808945,

'agentName': 'Jan',

'triggered_by_username': 'Jan',

'triggered_by': 'User',

'duration': 5508836,

'triggered_by_medium': 'Web',

'triggered_by_zuid': '67560001',

'current_status': 'Offline',

'logid': 'b6MdlJIBm7rVk3YNaz3l',

'zsoid': '67560292',

'triggered_reason': '',

'previous_status': 'Available'

...

'start_timestamp': 1729036800000,

'index': 0

{ 'hits': [...], 'start_timestamp': 1729123200000, 'index': 1},

{ 'hits': [...],'start_timestamp': 1729209600000,'index': 2},

{ 'hits': [...],'start_timestamp': 1729296000000,'index': 3},

{ 'hits': [...],'start_timestamp': 1729382400000,'index': 4},

{ 'hits': [...],'start_timestamp': 1729468800000,'index': 5},

{ 'hits': [...],'start_timestamp': 1729555200000,'index': 6}

]

}

]

'status': 'SUCCESS'

}

通話ログのステータス取得アクション

このAPIは、キューの通話ログに含まれるすべてのエージェントのステータス情報を取得します。これにより、不在着信または応答済みのキュー通話に対して、エージェントの対応可否を関連付けて確認できます。

メモ：このAPIは、着信キュー通話ログでのみ利用できます。その他の通話種別ではステータスの関連付けは利用できませんが、エージェントの一覧、通話ログのstartTime、endTimeが分かっている場合は、'statusaudit/list' APIを使用して取得できます。

スコープ：ZohoVoice.agents.READ

メソッド：GET

URL：https://voice.zoho.com/rest/json/zv/metrics/statusaudit/list/log

パラメーター：

キー	型	説明
fromEpoch*	long	エポックミリ秒単位のタイムスタンプ
toEpoch*	long	エポックミリ秒単位のタイムスタンプ
logId*	uuid	通話ログのUUID
queueIds	String	通話ログに関連するキューのqueueIds
tz*	String	結果の表示に使用するタイムゾーン

レスポンス。

{
'code': '200',
'log': {
'response': [
{
'ringingOrder': [
{
'agentId': '3029000003904005',
'rings': [
{
'start_time': 1729251588000,
'queueName': 'All in One',
'agent_name': 'aravindan.e5',
'agent_number': 3029000003904005,
'ringing_time': 0,
'is_answered': false,
'strategy': 'ring-all',

'hangup_cause': {

'hangup_cause_description': 'The user you are trying to reach is not available.',

'hangupcause': 'UNALLOCATED_NUMBER',

'hangup_cause_displayname': 'User unreachable'

}

]

{

'agentId': '3029000004016005',

'rings': [..]

{

'agentId': '3029000000002015',

'rings': [..]

}

'answeredAgent': {},

'queueDetails': {

'_queueId': 3029000004016033,

'ringtime_in_queue': 60,

'queueName': 'All in One',

'customer_entry_time': 1729251587000,

'strategy': 'ring-all',

'customer_exit_time': 1729251647000

'agentStatus': [

{

'hits': [..],

'agent_id': '3029000003904005',

'agentName': 'aravindan.e5'

{

'hits': [..],

'agent_id': '3029000004016005',

'agentName': 'aravindan.e3'

{

'hits': [..],

'agent_id': '3029000000002015',

'agentName': 'AravindaN1'

{

'hits': [..],

'agent_id': '3029000000003003',

'agentName': 'aravindan2'

{

'hits': [..],

'agent_id': '3029000000005013',

'agentName': 'aravindan.e4'

}

]

}

]

'status': 'SUCCESS'

}

エージェントの集計ステータスメトリクスの取得（全期間）

このAPIは、指定したエージェントまたはキューのステータス集計データを返します。

スコープ：ZohoVoice.agents.READ

メソッド：GET

URL：https://voice.zoho.com/rest/json/zv/metrics/statusaudit/overview

パラメーター

キー

種類

説明

from

数値

開始位置

size

数値

ログの件数

fromEpoch*

長整数

エポックミリ秒のタイムスタンプ

toEpoch*

長整数

エポックミリ秒のタイムスタンプ

agentIds*

文字列

コンマ区切りの担当者IDのリスト

queueIds*

文字列

コンマ区切りのキューIDのリスト（agentIdsとqueueIdsの両方が指定されている場合、結果の絞り込みにはqueueIdsのみが使用されます）

sortField

文字列

並べ替えに使用するステータス - On Call、Offline、On Break、Available、Busy、Working Timeのいずれか

sortMetric

文字列

並べ替えの基準となる指標（avg、sum、min、maxのいずれか）

sortOrder

文字列

asc、desc

tz*

文字列

タイムゾーン

excludeDays

文字列

除外する曜日の一覧。区切り文字なしで、1は月曜日、7は日曜日を表します

例：週末を除外するには、67を使用します

excludeStatus

文字列

除外するステータスの一覧（カンマ区切り）

例：OfflineとBreakを除外するには、On Break,Offlineを使用します

レスポンス。

{
'overview': {
'agentmetrics': {
'overallAggregation': {
'Working Time': {
'avg': 140780500.4,
'max': 162421466,
'onlineStatus': 'Working Time',

'sum': 703902502,

'daily_peragent_avg': 35195125.1

'Offline': {..},

'Available': {..},

'On Call': {..},

'agentCount': 4,

'daysCount': 5

'maxTimeAgents': {

'On Break': {

'duration': '--',

'agentName': '--',

'previous_status': 'On Break'

'Busy': {

'duration': '--',

'agentName': '--',

'previous_status': 'Busy'

}

'individualAggregation': [

{

'agent_id': '600000000039003',

'agentEmail': 'jacques@ジルカー.com',

'agentName': 'Jack',

'Working Time': {

'avg': 40426688,

'max': 161471551,

'onlineStatus': 'Working Time',

'sum': 2.0213344E+8

'On Break': {

'avg': '--',

'peragent_avg': '--',

'max': '--',

'onlineStatus': 'On Break',

'sum': '0',

'daily_peragent_avg': '--'

'Busy': {

'avg': '--',

'peragent_avg': '--',

'max': '--',

'onlineStatus': 'Busy',

'sum': '0',

'daily_peragent_avg': '--'

'Offline': {

'avg': '--',

'peragent_avg': '--',

'max': '--',

'onlineStatus': 'Offline',

'sum': '0',

'daily_peragent_avg': '--'

'Available': {

'avg': 40265253.8,

'max': 161471551,

'onlineStatus': 'Available',

'sum': 201326269

'On Call': {

'avg': 161434.2,

'max': 311311,

'onlineStatus': 'On Call',

'sum': 807171

}

{..},

{..}

]

}

'code': '200',

'status': 'SUCCESS'

}

エージェントのステータスメトリクス集計の取得（日別）

このAPIは、指定したエージェントまたはキューのステータス集計データを返します。

スコープ：ZohoVoice.agents.READ

メソッド：GET

URL：https://voice.zoho.com/rest/json/zv/metrics/statusaudit/calendarSummary

パラメーター。

キー	データ型	説明
from	数値	取得開始位置
size	数値	ログ数
fromEpoch*	long	エポックミリ秒のタイムスタンプ

toEpoch*

long

エポックミリ秒形式のタイムスタンプ

agentIds*

String

コンマ区切りの担当者IDのリスト

queueIds*

String

コンマ区切りのキューIDのリスト（agentIdsとqueueIdsの両方が指定された場合、結果の絞り込みにはqueueIdsのみが使用されます）

tz*

String

タイムゾーン

excludeDays

String

除外する曜日のリスト。1は月曜日、7は日曜日を表し、区切り文字は使用しません

例：週末を除外するには、67を使用します

excludeStatus

String

除外するステータスのコンマ区切りのリスト

例：オフラインと休憩を除外するには、On Break,Offlineを使用します

{
'calendarSummary': {
'histogramAggregation': [

{

'totalRow': {

'agent_id': '600000000039003',

'agentEmail': 'jacques@ジルカー.com',

'agentName': 'ジャック',

'稼働時間': {

'avg': 40426688,

'max': 161471551,

'onlineStatus': '稼働時間',

'sum': 2.0213344E+8

'休憩中': {

'avg': '--',

'peragent_avg': '--',

'max': '--',

'onlineStatus': '休憩中',

'sum': '0',

'daily_peragent_avg': '--'

'取り込み中': {..},

'Offline': {..},

'Available': {..},

'On Call': {..}

'intervalsData': {

'2024-10-18': {

'interval': '2024-10-18',

'previous_status': {

'Working Time': {

'avg': 5866688,

'max': 2.606828E+7,

'sum': 2.933344E+7,

'previous_status': 'Working Time'

'On Break': {

'avg': 0,

'max': 0,

'sum': 0,

'previous_status': 'On Break'

'Busy': {

'avg': 0,

'max': 0,

'sum': 0,

'previous_status': 'Busy'

'Offline': {

'avg': 0,

'max': 0,

'sum': 0,

'previous_status': 'Offline'

'Available': {

'avg': 5732255,

'max': 2.606828E+7,

'sum': 28661275,

'previous_status': 'Available'

'On Call': {

'avg': 134433,

'max': 311311,

'sum': 672165,

'previous_status': 'On Call'

}

'2024-10-16': {..},

'2024-10-17': {..},

'2024-10-21': {..},

'2024-10-22': {..}

'intervalsList': [

'2024-10-16',

'2024-10-17',

'2024-10-18',

'2024-10-21',

'2024-10-22'

]

}

'individualAggregation': [

{

'agent_id': '600000000039003',

'agentEmail': 'jacques@ジルカー.com',

'agentName': 'Jack',

'勤務時間': {

'avg': 40426688,

'max': 161471551,

'onlineStatus': '勤務時間',

'sum': 2.0213344E+8

'休憩中': {

'avg': '--',

'peragent_avg': '--',

'max': '--',

'onlineStatus': '休憩中',

'sum': '0',

'daily_peragent_avg': '--'

'取り込み中': {..},

'オフライン': {..},

'対応可能': {..},

'通話中': {..}

}

]

'code': '200',

'status': 'SUCCESS'

}

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Zoho Campaigns Resources

Campaigns Community Learning Series

Zoho WorkDrive Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day
Ask the Experts

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

Resources

Videos

Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.

Watch Now

eBooks

Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.

Download eBooks

Webinars

CRM Tips

Make the most of Zoho CRM with these useful tips.

Learn More

エージェントステータス指標API

エージェントステータス指標API

Zoho CRM 管理者向けトレーニング

Zoho Campaigns Resources

Zoho WorkDrive Resources

Resources

Videos

eBooks

Webinars

CRM Tips