POST
/
call
curl --request POST \
  --url https://api.clarionhealth.com/v1/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "assistant_id": 123,
  "source_phone_number_id": 123,
  "destination_phone_number": "<string>",
  "task_parameters": {}
}'
{
  "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": {
    "structuredData": {},
    "successEvaluation": "<string>"
  },
  "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.

Body

application/json
Call to add to the store
​
name
string

The name of the call for your own reference

Maximum length: 50
​
assistant_id
number

The id of the assistant to use for the call

​
source_phone_number_id
number

The phoneNumberId of the phone number that will be used to make the call

​
destination_phone_number
string

The phone number with area code of the number you would like to call (ex: +138726394823)

​
task_parameters
object

Any override setting you would like to pass into the assistant configuration.

Response

200 - application/json
Call response
​
id
integer

The unique id for the call

​
assistant_id
integer

The id of the assistant that handled the call

​
started_at
string | null

The date and time the call was started

​
ended_at
string | 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
object[]

Structured messages representing the events of the conversation

​
duration_ms
integer | null

The duration of the call in milliseconds

​
analysis
object

[Beta] Includes custom evaluations and data extractions for the call. Analysis feature is in beta and is not yet generally available.

​
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