MadelineProtoDocs/old_docs/API_docs_v42/methods/account.unregisterDevice.md

56 lines
2.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: account.unregisterDevice
2019-12-27 17:48:04 +01:00
description: Deletes a device by its token, stops sending PUSH-notifications to it.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/account_unregisterDevice.html
2018-04-01 13:19:25 +02:00
---
2020-09-12 12:47:38 +02:00
# Method: account.unregisterDevice
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-09-12 12:47:38 +02:00
2019-12-27 17:48:04 +01:00
Deletes a device by its token, stops sending PUSH-notifications to it.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|token\_type|[int](../types/int.md) | Device token type.<br>**Possible values**:<br>`1` \- APNS (device token for apple push)<br>`2` \- FCM (firebase token for google firebase)<br>`3` \- MPNS (channel URI for microsoft push)<br>`4` \- Simple push (endpoint for firefox's simple push API)<br>`5` \- Ubuntu phone (token for ubuntu push)<br>`6` \- Blackberry (token for blackberry push)<br>`7` \- Unused<br>`8` \- WNS (windows push)<br>`9` \- APNS VoIP (token for apple push VoIP)<br>`10` \- Web push (web push, see below)<br>`11` \- MPNS VoIP (token for microsoft push VoIP)<br>`12` \- Tizen (token for tizen push)<br><br>For `10` web push, the token must be a JSON-encoded object containing the keys described in [PUSH updates](https://core.telegram.org/api/push-updates) | Yes|
|token|[string](../types/string.md) | Device token | Yes|
2020-09-12 12:47:38 +02:00
|other\_uids|Array of [int](../types/int.md) | List of user identifiers of other users currently using the client | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2020-09-12 12:47:38 +02:00
$Bool = $MadelineProto->account->unregisterDevice(['token_type' => int, 'token' => 'string', 'other_uids' => [int, int], ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-09-12 12:47:38 +02:00
Bool = account.unregisterDevice({token_type=int, token='string', other_uids={int}, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|TOKEN_INVALID|The provided token is invalid|
2018-04-01 13:19:25 +02:00