GET
/
call
cURL
curl --request GET \
  --url https://api.clarionhealth.com/v1/call \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "assistant_id": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "call_status": "queued",
    "ended_reason": "<string>",
    "transcript": "<string>",
    "source_number": "<string>",
    "destination_number": "<string>",
    "call_type": "<string>",
    "messages": [
      {
        "role": "<string>",
        "message": "<string>",
        "time": 123,
        "endTime": 123,
        "secondsFromStart": 123,
        "duration": 123
      }
    ],
    "duration_ms": 123,
    "analysis": {
      "repetition_count": 123,
      "interruption_count": 123,
      "custom": {}
    },
    "summary": "<string>",
    "outcome": "<string>",
    "failure_reason": "declined"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

The maximum number of results to return. Defaults to 100, maximum is 1000.

createdAtGe
string<date-time>

Filter calls created on or after this date (ISO 8601 format)

createdAtLe
string<date-time>

Filter calls created on or before this date (ISO 8601 format)

Response

200 - application/json

List Calls

id
integer

The unique id for the call

assistant_id
integer

The id of the assistant that handled the call

started_at
string<date-time> | null

The date and time the call was started

ended_at
string<date-time> | null

The date and time the call ended

call_status
enum<string>

The status of the call

Available options:
queued,
ringing,
in-progress,
forwarding,
ended
ended_reason
string | null

The reason why the call ended

transcript
string | null

The transcript of the call

source_number
string | null

The phone number that initiated the call

destination_number
string | null

The phone number that received the call

call_type
string

The type of call

messages
(UserMessage · object | SystemMessage · object | BotMessage · object | ToolCallMessage · object | ToolCallResultMessage · object)[]

Structured messages representing the events of the conversation

duration_ms
integer | null

The duration of the call in milliseconds

analysis
object

Includes custom evaluations and data extractions for the call.

summary
string | null

A summary of the call

outcome
string | null

The outcome of the call

failure_reason
enum<string> | null

If the call was unsuccessful, this will be the reason why

Available options:
declined,
escalated,
requested-callback,
customer-dropped,
assistant-ended,
opt-out