MadelineProto/old_docs/API_docs_v72/methods/contacts_deleteContacts.md

65 lines
1.3 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: contacts.deleteContacts
description: contacts.deleteContacts parameters, return type and example
---
## Method: contacts.deleteContacts
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|Array of [InputUser](../types/InputUser.md) | Yes|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### 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|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-11-15 13:41:58 +01: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-11-15 13:41:58 +01:00
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->contacts->deleteContacts(['id' => [InputUser], ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.deleteContacts`
Parameters:
id - Json encoded array of InputUser
Or, if you're into Lua:
```
Bool = contacts.deleteContacts({id={InputUser}, })
```