Get a call

GET a call details from a specific voice channel.

Get channel call

get

Get a channel call

Authorizations

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

application/json

404

The request did not pass validation

application/json

get

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

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": "2025-12-08T10:03:37.446Z",
  "updatedAt": "2025-12-08T10:03:37.446Z",
  "ringingAt": "2025-12-08T10:03:37.446Z",
  "answeredAt": "2025-12-08T10:03:37.446Z",
  "endedAt": "2025-12-08T10:03:37.446Z",
  "scheduledFor": "2025-12-08T10:03:37.446Z",
  "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

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

{
  "id": "6b6f6675-2992-4959-b875-66001e442423",
  "channelId": "7c8f344a-4fc1-40b7-99a0-91a57b3ef365",
  "originator": {
    "contact": {
      "id": "408ce24d-25b3-47b7-b273-05ff96d6d5ad",
      "identifierKey": "phonenumber",
      "identifierValue": "+351211123123"
    },
    "number": {
      "type": "pstn",
      "number": "+351211123123",
      "callerIdName": "PRD",
      "countryIsoCode": "PT"
    }
  },
  "receiver": {
    "number": {
      "type": "pstn",
      "number": "+3197004499437",
      "countryIsoCode": "NL"
    }
  },
  "from": "+351211123123",
  "to": "+3197004499437",
  "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-02-28T16:54:33.241Z",
  "updatedAt": "2024-02-28T16:54:34.465Z",
  "endedAt": "2024-02-28T16:54:33.264Z"
}

Last updated 4 months ago

Was this helpful?

{ "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-12-08T10:03:37.446Z", "updatedAt": "2025-12-08T10:03:37.446Z", "ringingAt": "2025-12-08T10:03:37.446Z", "answeredAt": "2025-12-08T10:03:37.446Z", "endedAt": "2025-12-08T10:03:37.446Z", "scheduledFor": "2025-12-08T10:03:37.446Z", "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" ] }