MadelineProtoDocs/old_docs/API_docs_v33/methods/messages.exportChatInvite.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.exportChatInvite
2019-12-27 17:48:04 +01:00
description: Export an invite link for a chat
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_exportChatInvite.html
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.exportChatInvite
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Export an invite link for a chat
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional|
2018-04-01 13:19:25 +02:00
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```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->messages->exportChatInvite(['chat_id' => InputPeer, ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, })
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
2020-01-10 14:18:02 +01:00
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
2019-12-27 17:48:04 +01:00
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2019-09-02 17:41:28 +02:00
|400|CHAT_ID_INVALID|The provided chat id is invalid|
2019-12-27 17:48:04 +01:00
|400|PEER_ID_INVALID|The provided peer id is invalid|
2018-04-01 13:19:25 +02:00