MadelineProtoDocs/old_docs/API_docs_v81/methods/contacts_block.md

67 lines
1.3 KiB
Markdown
Raw Normal View History

2018-07-12 20:24:55 +02:00
---
title: contacts.block
description: Block a user
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: contacts.block
[Back to methods index](index.md)
Block a user
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to block | Optional|
2018-07-12 20:24:55 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```
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();
$Bool = $MadelineProto->contacts->block(['id' => InputUser, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.block`
Parameters:
id - Json encoded InputUser
Or, if you're into Lua:
```
Bool = contacts.block({id=InputUser, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CONTACT_ID_INVALID|The provided contact ID is invalid|