Get a Recording

In order to retrieve a recording metadata, you can use the following endpoint.

GET

/workspaces/{workspaceId}/recordings/{recordingId}

Get recording

Payload della risposta

string

obbligatorio

The ID for the recording.

source

string

obbligatorio

Possible values: call, conference

sourceId

string

obbligatorio

The ID for the source.

channelId

string

The ID for the channel.

status

string

obbligatorio

Possible values: accepted, completed, ongoing, paused, available, absent, failed

direction

string

Possible values: incoming, outgoing

originator

object

Mostra attributi secondari

originator.contact

object

Mostra attributi secondari

originator.contact.id

string

obbligatorio

originator.contact.identifierKey

string

obbligatorio

originator.contact.identifierValue

string

obbligatorio

originator.number

object

obbligatorio

Mostra attributi secondari

originator.number.type

string

obbligatorio

Possible values: pstn, webrtc

originator.number.number

string

obbligatorio

originator.number.anonymous

boolean

originator.number.callerIdName

string

originator.number.identity

string

originator.number.countryIsoCode

string

receiver

object

Mostra attributi secondari

receiver.contact

object

Mostra attributi secondari

receiver.contact.id

string

obbligatorio

receiver.contact.identifierKey

string

obbligatorio

receiver.contact.identifierValue

string

obbligatorio

receiver.number

object

obbligatorio

Mostra attributi secondari

receiver.number.type

string

obbligatorio

Possible values: pstn, webrtc

receiver.number.number

string

obbligatorio

receiver.number.anonymous

boolean

receiver.number.callerIdName

string

receiver.number.identity

string

receiver.number.countryIsoCode

string

origin

string

obbligatorio

Possible values: call-command-record, call-command-record-call, create-call, bridge-call

duration

integer

stereo

boolean

obbligatorio

format

string

obbligatorio

transcription

boolean

obbligatorio

conferenceId

string

The ID for the conference.

url

string

roomInfoUrl

string

createdAt

string

obbligatorio

updatedAt

string

obbligatorio

endedAt

string

startedAt

string

Esempio di codice

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/recordings/{recordingId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Esempio di codice

curl "/workspaces/{workspaceId}/recordings/{recordingId}" \
     -H 'Authorization: AccessKey YOUR_SECRET_TOKEN'

Esempio di codice

{
  "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": "+3197004499436",
      "countryIsoCode": "NL"
    }
  },
  "receiver": {
    "contact": {
      "id": "225dcb7c-efbd-4288-b78d-93fba8743dd0",
      "identifierKey": "phonenumber",
      "identifierValue": "+351919150029"
    },
    "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=ASIAZIY3TY7LBTBZCS45%2F20231024%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20231024T173426Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEBwaCWV1LXdlc3QtMSJHMEUCIBch4MlGQu3ErdIzwknxkM0z23Clo79heSynPWNzU7jeAiEA%2F9fuYlS5yImmZ%2FN53KEmG2dEENZFbPfoNkrdPj%2BExHMq7QMIRRABGgw2MzczMjM2OTE5OTAiDCSO0vsLR5UJ%2BOYdrirKAzCu4U7saMI%2FVJDauiWwesWmbhSYCt1LdcULqH4AqrKk1I700LcFzBTQ1HPjfbLDyM169KlHgY%2Fdw51lvvRt7vqynvho2Vwk6CQoNYNk2%2FORr07phUNtKZgxi%2FbD5cgvRz2upRixYdqST7CoDdN1QsSEz43jS9ka5vGHKZV3OvBXmCKElk9QU5557xIppybAbcQ6sCXssfEkcKsLpKaiLN8nN%2FRGJ6kyWriih41NaoNRv6ykPiqpQJtAIvEtRx19iY98vj%2Bg06TMKuzBXp%2FcLXI3KlUpVTBZRYetCNC7Kf5lpg2amyK9FNW14OPc9hArFkG%2F%2Fah7bj0KJJaink3Lu1m2A61DhkiQeqnUeY5tGTgh4vdEZT20%2BiNwMWI7UGErcesbcqQJnCm3oTwbbalsOIDfiPcYt1dKvjW0FJeclFY935sAIJiARlcCud%2BcNf96LtUc%2Bp3cMI1jTzbXec4YK%2BXMjYUczTpQ%2F%2BvHEeNdJkv9af%2B3hwMineFvtcW3e3r7dfmFYD5moZh91Ykj2N35RQ7Vvyvnb%2B4tax43j%2BUpOjth9sMZHo3bjgGpkYVc1mBOGtrSrQPANyQXKCIIS6YIOvFegGCeCU5ntkFnMJLe3qkGOqUBJRIHI%2BL5lnQl6U0i1YtFD9GI8B9O6M%2FLfdOkZLG7FWX0cpCoQtDVCKxQya5tQclGr5DasMadT5CWRQQTxgiCkQNxZLV%2FsnUVxPuVW%2Bxw9%2BnPZ%2BKzkSJ3zacSVhby2AUeZCMc5AkboJX0a4%2FnJ5%2FhULZtruZF0cwGHl69nCLTT1OLrj3%2FarCgYkyaRZyjlaz4zNulyBGqy%2BPkDP8xVKRPEGotlBHf&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=1fd89ce8b8efee07c416da2e1678009562829440229bae2e4dbf00bdc26a7c5d",
  "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"
}

In order to directly retrieve the recording media, you must add the extension .mp3 to the above request.

Esempio di codice

/workspaces/{workspaceId}/recordings/{recordingId}.mp3

If successful, the above request will return a "307 Temporary Redirect” with the recording file.