MadelineProtoDocs/old_docs/API_docs_v18/methods/auth.sendInvites.md

59 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: auth.sendInvites
2020-06-16 17:50:25 +02:00
description: auth.sendInvites parameters, return type and example
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/auth_sendInvites.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: auth.sendInvites
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
### Parameters:
2020-06-16 17:50:25 +02:00
| Name | Type | Required |
|----------|---------------|----------|
|phone\_numbers|Array of [string](../types/string.md) | Yes|
|message|[string](../types/string.md) | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
2019-08-15 20:25:16 +02:00
### Can bots use this method: **YES**
2018-04-01 13:19:25 +02:00
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();
$Bool = $MadelineProto->auth->sendInvites(['phone_numbers' => ['string', 'string'], 'message' => 'string', ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
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.
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 |
|------|----------|---------------|
|400|MESSAGE_EMPTY|The provided message is empty|
2018-04-01 13:19:25 +02:00