Get a call

GET a call details from a specific voice channel.

Get channel call

Get a channel call

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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

callId*string (uuid)

The ID for a call

channelId*string (uuid)

The ID for a channel

Response

200404

OK

Body

application/json

id*Id-2 (string (uuid))

channelId*ChannelId (string (uuid))

from*string

to*string

originator*ChannelCallOriginatorOrReceiver

receiver*ChannelCallOriginatorOrReceiver

parentIdId-2 (string (uuid))

direction*Direction (enum)

incomingoutgoing

status*Status-4 (enum)

acceptedstartingringingongoingcompletedno-answerbusyfailedcancelled

reasonstring

type*Type-2 (enum)

pstnsipwebrtc

durationinteger

hangupCauseCodeinteger

hangupSourcenullable HangupSource (enum)

calleecallerapitimeoutmedia-timeoutnone

hangupSipCodestring

createdAt*string (date-time)

updatedAt*string (date-time)

ringingAtstring (date-time)

answeredAtstring (date-time)

endedAtstring (date-time)

callFlowCallFlow

notificationCallNotification

qualityInsightsqualityInsights

sipInsightssignallingInsights

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "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": false,
      "callerIdName": "text",
      "identity": "text",
      "countryIsoCode": "text",
      "pstnNumberType": "text"
    }
  },
  "receiver": {
    "contact": {
      "id": "text",
      "identifierKey": "text",
      "identifierValue": "text"
    },
    "number": {
      "type": "pstn",
      "number": "text",
      "anonymous": false,
      "callerIdName": "text",
      "identity": "text",
      "countryIsoCode": "text",
      "pstnNumberType": "text"
    }
  },
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "incoming",
  "status": "accepted",
  "reason": "text",
  "type": "pstn",
  "hangupSource": "callee",
  "hangupSipCode": "text",
  "createdAt": "2024-04-29T08:41:15.228Z",
  "updatedAt": "2024-04-29T08:41:15.228Z",
  "ringingAt": "2024-04-29T08:41:15.228Z",
  "answeredAt": "2024-04-29T08:41:15.228Z",
  "endedAt": "2024-04-29T08:41:15.228Z",
  "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"
      }
    ]
  },
  "notification": {
    "url": "text"
  },
  "qualityInsights": {
    "mos": "text",
    "pdd": "text"
  },
  "sipInsights": {
    "hangupSipCode": "text",
    "edgeRegion": "text",
    "providerName": "text",
    "userAgent": "text",
    "remoteSignallingIp": "text",
    "remoteMediaIp": "text"
  }
}

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

Request Headers

curl "https://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/channels/880d8171-cbab-47bb-81b6-b1a0902da136/calls/382ef429-78ba-416d-899e-657d39d194ea" \
     -H 'Authorization: Bearer {Token}'

Request Body

// N/A

Response

{
  "id": "6b6f6675-2992-4959-b875-66001e442423",
  "channelId": "7c8f344a-4fc1-40b7-99a0-91a57b3ef365",
  "originator": {
    "contact": {
      "id": "408ce24d-25b3-47b7-b273-05ff96d6d5ad",
      "identifierKey": "phonenumber",
      "identifierValue": "[phone]"
    },
    "number": {
      "type": "pstn",
      "number": "[phone]",
      "callerIdName": "PRD",
      "countryIsoCode": "PT"
    }
  },
  "receiver": {
    "number": {
      "type": "pstn",
      "number": "[phone]",
      "countryIsoCode": "NL"
    }
  },
  "from": "[phone]",
  "to": "[phone]",
  "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"
}