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
    • Metrics
    • Events
    • Recipient Validation
    • SMTP API
  • 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. Voice Calls API

List calls from a channel

Last updated 9 months ago

Was this helpful?

Use this request to GET a list of all incoming and outgoing calls of a specific channel. You can include additional query parameters to filter the retrieved list.

Example 1: List calls from a workspace and a channel

You might consider filtering the call based on the channel and workspace using the available query parameters.

curl "/workspaces/{workspaceId}/channels/{channelId}/calls" \
     -H 'Authorization: Bearer {Token}'
// N/A
{
  "results": [
    {
      "id": "4fc2edf7-68f5-437a-89eb-3ce0095409d6",
      "channelId": "a739d30b-8171-471c-9df4-591d4dd7bee5",
      "originator": {
        "number": {
          "type": "webrtc",
          "number": "fc0be2c4-d3a2-458b-9a98-69ff811ee306",
          "callerIdName": "fc0be2c4-d3a2-458b-9a98-69ff811ee306",
          "identity": "+3197004499437"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "351927549927",
          "countryIsoCode": "PT",
          "pstnNumberType": "mobile"
        }
      },
      "from": "client:fc0be2c4-d3a2-458b-9a98-69ff811ee306",
      "to": "351927549927",
      "direction": "incoming",
      "status": "completed",
      "type": "webrtc",
      "duration": 6,
      "hangupCauseCode": 16,
      "hangupSource": "caller",
      "sipInsights": {
        "hangupSipCode": "200",
        "userAgent": "MessageBird webRTC 1.0"
      },
      "qualityInsights": {
        "mos": "4.47",
        "pdd": "1.23"
      },
      "createdAt": "2023-10-26T15:26:46.543Z",
      "updatedAt": "2023-10-26T15:26:53.779Z",
      "ringingAt": "2023-10-26T15:26:47.77Z",
      "answeredAt": "2023-10-26T15:26:47.77Z",
      "endedAt": "2023-10-26T15:26:53.62Z"
    },
    {
      "id": "85d18e36-a741-46eb-baa7-525e576abbc8",
      "channelId": "a739d30b-8171-471c-9df4-591d4dd7bee5",
      "originator": {
        "number": {
          "type": "pstn",
          "number": "3197004499437",
          "identity": "+3197004499437",
          "countryIsoCode": "NL",
          "pstnNumberType": "mobile"
        }
      },
      "receiver": {
        "contact": {
          "id": "79598230-266d-476a-b9ec-7933e006ded6",
          "identifierKey": "phonenumber",
          "identifierValue": "+351927549927"
        },
        "number": {
          "type": "pstn",
          "number": "351927549927",
          "countryIsoCode": "PT",
          "pstnNumberType": "mobile"
        }
      },
      "from": "3197004499437",
      "to": "351927549927",
      "parentId": "41bd96c0-1fbc-4ef7-b7bf-7571015b0380",
      "direction": "outgoing",
      "status": "completed",
      "type": "pstn",
      "duration": 7,
      "hangupCauseCode": 16,
      "hangupSource": "callee",
      "sipInsights": {
        "hangupSipCode": "200"
      },
      "qualityInsights": {
        "mos": "4.50",
        "pdd": "3.37"
      },
      "createdAt": "2023-10-26T14:55:46.214Z",
      "updatedAt": "2023-10-26T14:56:00.181Z",
      "ringingAt": "2023-10-26T14:55:49.582Z",
      "answeredAt": "2023-10-26T14:55:52.679Z",
      "endedAt": "2023-10-26T14:55:59.929Z"
    }
  ]
}

Example 2: List calls from a workspace and a channel filtered by startAt and endAt

curl "GET /workspaces/{workspaceId}/channels/{channelId}/calls?startAt=2024-02-28T16%3A54%3A33.241Z&endAt=2024-03-01T16%3A54%3A33.241Z" \
    -H 'Authorization: Bearer {Token}'
// N/A
{
  "nextPageToken": "WzE3MDkzMTA5MDgyNjksIjcxMTgwYjNlLWI1MDktNDRiNS1iN2IzLTIyNjQwNTI1ZTU4MCJd",
  "results": [
    {
      "id": "861bb6cf-3edd-4ed2-837a-5cdf7b88a59c",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 19,
      "hangupSource": "none",
      "sipInsights": {
        "hangupSipCode": "480"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "9.32"
      },
      "createdAt": "2024-03-01T16:48:48.873Z",
      "updatedAt": "2024-03-01T16:49:48.254Z",
      "ringingAt": "2024-03-01T16:48:58.194Z",
      "answeredAt": "2024-03-01T16:48:58.191Z",
      "endedAt": "2024-03-01T16:49:48.082Z"
    },
    {
      "id": "59b7f69f-f871-4166-9f33-fdf28886c268",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 16,
      "hangupSource": "none",
      "sipInsights": {
        "hangupSipCode": "487"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "0.00"
      },
      "createdAt": "2024-03-01T16:48:08.17Z",
      "updatedAt": "2024-03-01T16:48:11.209Z",
      "endedAt": "2024-03-01T16:48:11.059Z"
    },
    {
      "id": "a78dd93c-08fb-450b-8651-0def9cf77cf9",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "completed",
      "type": "pstn",
      "duration": 6,
      "hangupCauseCode": 16,
      "hangupSource": "api",
      "callFlow": {
        "id": "c4b84cee-66bb-4f1f-b43c-4b63be02ef84",
        "commands": [
          {
            "id": "2c27c266-856d-4ae2-abfe-19a3388bdfaf",
            "callId": "a78dd93c-08fb-450b-8651-0def9cf77cf9",
            "command": "ringing",
            "status": "accepted",
            "callFlowId": "c4b84cee-66bb-4f1f-b43c-4b63be02ef84"
          },
          {
            "id": "f39efa8f-5c8e-40f1-99a2-9b3eab040734",
            "callId": "a78dd93c-08fb-450b-8651-0def9cf77cf9",
            "command": "pause",
            "status": "accepted",
            "callFlowId": "c4b84cee-66bb-4f1f-b43c-4b63be02ef84"
          },
          {
            "id": "1d093dc0-3646-49d5-9125-939da797961a",
            "callId": "a78dd93c-08fb-450b-8651-0def9cf77cf9",
            "command": "answer",
            "status": "accepted",
            "callFlowId": "c4b84cee-66bb-4f1f-b43c-4b63be02ef84"
          },
          {
            "id": "57f960c6-455f-4884-b4de-fc017c0f1be3",
            "callId": "a78dd93c-08fb-450b-8651-0def9cf77cf9",
            "command": "say",
            "status": "accepted",
            "callFlowId": "c4b84cee-66bb-4f1f-b43c-4b63be02ef84"
          },
          {
            "id": "cf8a8557-f3ba-41a5-a21f-2543f7268380",
            "callId": "a78dd93c-08fb-450b-8651-0def9cf77cf9",
            "command": "hangup",
            "status": "accepted",
            "callFlowId": "c4b84cee-66bb-4f1f-b43c-4b63be02ef84"
          }
        ]
      },
      "sipInsights": {
        "hangupSipCode": "200",
        "edgeRegion": "eu-west-1",
        "providerName": "Test-MB-VPN"
      },
      "qualityInsights": {
        "mos": "4.50",
        "pdd": "11.22"
      },
      "createdAt": "2024-03-01T16:46:50.158Z",
      "updatedAt": "2024-03-01T16:47:10.193Z",
      "ringingAt": "2024-03-01T16:47:01.374Z",
      "answeredAt": "2024-03-01T16:47:03.791Z",
      "endedAt": "2024-03-01T16:47:10.028Z"
    },
    {
      "id": "4d02b72b-8a16-42ae-9b3d-6d4d78941240",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "completed",
      "type": "pstn",
      "duration": 7,
      "hangupCauseCode": 16,
      "hangupSource": "api",
      "callFlow": {
        "id": "bf3458bc-8c36-4635-b2ce-c4e2f215d7e9",
        "commands": [
          {
            "id": "f156256a-a02b-4583-911c-79ee4d195c51",
            "callId": "4d02b72b-8a16-42ae-9b3d-6d4d78941240",
            "command": "ringing",
            "status": "accepted",
            "callFlowId": "bf3458bc-8c36-4635-b2ce-c4e2f215d7e9"
          },
          {
            "id": "a35508dc-0d19-4e72-841e-687f00162400",
            "callId": "4d02b72b-8a16-42ae-9b3d-6d4d78941240",
            "command": "answer",
            "status": "accepted",
            "callFlowId": "bf3458bc-8c36-4635-b2ce-c4e2f215d7e9"
          },
          {
            "id": "cfdf1e4e-f0f3-4eaf-9414-c98c50a54ec7",
            "callId": "4d02b72b-8a16-42ae-9b3d-6d4d78941240",
            "command": "say",
            "status": "accepted",
            "callFlowId": "bf3458bc-8c36-4635-b2ce-c4e2f215d7e9"
          },
          {
            "id": "e12accfd-1b2b-40de-9899-a9a75f4678b4",
            "callId": "4d02b72b-8a16-42ae-9b3d-6d4d78941240",
            "command": "hangup",
            "status": "accepted",
            "callFlowId": "bf3458bc-8c36-4635-b2ce-c4e2f215d7e9"
          }
        ]
      },
      "sipInsights": {
        "hangupSipCode": "200",
        "edgeRegion": "eu-west-1",
        "providerName": "Test-MB-VPN"
      },
      "qualityInsights": {
        "mos": "4.50",
        "pdd": "22.20"
      },
      "createdAt": "2024-03-01T16:44:05.639Z",
      "updatedAt": "2024-03-01T16:44:34.396Z",
      "ringingAt": "2024-03-01T16:44:27.843Z",
      "answeredAt": "2024-03-01T16:44:28.021Z",
      "endedAt": "2024-03-01T16:44:34.249Z"
    },
    {
      "id": "c78fb160-5ed0-473c-8dce-0c72e3a9d3e0",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 19,
      "hangupSource": "none",
      "callFlow": {
        "id": "89d22003-4276-4a67-a9f6-102da61e44c9",
        "commands": [
          {
            "id": "0f8026e6-534b-4477-a075-1d84b8ab0f3b",
            "callId": "c78fb160-5ed0-473c-8dce-0c72e3a9d3e0",
            "command": "ringing",
            "status": "accepted",
            "callFlowId": "89d22003-4276-4a67-a9f6-102da61e44c9"
          },
          {
            "id": "855ded01-4d32-423d-b105-0e005f620b64",
            "callId": "c78fb160-5ed0-473c-8dce-0c72e3a9d3e0",
            "command": "answer",
            "status": "accepted",
            "callFlowId": "89d22003-4276-4a67-a9f6-102da61e44c9"
          }
        ]
      },
      "sipInsights": {
        "hangupSipCode": "480"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "52.14"
      },
      "createdAt": "2024-03-01T16:42:43.258Z",
      "updatedAt": "2024-03-01T16:43:43.235Z",
      "ringingAt": "2024-03-01T16:43:35.395Z",
      "answeredAt": "2024-03-01T16:43:35.613Z",
      "endedAt": "2024-03-01T16:43:43.068Z"
    },
    {
      "id": "3b491da7-9fa2-4b38-9696-06ce8c79ffe6",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 19,
      "hangupSource": "none",
      "callFlow": {
        "id": "a4f34275-d69f-4ca4-8e86-6e2e50079e26",
        "commands": [
          {
            "id": "2dd2fad3-a849-494c-b4e9-0abf08f3aa57",
            "callId": "3b491da7-9fa2-4b38-9696-06ce8c79ffe6",
            "command": "say",
            "status": "accepted",
            "callFlowId": "a4f34275-d69f-4ca4-8e86-6e2e50079e26"
          }
        ]
      },
      "sipInsights": {
        "hangupSipCode": "480"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "6.89"
      },
      "createdAt": "2024-03-01T16:41:39.355Z",
      "updatedAt": "2024-03-01T16:42:39.26Z",
      "ringingAt": "2024-03-01T16:41:46.247Z",
      "endedAt": "2024-03-01T16:42:39.076Z"
    },
    {
      "id": "28fb6fd6-adde-4d75-81eb-2bf2afa66000",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 19,
      "hangupSource": "none",
      "sipInsights": {
        "hangupSipCode": "480"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "0.00"
      },
      "createdAt": "2024-03-01T16:40:27.226Z",
      "updatedAt": "2024-03-01T16:41:27.3Z",
      "endedAt": "2024-03-01T16:41:27.11Z"
    },
    {
      "id": "3262d64e-304a-4771-b3b8-91e895dd02ac",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 19,
      "hangupSource": "none",
      "sipInsights": {
        "hangupSipCode": "480"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "0.00"
      },
      "createdAt": "2024-03-01T16:38:31.357Z",
      "updatedAt": "2024-03-01T16:39:31.258Z",
      "endedAt": "2024-03-01T16:39:31.077Z"
    },
    {
      "id": "6cd8342b-66e6-4358-88f7-b626e29c9365",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 19,
      "hangupSource": "none",
      "sipInsights": {
        "hangupSipCode": "480"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "0.00"
      },
      "createdAt": "2024-03-01T16:36:49.102Z",
      "updatedAt": "2024-03-01T16:37:48.292Z",
      "endedAt": "2024-03-01T16:37:48.081Z"
    },
    {
      "id": "71180b3e-b509-44b5-b7b3-22640525e580",
      "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
      "originator": {
        "contact": {
          "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0",
          "identifierKey": "phonenumber",
          "identifierValue": "+351910648518"
        },
        "number": {
          "type": "pstn",
          "number": "+351910648518",
          "callerIdName": "Jose G",
          "countryIsoCode": "PT"
        }
      },
      "receiver": {
        "number": {
          "type": "pstn",
          "number": "+3197058016589",
          "countryIsoCode": "NL"
        }
      },
      "from": "+351910648518",
      "to": "+3197058016589",
      "direction": "incoming",
      "status": "no-answer",
      "type": "pstn",
      "duration": 0,
      "hangupCauseCode": 19,
      "hangupSource": "none",
      "sipInsights": {
        "hangupSipCode": "480"
      },
      "qualityInsights": {
        "mos": "0.00",
        "pdd": "0.00"
      },
      "createdAt": "2024-03-01T16:35:08.269Z",
      "updatedAt": "2024-03-01T16:36:08.292Z",
      "endedAt": "2024-03-01T16:36:08.084Z"
    }
  ]
}

Get calls from a channel

get

Get a list of calls from a channel

Authorizations
Path parameters
workspaceIdstring · uuidRequired

The ID of the workspace

channelIdstring · uuidRequired

The ID for a channel

Query parameters
limitinteger · min: 1 · max: 1000Optional

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

startAtstring · date-timeOptional

Start date for the query

endAtstring · date-timeOptional

End date for the query

statusstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
tostring · min: 1 · max: 100Optional
fromstring · min: 1 · max: 100Optional
durationintegerOptional
directionstring · enumOptionalPossible values:
idstring · uuidOptional

The ID for a call

tagstring[]Optional

Filter based on tag

Responses
200
OK
application/json
Responseall of
404
The request did not pass validation
application/json
422
The request did not pass validation
application/json
get
GET /workspaces/{workspaceId}/channels/{channelId}/calls HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "from": "text",
      "to": "text",
      "originator": {
        "contact": {
          "id": "text",
          "identifierKey": "text",
          "identifierValue": "text"
        },
        "number": {
          "type": "pstn",
          "number": "text",
          "anonymous": true,
          "callerIdName": "text",
          "identity": "text",
          "countryIsoCode": "text",
          "pstnNumberType": "text"
        }
      },
      "receiver": {
        "contact": {
          "id": "text",
          "identifierKey": "text",
          "identifierValue": "text"
        },
        "number": {
          "type": "pstn",
          "number": "text",
          "anonymous": true,
          "callerIdName": "text",
          "identity": "text",
          "countryIsoCode": "text",
          "pstnNumberType": "text"
        }
      },
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "direction": "incoming",
      "status": "accepted",
      "reason": "text",
      "type": "pstn",
      "duration": 1,
      "hangupCauseCode": 1,
      "hangupSource": "callee",
      "hangupSipCode": "text",
      "createdAt": "2025-05-29T09:29:21.011Z",
      "updatedAt": "2025-05-29T09:29:21.011Z",
      "ringingAt": "2025-05-29T09:29:21.011Z",
      "answeredAt": "2025-05-29T09:29:21.011Z",
      "endedAt": "2025-05-29T09:29:21.011Z",
      "scheduledFor": "2025-05-29T09:29:21.011Z",
      "callFlow": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "commands": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "callId": "123e4567-e89b-12d3-a456-426614174000",
            "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
            "status": "text",
            "command": "text",
            "conditions": [
              {
                "variable": "keys",
                "operator": "eq",
                "value": "text"
              }
            ]
          }
        ]
      },
      "notification": {
        "url": "text"
      },
      "qualityInsights": {
        "mos": "text",
        "pdd": "text"
      },
      "sipInsights": {
        "hangupSipCode": "text",
        "edgeRegion": "text",
        "providerName": "text",
        "userAgent": "text",
        "remoteSignallingIp": "text",
        "remoteMediaIp": "text"
      },
      "amdResult": {
        "result": "human",
        "speech": "text",
        "locale": "text"
      },
      "sipType": "elastic",
      "tags": [
        "text"
      ]
    }
  ],
  "nextPageToken": "text"
}
  • GETGet calls from a channel
  • Example 1: List calls from a workspace and a channel
  • Example 2: List calls from a workspace and a channel filtered by startAt and endAt