Query Platform Recording Segments

Queries the list of recording segments that are associated with a platform CDR.

Request URL

GET {base_url}/uc-creport/api/v1/platform/recording/{cdrMainId}

Request parameters

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

Format: Bearer {access_token}.
x-tenant-code No String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
cdrMainId Yes String The ID of the CDR main record. You can obtain the ID using the Query Platform CDRs interface.

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_Segments_Result> The list of the recording segments.
Recording_Segments_Result
Parameter Type Description
recordings Array<Platform_Recording_Segment> The list of recording segments of the CDR.
totalDuration Integer The total duration of all recording segments, in milliseconds.
totalSize String The total size of all recording segments, in bytes.
Platform_Recording_Segment
Parameter Type Description
id String The ID of the recording segment.
duration Integer The duration of the recording segment, in milliseconds.
format String

The format of the recording file:

  • wav
  • mp3
speakerSegments Array<Platform_Speaker_Segment> The speaker time ranges of the recording segment, which are used to render the call timeline.
waveformSamples String The waveform amplitude samples of the recording segment, compressed with gzip.
startTime String The start time of the recording segment, in Unix timestamp format (microseconds).
cdrLegId String The ID of the CDR leg record that the recording segment belongs to.
Platform_Speaker_Segment
Parameter Type Description
speaker String

The role of the speaker:

  • caller
  • callee
number String The number of the speaker.
name String The name of the speaker.
avatar String The URL of the speaker's avatar.
segments Array<Platform_Time_Range> The list of the time ranges when the speaker is active.
Platform_Time_Range
Parameter Type Description
startMs Integer The start of the time range, in milliseconds.
endMs Integer The end of the time range, in milliseconds.

Example

Request example

GET /uc-creport/api/v1/platform/recording/371139016054157312 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM2MDcxNCwiaWF0IjoxNzkzMzM5MTE0LCJqdGkiOiIwYzU4YTVjMS1hNTMwLTQ1MjUtOTMzMS1hMTQ1NzQ1MjkxZTQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.rd9xVGzJcc2NyEZ1PJtMnMtmk4-ovkSPt7c1z75SvaND72UXsHLJ4pN-I83fEJRU06MFrSBRWsU4vUzaZ4nikEmUzHfuTuXARORPBf-SGvh65FwPR6nPB3a9DeWQVOToRukOE71hgJrY8n9d0z8W8wFFc8_7d0Uv4J9CZqZFK073YAhzoZCG6hQzsI_u9Z5MzGRiLbMotGM1YGejEOKCswE3MuiXy_Ka9bUNTw9ISlAYFl0V52_JXYGPmpc3zw-TWTK1J8FCMysvR4QD6KTPoY9MHOfzvD1GiQCWiFuuI2DipfxCWop5I4Lg1qzrXV5W-MVieZYaD0kwFcvmj78xOw

Response example

HTTP/1.1 200 OK
{
  "requestId": "7e76bb51b41b3cea6166aa034d33f58a",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "recordings": [],
    "totalDuration": 0,
    "totalSize": "0"
  }
}