MyChat Integration API: MCIAPI_CS_GetUINByNick, get a user UIN by his nickname

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.

 

Syntax

{

 "cmd"        : "0005",

 "ServerKey"  : "iddqd",

 "APIStype"   : "mydata",

 

 "Nick"       : "JohnSmith",

 "Domain"     : "",

 

 "AuthType"   : 0

}

 

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;

Nick

string

user nickname, this field is necessary and unique;

Domain

string

user's domain name. This parameter is used when a user uses domain authorization;

AuthType

integer

user authentication type, number.

 

Work result

{

 "cmd" : "0005",

 "UIN" : 17

}

 

Field

Type

Value

cmd

integer

HEX number of a command that was successfully executed;

UIN

integer

unique identifier of the found user (UIN).

 

Possible errors

#5, MCIAPI_Error_WrongIntegrationKey

#8, MCIAPI_Error_NickNotFound

 

See also

MCIAPI_CS_GetUINByEmail