INinfobip
customer-engagement
conversations
recording-metadata-calls

Get recording metadata

Use this method to retrieve a pageable list of recording metadata based on parameters.

get/ccaas/voice/2/recording/metadata

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Query parameters

recordingIdstring

Unique id of the recorded file.

conversationIdstring

Unique id of the conversation.

conferenceIdstring

Unique id of the conference.

callIdstring

Unique id of the call.

directionstring

Call direction of recorded file.

filenamestring

Filename of recorded file.

participantIdstring

Participant id associated with the recorded file.

participantIdentitystring

Participant identity associated with the recorded file.

participantNamestring

Participant name associated with the recorded file.

participantTypestring

Participant type associated with the recorded file.

mediaTypestring

Media type of recorded file.

deletedBystring

Identity of the user who deleted the recorded file.

transferredFromstring

Identity of the user who has transferred the call.

transferredTostring

Identity of the user to whom the call has been transferred.

transferredFromQueuestring

Queue id from which the call has been transferred.

transferredToQueuestring

Queue id to which the call has been transferred.

durationFrominteger

Minimum duration to filter recorded files.

durationTointeger

Maximum duration to filter recorded files.

startedAtFrominteger

Lower bound for filtering by recording start time.

startedAtTointeger

Upper bound for filtering by recording start time.

deletedAtFrominteger

Lower bound for filtering by deleted at time.

deletedAtTointeger

Upper bound for filtering by deleted at time.

pageinteger

Page number.

sizeinteger

Page size.

sortBystring

Field by which the sorting will be done.

sortDirection'ASC' | 'DESC'

Type of sorting.

Response

OK

recordingIdstring

Unique id of the recorded file.

conversationIdstring

Conversation id of the recorded file.

conferenceIdstring

Conference id of the recorded file.

callIdstring

Call id of the recorded file.

directionstring

Call direction of the recorded file.

recordingStatusstring

Status of the recorded file.

composedboolean

Flag indicating whether the recorded file is composed.

filenamestring

Filename of the recorded file.

durationinteger

Duration of the recorded file in seconds.

participantIdstring

Unique id of the participant associated with the recorded file.

participantIdentitystring

Unique identity of the participant associated with the recorded file.

participantNamestring

Participant name associated with the recorded file.

participantTypestring

Participant type associated with the recorded file. Values can be either customer or agent.

mediaTypestring

Specifies recorded file type. Values can be either audio or audio and video.

startedAtinteger

Unix timestamp for when the recording started.

deletedAtinteger

Unix timestamp for when the recorded file was deleted.

deletedBystring

Identity of the user who deleted the recorded file.

sftpPathstring

Location of the recorded file on the SFTP server.

transferredFromstring

Identity of the user who has transferred the call.

transferredTostring

Identity of the user to whom the call has been transferred.

transferredFromQueuestring

Queue id from which the call has been transferred.

transferredToQueuestring

Queue id to which the call has been transferred.

Example response

{
  "elements": [
    {
      "id": 1,
      "recordingId": "11f1b111-1111-1111-a111-1111e11f111e",
      "conversationId": "11f1b111-1111-1111-a111-1111e11f111a",
      "conferenceId": "11f1b111-1111-1111-a111-1111e11f111b",
      "callId": "11f1b111-1111-1111-a111-1111e11f111c",
      "direction": "INBOUND",
      "recordingStatus": "SUCCESSFUL",
      "composed": false,
      "filename": "11f1b111-1111-1111-a111-1111e11f111a_IDENTITY_20230612155341-11f1b111-1111-1111-a111-1111e11f111e.wav",
      "duration": 28,
      "participantId": "11f1b111-1111-1111-a111-1111e11f111d",
      "participantIdentity": "customer1",
      "participantName": "Customer 1",
      "participantType": "CUSTOMER",
      "mediaType": "AUDIO",
      "startedAt": 1686585221999,
      "deletedAt": null,
      "deletedBy": null,
      "sftpPath": null,
      "transferredFrom": null,
      "transferredTo": null,
      "transferredFromQueue": null,
      "transferredToQueue": null
    },
    {
      "id": 2,
      "recordingId": "52341263-0a22-1111-a1a1-1111bade8581",
      "conversationId": "52341263-0a22-1111-a1a1-1111bade8582",
      "conferenceId": "52341263-0a22-1111-a1a1-1111bade8583",
      "callId": "52341263-0a22-1111-a1a1-1111bade8584",
      "direction": "INBOUND",
      "recordingStatus": "SUCCESSFUL",
      "composed": false,
      "filename": "52341263-0a22-1111-a1a1-1111bade8582_IDENTITY_20230612155341-52341263-0a22-1111-a1a1-1111bade8581.wav",
      "duration": 28,
      "participantId": "52341263-0a22-1111-a1a1-1111bade8584",
      "participantIdentity": "agent1",
      "participantName": "Agent 1",
      "participantType": "AGENT",
      "mediaType": "AUDIO",
      "startedAt": 1686585221999,
      "deletedAt": null,
      "deletedBy": null,
      "sftpPath": null,
      "transferredFrom": null,
      "transferredTo": null,
      "transferredFromQueue": null,
      "transferredToQueue": null
    }
  ],
  "total": 2,
  "totalPages": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.