MTKruto / API Reference / Methods /

startTakeoutSession

Start a takeout session. USER-ONLY

Parameters

isExportingContacts?: boolean

Whether contacts will be exported in the takeout session.

isExportingPrivateChats?: boolean

Whether messages from private chats will be exported in the takeout session.

isExportingGroupChats?: boolean

Whether messages from group chats will be exported in the takeout session.

isExportingSupergroupChats?: boolean

Whether messages from supergroup chats will be exported in the takeout session.

isExportingChannelChats?: boolean

Whether messages from channel chats will be exported in the takeout session.

isExportingFiles?: boolean

Whether files will be exported in the takeout session.

maxFileSize?: number

The maximum file size that will be exported.

Result

string

The identifier of the takeout session.

Syntax

// Optional parameters.
// Any of the optional parameters can be omitted.
await client.startTakeoutSession( {
    isExportingContacts,
    isExportingPrivateChats,
    isExportingGroupChats,
    isExportingSupergroupChats,
    isExportingChannelChats,
    isExportingFiles,
    maxFileSize,
});