Skip to main content
GET
/
phone-calls
Retrieves phone calls within a specified date range, optionally filtered by client ID.
curl --request GET \
  --url https://api.example.com/phone-calls
[
  {
    "id": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "fromNumber": "<string>",
    "toNumber": "<string>",
    "summary": "<string>",
    "uuid": "<string>",
    "clientId": 123,
    "confidence": 123,
    "confidenceReason": "<string>",
    "satisfaction": 123,
    "satisfactionReason": "<string>",
    "purpose": "<string>",
    "dynamicVariables": "<string>",
    "connectedTo": 123,
    "conversationUuid": "<string>",
    "name": "<string>",
    "transcript": [
      {
        "id": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "by": "<string>",
        "message": "<string>",
        "phoneCallId": 123,
        "category": 0
      }
    ],
    "isUnknown": true,
    "portalId": 123
  }
]

Query Parameters

​
after
string<date-time>

The start date for filtering phone calls.

​
before
string<date-time>

The end date for filtering phone calls.

​
clientId
integer<int32>

Optional client ID to filter phone calls for a specific client.

Response

Successfully retrieved phone calls.

​
id
integer<int32>
​
startDate
string<date-time>
​
endDate
string<date-time> | null
​
fromNumber
string | null
​
toNumber
string | null
​
summary
string | null
​
uuid
string | null
​
clientId
integer<int32>
​
confidence
integer<int32>
​
confidenceReason
string | null
​
satisfaction
integer<int32>
​
satisfactionReason
string | null
​
purpose
string | null
​
dynamicVariables
string | null
​
connectedTo
integer<int32> | null
​
conversationUuid
string | null
​
name
string | null
​
transcript
object[] | null
​
isUnknown
boolean
​
portalId
integer<int32>