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

The body is of type object.

Response

200 - application/json

Call response

The response is of type object.