v2

latestOpenAPI 3.0.02026-07-26365590.3 KB

Calls

Get a call

Returns a single call by ID. Returns 404 if the call is in a workspace outside the API key scope.

get/v1/calls/{id}

Path parameters

idstring required

Response

The call

idstring required

Unique identifier of the call history entry

callType'CALL_SESSION' | 'DIRECT_CALL' required

Type of the call history entry (e.g., CALL_SESSION, DIRECT_CALL)

phoneNumberIdstring

Unique identifier of the phone number used for the call

userProviderSidstring

Provider SID for the user side of the call

adminProviderSidobject nullable

Provider SID for the admin side of the call

providerConferenceIdstring

Provider conference ID

statusstring required

Status of the call

typestring required

Type of call (e.g., outbound, inbound)

transferredboolean

Indicates if the call was transferred

startedAtobject nullable required

Start time of the call

endedAtobject nullable required

End time of the call

createdAtstring date-time required

Date and time when the call history entry was created

updatedAtstring date-time

Date and time when the call history entry was last updated

sequenceRunIdstring

Unique identifier of the related sequence run

sequenceIdstring

Unique identifier of the parent sequence

syncedWithCrmDateobject nullable

Date and time when the call was synced with CRM

deletedAtstring date-time nullable

Date and time when the call history entry was deleted

organizationIdstring

Unique identifier of the organization

organizationMembershipIdstring

Unique identifier of the organization membership

managedPhoneNumberIdstring

Unique identifier of the managed phone number

notesstring

Notes associated with the call

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callType": "CALL_SESSION",
  "phoneNumberId": "123e4567-e89b-12d3-a456-426614174002",
  "userProviderSid": "CA123456789",
  "providerConferenceId": "CF123456789",
  "status": "completed",
  "type": "outbound",
  "createdAt": "2024-03-20T08:55:00.000Z",
  "updatedAt": "2024-03-20T09:16:00.000Z",
  "sequenceRunId": "123e4567-e89b-12d3-a456-426614174003",
  "sequenceId": "123e4567-e89b-12d3-a456-426614174010",
  "deletedAt": "2024-03-20T09:15:00.000Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174004",
  "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174005",
  "managedPhoneNumberId": "123e4567-e89b-12d3-a456-426614174006",
  "notes": "Call notes here",
  "contact": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "John",
    "lastName": "Doe"
  },
  "phoneNumber": {
    "value": "+33612345678"
  },
  "caller": {
    "firstName": "Alice",
    "lastName": "Martin"
  },
  "callerPhoneNumber": {
    "value": "+33612345678"
  }
}