MadelineProtoDocs/old_docs/API_docs_v102/methods/messages_checkChatInvite.md

54 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
title: messages.checkChatInvite
description: Check if an invitation link is valid
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
---
2019-06-24 15:45:02 +02:00
# Method: messages.checkChatInvite
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-06-24 15:45:02 +02:00
Check if an invitation link is valid
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-06-24 15:45:02 +02:00
|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes|
2018-04-01 13:19:25 +02:00
2019-06-24 15:45:02 +02:00
### Return type: [ChatInvite](../types/ChatInvite.md)
2018-04-01 13:19:25 +02:00
### 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();
2019-06-24 15:45:02 +02:00
$ChatInvite = $MadelineProto->messages->checkChatInvite(['hash' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-06-24 15:45:02 +02:00
ChatInvite = messages.checkChatInvite({hash='string', })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
2019-06-24 15:45:02 +02:00
|INVITE_HASH_EMPTY|The invite hash is empty|
|INVITE_HASH_EXPIRED|The invite link has expired|
|INVITE_HASH_INVALID|The invite hash is invalid|
2018-04-01 13:19:25 +02:00