Get calls log

Get calls from a workspace

Get a list of calls from a given workspace ID

get

/workspaces/{workspaceId}/channels/calls

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

Query parameters

limitinteger · min: 1 · max: 1000 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

startAtstring · date-time

Start date for the query

endAtstring · date-time

End date for the query

statusstring · enum

Options: accepted, starting, ringing, ongoing, completed, no-answer, busy, failed, cancelled, scheduled

typestring · enum

Options: pstn, sip, webrtc

tostring · min: 1 · max: 100

fromstring · min: 1 · max: 100

durationinteger

directionstring · enum

Options: incoming, outgoing

idstring · uuid

The ID for a call

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channels/calls' \
  --header 'Authorization: Bearer jwt'

200

404

422

200

{
  "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": 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-02-21T18:12:59.600Z",
      "updatedAt": "2025-02-21T18:12:59.600Z",
      "ringingAt": "2025-02-21T18:12:59.600Z",
      "answeredAt": "2025-02-21T18:12:59.600Z",
      "endedAt": "2025-02-21T18:12:59.600Z",
      "scheduledFor": "2025-02-21T18:12:59.600Z",
      "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": {
        "speech": "text",
        "locale": "text",
        "result": "human"
      }
    }
  ],
  "nextPageToken": "text"
}

OK