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

    Interface TelehealthRoomResponse

    POST /v1/telehealth-consults/{id}/room response — the physician's way into their call, keyed on the consult's state.

    • 'in_progress' — livekit is present: connect and render the room.
    • 'ringing' — no grant yet; the patient's client is confirming. Keep polling the workspace (telehealth.active) and call again when it reads in_progress.
    • terminal (completed / cancelled / no_show) — the call is over.
    interface TelehealthRoomResponse {
        status: TelehealthStatus;
        livekit?: LiveKitGrant;
        consult: TelehealthConsultResource;
    }
    Index

    The consult's state as of this call.

    livekit?: LiveKitGrant

    Room credentials. Present only when status is 'in_progress'.

    The consult, for the call panel's header.