MyChat Integration API: MCIAPI_CS_GetUsersStatusList, get a list of user network statuses

MyChat Integration API: MCIAPI_CS_GetUsersStatusList, get a list of user network statuses

Get a list of statuses (online, offline, do not disturb, away) for a specified list of users.

 

Syntax

{

 "cmd"        : "000F",

 "ServerKey"  : "iddqd",

 "APIStype"   : "mydata",

 

 "UINS"       : "17,13,18,99,165"

}

 

Параметры

Parameter

Type

Value

cmd

string

"000F", number of the command MCIAPI_CS_GetUsersStatusList;

ServerKey

string

IntegrationAPI key, can be set in the server settings;

APIStype

string

integration type. You can set any string;

UINs

string

list of user numeric identifiers which status you need to obtain.

 

Результат работы

{

"Cmd"      : 15,

"UINS"     : "17,13,18,99,165"

"Statuses" : "-1,-1,0,1,2"

}

 

Field

Type

Value

Cmd

integer

number of a command that was successfully executed, equal to 15 (HEX 000F);

UINs

string

list of user numeric identifiers divided by commas;

Statuses

string

list of user statuses divided by commas. If non-existent identifiers are present in the user UIN list, then the server returns the "-1" value for them (offline).

 

Possible errors

MCIAPI_Error_UINSIsNotDefined

MCIAPI_Error_WrongIntegrationKey

MCIAPI_Error_WrongUINSList

 

See also

MCIAPI_CS_GetUINByNick