@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface CallEvent

    An inbound call notification. Transports may emit several per call (one per status update) with the same id.

    interface CallEvent {
        id: string;
        from: string;
        status: string;
        chatId?: string;
        isGroup?: boolean;
        isVideo?: boolean;
        offline?: boolean;
    }
    Index
    id from status chatId? isGroup? isVideo? offline?
    id: string
    from: string

    The caller, resolved to the SAME canonical id their messages carry as senderId (the identity-stability contract applies to calls too).

    status: string

    Transport status, e.g. WhatsApp offer / ringing / reject / timeout / terminate.

    chatId?: string

    The chat the call belongs to: the group for a group call. Omitted → the DM with the caller (from).

    isGroup?: boolean

    true when chatId is a group (a group call). Provider-set, like ChatInfo.isGroup.

    isVideo?: boolean

    true for a video call, when the transport says so.

    offline?: boolean

    true when the notification was delivered late (e.g. replayed after the bot reconnected) rather than while the call was ringing.

    Settings
    Member Visibility

    On This Page
    Properties