MyChat Integration API: MCIAPI_CS_GetUINByNick, get a user UIN by his nickname
Get a user UIN by his nickname.
A nickname or login is a special user's name used for entering the chat. If this is a domain user, this is his domain login (domain\login).
If the ban for duplication of nicknames is disabled on the server, you are looking for a regular (non-domain) user and your nicknames are repeated, then the system will find the first suitable nickname. Consider this moment.
Letter case does not matter, "JohnSmith" and "johnsmith" are the same nicknames.
Syntax
{
"cmd" : "0005",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"Nick" : "JohnSmith",
}
Parameters
|
Parameter |
Type |
Value |
|
cmd |
string |
"0005", the number of the command MCIAPI_CS_GetUINByNick; |
|
ServerKey |
string |
IntegrationAPI key, can be set in the server settings; |
|
APIStype |
string |
integration type. You can set any string; |
|
context |
string |
optional parameter, any text that returns in a response command; |
|
Nick |
string |
user nickname, this field is necessary and unique; |
Work result
{
"cmd" : "0005",
"UIN" : 17
}
|
Field |
Type |
Value |
|
cmd |
integer |
HEX number of a command that was successfully executed; |
|
context |
integer |
any text sent to the server in a query command; |
|
UIN |
integer |
unique identifier of the found user (UIN). |
Possible errors
#5, MCIAPI_Error_WrongIntegrationKey
#10, MCIAPI_Error_ParameterAbsent
#18, MCIAPI_Error_NickCannotBeEmpty
#43, MCIAPI_Error_UnknownDomainUser