使用此API获取有关当前队列、帐户、代理或其活动的统计信息。

所有端点返回的数据的时间范围是当前的一天,从您的帐户所在时区的午夜到您发出请求的那一刻。

例如,如果您的帐户设置为太平洋时间(GMT-7),并且您在该时区的上午07:02发出请求,那么数据的时间框架如下:

             
我的11小君2018000000PDT-0700我的11小君2018070243PDT-0700

显示帐户概述

  • GET / api / v2 /渠道/语音/数据/ account_overview

您还可以根据电话号码筛选结果。

允许

  • 代理

JSON格式

帐户概览统计数据由具有以下属性的JSON对象表示:

名字 类型 描述
average_call_duration 整数 所有呼叫的平均呼叫时间
average_queue_wait_time 整数 呼叫方在队列中等待路由到代理的平均时间
average_wrap_up_time 整数 所有呼叫的平均结束时间
max_calls_waiting 整数 队列中等待座席的最大呼叫数,包括在线呼叫和回调请求
max_queue_wait_time 整数 呼叫方在队列中等待路由到代理的最长时间
total_call_duration 整数 所有呼叫的总时长
total_calls 整数 呼入和呼出的总次数
total_voicemails 整数 所有转到语音信箱的电话总数
total_wrap_up_time 整数 所有电话的总结束时间

例子

             
“average_call_duration”33“average_queue_wait_time”1“average_wrap_up_time”1“max_calls_waiting”1“max_queue_wait_time”10“total_call_duration”41“total_calls”39“total_voicemails”12“total_wrap_up_time”11}

JSON格式(专业方案及以上)

在Professional计划及以上版本中,JSON对象具有以下附加属性:

名字 类型 描述
average_callback_wait_time 整数 客户在队列中等待座席的平均回呼时间。不包括可用座席问候语
average_hold_time 整数 呼叫方每次呼叫的平均等待时间
average_time_to_answer 整数 从系统应答到客户与座席接通之间的平均时间。包括问候和其他播放的录音
total_callback_calls 整数 回调请求总数(成功或不成功)
total_calls_abandoned_in_queue 整数 客户在排队等待时挂断电话的总次数
total_calls_outside_business_hours 整数 营业时间以外接听的电话总数
total_calls_with_exceeded_queue_wait_time 整数 超过队列最大等待时间后转语音信箱的总次数
total_calls_with_requested_voicemail 整数 客户要求通过拨打1转语音信箱的总次数
total_hold_time 整数 所有呼叫的总保持时间
total_inbound_calls 整数 总呼入数
total_outbound_calls 整数 呼出总数
total_textback_requests 整数 IVR发送的短信总数
total_embeddable_callback_calls 整数 通过Web Widget请求的回调调用总数(成功或失败)

例子

             
“average_call_duration”33“average_queue_wait_time”1“average_wrap_up_time”1“max_calls_waiting”1“max_queue_wait_time”10“total_call_duration”41“total_calls”39“total_voicemails”12“total_wrap_up_time”11“average_callback_wait_time”0“average_hold_time”0“average_time_to_answer”2“total_callback_calls”0“total_calls_abandoned_in_queue”2“total_calls_outside_business_hours”0“total_calls_with_exceeded_queue_wait_time”0“total_calls_with_requested_voicemail”0“total_hold_time”0“total_inbound_calls”34“total_outbound_calls”5“total_textback_requests”0“total_embeddable_callback_calls”1}

参数

名字 类型 要求 描述
phone_number_ids 数组 查询 要过滤结果的电话号码id。接受一个以逗号分隔的最多包含100个电话号码id的列表。

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/channels/voice/stats/account_overview.json- v - uemail_address}密码}
旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity.json ? phone_number_ids1、23- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/channels/voice/stats/account_overview?phone_number_ids=”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/v2/channels/voice/stats/account_overview”newBuilderaddQueryParameter“phone_number_ids””“请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/account_overview”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数“phone_number_ids”''}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/account_overview?phone_number_ids=”“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/v2/channels/voice/stats/account_overview”uri查询URIencode_www_form“phone_number_ids””“请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“account_overview”“average_call_duration”33“average_callback_wait_time”0“average_hold_time”0“average_queue_wait_time”1“average_time_to_answer”2“average_wrap_up_time”1“max_calls_waiting”1“max_queue_wait_time”10“total_call_duration”41“total_callback_calls”0“total_calls”39“total_calls_abandoned_in_queue”2“total_calls_outside_business_hours”0“total_calls_with_exceeded_queue_wait_time”0“total_calls_with_requested_voicemail”0“total_embeddable_callback_calls”0“total_hold_time”0“total_inbound_calls”34“total_outbound_calls”5“total_textback_requests”0“total_voicemails”12“total_wrap_up_time”11}}

列出代理活动

  • GET / api / v2 /渠道/语音/数据/ agents_activity

允许

  • 代理

代理活动由一个JSON对象表示,具有以下属性:

名字 类型 描述
agent_id 字符串 代理人的身份证
agent_state 字符串 代理的状态。允许的值是"online", "offline", "away"或"transfers_only"
available_time 整数 座席接听电话的总时间设置为“在线”。不包括通话或总结模式的时间
avatar_url 字符串 代理头像的URL
away_time 整数 代理状态设置为“离开”的总时间
call_status 字符串 座席呼叫状态。允许的值是"on_call", "wrap_up"或"null"
calls_accepted 整数 座席接听的总电话数
calls_denied 整数 座席拒绝呼入的总次数
calls_missed 整数 座席不接电话并将呼叫路由到下一个可用座席的总次数
forwarding_number 字符串 座席设置的转发表号,如果座席没有转发表号,则为空
名字 字符串 代理人姓名
online_time 整数 代理状态设置为“online”、“away”或“transfers_only”的总时间
transfers_only_time 整数 代理状态设置为“transfers_only”的总时间
total_call_duration 整数 座席在所有呼叫中的总时间
total_talk_time 整数 总通话时间(不包括保持时间和咨询时间)
total_wrap_up_time 整数 所有电话的总结性时间
通过 字符串 座席注册的通道(客户端/电话)

例子

             
“agent_id”1“agent_state”“在线”“available_time”3600“avatar_url”“https://path_to_avatar.png”“away_time”250“call_status”“calls_accepted”5“calls_denied”1“calls_missed”1“forwarding_number”“+ 1234567890”“名称”“约翰尼代理”“online_time”5600“transfers_only_time”123“total_call_duration”121“total_talk_time”87“total_wrap_up_time”68“通过”“电话”}

在Professional计划及以上版本中,JSON对象具有以下附加属性:

名字 类型 描述
accepted_third_party_conferences 整数 接听电话的平均次数、座席接听电话的平均次数、座席接听电话的平均次数和座席接听电话的平均次数之差的百分比
accepted_transfers 整数 代理接受的传输总数
average_hold_time 整数 座席每次呼叫的平均等待时间
average_talk_time 整数 所有呼叫的平均通话时间(不包括保持时间和咨询时间)
average_wrap_up_time 整数 所有呼叫的平均结束时间
calls_put_on_hold 整数 座席保持呼叫的总次数
started_third_party_conferences 整数 平均发起的电话数、所选座席发起的电话数以及两者之差的百分比
started_transfers 整数 代理启动的传输总数
total_hold_time 整数 所有通话中座席等待的总时间

例子

             
“accepted_third_party_conferences”0“accepted_transfers”5“agent_id”1“available_time”3600“avatar_url”“https://path_to_avatar.png”“average_hold_time”10“average_talk_time”25“average_wrap_up_time”39“calls_accepted”5“calls_denied”1“calls_missed”1“calls_put_on_hold”8“forwarding_number”“+ 1234567890”“名称”“约翰尼代理”“online_time”5600“transfers_only_time”123“started_third_party_conferences”0“started_transfers”2“total_call_duration”121“total_hold_time”27“total_talk_time”87“total_wrap_up_time”68“通过”“电话”}

参数

名字 类型 要求 描述
group_ids 数组 查询 要筛选结果的组的id。接受最多包含100个组id的逗号分隔列表。

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/channels/voice/stats/agents_activity.json- v - uemail_address}密码}
旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/channels/voice/stats/agents_activity.json ? group_ids1、23- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_activity?group_ids=%5B1%2C2%5D”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_activity”newBuilderaddQueryParameter“group_ids”“[1,2]”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_activity”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数“group_ids”' % b1 % 2 c2 % 5 d '}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_activity?group_ids=%5B1%2C2%5D”“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_activity”uri查询URIencode_www_form“group_ids”“[1,2]”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“agents_activity”(“agent_id”1“available_time”3600“avatar_url”“https://path_to_avatar.png”“calls_accepted”5“calls_denied”1“calls_missed”1“forwarding_number”“+ 1234567890”“名称”“约翰尼代理”“online_time”5600“total_call_duration”121“total_talk_time”87“total_wrap_up_time”68“transfers_only_time”123“通过”“电话”}“数”1“next_page”“previous_page”}

Show agent概述

  • GET / api / v2 /渠道/语音/数据/ agents_overview

允许

  • 代理

代理概览统计数据由具有以下属性的JSON对象表示:

名字 类型 描述
average_wrap_up_time 整数 所有呼叫的平均结束时间
total_calls_accepted 整数 座席应答的总呼叫数
total_calls_denied 整数 被拒绝的呼叫座席总数
total_calls_missed 整数 座席未接呼叫总数
total_talk_time 整数 所有呼叫的总通话时间(不包括保持时间和咨询时间)
total_wrap_up_time 整数 所有电话的总结束时间

请注意:诸如total_calls_acceptedtotal_calls_deniedtotal_calls_missed,total_calls_put_on_hold可以大于total_inbound_calls。示例:一个呼入被两个座席漏接或被两个座席拒绝。

例子

             
“average_wrap_up_time”120“total_calls_accepted”41“total_calls_denied”39“total_calls_missed”12“total_talk_time”31“total_wrap_up_time”13}

在Professional计划及以上版本中,JSON对象具有以下附加属性:

名字 类型 描述
average_accepted_transfers 整数 经纪人接受的平均转会次数
average_available_time 整数 座席接听电话并设置为“在线”的平均时间。不包括通话或总结模式的时间
average_away_time 整数 agent状态设置为“离开”的平均时间
average_calls_accepted 整数 座席应答的平均呼叫数
average_calls_denied 整数 座席拒绝的平均呼叫数
average_calls_missed 整数 座席错过的平均呼叫数
average_calls_put_on_hold 整数 座席被保持的平均呼叫数
average_hold_time 整数 呼叫方每次呼叫的平均等待时间
average_online_time 整数 agent状态设置为“online”、“away”或“transfers_only”的平均时间
average_transfers_only_time 整数 将代理状态设置为“仅传输”的平均时间
average_started_transfers 整数 启动的传输代理的平均数目
average_talk_time 整数 所有呼叫的座席平均通话时间(不包括保持时间和咨询时间)
total_accepted_transfers 整数 已启动的传输代理总数
total_calls_put_on_hold 整数 被保持呼叫的座席总数
total_hold_time 整数 所有呼叫的总保持时间
total_started_transfers 整数 已启动的传输代理总数

例子

             
“average_accepted_transfers”8“average_available_time”2100“average_away_time”4438“average_calls_accepted”14“average_calls_denied”4“average_calls_missed”3.“average_calls_put_on_hold”14“average_hold_time”35“average_online_time”3600“average_transfers_only_time”123“average_started_transfers”12“average_talk_time”67“average_wrap_up_time”120“total_accepted_transfers”12“total_calls_accepted”41“total_calls_denied”39“total_calls_missed”12“total_calls_put_on_hold”5“total_hold_time”120“total_started_transfers”17“total_talk_time”31“total_wrap_up_time”13}

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/channels/voice/stats/agents_overview.json- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_overview”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_overview”newBuilder请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_overview”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_overview”“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/v2/channels/voice/stats/agents_overview”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“agents_overview”“average_accepted_transfers”8“average_available_time”2100“average_away_time”210“average_calls_accepted”14“average_calls_denied”4“average_calls_missed”3.“average_calls_put_on_hold”14“average_hold_time”35“average_online_time”3600“average_started_transfers”12“average_talk_time”67“average_transfers_only_time”123“average_wrap_up_time”120“total_accepted_transfers”12“total_calls_accepted”41“total_calls_denied”39“total_calls_missed”12“total_calls_put_on_hold”5“total_hold_time”120“total_started_transfers”17“total_talk_time”31“total_wrap_up_time”13}}

显示当前队列活动

  • GET / api / v2 /渠道/语音/数据/ current_queue_activity

如果注意到与返回值不一致,可以根据电话号码筛选结果。

允许

  • 代理

速率限制

您可以每5分钟向这个端点发出最多2500个请求。

名字 类型 描述
agents_online 整数 当前在线或不在的座席数量,包括随叫随到的座席数量和随到的座席数量
average_wait_time 整数 等待可用座席的所有呼叫者的平均等待时间(以秒为单位)
callbacks_waiting 整数 当前在回调队列中等待下一个可用支持代理的呼叫者数量
calls_waiting 整数 队列中等待下一个可用支持代理的当前呼叫者数量
embeddable_callbacks_waiting 整数 等待下一个可用支持代理的队列中来自Web Widget的回调请求的当前数量
longest_wait_time 整数 队列中任何调用者的最长等待时间(以秒为单位)

例子

             
“agents_online”1“average_wait_time”5“calls_waiting”1“callbacks_waiting”3.“embeddable_callbacks_waiting”1“longest_wait_time”10}

参数

名字 类型 要求 描述
phone_number_ids 数组 查询 要过滤结果的电话号码id。接受一个以逗号分隔的最多包含100个电话号码id的列表。

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity.json- v - uemail_address}密码}
旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity.json ? phone_number_ids1、23- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity?phone_number_ids=”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity”newBuilderaddQueryParameter“phone_number_ids””“请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数“phone_number_ids”''}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity?phone_number_ids=”“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/v2/channels/voice/stats/current_queue_activity”uri查询URIencode_www_form“phone_number_ids””“请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“current_queue_activity”“agents_online”2“average_wait_time”5“callbacks_waiting”1“calls_waiting”1“embeddable_callbacks_waiting”1“longest_wait_time”10}}