MadelineProtoDocs/old_docs/API_docs_v29/methods/contacts.resolveUsername.md

59 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
title: contacts.resolveUsername
description: Resolve a @username to get peer info
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-06-16 17:50:25 +02:00
redirect_from: /API_docs/methods/contacts_resolveUsername.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: contacts.resolveUsername
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Resolve a @username to get peer info
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|username|[string](../types/string.md) | @username to resolve | Yes|
2018-04-01 13:19:25 +02:00
2020-06-16 17:50:25 +02:00
### Return type: [contacts.ResolvedPeer](../types/contacts.ResolvedPeer.md)
2018-04-01 13:19:25 +02:00
2019-08-15 20:25:16 +02:00
### Can bots use this method: **YES**
2018-04-01 13:19:25 +02:00
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-06-16 17:50:25 +02:00
$contacts.ResolvedPeer = $MadelineProto->contacts->resolveUsername(['username' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
contacts.ResolvedPeer = contacts.resolveUsername({username='string', })
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 |
|------|----------|---------------|
2020-06-16 17:50:25 +02:00
|400|CONNECTION_LAYER_INVALID|Layer invalid|
|400|USERNAME_INVALID|The provided username is not valid|
|400|USERNAME_NOT_OCCUPIED|The provided username is not occupied|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
2019-12-27 17:48:04 +01:00
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
2020-06-16 17:50:25 +02:00
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
2018-04-01 13:19:25 +02:00