MadelineProto/old_docs/API_docs_v73/methods/auth_sendInvites.md
Daniil Gentili e4a326e552
Http refactor (#307)
* refactor

* Apply fixes from StyleCI

* Implement https and http transport, add support for new req_pq_multi, send pending acks and objects in containers along with the next method call, remove dependency on the socket extension.

* Apply fixes from StyleCI

* Make types with empty constructors optional, fix phar archives (fixes #217)

* Apply fixes from StyleCI

* Update to layer 75

* Update github pages gemfile.lock
2018-02-18 14:18:18 +01:00

1.7 KiB

title description
auth.sendInvites auth.sendInvites parameters, return type and example

Method: auth.sendInvites

Back to methods index

Parameters:

Name Type Required
phone_numbers Array of string Yes
message string Yes

Return type: Bool

Can bots use this method: NO

Errors this method can return:

Error Description
MESSAGE_EMPTY The provided message is empty

Example:

$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
    $MadelineProto->phone_login($number);
    $code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
    $MadelineProto->complete_phone_login($code);
}

$Bool = $MadelineProto->auth->sendInvites(['phone_numbers' => ['string'], 'message' => 'string', ]);

Or, if you're using the PWRTelegram HTTP API:

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 will be returned instead.