LogoLogo
No-code docsResources
  • 🖥️Welcome to the Bird API Docs
  • API Access
    • Access Policies
    • Access Roles
    • API Authorization
    • Common API usage
  • Conversations API
    • API reference
      • Channel configuration
        • Get conversations configuration
        • Update conversations configuration
      • Conversations messaging
        • Create conversation message
        • List conversation messages
        • Get conversation message
        • Update conversation message
        • Delete conversation message
        • Create pre-signed upload
      • Conversations management
        • Create conversation
        • List conversations
        • Get conversation
        • Update conversation
        • Delete conversation
      • Conversation Participants
        • Add participant to conversation
        • List participants
        • Get participant by ID
        • Get participant by identifier key and value
        • Update participant by ID
        • Update participant by identifier key and value
        • Delete participant
        • List participant conversations by ID
        • List participant conversations by identifier key and value
      • Workspace settings
        • Get antispam setting
        • Update antispam setting
        • Create allow/block rule
        • Get allow/block rule
        • List allow/block rules
        • Update allow/block rule
        • Delete allow/block rule
        • Add allow/block rules in bulk
        • Get allow/block bulk upload status
      • Events
  • Collaborations API
    • API reference
      • Agent Management
      • Team Management
      • Feeds
      • Feed item activity
      • Tags
      • Automation Rules
      • Business Hours
      • Capacity Rules
      • Routing Queues
      • Skills
      • SLA Policies
      • Macros
      • Sender Profiles
      • Ticket fields
  • Channels API
    • Supported channels
      • Programmable WhatsApp
        • Sending WhatsApp messages
        • Customer service window
        • Receiving messages
        • Message interactions
        • WhatsApp ISV integration
          • Setting up your customer workspaces
            • API Access
            • Associating your Facebook solution ID and business ID with your Bird CRM Organization
            • Creating a workspace for your customer
            • Buying a number through Bird
            • Subscribing to channel created webhooks
          • WhatsApp channel onboarding
            • Setting up the WhatsApp Embedded flow
            • Install WhatsApp phone number in Bird CRM
            • Subscribe to channel webhooks
      • Programmable SMS
        • Installing an SMS channel
          • US 10DLC API Installation
          • Toll-Free Numbers Verification API
        • Sending SMS messages
        • Receiving messages
        • Twilio Exit API
          • Using Twilio PHP SDK
          • Using Twilio Go SDK
          • Using Twilio Ruby SDK
        • Sinch Exit API
      • Programmable RCS
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Email
        • Sending Emails
        • Receiving messages
        • Message status
        • Message interactions
      • Programmable Line
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Telegram
        • Sending messages
        • Receiving messages
        • Message interactions
    • Message types
      • Text
      • Images
      • Files
      • List
      • Carousel
      • Template
    • Message status and interactions
      • Message Failure Codes
      • Message Failure Sources
        • SMS Platform Extended Error Codes
    • Send batch messages
    • API reference
      • Channel Groups
      • Messaging
      • Channels management
      • Channel connectors
      • Navigators
      • Compliance Keywords Messages
      • Conversions Sharing
      • Events
    • Rate Limit
  • Voice API
    • Installing a Voice channel
    • Voice Calls API
      • Initiate an outbound call
      • List calls from a channel
      • Get a call
      • Update a call
      • Answer a call
      • Ring a call
      • Hangup a call
      • Play a message in a call
      • Say Text-To-Speech (TTS)
      • Gather DTMF from a call
      • Forward a call
      • Record a Call
      • Record a call session
      • Update a call recording
      • List call recordings of a call
      • Get a call recording
      • Get a call insights
      • Get calls log
    • Recordings API
      • List Recordings
      • Get a Recording
      • Delete a Recording
      • List recording storage metrics
    • Transcriptions API
      • Initiate a Transcription
      • List Transcriptions
      • Get a Transcription
      • Delete a Transcription
    • Voice webhooks
    • Flash Calling API
  • Verify API
    • Verify API: Quick Start
  • Contacts API
    • Tracking Contact Events
      • API Reference
        • Get configuration
        • Track events
    • API reference
      • Manage workspace contacts
        • Create a contact
        • Get a contact
        • List contacts
        • Search contact by identifier
        • Update a contact
        • Create or update a contact by identifier
        • Delete a contact
      • Manage contact identifiers
        • Create contact identifier
        • List contact identifiers
        • Delete contact identifier
      • Manage contact attribute definition
        • Create attribute definition
        • Get attribute definition
        • List attribute definitions
      • Manage contact lists
        • Create a list
        • Get a list
        • List lists
        • Update a list
        • Delete a list
        • Add contacts to a list
        • Get contact list memberships
        • List contacts in a list
        • Remove contacts from a list
      • Lookup
        • Network/Country information for a phone number
  • Numbers API
    • API reference
      • Search Available Numbers
      • Buy a Number
      • List your Numbers
      • Get Long Code Number Details
      • Manage Endpoint Subscriptions
        • Cancel Number Subscription
      • Manage Endpoint Compliance Requirements
        • List Workspace compliace Requirements
        • Get Workspace Compliace Requirements
        • Update Workspace Compliace Requirements
      • 10DLC Compliance
        • Brands - Organization
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
        • Brands - workspace
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
          • List brand vettings
        • Campaigns
          • Optional: acting as Reseller
          • Create a campaign
          • List all campaigns
          • Get a campaign
          • Update a campaign
          • Delete a campaign
        • TCR Enums
        • Events
      • Toll-Free Numbers Verification API
      • Long Code Numbers
      • Short Code Numbers
      • Alphanumeric Senders
      • Events
  • Know-Your-Customer (KYC) API
    • List KYC forms
    • Get KYC form
    • Create KYC form entry
    • Update KYC form entry
    • List KYC form entries
    • Get a KYC form entry details
  • Reporting API
    • API reference
      • Channel Metrics
      • Flow Run Metrics
      • Wallet Metrics
      • Campaign Metrics
      • Message Metrics
  • Accounts API
    • API reference
      • Current user
        • Change password
        • Presigned upload
        • Memberships
        • Sessions
        • Configurations
          • Groups
            • Keys
      • IAM policies
      • Organizations
        • Upload media
        • Profile
        • Workspaces
        • Users
        • Access keys
        • Organization roles
        • Organization policies
        • Teams
          • Members
        • Approvals
          • Runs
            • Reviews
        • Configurations
          • Groups
            • Keys
      • Region groups
  • Touchpoints API
    • Supported Projects
      • Whatsapp Approved Message Templates
        • Creating WhatsApp Message templates
          • Text template blocks
          • Blocks Documentation
    • API reference
      • Projects
      • Message Templates
  • Notifications API
    • API Reference
      • Webhook subscriptions
        • Create a webhook subscription
        • List available webhook events
        • Get a webhook subscription
        • List webhook subscriptions
        • Update a webhook subscription
        • Delete a webhook subscription
        • Verifying a webhook subscription
        • Webhook subscription logs
  • Knowledge Base (KB) API
    • API reference
      • Documents
      • Folders
        • Import
      • Search
      • Presigned upload
  • Email API
    • Transmissions
  • Connectivity platform migration guide
    • Channels API and Conversations API
    • Migrating conversations API actions
    • Migrating WhatsApp channels
  • Client SDKs
    • Applications
    • Contact Profiles
      • Signed Identity
    • Push notifications
      • Quick Start
      • Subscribe contacts to push notification campaigns
      • Notification Display Priority
    • Event Tracking
      • Quick Start
      • Track Events
        • App
        • Audiences
        • Conference
        • Ecommerce
        • Hospitality
        • Lists
        • Messaging
        • Payments
        • Subscription
        • Suppressions
        • Survey
        • Web
    • App Inbox
      • Quick Start
      • Usage
      • Subscribe contacts to app inbox campaigns
    • SDK Integration
      • Android SDK
        • Notification Interactions
      • Swift SDK
        • Notification Interactions
      • Web SDK
        • Quick Start
        • Usage
        • API Reference
          • IdentityManager
          • BirdSdkApi
          • BirdTracker
            • Ecommerce
            • Conference
            • Messaging
            • Suppressions
            • Subscription
            • Survey
            • Web
            • Audiences
        • Web Push Notifications
          • Notification Interactions
  • Quickstarts
    • Conversations
    • Send an SMS message
    • Send an Email message
    • Send a WhatsApp message
Powered by GitBook
On this page

Was this helpful?

  1. Voice API
  2. Recordings API

List Recordings

Last updated 8 months ago

Was this helpful?

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

curl "/workspaces/{workpaceId}/recordings" \
     -H 'Authorization: Bearer {Token}'
{
  "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": "+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=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"
    }
  ]
}

List recordings

get

List recordings

Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
limitinteger · min: 1 · max: 99Optional

Limits the number of results to return

Default: 10
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

Possible values:
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 · enumOptionalPossible values:
Responses
200
OK
application/json
Responseall of
404
Not found
application/json
get
GET /workspaces/{workspaceId}/recordings HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "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-05-09T05:27:32.570Z",
      "updatedAt": "2025-05-09T05:27:32.570Z",
      "endedAt": "2025-05-09T05:27:32.570Z",
      "startedAt": "2025-05-09T05:27:32.570Z"
    }
  ],
  "nextPageToken": "text"
}