MadelineProto/old_docs/API_docs_v40/methods/messages_checkChatInvite.md

68 lines
1.4 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.checkChatInvite
2018-03-23 16:23:49 +01:00
description: Check if an invitation link is valid
---
2017-01-19 23:02:27 +01:00
## Method: messages.checkChatInvite
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Check if an invitation link is valid
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format|
### Return type: [ChatInvite](../types/ChatInvite.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### 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|
2018-03-20 19:57:36 +01:00
### 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();
2017-07-23 16:33:46 +02:00
$ChatInvite = $MadelineProto->messages->checkChatInvite(['hash' => 'string', ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.checkChatInvite`
Parameters:
hash - Json encoded string
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
ChatInvite = messages.checkChatInvite({hash='string', })
```