MadelineProto/old_docs/API_docs_v41/methods/channels_inviteToChannel.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

2.6 KiB

title description
channels.inviteToChannel channels.inviteToChannel parameters, return type and example

Method: channels.inviteToChannel

Back to methods index

Parameters:

Name Type Required
channel Username, chat ID, Update, Message or InputChannel Optional
users Array of Username, chat ID, Update, Message or InputUser Yes

Return type: Updates

Can bots use this method: NO

Errors this method can return:

Error Description
BOT_GROUPS_BLOCKED This bot can't be added to groups
BOTS_TOO_MUCH There are too many bots in this chat/channel
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
INPUT_USER_DEACTIVATED The specified user was deleted
USER_BANNED_IN_CHANNEL You're banned from sending messages in supergroups/channels
USER_BLOCKED User blocked
USER_BOT Bots can only be admins in channels.
USER_ID_INVALID The provided user ID is invalid
USER_KICKED This user was kicked from this supergroup/channel
USER_NOT_MUTUAL_CONTACT The provided user is not a mutual contact
USERS_TOO_MUCH The maximum number of users has been exceeded (to create a chat, for example)
CHAT_WRITE_FORBIDDEN You can't write in this chat
USER_CHANNELS_TOO_MUCH One of the users you tried to add is already in too many channels/supergroups
USER_PRIVACY_RESTRICTED The user's privacy settings do not allow you to do this

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->channels->inviteToChannel(['channel' => InputChannel, 'users' => [InputUser, InputUser], ]);

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

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/channels.inviteToChannel

Parameters:

channel - Json encoded InputChannel

users - Json encoded array of InputUser

Or, if you're into Lua:

Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, })