MadelineProtoDocs/old_docs/API_docs_v18/methods/contacts.importContacts.md

57 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: contacts.importContacts
2019-12-27 17:48:04 +01:00
description: Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info.
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/contacts_importContacts.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: contacts.importContacts
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
2019-12-27 17:48:04 +01:00
Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info.
2018-04-01 13:19:25 +02:00
2020-06-16 17:50:25 +02:00
Use [contacts.addContact](../methods/contacts.addContact.md) to add Telegram contacts without actually using their phone number.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|contacts|Array of [InputContact](../types/InputContact.md) | List of contacts to import | Yes|
|replace|[Bool](../types/Bool.md) | | Yes|
2018-04-01 13:19:25 +02:00
2019-12-27 18:25:37 +01:00
### Return type: [contacts.ImportedContacts](../types/contacts.ImportedContacts.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
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();
2019-12-27 18:25:37 +01:00
$contacts.ImportedContacts = $MadelineProto->contacts->importContacts(['contacts' => [InputContact, InputContact], 'replace' => Bool, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-12-27 18:25:37 +01:00
contacts.ImportedContacts = contacts.importContacts({contacts={InputContact}, replace=Bool, })
2018-04-01 13:19:25 +02:00
```
2020-06-16 17:50:25 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|