mirror of
https://github.com/danog/MadelineProto.git
synced 2024-12-15 10:36:54 +01:00
64 lines
1.2 KiB
Markdown
64 lines
1.2 KiB
Markdown
---
|
|
title: contacts.block
|
|
description: contacts.block parameters, return type and example
|
|
---
|
|
## Method: contacts.block
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
### Parameters:
|
|
|
|
| Name | Type | Required |
|
|
|----------|---------------|----------|
|
|
|id|[InputUser](../types/InputUser.md) | Yes|
|
|
|
|
|
|
### Return type: [Bool](../types/Bool.md)
|
|
|
|
### Can bots use this method: **NO**
|
|
|
|
|
|
### Errors this method can return:
|
|
|
|
| Error | Description |
|
|
|----------|---------------|
|
|
|CONTACT_ID_INVALID|The provided contact ID is invalid|
|
|
|
|
|
|
### Example:
|
|
|
|
|
|
```
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
|
$MadelineProto->session = 'mySession.madeline';
|
|
if (isset($number)) { // Login as a user
|
|
$MadelineProto->phone_login($number);
|
|
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
|
|
$MadelineProto->complete_phone_login($code);
|
|
}
|
|
|
|
$Bool = $MadelineProto->contacts->block(['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.block`
|
|
|
|
Parameters:
|
|
|
|
id - Json encoded InputUser
|
|
|
|
|
|
|
|
|
|
Or, if you're into Lua:
|
|
|
|
```
|
|
Bool = contacts.block({id=InputUser, })
|
|
```
|
|
|