MadelineProtoDocs/docs/API_docs/methods/contacts_deleteContacts.md

53 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: contacts.deleteContacts
description: Delete multiple contacts
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: contacts.deleteContacts
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Delete multiple contacts
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contacts to delete | Yes|
2018-04-01 13:19:25 +02:00
2019-06-24 15:45:02 +02:00
### Return type: [Updates](../types/Updates.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-06-24 15:45:02 +02:00
$Updates = $MadelineProto->contacts->deleteContacts(['id' => [InputUser, InputUser], ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-06-24 15:45:02 +02:00
Updates = contacts.deleteContacts({id={InputUser}, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|NEED_MEMBER_INVALID|The provided member is invalid|
|Timeout|A timeout occurred while fetching data from the bot|