1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-12 09:19:57 +01:00
MadelineProto/old_docs/API_docs_v71/methods/contacts_block.md

64 lines
1.2 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
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) | Optional|
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|
2017-10-14 11:50:46 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-10-14 11:50:46 +02: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-10-14 11:50:46 +02:00
$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, })
```