MadelineProto/old_docs/API_docs_v71/methods/contacts_block.md

71 lines
1.4 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: contacts.block
description: Block a user
2017-10-14 11:50:46 +02:00
---
## Method: contacts.block
[Back to methods index](index.md)
Block a user
2017-10-14 11:50:46 +02:00
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to block|
2017-10-14 11:50:46 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CONTACT_ID_INVALID|The provided contact ID is invalid|
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-10-14 11:50:46 +02:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-10-14 11:50:46 +02:00
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
2017-10-14 11:50:46 +02:00
$Bool = $MadelineProto->contacts->block(['id' => InputUser, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-10-14 11:50:46 +02:00
### 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, })
```