Get a call

GET a call details from a specific voice channel.

Get channel call

get

Get a channel call

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

Responses

200

OK

application/json

idstring · uuidRequired

channelIdstring · uuidRequired

fromstringRequired

tostringRequired

parentIdstring · uuidOptional

directionstring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

reasonstringOptional

typestring · enumRequiredPossible values:

durationintegerOptional

hangupCauseCodeintegerOptional

hangupSourcestring · enum · nullableOptionalPossible values:

hangupSipCodestringOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

ringingAtstring · date-timeOptional

answeredAtstring · date-timeOptional

endedAtstring · date-timeOptional

scheduledForstring · date-timeOptional

sipTypestring · enumOptionalPossible values:

tagsstring[] · max: 10Optional

Tags to associate with the call. Tags are converted to lower case and tags that do not exist are automatically created. You can view your created tags in the UI. You can specify up to 10 tags per call.

404

The request did not pass validation

application/json

get

/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/channels/{channelId}/calls/{callId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-03-06T17:59:48.060Z",
  "updatedAt": "2026-03-06T17:59:48.060Z",
  "ringingAt": "2026-03-06T17:59:48.060Z",
  "answeredAt": "2026-03-06T17:59:48.060Z",
  "endedAt": "2026-03-06T17:59:48.060Z",
  "scheduledFor": "2026-03-06T17:59:48.060Z",
  "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"
  ]
}

Example 1: Get a call from a workspace and a channel

Request Headers

curl "/workspaces/{workspaceId}/channels/{channelId}/calls/{channelId}" \
     -H 'Authorization: AccessKey YOUR_SECRET_TOKEN'

Request Body

Response