MadelineProtoDocs/old_docs/API_docs_v66/methods/channels_exportInvite.md

78 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: channels.exportInvite
description: Export the invite link of a channel
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: channels.exportInvite
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Export the invite link of a channel
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
2018-04-01 13:19:25 +02:00
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)
### Can bots use this method: **YES**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
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, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.exportInvite
* params - `{"channel": InputChannel, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.exportInvite`
Parameters:
channel - Json encoded InputChannel
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
ExportedChatInvite = channels.exportInvite({channel=InputChannel, })
```
### 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|