Sign in

v2

latestOpenAPI 3.1.02026-07-31515292.8 KB

Get Patient Calls

get/api/v0/patient-calls/calls/

Query parameters

external_idstring
limitinteger

Response

Successful Response

idstring required

Unique generated (uuid4) id for the patient call

status'SCHEDULED' | 'IN_PROGRESS' | 'SUCCESS' | 'UNSUCCESSFUL' | 'CANCELLED' | 'UNKNOWN' required

An enumeration.

outcome'LIVE_ANSWERED' | 'VOICEMAIL_LEFT' | 'NO_ANSWER' | 'FAILED'

An enumeration.

voicemail_leftboolean

True if a voicemail was left as a fallback when the patient did not answer.

call_summarystring

Short summary of the call outcome

recording_urlstring

URL of the call recording, if your team is entitled to recordings.

creation_tsstring date-time required

Timestamp when the call was created

completed_atstring date-time

Timestamp when the call reached a terminal status

Example response

[
  {
    "request": {
      "patient_name": "Alex Martin",
      "patient_phone": "+14155552671",
      "desired_call_ts": "2024-03-19T14:30:00Z",
      "call_script_id": "script_abc123",
      "external_id": "provider_123",
      "metadata": {
        "medication": "Atorvastatin",
        "appointment_date": "04-01-2024"
      },
      "voicemail_script": "Hi, this is Riverside Family Medicine calling about your prescription refill. Please call us back at 555-0100."
    },
    "answers": [
      {
        "question_id": "q_abc123",
        "question_text": "Would you like to schedule a refill?",
        "answer": "Yes"
      }
    ],
    "call_summary": "Patient confirmed refill; pickup at main pharmacy.",
    "creation_ts": "2020-01-01T00:00:00.000000Z",
    "completed_at": "2020-01-01T00:05:00.000000Z"
  }
]