How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bird Voice Calls API

Call records (CDR) for the workspace, in flight and completed.

Bird Voice Calls API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include voice-calls. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

2 operations 2 paths 25 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Voice Calls API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

voice-calls 2

Call records (CDR) for the workspace, in flight and completed.

GET
/v1/voice/calls
List calls
listVoiceCalls 13 params → 200401403422429500
GET
/v1/voice/calls/{call_id}
Get a call
getVoiceCall 1 param → 200401403404422429500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are VoiceCall (21 properties), ErrorBody (11 properties), VoiceCallCost (7 properties), NextAction (5 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
VoiceCallRejectionReason
string
Why we rejected the call. Use rejectionreason to identify the cause; sipresponsecode alone cannot distinguish these reasons. You can resolve these issues: - so…
WorkspaceID
string
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
CurrencyCode
string
ISO 4217 three-letter currency code.
VoiceCallList
VoiceCall
object
21 properties 7 required
NextAction
object
5 properties 2 required
VoiceCallDirection
string
Whether the call originated from your PBX (outbound) or arrived from a remote party (inbound).
VoiceCallStatus
string
Call status. A call that has ended carries one of: - answered means it connected and the far end picked up. - noanswer means nobody picked up before the call t…
Actor
object
3 properties 2 required
VoiceCallCost
object
What was charged for a call, split into the components that make it up.
7 properties 7 required
VoiceCallInboundRouteTrunk
object
2 properties 2 required
VoiceCallID
string
VoiceCallInboundRoute
The routing choice recorded for an incoming call. A recorded route does not guarantee that the call connected. Check status for the outcome and rejectionreason…
SIPTrunkID
string
VoiceMediaQuality
object
4 properties 4 required
Error
object
1 property 1 required
VoiceCallInboundRouteReject
object
1 property 1 required
Tag
object
Structured key/value label attached to a message or a call. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID); they surf…
2 properties 2 required
VoiceInboundForwardAs
string
Which of a forwarded call's two numbers it shows as the caller. "dialednumber" is the number the caller dialled, which is one of yours. Carriers treat it as fu…
VoiceCallRouteType
string
Which answer a number carries. - reject: refuses the call. This is where every number starts. - trunk: delivers the call to one of your SIP trunks. - forward:…
VoiceCallInboundRouteForward
object
3 properties 3 required
VoiceSessionID
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-voice-calls-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Voice Calls API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.