MadelineProto/docs/API_docs/methods/contacts_getBlocked.md

71 lines
1.4 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: contacts.getBlocked
description: contacts.getBlocked parameters, return type and example
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: contacts.getBlocked
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|:-------------:|---------:|
|offset|[int](../types/int.md) | Yes|
|limit|[int](../types/int.md) | Yes|
2016-12-19 18:35:27 +01:00
### Return type: [contacts\_Blocked](../types/contacts_Blocked.md)
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
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);
}
2016-12-21 10:40:30 +01:00
$contacts_Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]);
2017-02-13 04:33:06 +01:00
```
2017-07-23 16:11:02 +02:00
Or, if you're using [PWRTelegram](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - contacts.getBlocked
* params - {"offset":"int","limit":"int"}
```
### 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, })
```