MadelineProto/old_docs/API_docs_v66/methods/contacts_getBlocked.md

63 lines
1.2 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-06-30 15:36:33 +02:00
title: contacts.getBlocked
description: contacts.getBlocked parameters, return type and example
2016-12-20 13:15:22 +01:00
---
2017-06-30 15:36:33 +02:00
## Method: contacts.getBlocked
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-06-30 15:36:33 +02:00
|offset|[int](../types/int.md) | Yes|
|limit|[int](../types/int.md) | Yes|
2017-06-30 15:36:33 +02:00
### Return type: [contacts\_Blocked](../types/contacts_Blocked.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
2017-06-30 15:36:33 +02:00
$contacts_Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.getBlocked`
Parameters:
offset - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
limit - Json encoded int
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-06-30 15:36:33 +02:00
contacts_Blocked = contacts.getBlocked({offset=int, limit=int, })
```