Calls

Last updated 3 months ago

The calls you are able to fetch might be filtered by your service account's permissions, and the organization you represent.

The collection you are paginating is sorted by creation datetime, descending. This means that the first page contains the most recently created calls.

GET/api/v1/calls

Authorization

Query parameters

Response

Body

edges*array of CallEdgeDto (object)

pageInfo*PageInfo (object)

Request

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

Response

{
  "edges": [
    {
      "node": {
        "uuid": "5cf67f69-34d0-46fe-b904-20d56248a844",
        "status": "requested",
        "requestedAt": "2024-10-11T20:31:50.704Z",
        "externalMetadata": {
          "applicationName": "basicall",
          "referenceId": "ref_1234567890",
          "agentReferenceId": "agent_1234567890",
          "statusCode": "completed",
          "statusDescription": "The call was completed successfully",
          "additionalProperties": {
            "foo": "bar"
          }
        },
        "attempts": [
          {
            "userUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
            "attemptAt": "2024-10-11T20:31:50.704Z",
            "createdAt": "2024-10-11T20:31:50.704Z"
          }
        ],
        "attemptsCount": 1,
        "result": {
          "resultCode": "confirmed",
          "completedAt": "2024-10-11T20:31:50.704Z",
          "notes": "text",
          "duration": 120.23,
          "donorRetentionRating": 7
        },
        "lastUpdatedAt": "2024-10-11T20:31:50.704Z",
        "cancelledAt": "2024-10-11T20:31:50.704Z",
        "completedAt": "2024-10-11T20:31:50.704Z",
        "expiredAt": "2024-10-11T20:31:50.704Z",
        "notes": "text",
        "personUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
        "relatedCaseUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
        "callingOrganizationUuid": "f5e2ba11-1786-4ba9-bd5a-0d99317f4706",
        "type": "happy_call"
      },
      "cursor": "48094b0e-15b3-430f-ab5a-16ecf12b9171"
    }
  ],
  "pageInfo": {
    "startCursor": "48094b0e-15b3-430f-ab5a-16ecf12b9171",
    "endCursor": "494d74df-6fbc-46a3-811e-1c17230340a1",
    "hasPreviousPage": true,