MadelineProto/docs/API_docs/methods/contacts_getBlocked.md
2017-12-11 12:12:38 +01:00

60 lines
1.2 KiB
Markdown

---
title: contacts.getBlocked
description: contacts.getBlocked parameters, return type and example
---
## Method: contacts.getBlocked
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|limit|[int](../types/int.md) | Yes|
### Return type: [contacts\_Blocked](../types/contacts_Blocked.md)
### Can bots use this method: **NO**
### 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);
}
$contacts_Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.getBlocked`
Parameters:
offset - Json encoded int
limit - Json encoded int
Or, if you're into Lua:
```
contacts_Blocked = contacts.getBlocked({offset=int, limit=int, })
```