Interface NormalizedMeetingEvent

One report from a provider, in the channel's terms, as the provider's parser returns it.

interface NormalizedMeetingEvent {
    eventId: string;
    runId: string;
    type: ProviderEventType;
    at: number;
    data?: {
        reason?: MeetingLeaveReason;
        seconds?: number;
        text?: string;
        sender?: string;
        participantRef?: string;
        participantCount?: number;
        message?: string;
        supplierUsage?: SupplierUsage;
    };
}

Properties

eventId runId type at data?

Properties

eventId

eventId: string

Stable: the provider supplies it or derives it from its own ids, never at random.

runId

runId: string

type

type: ProviderEventType

at

at: number

Optional data

data?: {
    reason?: MeetingLeaveReason;
    seconds?: number;
    text?: string;
    sender?: string;
    participantRef?: string;
    participantCount?: number;
    message?: string;
    supplierUsage?: SupplierUsage;
}

Type declaration

  • Optional reason?: MeetingLeaveReason

    Why the bot left, on left.

  • Optional seconds?: number

    The seconds the worker counted, on usage, left, done and crashed.

  • Optional text?: string

    A chat message's text.

  • Optional sender?: string

    Who sent a chat message or a stop command.

  • Optional participantRef?: string

    The provider's reference for a participant who joined or left.

  • Optional participantCount?: number

    How many participants besides the bot, on in_call and when one joins or leaves.

  • Optional message?: string

    An error's description, on error; on left, the provider's word for why the run ended, which bot:left carries beside the reason.

  • Optional supplierUsage?: SupplierUsage

    What the provider's supplier measured so far, on any report: recorded whatever the run's state, a terminal one included.

Settings

Member Visibility

Theme

On This Page

eventIdrunIdtypeatdata