查询预约通话报告列表

查询预约通话报告的列表信息。

请求 URL

GET {base_url}/{api_path}/call_schedule_report/list?access_token={access_token}
注： 为提升系统性能，Yeastar 在 83.21.0.117 版本中对通话记录模块进行了升级，采用全新的数据结构，以提供更清晰的展示和更完整的通话信息。系统会根据 通话记录自动清理 规则逐步清理历史通话记录及相关报告数据。

在历史报告数据清理完成前，新旧数据分开管理 - 新生成的通话报告数据通过 openapi/v2.0 获取，历史数据通过 openapi/v1.0 获取。请根据要获取的数据使用正确的 API 路径。

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • id
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 预约报告总数。
data Array<scheduled_reports> 预约报告信息。
scheduled_reports
参数 类型 说明
id Integer 预约通话报告的唯一 ID。
name String 预约通话报告的名称。
format String 预约通话报告的文件格式。
date String 预约通话报告的预约时间。

示例

请求示例

重要： 请根据要获取的数据使用正确的 API 路径。
  • 获取 83.21.0.117 或更高版本生成的通话报告数据，使用 openapi/v2.0。
  • 获取 83.21.0.66 或更低版本生成的通话报告数据，使用 openapi/v1.0。
GET /openapi/v1.0/call_schedule_report/list?access_token=jw9RB1zwQ5g6qnoceH8vztrnaOiYoZwN&sort_by=name&order_by=desc HTTP/1.1  
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 6,
    "data": [
        {
            "id": 6,
            "name": "test-extension-report",
            "format": "csv",
            "date": "2022/04/12 19:19:38"
        },
        {
            "id": 3,
            "name": "Support",
            "format": "csv",
            "date": "2022/03/14 13:17:57"
        },
        {
            "id": 5,
            "name": "Support2",
            "format": "csv",
            "date": "2022/03/14 18:00:00"
        },
        {
            "id": 4,
            "name": "Sales",
            "format": "csv",
            "date": "2022/03/14 13:18:53"
        },
        {
            "id": 1,
            "name": "test1",
            "format": "csv",
            "date": "2022/01/06 19:31:11"
        },
        {
            "id": 2,
            "name": "test2",
            "format": "csv",
            "date": "2022/03/02 13:39:14"
        }
    ]
}