Link Search Menu Expand Document
⭐️ 1.8k 🌞 🌚

danog\MadelineProto\API

Back to index

Author: Daniil Gentili daniil@daniil.it

Main API wrapper for MadelineProto.

Constants

  • danog\MadelineProto\API::RELEASE: Release version.

  • danog\MadelineProto\API::SECRET_EMPTY: Secret chat was not found.

  • danog\MadelineProto\API::SECRET_REQUESTED: Secret chat was requested.

  • danog\MadelineProto\API::SECRET_READY: Secret chat was found.

  • danog\MadelineProto\API::NOT_LOGGED_IN: We’re not logged in.

  • danog\MadelineProto\API::WAITING_CODE: We’re waiting for the login code.

  • danog\MadelineProto\API::WAITING_SIGNUP: We’re waiting for parameters to sign up.

  • danog\MadelineProto\API::WAITING_PASSWORD: We’re waiting for the 2FA password.

  • danog\MadelineProto\API::LOGGED_IN: We’re logged in.

  • danog\MadelineProto\API::LOGGED_OUT: We’re logged out, the session will be deleted ASAP.

  • danog\MadelineProto\API::PEER_TYPE_USER: This peer is a user.

  • danog\MadelineProto\API::PEER_TYPE_BOT: This peer is a bot.

  • danog\MadelineProto\API::PEER_TYPE_GROUP: This peer is a normal group.

  • danog\MadelineProto\API::PEER_TYPE_SUPERGROUP: This peer is a supergroup.

  • danog\MadelineProto\API::PEER_TYPE_CHANNEL: This peer is a channel.

  • danog\MadelineProto\API::INFO_TYPE_PEER: Whether to generate only peer information.

  • danog\MadelineProto\API::INFO_TYPE_CONSTRUCTOR: Whether to generate only constructor information.

  • danog\MadelineProto\API::INFO_TYPE_ID: Whether to generate only ID information.

  • danog\MadelineProto\API::INFO_TYPE_ALL: Whether to generate all information.

  • danog\MadelineProto\API::INFO_TYPE_USERNAMES: Whether to generate all usernames.

  • danog\MadelineProto\API::INFO_TYPE_TYPE: Whether to generate just type info.

Properties

  • $auth: \danog\MadelineProto\Namespace\Auth
  • $account: \danog\MadelineProto\Namespace\Account
  • $users: \danog\MadelineProto\Namespace\Users
  • $contacts: \danog\MadelineProto\Namespace\Contacts
  • $messages: \danog\MadelineProto\Namespace\Messages
  • $updates: \danog\MadelineProto\Namespace\Updates
  • $photos: \danog\MadelineProto\Namespace\Photos
  • $upload: \danog\MadelineProto\Namespace\Upload
  • $help: \danog\MadelineProto\Namespace\Help
  • $channels: \danog\MadelineProto\Namespace\Channels
  • $bots: \danog\MadelineProto\Namespace\Bots
  • $payments: \danog\MadelineProto\Namespace\Payments
  • $stickers: \danog\MadelineProto\Namespace\Stickers
  • $phone: \danog\MadelineProto\Namespace\Phone
  • $langpack: \danog\MadelineProto\Namespace\Langpack
  • $folders: \danog\MadelineProto\Namespace\Folders
  • $stats: \danog\MadelineProto\Namespace\Stats
  • $chatlists: \danog\MadelineProto\Namespace\Chatlists
  • $stories: \danog\MadelineProto\Namespace\Stories

Method list:

Methods:

getWebAPITemplate(): string

Obtain the API ID UI template.

setWebApiTemplate(string $template): void

Set the API ID UI template.

Parameters:

  • $template: string

__construct(string $session, \danog\MadelineProto\SettingsAbstract $settings = NULL)

Constructor function.

Parameters:

  • $session: string Session name
  • $settings: \danog\MadelineProto\SettingsAbstract Settings

See also:

  • \danog\MadelineProto\SettingsAbstract

startAndLoopMulti(\danog\MadelineProto\API[] $instances, class-string<\danog\MadelineProto\EventHandler>[]|class-string<\danog\MadelineProto\EventHandler> $eventHandler): void

Start multiple instances of MadelineProto and the event handlers (enables async).

Parameters:

  • $instances: \danog\MadelineProto\API[] Instances of madeline
  • $eventHandler: class-string<\danog\MadelineProto\EventHandler>[]|class-string<\danog\MadelineProto\EventHandler> Event handler(s)

See also:

MTProtoToBotAPI(array $data): array

Convert MTProto parameters to bot API parameters.

Parameters:

  • $data: array Data

MTProtoToTd(mixed $params): array

MTProto to TD params.

Parameters:

  • $params: mixed Params

MTProtoToTdcli(mixed $params): array

MTProto to TDCLI params.

Parameters:

  • $params: mixed Params

acceptCall(int $id): void

Accept call.

Parameters:

  • $id: int

acceptSecretChat(array $params): void

Accept secret chat.

Parameters:

  • $params: array Secret chat ID

arr(mixed ...$params): array

Create array.

Parameters:

  • ...$params: mixed Params

base64urlDecode(string $data): string

base64URL decode.

Parameters:

  • $data: string Data to decode

base64urlEncode(string $data): string

Base64URL encode.

Parameters:

  • $data: string Data to encode

botAPIToMTProto(array $arguments): array

Convert bot API parameters to MTProto parameters.

Parameters:

  • $arguments: array Arguments

botLogin(string $token): ?array

Login as bot.

Parameters:

  • $token: string Bot token

broadcastCustom(\danog\MadelineProto\Broadcast\Action $action, ?\danog\MadelineProto\Broadcast\Filter $filter = NULL): int

Executes a custom broadcast action with all peers (users, chats, channels) of the bot. Will return an integer ID that can be used to:

  • Get the current broadcast progress with getBroadcastProgress
  • Cancel the broadcast using cancelBroadcast

Note that to avoid manually polling the progress,
MadelineProto will also periodically emit updateBroadcastProgress updates,
containing a Progress object for all broadcasts currently in-progress.

Parameters:

  • $action: \danog\MadelineProto\Broadcast\Action A custom, serializable Action class that will be called once for every peer.
  • $filter: ?\danog\MadelineProto\Broadcast\Filter

See also:

broadcastForwardMessages(mixed $from_peer, list<int> $message_ids, bool $drop_author = false, ?\danog\MadelineProto\Broadcast\Filter $filter = NULL, bool $pin = false): int

Forwards a list of messages to all peers (users, chats, channels) of the bot. Will return an integer ID that can be used to:

  • Get the current broadcast progress with getBroadcastProgress
  • Cancel the broadcast using cancelBroadcast

Note that to avoid manually polling the progress,
MadelineProto will also periodically emit updateBroadcastProgress updates,
containing a Progress object for all broadcasts currently in-progress.

Parameters:

  • $from_peer: mixed Bot API ID or Update, from where to forward the messages.
  • $message_ids: list<int> IDs of the messages to forward.
  • $drop_author: bool If true, will forward messages without quoting the original author.
  • $filter: ?\danog\MadelineProto\Broadcast\Filter
  • $pin: bool Whether to also pin the last sent message.

See also:

broadcastMessages(array $messages, ?\danog\MadelineProto\Broadcast\Filter $filter = NULL, bool $pin = false): int

Sends a list of messages to all peers (users, chats, channels) of the bot. A simplified version of this method is also available: broadcastForwardMessages can work with pre-prepared messages.

Will return an integer ID that can be used to:

  • Get the current broadcast progress with getBroadcastProgress
  • Cancel the broadcast using cancelBroadcast

Note that to avoid manually polling the progress,
MadelineProto will also periodically emit updateBroadcastProgress updates,
containing a Progress object for all broadcasts currently in-progress.

Parameters:

  • $messages: array The messages to send: an array of arrays, containing parameters to pass to messages.sendMessage.
  • $filter: ?\danog\MadelineProto\Broadcast\Filter
  • $pin: bool Whether to also pin the last sent message.

See also:

callFork(\Generator|\Amp\Future|callable $callable, mixed ...$args): \Amp\Future<\T>

Fork a new green thread and execute the passed function in the background.

Parameters:

  • $callable: \Generator|\Amp\Future|callable
  • ...$args: mixed Arguments forwarded to the function when forking the thread.

See also:

  • \Generator
  • \Amp\Future
  • \T

callGetCurrent(int $id): \danog\MadelineProto\RemoteUrl|\danog\MadelineProto\LocalFile|string|null

Get the file that is currently being played. Will return a string with the object ID of the stream if we’re currently playing a stream, otherwise returns the related LocalFile or RemoteUrl.

Parameters:

  • $id: int

See also:

callPlay(int $id, \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $file): void

Play file in call.

Parameters:

  • $id: int
  • $file: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream

See also:

callPlayOnHold(int $id, \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream ...$files): void

Play files on hold in call.

Parameters:

  • $id: int
  • ...$files: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream

See also:

canConvertOgg(): bool

Whether we can convert any audio/video file to a VoIP OGG OPUS file, or the files must be preconverted using @libtgvoipbot.

cancelBroadcast(int $id): void

Cancel a running broadcast.

Parameters:

  • $id: int Broadcast ID

closeConnection(string $message): void

Close connection with client, connected via web.

Parameters:

  • $message: string Message

complete2faLogin(string $password): array

Complete 2FA login.

Parameters:

  • $password: string Password

completePhoneLogin(string $code): array

Complet user login using login code.

Parameters:

  • $code: string Login code

completeSignup(string $first_name, string $last_name = ''): array

Complete signup to Telegram.

Parameters:

  • $first_name: string First name
  • $last_name: string Last name

discardCall(int $id, \danog\MadelineProto\VoIP\DiscardReason $reason = \danog\MadelineProto\VoIP\DiscardReason::HANGUP, int<\1, \5> $rating = NULL, string $comment = NULL): void

Discard call.

Parameters:

  • $id: int
  • $reason: \danog\MadelineProto\VoIP\DiscardReason
  • $rating: int<\1, \5> Call rating in stars
  • $comment: string Additional comment on call quality.

See also:

discardSecretChat(int $chat): void

Discard secret chat.

Parameters:

  • $chat: int Secret chat ID

downloadServer(string $session): void

Downloads a file to the browser using the specified session file.

Parameters:

  • $session: string

downloadToBrowser(array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message $messageMedia, null|callable $cb = NULL, null|int $size = NULL, null|string $name = NULL, null|string $mime = NULL): void

Download file to browser. Supports HEAD requests and content-ranges for parallel and resumed downloads.

Parameters:

  • $messageMedia: array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message File to download
  • $cb: null|callable Status callback (can also use FileCallback)
  • $size: null|int Size of file to download, required for bot API file IDs.
  • $name: null|string Name of file to download, required for bot API file IDs.
  • $mime: null|string MIME type of file to download, required for bot API file IDs.

See also:

downloadToCallable(mixed $messageMedia, callable|\danog\MadelineProto\FileCallbackInterface $callable, callable $cb = NULL, bool $seekable = true, int $offset = 0, int $end = -1, int $part_size = NULL): void

Download file to callable. The callable must accept two parameters: string $payload, int $offset
The callable will be called (possibly out of order, depending on the value of $seekable).

Parameters:

  • $messageMedia: mixed File to download
  • $callable: callable|\danog\MadelineProto\FileCallbackInterface Chunk callback
  • $cb: callable Status callback
  • $seekable: bool Whether the callable can be called out of order
  • $offset: int Offset where to start downloading
  • $end: int Offset where to stop downloading (inclusive)
  • $part_size: int Size of each chunk

See also:

downloadToDir(mixed $messageMedia, string|\danog\MadelineProto\FileCallbackInterface $dir, callable $cb = NULL): \non-empty-string Downloaded file name

Download file to directory.

Parameters:

  • $messageMedia: mixed File to download
  • $dir: string|\danog\MadelineProto\FileCallbackInterface Directory where to download the file
  • $cb: callable Callback

Return value: Downloaded file name

See also:

downloadToFile(mixed $messageMedia, string|\danog\MadelineProto\FileCallbackInterface $file, callable $cb = NULL): \non-empty-string Downloaded file name

Download file.

Parameters:

  • $messageMedia: mixed File to download
  • $file: string|\danog\MadelineProto\FileCallbackInterface Downloaded file path
  • $cb: callable Callback

Return value: Downloaded file name

See also:

downloadToResponse(array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message $messageMedia, \Amp\Http\Server\Request $request, callable $cb = NULL, null|int $size = NULL, null|string $mime = NULL, null|string $name = NULL): \Amp\Http\Server\Response

Download file to amphp/http-server response. Supports HEAD requests and content-ranges for parallel and resumed downloads.

Parameters:

  • $messageMedia: array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message File to download
  • $request: \Amp\Http\Server\Request Request
  • $cb: callable Status callback (can also use FileCallback)
  • $size: null|int Size of file to download, required for bot API file IDs.
  • $mime: null|string MIME type of file to download, required for bot API file IDs.
  • $name: null|string Name of file to download, required for bot API file IDs.

See also:

downloadToReturnedStream(mixed $messageMedia, callable $cb = NULL, int $offset = 0, int $end = -1): \Amp\ByteStream\ReadableStream

Download file to an amphp stream, returning it.

Parameters:

  • $messageMedia: mixed File to download
  • $cb: callable Callback
  • $offset: int Offset where to start downloading
  • $end: int Offset where to end download

See also:

  • \Amp\ByteStream\ReadableStream

downloadToStream(mixed $messageMedia, mixed|\danog\MadelineProto\FileCallbackInterface|\resource|\Amp\ByteStream\WritableStream $stream, callable $cb = NULL, int $offset = 0, int $end = -1): void

Download file to stream.

Parameters:

  • $messageMedia: mixed File to download
  • $stream: mixed|\danog\MadelineProto\FileCallbackInterface|\resource|\Amp\ByteStream\WritableStream Stream where to download file
  • $cb: callable Callback
  • $offset: int Offset where to start downloading
  • $end: int Offset where to end download

See also:

echo(string $string): void

Asynchronously write to stdout/browser.

Parameters:

  • $string: string Message to echo

end(\T[] $what): \T

Get final element of array.

Parameters:

  • $what: \T[] Array

See also:

  • \T

entitiesToHtml(string $message, list<\danog\MadelineProto\EventHandler\Message\Entities\MessageEntity|array{_: string, offset: int, length: int}> $entities, bool $allowTelegramTags = false): string

Convert a message and a set of entities to HTML.

Parameters:

  • $message: string
  • $entities: list<\danog\MadelineProto\EventHandler\Message\Entities\MessageEntity|array{_: string, offset: int, length: int}>
  • $allowTelegramTags: bool Whether to allow telegram-specific tags like tg-spoiler, tg-emoji, mention links and so on…

See also:

exportAuthorization(): array{0: int|string, 1: string}

Export authorization.

extractBotAPIFile(array $info): ?array

Extract file info from bot API message.

Parameters:

  • $info: array Bot API message object

extractMessage(array $updates): array

Extract a message constructor from an Updates constructor.

Parameters:

  • $updates: array

extractMessageId(array $updates): int

Extract a message ID from an Updates constructor.

Parameters:

  • $updates: array

extractMessageUpdate(array $updates): array

Extract an update message constructor from an Updates constructor.

Parameters:

  • $updates: array

extractUpdates(array $updates): array[]

Extract Update constructors from an Updates constructor.

Parameters:

  • $updates: array

fileGetContents(string $url): string

Get contents of remote file asynchronously.

Parameters:

  • $url: string URL

flock(string $file, int $operation, float $polling = 0.1, ?\Amp\Cancellation $token = NULL, ?\Closure $failureCb = NULL): mixed

Asynchronously lock a file Resolves with a callbable that MUST eventually be called in order to release the lock.

Parameters:

  • $file: string File to lock
  • $operation: int Locking mode
  • $polling: float Polling interval
  • $token: ?\Amp\Cancellation Cancellation token
  • $failureCb: ?\Closure Failure callback, called only once if the first locking attempt fails.

See also:

  • \Amp\Cancellation
  • \Closure

fullChatLastUpdated(mixed $id): int

When was full info for this chat last cached.

Parameters:

  • $id: mixed Chat ID

fullGetSelf(): array|false

Get info about the logged-in user, not cached.

genVectorHash(array $longs): string

Generate MTProto vector hash. Returns a vector hash.

Parameters:

  • $longs: array IDs

getAdminIds(): array

Get admin IDs (equal to all user report peers).

getAllCalls(): array<int, \danog\MadelineProto\VoIP>

Get all pending and running calls, indexed by user ID.

See also:

getAllMethods(): array

Get full list of MTProto and API methods.

getAuthorization(): \danog\MadelineProto\API::NOT_LOGGED_IN|\danog\MadelineProto\API::WAITING_CODE|\danog\MadelineProto\API::WAITING_SIGNUP|\danog\MadelineProto\API::WAITING_PASSWORD|\danog\MadelineProto\API::LOGGED_IN|\API::LOGGED_OUT

Get authorization info.

See also:

  • \danog\MadelineProto\API::NOT_LOGGED_IN
  • \danog\MadelineProto\API::WAITING_CODE
  • \danog\MadelineProto\API::WAITING_SIGNUP
  • \danog\MadelineProto\API::WAITING_PASSWORD
  • \danog\MadelineProto\API::LOGGED_IN
  • \API::LOGGED_OUT

getBroadcastProgress(int $id): ?\danog\MadelineProto\Broadcast\Progress

Get the progress of a currently running broadcast. Will return null if the broadcast doesn’t exist, has already completed or was cancelled.

Use updateBroadcastProgress updates to get real-time progress status without polling.

Parameters:

  • $id: int Broadcast ID

See also:

getCachedConfig(): array

Get cached server-side config.

getCall(int $id): ?\danog\MadelineProto\VoIP

Get phone call information.

Parameters:

  • $id: int

See also:

getCallByPeer(int $userId): ?\danog\MadelineProto\VoIP

Get the phone call with the specified user ID.

Parameters:

  • $userId: int

See also:

getCallState(int $id): ?\danog\MadelineProto\VoIP\CallState

Get call state.

Parameters:

  • $id: int

See also:

getCdnConfig(): void

Store RSA keys for CDN datacenters.

getConfig(array $config = []): array

Get cached (or eventually re-fetch) server-side config.

Parameters:

  • $config: array Current config

getDNSClient(): \Amp\Dns\DnsResolver

Get async DNS client.

See also:

  • \Amp\Dns\DnsResolver

getDhConfig(): array

Get diffie-hellman configuration.

getDialogIds(): list<int>

Get dialog IDs.

getDialogs(): list<array>

Get dialog peers.

getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}

Get download info of file Returns an array with the following structure:. $info['ext'] - The file extension
$info['name'] - The file name, without the extension
$info['mime'] - The file mime type
$info['size'] - The file size

Parameters:

  • $messageMedia: mixed File ID

Get download link of media file.

Parameters:

  • $media: \danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string
  • $scriptUrl: ?string
  • $size: ?int
  • $name: ?string
  • $mime: ?string

See also:

getEventHandler(class-string<\T>|null $class = NULL): \T|\danog\MadelineProto\Ipc\EventHandlerProxy|\__PHP_Incomplete_Class|null

Get event handler (or plugin instance).

Parameters:

  • $class: class-string<\T>|null

See also:

  • \T
  • \danog\MadelineProto\Ipc\EventHandlerProxy
  • \__PHP_Incomplete_Class

getExtensionFromLocation(mixed $location, string $default): string

Get extension from file location.

Parameters:

  • $location: mixed File location
  • $default: string Default extension

getExtensionFromMime(string $mime): string

Get extension from mime type.

Parameters:

  • $mime: string MIME type

getFileInfo(mixed $constructor): array

Get info about file.

Parameters:

  • $constructor: mixed File ID

getFolderId(mixed $id): ?int

Get folder ID from object.

Parameters:

  • $id: mixed Object

getFullDialogs(): array<int, array>

Get full info of all dialogs. Bots should use getDialogs or getDialogIds, instead.

getFullInfo(mixed $id): array

Get full info about peer, returns an FullInfo object.

Parameters:

  • $id: mixed Peer

See also:

getHTTPClient(): \Amp\Http\Client\HttpClient

Get async HTTP client.

See also:

  • \Amp\Http\Client\HttpClient

getHint(): string

Get current password hint.

getId(mixed $id): int

Get the bot API ID of a peer.

Parameters:

  • $id: mixed Peer

getInfo(mixed $id, \danog\MadelineProto\API::INFO_TYPE_* $type = \danog\MadelineProto\API::INFO_TYPE_ALL): mixed

Get info about peer, returns an Info object.

Parameters:

  • $id: mixed Peer
  • $type: \danog\MadelineProto\API::INFO_TYPE_* Whether to generate an Input*, an InputPeer or the full set of constructors

See also:

getLogger(): \danog\MadelineProto\Logger

Get logger.

See also:

getMaps(): ?int

Get current number of memory-mapped regions, UNIX only.

getMaxMaps(): ?int

Get maximum number of memory-mapped regions, UNIX only. Use testFibers to get the maximum number of fibers on any platform.

getMethodNamespaces(): array

Get TL namespaces.

getMethodsNamespaced(): array

Get namespaced methods (method => namespace).

getMimeFromBuffer(string $buffer): string

Get mime type from buffer.

Parameters:

  • $buffer: string Buffer

getMimeFromExtension(string $extension, string $default): string

Get mime type from file extension.

Parameters:

  • $extension: string File extension
  • $default: string Default mime type

getMimeFromFile(string $file): string

Get mime type of file.

Parameters:

  • $file: string File

getPlugin(class-string<\T> $class): \danog\MadelineProto\PluginEventHandler|\danog\MadelineProto\Ipc\EventHandlerProxy|null

Obtain a certain event handler plugin instance.

Parameters:

  • $class: class-string<\T>

See also:

getPropicInfo(mixed $data): array

Get download info of the propic of a user Returns an array with the following structure:. $info['ext'] - The file extension
$info['name'] - The file name, without the extension
$info['mime'] - The file mime type
$info['size'] - The file size

Parameters:

  • $data: mixed

getPsrLogger(): \Psr\Log\LoggerInterface

Get PSR logger.

See also:

  • \Psr\Log\LoggerInterface

getPwrChat(mixed $id, bool $fullfetch = true): array

Get full info about peer (including full list of channel members), returns a Chat object.

Parameters:

  • $id: mixed Peer
  • $fullfetch: bool

See also:

getSecretChat(array|int $chat): array

Get secret chat.

Parameters:

  • $chat: array|int Secret chat ID

getSelf(): array|false

Get info about the logged-in user, cached. Use fullGetSelf to bypass the cache.

getSessionName(): string

Returns the session name.

getSettings(): \danog\MadelineProto\Settings

Return current settings.

See also:

getSponsoredMessages(int|string|array $peer): ?array

Get sponsored messages for channel. This method will return an array of sponsored message objects.

See the API documentation for more info on how to handle sponsored messages.

Parameters:

  • $peer: int|string|array Channel ID, or Update, or Message, or Peer.

getStreamPipe(): \Amp\ByteStream\Pipe

Obtains a pipe that can be used to upload a file from a stream.

See also:

  • \Amp\ByteStream\Pipe

getTL(): \danog\MadelineProto\TL\TLInterface

Get TL serializer.

See also:

getType(mixed $id): \danog\MadelineProto\API::PEER_TYPE_*

Get type of peer.

Parameters:

  • $id: mixed Peer

getUpdates(array{offset?: int, limit?: int, timeout?: float} $params = []): list<array{update_id: mixed, update: mixed}>

Only useful when consuming MadelineProto updates through an API in another language (like Javascript), absolutely not recommended when directly writing MadelineProto bots. getUpdates will greatly slow down your bot if used directly inside of PHP code.

Only use the event handler when writing a MadelineProto bot, because update handling in the event handler is completely parallelized and non-blocking.

Parameters:

  • $params: array{offset?: int, limit?: int, timeout?: float} Params

getWebMessage(string $message): string

Get a message to show to the user when starting the bot.

Parameters:

  • $message: string

getWebWarnings(): string

Get various warnings to show to the user in the web UI.

hasAdmins(): bool

Check if has admins.

hasEventHandler(): bool

Check if an event handler instance is present.

hasPlugin(class-string<\danog\MadelineProto\EventHandler> $class): bool

Check if a certain event handler plugin is installed.

Parameters:

  • $class: class-string<\danog\MadelineProto\EventHandler>

See also:

hasReportPeers(): bool

Check if has report peers.

hasSecretChat(array|int $chat): bool

Check whether secret chat exists.

Parameters:

  • $chat: array|int Secret chat ID

htmlToMessageEntities(string $html): \danog\MadelineProto\TL\Conversion\DOMEntities Object containing message and entities

Manually convert HTML to a message and a set of entities. NOTE: You don’t have to use this method to send HTML messages.

This method is already called automatically by using parse_mode: “HTML” in messages.sendMessage, messages.sendMedia, et cetera…

Parameters:

  • $html: string

Return value: Object containing message and entities

See also:

importAuthorization(array<int, string> $authorization, int $mainDcID): array

Import authorization.

Parameters:

  • $authorization: array<int, string> Authorization info
  • $mainDcID: int Main DC ID

inflateStripped(string $stripped): string

Inflate stripped photosize to full JPG payload.

Parameters:

  • $stripped: string Stripped photosize

initSelfRestart(): void

Initialize self-restart hack.

isAltervista(): bool

Whether this is altervista.

isArrayOrAlike(mixed $var): bool

Check if is array or similar (traversable && countable && arrayAccess).

Parameters:

  • $var: mixed Value to check

isBot(mixed $peer): bool

Check if the specified peer is a bot.

Parameters:

  • $peer: mixed

isForum(mixed $peer): bool

Check if the specified peer is a forum.

Parameters:

  • $peer: mixed

isIpc(): bool

Whether we’re an IPC client instance.

isIpcWorker(): bool

Whether we’re an IPC server process (as opposed to an event handler).

isPlayPaused(int $id): bool

Whether the currently playing audio file is paused.

Parameters:

  • $id: int

isPremium(): bool

Returns whether the current user is a premium user, cached.

isSelfBot(): bool

Returns whether the current user is a bot.

isSelfUser(): bool

Returns whether the current user is a user.

isTestMode(): bool

Whether we’re currently connected to the test DCs.

logger(mixed $param, int $level = \danog\MadelineProto\Logger::NOTICE, string $file = ''): void

Logger.

Parameters:

  • $param: mixed Parameter
  • $level: int Logging level
  • $file: string File where the message originated

logout(): void

Logout the session.

markdownCodeblockEscape(string $what): string

Escape string for markdown codeblock.

Parameters:

  • $what: string String to escape

markdownEscape(string $what): string

Escape string for markdown.

Parameters:

  • $what: string String to escape

markdownToMessageEntities(string $markdown): \danog\MadelineProto\TL\Conversion\MarkdownEntities Object containing message and entities

Manually convert markdown to a message and a set of entities. NOTE: You don’t have to use this method to send Markdown messages.

This method is already called automatically by using parse_mode: “Markdown” in messages.sendMessage, messages.sendMedia, et cetera…

Parameters:

  • $markdown: string

Return value: Object containing message and entities

See also:

markdownUrlEscape(string $what): string

Escape string for URL.

Parameters:

  • $what: string String to escape

mbStrSplit(string $text, int $length): string[]

Telegram UTF-8 multibyte split.

Parameters:

  • $text: string Text
  • $length: int Length

mbStrlen(string $text): int

Get Telegram UTF-8 length of string.

Parameters:

  • $text: string Text

mbSubstr(string $text, int $offset, null|int $length = NULL): string

Telegram UTF-8 multibyte substring.

Parameters:

  • $text: string Text to substring
  • $offset: int Offset
  • $length: null|int Length

openBuffered(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $stream, ?\Amp\Cancellation $cancellation = NULL): callable

Provide a buffered reader for a file, URL or amp stream.

Parameters:

  • $stream: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream
  • $cancellation: ?\Amp\Cancellation

See also:

openFileAppendOnly(string $path): \Amp\File\File

Opens a file in append-only mode.

Parameters:

  • $path: string File path.

See also:

  • \Amp\File\File

packDouble(float $value): string

Convert double to binary version.

Parameters:

  • $value: float Value to convert

packSignedInt(int $value): string

Convert integer to base256 signed int.

Parameters:

  • $value: int Value to convert

packSignedLong(int $value): string

Convert integer to base256 long.

Parameters:

  • $value: int Value to convert

packUnsignedInt(int $value): string

Convert value to unsigned base256 int.

Parameters:

  • $value: int Value

pausePlay(int $id): void

Pauses playback of the current audio file in the call.

Parameters:

  • $id: int

peerIsset(mixed $id): bool

Check if peer is present in internal peer database.

Parameters:

  • $id: mixed Peer

phoneLogin(string $number, int $sms_type = 5): array

Login as user.

Parameters:

  • $number: string Phone number
  • $sms_type: int SMS type

posmod(int $a, int $b): int

Positive modulo Works just like the % (modulus) operator, only returns always a postive number.

Parameters:

  • $a: int A
  • $b: int B

processDownloadServerPing(string $path, string $payload): void

Internal endpoint used by the download server.

Parameters:

  • $path: string
  • $payload: string

qrLogin(): ?\danog\MadelineProto\TL\Types\LoginQrCode

Initiates QR code login. Returns a QR code login helper object, that can be used to render the QR code, display the link directly, wait for login, QR code expiration and much more.

Returns null if we’re already logged in, or if we’re waiting for a password (use getAuthorization to distinguish between the two cases).

See also:

random(int $length): string

Get secure random string of specified length.

Parameters:

  • $length: int Length

randomInt(int $modulus = 0): int

Get random integer.

Parameters:

  • $modulus: int Modulus

readLine(string $prompt = '', ?\Amp\Cancellation $cancel = NULL): string

Asynchronously read line.

Parameters:

  • $prompt: string Prompt
  • $cancel: ?\Amp\Cancellation

See also:

  • \Amp\Cancellation

refreshFullPeerCache(mixed $id): void

Refresh full peer cache for a certain peer.

Parameters:

  • $id: mixed The peer to refresh

refreshPeerCache(mixed ...$ids): void

Refresh peer cache for a certain peer.

Parameters:

  • ...$ids: mixed

rekey(int $chat): ?string

Rekey secret chat.

Parameters:

  • $chat: int Secret chat to rekey

report(string $message, string $parseMode = ''): void

Report an error to the previously set peer.

Parameters:

  • $message: string Error to report
  • $parseMode: string Parse mode

reportMemoryProfile(): void

Report memory profile with memprof.

requestCall(mixed $user): \danog\MadelineProto\VoIP

Request VoIP call.

Parameters:

  • $user: mixed User

See also:

requestSecretChat(mixed $user): int

Request secret chat.

Parameters:

  • $user: mixed User to start secret chat with

resetUpdateState(): void

Reset the update state and fetch all updates from the beginning.

restart(): void

Restart update loop.

resumePlay(int $id): void

Resumes playback of the current audio file in the call.

Parameters:

  • $id: int

rethrow(\Throwable $e): void

Rethrow exception into event loop.

Parameters:

  • $e: \Throwable

See also:

  • \Throwable

rleDecode(string $string): string

null-byte RLE decode.

Parameters:

  • $string: string Data to decode

rleEncode(string $string): string

null-byte RLE encode.

Parameters:

  • $string: string Data to encode

secretChatStatus(int $chat): \int One of \danog\MadelineProto\API::SECRET_EMPTY, \danog\MadelineProto\API::SECRET_REQUESTED, \danog\MadelineProto\API::SECRET_READY

Get secret chat status.

Parameters:

  • $chat: int Chat ID

Return value: One of \danog\MadelineProto\API::SECRET_EMPTY, \danog\MadelineProto\API::SECRET_REQUESTED, \danog\MadelineProto\API::SECRET_READY

sendCustomEvent(mixed $payload): void

Sends an updateCustomEvent update to the event handler.

Parameters:

  • $payload: mixed

sendDocument(int|string $peer, \danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream $file, \danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream|null $thumb = NULL, string $caption = '', \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, ?callable $callback = NULL, ?string $fileName = NULL, ?string $mimeType = NULL, ?int $ttl = NULL, bool $spoiler = false, int|null $replyToMsgId = NULL, int|null $topMsgId = NULL, array|null $replyMarkup = NULL, int|null $sendAs = NULL, int|null $scheduleDate = NULL, bool $silent = false, bool $noForwards = false, bool $background = false, bool $clearDraft = false, bool $updateStickersetsOrder = false): \danog\MadelineProto\EventHandler\Message

Sends a document. Please use named arguments to call this method.

Parameters:

  • $peer: int|string Destination peer or username.
  • $file: \danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream File to upload: can be a message to reuse media present in a message.
  • $thumb: \danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream|null Optional: Thumbnail to upload
  • $caption: string Caption of document
  • $parseMode: \danog\MadelineProto\ParseMode Text parse mode for the caption
  • $callback: ?callable
  • $fileName: ?string Optional file name, if absent will be extracted from the passed $file.
  • $mimeType: ?string
  • $ttl: ?int
  • $spoiler: bool
  • $replyToMsgId: int|null ID of message to reply to.
  • $topMsgId: int|null ID of thread where to send the message.
  • $replyMarkup: array|null Keyboard information.
  • $sendAs: int|null Peer to send the message as.
  • $scheduleDate: int|null Schedule date.
  • $silent: bool Whether to send the message silently, without triggering notifications.
  • $noForwards: bool
  • $background: bool Send this message as background message
  • $clearDraft: bool Clears the draft field
  • $updateStickersetsOrder: bool Whether to move used stickersets to top

See also:

sendMessage(int|string $peer, string $message, \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, int|null $replyToMsgId = NULL, int|null $topMsgId = NULL, array|null $replyMarkup = NULL, int|null $sendAs = NULL, int|null $scheduleDate = NULL, bool $silent = false, bool $noForwards = false, bool $background = false, bool $clearDraft = false, bool $noWebpage = false, bool $updateStickersetsOrder = false): \danog\MadelineProto\EventHandler\Message

Sends a message.

Parameters:

  • $peer: int|string Destination peer or username.
  • $message: string Message to send
  • $parseMode: \danog\MadelineProto\ParseMode Parse mode
  • $replyToMsgId: int|null ID of message to reply to.
  • $topMsgId: int|null ID of thread where to send the message.
  • $replyMarkup: array|null Keyboard information.
  • $sendAs: int|null Peer to send the message as.
  • $scheduleDate: int|null Schedule date.
  • $silent: bool Whether to send the message silently, without triggering notifications.
  • $noForwards: bool
  • $background: bool Send this message as background message
  • $clearDraft: bool Clears the draft field
  • $noWebpage: bool Set this flag to disable generation of the webpage preview
  • $updateStickersetsOrder: bool Whether to move used stickersets to top

See also:

sendMessageToAdmins(string $message, \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, array|null $replyMarkup = NULL, int|null $scheduleDate = NULL, bool $silent = false, bool $noForwards = false, bool $background = false, bool $clearDraft = false, bool $noWebpage = false): list<\danog\MadelineProto\EventHandler\Message>

Sends a message to all report peers (admins of the bot).

Parameters:

  • $message: string Message to send
  • $parseMode: \danog\MadelineProto\ParseMode Parse mode
  • $replyMarkup: array|null Keyboard information.
  • $scheduleDate: int|null Schedule date.
  • $silent: bool Whether to send the message silently, without triggering notifications.
  • $noForwards: bool
  • $background: bool Send this message as background message
  • $clearDraft: bool Clears the draft field
  • $noWebpage: bool Set this flag to disable generation of the webpage preview

See also:

sendPhoto(int|string $peer, \danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream $file, string $caption = '', \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, ?callable $callback = NULL, ?string $fileName = NULL, ?int $ttl = NULL, bool $spoiler = false, int|null $replyToMsgId = NULL, int|null $topMsgId = NULL, array|null $replyMarkup = NULL, int|null $sendAs = NULL, int|null $scheduleDate = NULL, bool $silent = false, bool $noForwards = false, bool $background = false, bool $clearDraft = false, bool $updateStickersetsOrder = false): \danog\MadelineProto\EventHandler\Message

Sends a photo. Please use named arguments to call this method.

Parameters:

  • $peer: int|string Destination peer or username.
  • $file: \danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream File to upload: can be a message to reuse media present in a message.
  • $caption: string Caption of document
  • $parseMode: \danog\MadelineProto\ParseMode Text parse mode for the caption
  • $callback: ?callable
  • $fileName: ?string Optional file name, if absent will be extracted from the passed $file.
  • $ttl: ?int
  • $spoiler: bool
  • $replyToMsgId: int|null ID of message to reply to.
  • $topMsgId: int|null ID of thread where to send the message.
  • $replyMarkup: array|null Keyboard information.
  • $sendAs: int|null Peer to send the message as.
  • $scheduleDate: int|null Schedule date.
  • $silent: bool Whether to send the message silently, without triggering notifications.
  • $noForwards: bool
  • $background: bool Send this message as background message
  • $clearDraft: bool Clears the draft field
  • $updateStickersetsOrder: bool Whether to move used stickersets to top

See also:

setNoop(): void

Set NOOP update handler, ignoring all updates.

setReportPeers(int|string|(int|string)[] $userOrId): void

Set peer(s) where to send errors occurred in the event loop.

Parameters:

  • $userOrId: int|string|(int|string)[] Username(s) or peer ID(s)

setWebhook(string $webhookUrl): void

Set webhook update handler.

Parameters:

  • $webhookUrl: string Webhook URL

skipPlay(int $id): void

When called, skips to the next file in the playlist.

Parameters:

  • $id: int

sleep(float $time): void

Asynchronously sleep.

Parameters:

  • $time: float Number of seconds to sleep for

start(): array

Log in to telegram (via CLI or web).

stop(): void

Stop update loop.

stopPlay(int $id): void

Stops playing all files in the call, clears the main and the hold playlist.

Parameters:

  • $id: int

stringToStream(string $str): \Amp\ByteStream\ReadableBuffer

Converts a string into an async amphp stream.

Parameters:

  • $str: string

See also:

  • \Amp\ByteStream\ReadableBuffer

subscribeToUpdates(mixed $channel): \bool False if we were already subscribed

Subscribe to event handler updates for a channel/supergroup we’re not a member of.

Parameters:

  • $channel: mixed Channel/supergroup to subscribe to

Return value: False if we were already subscribed

tdToMTProto(array $params): array

Convert TD to MTProto parameters.

Parameters:

  • $params: array Parameters

tdToTdcli(mixed $params): array

Convert TD parameters to tdcli.

Parameters:

  • $params: mixed Parameters

tdcliToTd(mixed $params, array $key = NULL): array

Convert tdcli parameters to tdcli.

Parameters:

  • $params: mixed Params
  • $key: array Key

testFibers(int $fiberCount = 100000): array{maxFibers: int, realMemoryMb: int, maps: ?int, maxMaps: ?int}

Test fibers.

Parameters:

  • $fiberCount: int

toCamelCase(string $input): string

Convert to camelCase.

Parameters:

  • $input: string String

toSnakeCase(string $input): string

Convert to snake_case.

Parameters:

  • $input: string String

unpackDouble(string $value): float

Unpack binary double.

Parameters:

  • $value: string Value to unpack

unpackFileId(string $fileId): \array Unpacked file ID

Unpack bot API file ID.

Parameters:

  • $fileId: string Bot API file ID

Return value: Unpacked file ID

unpackSignedInt(string $value): int

Unpack base256 signed int.

Parameters:

  • $value: string base256 int

unpackSignedLong(string $value): int

Unpack base256 signed long.

Parameters:

  • $value: string base256 long

unpackSignedLongString(string|int|array $value): string

Unpack base256 signed long to string.

Parameters:

  • $value: string|int|array base256 long

unsetEventHandler(): void

Unset event handler.

update2fa(array{password?: string, new_password?: string, email?: string, hint?: string} $params): void

Update the 2FA password. The params array can contain password, new_password, email and hint params.

Parameters:

  • $params: array{password?: string, new_password?: string, email?: string, hint?: string} The params

updateSettings(\danog\MadelineProto\SettingsAbstract $settings): void

Parse, update and store settings.

Parameters:

  • $settings: \danog\MadelineProto\SettingsAbstract Settings

See also:

  • \danog\MadelineProto\SettingsAbstract

upload(\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|string|array|\resource $file, string $fileName = '', callable $cb = NULL, bool $encrypted = false): \array InputFile constructor

Upload file.

Parameters:

  • $file: \danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|string|array|\resource File, URL or Telegram file to upload
  • $fileName: string File name
  • $cb: callable Callback
  • $encrypted: bool Whether to encrypt file for secret chats

Return value: InputFile constructor

See also:

uploadEncrypted(\danog\MadelineProto\FileCallbackInterface|string|array $file, string $fileName = '', callable $cb = NULL): \array InputFile constructor

Upload file to secret chat.

Parameters:

  • $file: \danog\MadelineProto\FileCallbackInterface|string|array File, URL or Telegram file to upload
  • $fileName: string File name
  • $cb: callable Callback

Return value: InputFile constructor

See also:

uploadFromCallable(mixed $callable, int $size = 0, string $mime = 'application/octet-stream', string $fileName = '', callable $cb = NULL, bool $seekable = true, bool $encrypted = false): \array InputFile constructor

Upload file from callable. The callable must accept two parameters: int $offset, int $size
The callable must return a string with the contest of the file at the specified offset and size.

Parameters:

  • $callable: mixed Callable
  • $size: int File size
  • $mime: string Mime type
  • $fileName: string File name
  • $cb: callable Callback
  • $seekable: bool Whether chunks can be fetched out of order
  • $encrypted: bool Whether to encrypt file for secret chats

Return value: InputFile constructor

uploadFromStream(mixed $stream, int $size = 0, string $mime = 'application/octet-stream', string $fileName = '', callable $cb = NULL, bool $encrypted = false): \array InputFile constructor

Upload file from stream.

Parameters:

  • $stream: mixed PHP resource or AMPHP async stream
  • $size: int File size
  • $mime: string Mime type
  • $fileName: string File name
  • $cb: callable Callback
  • $encrypted: bool Whether to encrypt file for secret chats

Return value: InputFile constructor

uploadFromTgfile(mixed $media, callable $cb = NULL, bool $encrypted = false): \array InputFile constructor

Reupload telegram file.

Parameters:

  • $media: mixed Telegram file
  • $cb: callable Callback
  • $encrypted: bool Whether to encrypt file for secret chats

Return value: InputFile constructor

uploadFromUrl(string|\danog\MadelineProto\FileCallbackInterface $url, int $size = 0, string $fileName = '', callable $cb = NULL, bool $encrypted = false): \array InputFile constructor

Upload file from URL.

Parameters:

  • $url: string|\danog\MadelineProto\FileCallbackInterface URL of file
  • $size: int Size of file
  • $fileName: string File name
  • $cb: callable Callback
  • $encrypted: bool Whether to encrypt file for secret chats

Return value: InputFile constructor

See also:

validateEventHandlerClass(class-string<\danog\MadelineProto\EventHandler> $class): list<\danog\MadelineProto\EventHandlerIssue>

Perform static analysis on a certain event handler class, to make sure it satisfies some performance requirements.

Parameters:

  • $class: class-string<\danog\MadelineProto\EventHandler> Class name

See also:

viewSponsoredMessage(int|array $peer, string|array{random_id: string} $message): bool

Mark sponsored message as read.

Parameters:

  • $peer: int|array Channel ID, or Update, or Message, or Peer.
  • $message: string|array{random_id: string} Random ID or sponsored message to mark as read.

wrapMedia(array $media, bool $protected = false): ?\danog\MadelineProto\EventHandler\Media

Wrap a media constructor into an abstract Media object.

Parameters:

  • $media: array
  • $protected: bool

See also:

wrapMessage(array $message): ?\danog\MadelineProto\EventHandler\AbstractMessage

Wrap a Message constructor into an abstract Message object.

Parameters:

  • $message: array

See also:

wrapUpdate(array $update): ?\danog\MadelineProto\EventHandler\Update

Wrap an Update constructor into an abstract Update object.

Parameters:

  • $update: array

See also:

Generated by danog/phpdoc