MadelineProtoDocs/old_docs/API_docs_v62/methods/auth_sendInvites.md

76 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: auth.sendInvites
description: Invite friends to telegram!
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: auth.sendInvites
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Invite friends to telegram!
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes|
|message|[string](../types/string.md) | The message to send | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.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();
$Bool = $MadelineProto->auth->sendInvites(['phone_numbers' => ['string', 'string'], 'message' => 'string', ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.sendInvites`
Parameters:
phone_numbers - Json encoded array of string
message - Json encoded string
Or, if you're into Lua:
```
Bool = auth.sendInvites({phone_numbers={'string'}, message='string', })
```
## Return value
If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead.
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_EMPTY|The provided message is empty|