Type alias EndCallToolOptions<UserData>

EndCallToolOptions<UserData>: {
    deleteRoom?: boolean;
    endInstructions?: string | null;
    extraDescription?: string;
    onToolCalled?: ((event) => Promise<void> | void);
    onToolCompleted?: ((event) => Promise<void> | void);
}

Type Parameters

  • UserData = UnknownUserData

Type declaration

  • Optional deleteRoom?: boolean

    Whether to delete the room when the user ends the call. Deleting the room disconnects all remote users, including SIP callers.

  • Optional endInstructions?: string | null

    Tool output to the LLM for generating the tool response.

  • Optional extraDescription?: string

    Additional description to add to the end call tool.

  • Optional onToolCalled?: ((event) => Promise<void> | void)

    Callback to call when the tool is called.

  • Optional onToolCompleted?: ((event) => Promise<void> | void)

    Callback to call when the tool is completed.