MadelineProto/old_docs/API_docs_v71/methods/channels_exportInvite.md

78 lines
1.7 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: channels.exportInvite
description: channels.exportInvite parameters, return type and example
---
## Method: channels.exportInvite
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|channel|[InputChannel](../types/InputChannel.md) | Optional|
2017-10-14 11:50:46 +02:00
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)
### 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|
2017-10-14 11:50:46 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-10-14 11:50:46 +02:00
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-10-14 11:50:46 +02:00
$MadelineProto->complete_phone_login($code);
}
$ExportedChatInvite = $MadelineProto->channels->exportInvite(['channel' => InputChannel, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### 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:
```
ExportedChatInvite = channels.exportInvite({channel=InputChannel, })
```