下载通话报告
下载特定的通话报告。
下载步骤
请求 URL
GET {base_url}/{api_path}/call_report/download?access_token={access_token}
请求参数
参数 | 适用范围 | 是否必填 | 类型 | 说明 |
---|---|---|---|---|
type | 此参数适用于查询所有类型的通话报告。 | 是 | String | 通话报告类型。 取值范围:
|
start_time | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 指定起始时间以筛选报告 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
end_time | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 指定结束时间以筛选报告。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
time | 此参数仅适用于查询以下类型的通话报告:
|
是 | String |
指定时间范围以筛选报告。 注: 时间格式取决于 PBX 的日期显示格式。
例如:PBX 的
日期显示格式 为
年/月/日,则此参数的有效时间填写格式为
时间格式:
|
ext_id_list | 此参数仅适用于查询以下类型的通话报告:
|
此参数在查询以下类型的通话报告时必填:
|
String | 要查询的分机/分机组的唯一 ID。 注:
|
trunk_id | 此参数仅适用于查询 DID /去电号码活动报告。 | 是 | String | 单个中继的唯一 ID。 注: 可使用 获取菜单选项 接口查询中继 ID。 |
trunk_id_list | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 中继的唯一 ID。 注:
|
ivr_id_list | 此参数仅适用于查询 IVR 报告。 | 是 | String | IVR 的唯一 ID。 注:
|
ring_group_id_list | 此参数仅适用于查询 响铃组统计报告。 | 是 | String | 响铃组的唯一 ID。 注:
|
queue_id | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 单个队列的唯一 ID。 注: 可使用 获取菜单选项 接口查询队列的
ID。 |
queue_id_list | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 队列的唯一 ID。 注:
|
agent_id_list | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 队列坐席的唯一 ID。 注:
|
abandon_time | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 设置一个时间。在指定时间内放弃的电话将不计入报告。(单位:秒) |
talk_time | 此参数仅适用于查询 队列业绩报告。 | 否 | Integer | 设置一个时间。通话时间少于此指定时间的通话将不计入报告。(单位:秒) |
include_internal | 此参数仅适用于查询 PBX 通话活动报告。 | 否 | Integer | 是否在报告中包含内部通话的数据。 取值范围:
|
callback_result | 此参数仅适用于查询 队列回拨报告。 | 否 | String | 队列回拨结果。 取值范围:
|
reason | 此参数仅适用于查询 坐席暂停报告。 | 否 | String | 坐席切换为暂停状态的原因。 取值范围:在 PBX 管理网页上设置的暂停原因 (路径: )。 |
communication_type | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 通讯类型。 注: 如果不传递此参数,则会查询并返回所有通讯类型的记录。 分机相关报告取值范围:
中继相关报告取值范围:
|
need_detail | 此参数仅适用于查询以下类型的通话报告:
|
否 | Integer | 是否包含相关通话详情。 取值范围:
|
is_async | 此参数适用于查询所有类型的通话报告。 | 否 | Integer |
是否异步获取数据和通话报告的下载 URL。 取值范围:
|
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注:
|
errmsg | String | 返回信息。
|
file | String | 通话报告文件。 |
download_resource_url | String | 通话报告下载 URL。 |
示例
请求示例
获取 04/01/2022 00:00:00-05/31/2022 23:59:59 期间某队列满意度调查报告的下载 URL(队列 ID 为
“1”)。
GET /openapi/v1.0/call_report/download?type=queuesatisfaction&start_time=04/01/2022 00:00:00&end_time=05/31/2022 23:59:59&queue_id=1&access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"file": "QueueSatisfaction-X.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv",
"download_resource_url": "/api/download/QueueSatisfaction-x.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv"
}
下载通话报告
在获取通话报告下载 URL 后,你需要将下载 URL 与 {base_url} 整合,组成一个下载请求 URL,并发送请求下载通话报告。
下载链接格式
GET {base_url}/{download_resource_url}
?access_token={access_token}
下载链接示例
GET https://yeastardocs.example.yeastarcloud.com/api/download/QueueSatisfaction-x.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv?access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr HTTP/1.1