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

    Interface JoinTelehealthConsultResponse

    POST /v1/telehealth-consults/{id}/join response — what to render right now, plus the credentials when the call is live.

    Drive your waiting-room screen entirely from status:

    • 'waiting' — show position / estimatedMinutes and keep heartbeating.
    • 'in_progress' — connect to livekit.url with livekit.token.
    • 'completed' / 'cancelled' / 'no_show' — the call is over; show the rating prompt when rateable is true.
    • 'expired' — the invite is no longer usable; ask your backend to create a new consult.
    interface JoinTelehealthConsultResponse {
        status: TelehealthStatus | "expired";
        position?: number;
        estimatedMinutes?: number;
        livekit?: LiveKitGrant;
        rateable?: boolean;
    }
    Index
    status position? estimatedMinutes? livekit? rateable?
    status: TelehealthStatus | "expired"

    The consult's state after this heartbeat. 'expired' is join-only — it is not a stored TelehealthStatus.

    position?: number

    1-based place in the queue. Present while waiting.

    estimatedMinutes?: number

    Rough wait in minutes, derived from position. Present while waiting.

    livekit?: LiveKitGrant

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

    rateable?: boolean

    Whether a rating can still be submitted for this consult.

    Settings
    Member Visibility

    On This Page
    Properties