查询录音列表

查询通话录音文件列表。

请求 URL

GET {base_url}/{api_path}/recording/list?access_token={access_token}

请求参数

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

取值范围：

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

取值范围：

  • asc：升序
  • desc：降序

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 通话录音文件总数量。
data Array<Recording_Details> 通话录音文件详细信息。
Recording_Details
表 3.
参数 类型 说明
id Integer 通话录音的唯一 ID。
time String 接听或拨打该通通话的时间。
uid String 进行录音的通话的 CDR 唯一 ID。
call_from String 主叫的号码和名称。
call_to String 被叫的号码和名称。
duration Integer 呼叫时长。
size Integer 通话录音文件大小 。

单位：字节(byte)
call_type String 通讯类型。
  • Inbound：呼入
  • Outbound：呼出
  • Internal：内部
file String 通话录音文件名。

示例

请求示例

GET /openapi/v1.0/recording/list?access_token=XLS56U6Uq16jvYozSuTM0jHY8NqQcfIG&sort_by=id&order_by=asc HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 184,
    "data": [
     {
            "id": 614,
            "time": "01/12/2022 17:36:24",
            "uid": "2022011217362446627",
            "call_from": "Evelyn<5566>",
            "call_to": "Dave Harris<5556>",
            "duration": 250,
            "size": 825588,
            "call_type": "Internal",
            "file": "20220112173629-1641980184.14-5566-5556-Internal.wav"
        },
        {
            "id": 615,
            "time": "01/13/2022 14:09:04",
            "uid": "202201131409043E81A",
            "call_from": "Leo Ball<5555>",
            "call_to": "Dave Harris<5556>",
            "duration": 53,
            "size": 4148,
            "call_type": "Internal",
            "file": "20220113140906-1642054144.17-5555-5556-Internal.wav"
        },
        {
            "id": 618,
            "time": "01/25/2022 14:32:06",
            "uid": "202201251432063097C",
            "call_from": "Leo Ball<5555>",
            "call_to": "Dave Harris<5556>",
            "duration": 115,
            "size": 177588,
            "call_type": "Internal",
            "file": "20220125143212-1643092326.23-5555-5556-Internal.wav"
        },
      ... ...
    ]
  
}