List Recordings

In order to retrieve all recordings you can use this request.

List recordings

get

List recordings

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 99 · default: 10optional

Limits the number of results to return

pageTokenstring · max: 8000optional

Pagination token that keeps of track of the current position in the list

sourceIdstring · uuidoptional

The ID for the source.

channelIdstring · uuidoptional

The ID for the channel.

idstring · uuidoptional

The ID for the call.

directionstring · enumoptional

Direction of the call

Options: incoming, outgoing

startAtstring · date-timeoptional

Start date for the query

endAtstring · date-timeoptional

End date for the query

fromstringoptional

From number of the call

tostringoptional

To number of the call

statusstring · enumoptional

Options: accepted, completed, ongoing, paused, available, absent, failed

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/recordings' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "source": "call",
      "sourceId": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "accepted",
      "direction": "incoming",
      "originator": {
        "contact": {
          "id": "text",
          "identifierKey": "text",
          "identifierValue": "text"
        },
        "number": {
          "type": "pstn",
          "number": "text",
          "anonymous": true,
          "callerIdName": "text",
          "identity": "text",
          "countryIsoCode": "text"
        }
      },
      "receiver": {
        "contact": {
          "id": "text",
          "identifierKey": "text",
          "identifierValue": "text"
        },
        "number": {
          "type": "pstn",
          "number": "text",
          "anonymous": true,
          "callerIdName": "text",
          "identity": "text",
          "countryIsoCode": "text"
        }
      },
      "origin": "call-command-record",
      "duration": 1,
      "stereo": true,
      "format": "text",
      "transcription": true,
      "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
      "url": "text",
      "roomInfoUrl": "text",
      "createdAt": "2025-03-28T18:38:30.576Z",
      "updatedAt": "2025-03-28T18:38:30.576Z",
      "endedAt": "2025-03-28T18:38:30.576Z",
      "startedAt": "2025-03-28T18:38:30.576Z"
    }
  ],
  "nextPageToken": "text"
}

OK

Request

curl "/workspaces/{workpaceId}/recordings" \
     -H 'Authorization: Bearer {Token}'

Response

{
  "results": [
    {
      "id": "5b74ee9e-9d45-473a-82cd-f1f7feea6bbd",
      "sourceId": "50fa2203-66c2-4820-864a-1a8002952f4e",
      "channelId": "880d8171-cbab-47bb-81b6-b1a0902da136",
      "originator": {
        "number": {
          "type": "pstn",
          "number": "3197004499436",
          "identity": "[phone]",
          "countryIsoCode": "NL"
        }
      },
      "receiver": {
        "contact": {
          "id": "225dcb7c-efbd-4288-b78d-93fba8743dd0",
          "identifierKey": "phonenumber",
          "identifierValue": "[phone]"
        },
        "number": {
          "type": "pstn",
          "number": "351919150029",
          "countryIsoCode": "PT"
        }
      },
      "source": "call",
      "direction": "outgoing",
      "origin": "create-call",
      "status": "available",
      "duration": 29,
      "format": "mp3",
      "stereo": false,
      "transcription": false,
      "url": "https://regional--voice-recordings--637323691990--euw1.s3.eu-west-1.amazonaws.com/workspaceID%3A8bc02f53-87ac-48d2-b4fd-c2cf856a305f/sourceID%3A50fa2203-66c2-4820-864a-1a8002952f4e/5b74ee9e-9d45-473a-82cd-f1f7feea6bbd.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZIY3TY7LJ5FTXZNH%2F20231024%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20231024T192759Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECMaCWV1LXdlc3QtMSJHMEUCICn7aCxvGiqRhraKX%2BYMxuXotSVXNhaYWL9QLFZObgzEAiEAs9JvMn%2FmD89hj0GMqMEIvyWtXAS%2FZ3N2SMqeG8n1vpsq7QMITBABGgw2MzczMjM2OTE5OTAiDPTgnFfpK8sIuKNDhirKA7W3WYuW2lc100QOlZwHqjabQMRTUym7FSUg6P7pICk1%2FjWS%2FzIJSQuzcke%2BfsEJZoHcoC7UAN8gW5SnfWZcMTq%2FeSpeAR8XWzW7fbF41gc8EeAJ6Jon0yFasS931L9n0jSSDrXcxvj4qHkLfbvTL5xfmxFqsZ86LyNRv1Jz2M7UCTiWRbZidA31Bpnr%2FRpArDd2jH7iPqsV8tnGGTqgXV7QoQT5hTmxuNCYmAc7qqWOb4xsj764eCCGRCexdmZVLHc6EpkDT2rGnmoaKaxg7QY9HVnk980pCwzAmLXGVOBOKenEf4VOve66nIiCXK%2FhWAThcPbuj8I4cCZxUc7KqmdA693RaY24F99WraNoBhEHowFKRWOrz78O2PHiz9ulDeHAQBYxKmptwqizuuNVi4dYiaB%2BErp0OvfQdu8A1W8DRwJnpbfbIP1Za1LSdH6%2FJMXy%2BfIOO%2FfE9S%2FExEHBUBXzZvOXFqKe4StxpUSq3y%2F2tNeQmisFo9fRBMF0FMJI8ovM94bFjlcTOYm6JwXoy%2BHq0ULuaEVhF5M3yBUV63zzungZBH%2BxAXwBHDY2qQUNmMHP7uhq%2BRmKuk9ijkKK2D7FqlbfPK7y0svsMNmg4KkGOqUBEookm2SQ2xZr3XEMrLeNVGQISomhQXcVn2oVS2F4Q8U3L%2FeO5fEwYus%2BYaNiZUbY2jG31qHoYLT%2BvonZSUfLZrilgPbKQvh2SXdtZFKDo%2BHdwYXt%2FZIomNXUXMZz1QflKHLSkzGwaCH7Ex9ECxPDgPjVqA25uPPsmlsti7qzlXvymHRFNvRn1fu%2F207PUCmro4ejXmjVPdMXr5FBsRChI2sZli8z&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=9a32932db1a464460cb29efb55347b0725b0f73ca7303eb6fd194ddd32a5f0e4",
      "createdAt": "2023-10-23T15:55:08.234Z",
      "updatedAt": "2023-10-23T15:55:38.278Z",
      "startedAt": "2023-10-23T15:55:08.121Z",
      "endedAt": "2023-10-23T15:55:38.101Z"
    }
  ]
}