MadelineProtoDocs/old_docs/API_docs_v82/methods/contacts_deleteContact.md

67 lines
1.4 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-12-26 02:56:50 +01:00
title: contacts.deleteContact
description: Delete a contact
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-12-26 02:56:50 +01:00
# Method: contacts.deleteContact
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-12-26 02:56:50 +01:00
Delete a contact
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2018-12-26 02:56:50 +01:00
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contact to delete | Optional|
2018-04-01 13:19:25 +02:00
2018-12-26 02:56:50 +01:00
### Return type: [contacts\_Link](../types/contacts_Link.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
### MadelineProto Example:
```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();
2018-12-26 02:56:50 +01:00
$contacts_Link = $MadelineProto->contacts->deleteContact(['id' => InputUser, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
2018-12-26 02:56:50 +01:00
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.deleteContact`
2018-04-01 13:19:25 +02:00
Parameters:
2018-12-26 02:56:50 +01:00
id - Json encoded InputUser
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```lua
2018-12-26 02:56:50 +01:00
contacts_Link = contacts.deleteContact({id=InputUser, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
2018-12-26 02:56:50 +01:00
|CONTACT_ID_INVALID|The provided contact ID is invalid|
2018-04-01 13:19:25 +02:00