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

    Variable joinTelehealthConsultSchemaConst

    joinTelehealthConsultSchema: ZodObject<{}, $strict> = ...

    Body of POST /v1/telehealth-consults/{id}/join — the patient's presence heartbeat AND the waiting-room read, in one call.

    Call it when the patient opens your waiting-room screen and every ~10 seconds while it stays open: presence is a 30-second TTL, so a client that stops calling simply leaves the queue (there is no explicit "leave"). The response tells you what to render — queue position while waiting, and the LiveKit token/url the moment a physician picks the call up.

    STOP calling it when the patient backgrounds the screen; continuing to heartbeat for a patient who isn't watching holds a queue slot they can't use.