MadelineProto/docs/API_docs/methods/messages_forwardMessages.md
Daniil Gentili 7a0153a139
Documentation rework (#349)
* Documentation rework

* Apply fixes from StyleCI

* Documentation fixes

* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite

* Apply fixes from StyleCI

* Logging fixes

* Build docs

* Add methods to modify start template, bugfix to logging and keyboard conversion

* Add TL documentator

* Document MTProto methods

* Documenting methods...

* 7% documented

* Bugfixes

* Update docs

* Update docs

* Simplify file management

* Implement automatic object conversion for media, and more awesome stuff

* Implement automatic object conversion for media, and more awesome stuff

* Implement event update handler and file upload/download callback

* Auto-detect mime type, duration, width and height of media

* Update docs

* Document new file functions

* Fix links

* Fix links

* Update bot.php to use event loop

* Implement webhook update handler and forking in main loop

* Build docs

* Better docs

* Fixes to secret chats

* Almost finished updating docs

* Bugfixes, implemented infinite loop for loop() method, almost finished docs

* Finish writing docs

* Add automatic documentation builder script

* Finished writing docs
2018-03-20 12:48:05 +01:00

3.6 KiB

title description
messages.forwardMessages messages.forwardMessages parameters, return type and example

Method: messages.forwardMessages

Back to methods index

Parameters:

Name Type Required
silent Bool Optional
background Bool Optional
with_my_score Bool Optional
grouped Bool Optional
from_peer Username, chat ID, Update, Message or InputPeer Optional
id Array of int Yes
to_peer Username, chat ID, Update, Message or InputPeer Optional

Return type: Updates

Can bots use this method: YES

Errors this method can return:

Error Description
CHANNEL_INVALID The provided channel is invalid
CHANNEL_PRIVATE You haven't joined this channel/supergroup
CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this
CHAT_ID_INVALID The provided chat id is invalid
GROUPED_MEDIA_INVALID Invalid grouped media
INPUT_USER_DEACTIVATED The specified user was deleted
MEDIA_EMPTY The provided media object is invalid
MESSAGE_ID_INVALID The provided message id is invalid
MESSAGE_IDS_EMPTY No message ids were provided
PEER_ID_INVALID The provided peer id is invalid
RANDOM_ID_INVALID A provided random ID is invalid
USER_BANNED_IN_CHANNEL You're banned from sending messages in supergroups/channels
USER_IS_BLOCKED User is blocked
USER_IS_BOT Bots can't send messages to other bots
YOU_BLOCKED_USER You blocked this user
PTS_CHANGE_EMPTY No PTS change
RANDOM_ID_DUPLICATE You provided a random ID that was already used
CHAT_SEND_GIFS_FORBIDDEN You can't send gifs in this chat
CHAT_SEND_MEDIA_FORBIDDEN You can't send media in this chat
CHAT_SEND_STICKERS_FORBIDDEN You can't send stickers in this chat.
CHAT_WRITE_FORBIDDEN You can't write in this chat
Timeout A timeout occurred while fetching data from the bot

Example:

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';

$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();

$Updates = $MadelineProto->messages->forwardMessages(['silent' => Bool, 'background' => Bool, 'with_my_score' => Bool, 'grouped' => Bool, 'from_peer' => InputPeer, 'id' => [int, int], 'to_peer' => InputPeer, ]);

Or, if you're using the PWRTelegram HTTP API:

As a bot:

POST/GET to https://api.pwrtelegram.xyz/botTOKEN/madeline

Parameters:

  • method - messages.forwardMessages
  • params - {"silent": Bool, "background": Bool, "with_my_score": Bool, "grouped": Bool, "from_peer": InputPeer, "id": [int], "to_peer": InputPeer, }

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/messages.forwardMessages

Parameters:

silent - Json encoded Bool

background - Json encoded Bool

with_my_score - Json encoded Bool

grouped - Json encoded Bool

from_peer - Json encoded InputPeer

id - Json encoded array of int

to_peer - Json encoded InputPeer

Or, if you're into Lua:

Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, grouped=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, })