MadelineProtoDocs/old_docs/API_docs_v45/methods/messages_checkChatInvite.md

69 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +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
---
2018-04-05 01:19:57 +02:00
# Method: messages.checkChatInvite
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Check if an invitation link is valid
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [ChatInvite](../types/ChatInvite.md)
### Can bots use this method: **NO**
### 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();
$ChatInvite = $MadelineProto->messages->checkChatInvite(['hash' => 'string', ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.checkChatInvite`
Parameters:
hash - Json encoded string
Or, if you're into Lua:
```
ChatInvite = messages.checkChatInvite({hash='string', })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|INVITE_HASH_EMPTY|The invite hash is empty|
|INVITE_HASH_EXPIRED|The invite link has expired|
|INVITE_HASH_INVALID|The invite hash is invalid|