MadelineProto/old_docs/API_docs_v66/methods/auth_sendInvites.md

73 lines
1.7 KiB
Markdown
Raw Normal View History

2017-06-30 15:36:33 +02:00
---
title: auth.sendInvites
description: auth.sendInvites parameters, return type and example
---
## Method: auth.sendInvites
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-06-30 15:36:33 +02:00
|phone\_numbers|Array of [string](../types/string.md) | Yes|
|message|[string](../types/string.md) | Yes|
### Return type: [Bool](../types/Bool.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 |
|----------|---------------|
|MESSAGE_EMPTY|The provided message is empty|
2017-06-30 15:36:33 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-06-30 15:36:33 +02:00
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-06-30 15:36:33 +02:00
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$Bool = $MadelineProto->auth->sendInvites(['phone_numbers' => ['string'], 'message' => 'string', ]);
2017-06-30 15:36:33 +02:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
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/auth.sendInvites`
Parameters:
phone_numbers - Json encoded array of string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
message - 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
2017-06-30 15:36:33 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
Bool = auth.sendInvites({phone_numbers={'string'}, message='string', })
2017-06-30 15:36:33 +02:00
```
## 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.