Interface LiveKitSipInboundResult

The outcome of an inbound call webhook.

interface LiveKitSipInboundResult {
    accepted: boolean;
    Busy?: boolean;
    reason?: string;
    Started?: Promise<void>;
}

Properties

accepted: boolean

Whether the event was a new call that was admitted.

Busy?: boolean

Set when the call was refused only because the server is at its concurrent-call cap.

reason?: string

Why it was not (no agent for the number, at capacity, not a phone call, a repeat).

Started?: Promise<void>

Resolves when the agent's session has started (or failed and been cleaned up). Never rejects. Callers ignore it; tests await it.