Search Recordings

Searches recordings with pagination and returns the list of recordings that match the search conditions.

Request URL

POST {base_url}/uc-creport/api/v1/recordings/search-page

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
pageSize Yes Integer The number of records to retrieve per page.
pageNumber Yes Integer The page number to retrieve.
startTimeFrom No String The start of the recording time range, in Unix timestamp format (microseconds).
startTimeTo No String The end of the recording time range, in Unix timestamp format (microseconds).
callerNumber No String The caller number, used for fuzzy matching.
calleeNumber No String The callee number, used for fuzzy matching.
cdrUid No String The business UID of the CDR, used for fuzzy matching.
communicationTypes No String

The list of call types, separated by commas.

Valid value:

  • inbound
  • outbound
  • internal
scenes No String

The list of scenarios, separated by commas.

Valid value:

  • queue
  • ring_group
  • ivr
  • conference
sorts No Array<Sort_Condition> The sort conditions. The supported fields are startTime, duration, size, communicationType, and cdrUid.
Sort_Condition
Parameter Required Type Description
direction No String The sort order.

Valid value:

  • asc: Sort in ascending order.
  • desc: Sort in descending order.
property No String The name of the field to sort by.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Recording_Page> The search result of recordings.
Recording_Page
Parameter Type Description
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
total Integer The total number of recordings that match the search conditions.
items Array<Recording> The list of recordings that match the search conditions.
Recording
Parameter Type Description
id String The ID of the recording.
cdrMainId String The ID of the associated CDR main record.
cdrUid String The business UID of the CDR.
fileName String The name of the recording file.
format String

The format of the recording file:

  • wav
  • mp3
duration Integer The duration of the recording, in milliseconds.
size String The size of the recording file, in bytes.
caller Object<Party_Info> The caller of the call.
callee Object<Party_Info> The callee of the call.
communicationType String

The call type:

  • inbound: An inbound call.
  • outbound: An outbound call.
  • internal: An internal call.
scene Object<Party_Info> The scenario of the call, such as a queue, ring group, IVR, or conference.
startTime String The start time of the recording, in Unix timestamp format (microseconds).
downloadable Boolean Whether the recording can be downloaded. false indicates that the file exceeds 600 MB.
resourceId String The resource ID of the resource service.
Party_Info
Parameter Type Description
number String The number of the party.
name String The name of the party.
avatar String The URL of the avatar.
type String

The type of the contact:

  • extension: An extension.
  • extension_mobile: An extension user with a bound mobile number.
  • personal_contact: A personal contact.
  • company_contact: A company contact.
  • external: An external contact.
presence String The presence status. This parameter is returned only when the type is extension or extension_mobile, and can be an empty string.
online Boolean The online status. This parameter is true when the party is online or in a call, and is returned only when the type is extension or extension_mobile.
companyName String The company name. This parameter is returned only when the type is company_contact, and can be an empty string.
extensionNumber String The extension number that the mobile number is bound to. This parameter is returned only when the type is extension_mobile, and can be an empty string.

Example

Request example

POST /uc-creport/api/v1/recordings/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjA4ODM1MSwiaWF0IjoxNzkyMDY2NzUxLCJqdGkiOiIzYjRmN2IxZC04ZWQyLTQzZTEtOTIyZC1kZmRhNjk4ZjQ2ZDgiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.OgeYovYZA5JEX-2F0VglvINizU6lzmE0EIpqSzWMb2PZa3XOBnAJjydZAVi-2_HJXQy1DDpZAkz3kcVlbOPQU8n0B9gfeHA-OPIxBWVeNTOZHO1BHHi_nMYDlNt59sRHO8pnYmakLbzrtA0qNF47jgPdNxm4yA_Jodhec-k-uT0xzpG_F0YugtZwcMIg9cujyWdqAs-lEohoYchO_WEMYENLOeQR966nspafFfxoKa-NafsEOyZX1igzWB9tX8nSgdQv_F4YqmUVXE7giTyUC9GmS_QzHymDJ9jbYZh8Ktp_bVoqFZfhd7WPVPR8HycGeX1dazgpH6Q8HBE6fsp2ZQ
x-tenant-code: jint
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 10,
  "communicationTypes": "inbound,outbound,internal",
  "sorts": [
    {
      "property": "startTime",
      "direction": "desc"
    }
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "b021c2ffb1da1d8e9b547c6dd173748b",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "items": [
      {
        "id": "347642307762311168",
        "cdrMainId": "347642293061275648",
        "cdrUid": "20260817151954ZAFHX",
        "fileName": "20260817151957-20260817151954ZAFHX-1000-1001-Queue-Internal.wav",
        "format": "wav",
        "duration": 383520,
        "size": "6136398",
        "caller": {
          "number": "1000",
          "name": "Leo Ball",
          "avatar": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/platform/jint/user_avatar/1786586611608/1.png",
          "type": ""
        },
        "callee": {
          "number": "1001",
          "name": "Terrell Smith",
          "avatar": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/platform/jint/user_avatar/1786586587824/2.png",
          "type": ""
        },
        "communicationType": "internal",
        "scene": {
          "number": "6401",
          "name": "6401",
          "avatar": "",
          "type": "queue"
        },
        "startTime": "1786951197826217",
        "downloadable": true,
        "resourceId": "2089252490675871745"
      }
    ],
    "total": 2
  }
}
Note:

The response is condensed. The array contains 2 items.