MadelineProto/old_docs/API_docs_v51/methods/channels_exportInvite.md

77 lines
1.6 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: channels.exportInvite
2018-03-23 16:23:49 +01:00
description: Export the invite link of a channel
---
2017-01-19 23:02:27 +01:00
## Method: channels.exportInvite
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Export the invite link of a channel
### 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|
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01: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|
|INVITE_HASH_EXPIRED|The invite link has expired|
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();
$ExportedChatInvite = $MadelineProto->channels->exportInvite(['channel' => InputChannel, ]);
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
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.exportInvite
2017-07-23 16:40:54 +02:00
* params - `{"channel": InputChannel, }`
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.exportInvite`
Parameters:
channel - Json encoded InputChannel
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:
```
ExportedChatInvite = channels.exportInvite({channel=InputChannel, })
```