MadelineProto/docs/API_docs/methods/channels_toggleInvites.md

71 lines
1.6 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: channels.toggleInvites
2018-03-23 16:23:49 +01:00
description: Allow or disallow any user to invite users to this channel/supergroup
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: channels.toggleInvites
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Allow or disallow any user to invite users to this channel/supergroup
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
2018-03-27 14:41:50 +02:00
|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow|
### Return type: [Updates](../types/Updates.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2016-12-21 10:40:30 +01:00
$Updates = $MadelineProto->channels->toggleInvites(['channel' => InputChannel, 'enabled' => Bool, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.toggleInvites`
Parameters:
channel - Json encoded InputChannel
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
enabled - Json encoded Bool
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, })
```
2018-03-27 14:41:50 +02:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|CHAT_NOT_MODIFIED|The pinned message wasn't modified|