Get calls log

Get calls from a workspace

Get a list of calls from a given workspace ID

GET/workspaces/{workspaceId}/channels/calls

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

Query parameters

Response

200404422

OK

Body

application/json

resultsarray of ChannelCall

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

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

Response

200404422

{
  "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": 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",
      "duration": 0,
      "hangupCauseCode": 0,
      "hangupSource": "callee",
      "hangupSipCode": "text",
      "createdAt": "2024-12-21T12:14:40.413Z",
      "updatedAt": "2024-12-21T12:14:40.413Z",
      "ringingAt": "2024-12-21T12:14:40.413Z",
      "answeredAt": "2024-12-21T12:14:40.413Z",
      "endedAt": "2024-12-21T12:14:40.413Z",
      "scheduledFor": "2024-12-21T12:14:40.413Z",
      "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"
      },
      "amdResult": {
        "result": "human",
        "speech": "text",
        "locale": "text"
      }
    }
  ],
  "nextPageToken": "text"
}