MadelineProto/old_docs/API_docs_v71/methods/contacts_getBlocked.md

62 lines
1.3 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: contacts.getBlocked
description: Get blocked users
2017-10-14 11:50:46 +02:00
---
## Method: contacts.getBlocked
[Back to methods index](index.md)
Get blocked users
2017-10-14 11:50:46 +02:00
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-23 17:44:33 +01:00
|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched|
2018-03-20 16:42:05 +01:00
|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch|
2017-10-14 11:50:46 +02:00
### Return type: [contacts\_Blocked](../types/contacts_Blocked.md)
### Can bots use this method: **NO**
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';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-10-14 11:50:46 +02:00
$contacts_Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]);
```
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.getBlocked`
Parameters:
offset - Json encoded int
limit - Json encoded int
Or, if you're into Lua:
```
contacts_Blocked = contacts.getBlocked({offset=int, limit=int, })
```