Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface ModalityCapabilities

    One modality's switches, as they apply to YOUR key on THIS tenant.

    Two questions, deliberately separated:

    • live / book — WHAT the clinic runs. live is a clinician engaging now (the video queue; a messaging thread picked up straight away); book is an appointment at a chosen time. A scenario the clinic doesn't run cannot be reached by anyone, in any way.
    • onDemand — WHO may start it. With it off, the scenario exists but only the AI agent (or a clinician) offers it, on clinical judgement; a direct request — yours over REST, or the patient's in the embed — is refused with on_demand_disabled. With it on, the patient may ask.

    So onDemandLive / onDemandBook are the fields to branch on when the question is "may I create one right now": they are already the AND of the mode and the initiator switch.

    interface ModalityCapabilities {
        live: boolean;
        book: boolean;
        onDemand: boolean;
        onDemandLive: boolean;
        onDemandBook: boolean;
        enabled: boolean;
    }
    Index
    live: boolean

    A clinician engages now. Always false for in_person.

    book: boolean

    An appointment at a chosen time, from published availability.

    onDemand: boolean

    The patient (or you, on their behalf) may ask for this unprompted.

    onDemandLive: boolean

    live && onDemand — a live create would be accepted.

    onDemandBook: boolean

    book && onDemand — a book/scheduled create would be accepted.

    enabled: boolean

    live || book — the modality is reachable at all.