MyChat Integration API: MCIAPI_CS_GetUINByNick получить UIN пользователя по нику
Функция для получения уникального числового идентификатора (UIN) зарегистрированного пользователя по его нику.
Ник или логин — это специальное имя пользователя, под которым он может войти в чат. Если это доменный пользователь, то нужно указать сначала домен через обратный слеш, вот так: "domain\login".
Если на сервере отключен запрет на дублирование ников, вы ищете обычного, не доменного пользователя, и ники у вас повторяются, то система найдёт первый попавшийся подходящий ник. Учитывайте этот момент.
Регистр букв не важен, "JohnSmith" и "johnsmith" считаются одинаковыми никами.
Синтаксис
{
"cmd" : "0005",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"context" : "myfunc",
"Nick" : "JohnSmith"
}
Параметры
|
Параметр |
Тип |
Значение |
|
cmd |
string |
"0005", номер команды MCIAPI_CS_GetUINByNick; |
|
ServerKey |
string |
ключ Integration API, задаётся в настройках сервера; |
|
APIStype |
string |
тип интеграции. Можно задавать произвольную строку; |
|
context |
string |
необязательный параметр, любой текст, который вернётся в ответной команде; |
|
Nick |
string |
ник пользователя, обязательное уникальное текстовое поле. Если пользователь доменный, то надо указать "domain\nick" через обратный слеш. |
Результат работы
{
"cmd" : "0005",
"сontext" : "myfunc",
"UIN" : 17
}
|
Поле |
Тип |
Значение |
|
cmd |
string |
HEX-номер команды, которая была успешно выполнена; |
|
context |
string |
произвольный текст, который был передан серверу в команде запроса; |
|
UIN |
integer |
уникальный идентификатор найденного пользователя (UIN). |
Возможные ошибки
#5, MCIAPI_Error_WrongIntegrationKey
#10, MCIAPI_Error_ParameterAbsent
#18, MCIAPI_Error_NickCannotBeEmpty
#43, MCIAPI_Error_UnknownDomainUser