1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-14 21:26:55 +01:00
MadelineProto/docs/API_docs/methods/contacts_getBlocked.md

67 lines
1.5 KiB
Markdown

---
title: contacts.getBlocked
description: Get blocked users
---
## Method: contacts.getBlocked
[Back to methods index](index.md)
Get blocked users
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched|
|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch|
### Return type: [contacts\_Blocked](../types/contacts_Blocked.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';
// !!! 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();
$contacts_Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### 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, })
```