MyChat Integration API: MCIAPI_CS_GetServerInfo, brief statistics about the working server
Get a bref statistics about working MyChat Server.
Syntax
{
"cmd" : "0012",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"context" : "myfunc"
}
Parameters
|
Parameter |
Тип |
Value |
|
cmd |
string |
"0012", number of the command MCIAPI_CS_GetServerStat; |
|
ServerKey |
string |
Integration API key that is set in the server's settings; |
|
APIStype |
string |
integration type. Random string is allowed; |
|
context |
string |
unnecessary parameter; any text that returns in the response command. |
Work result
{
"cmd": "0012",
"context": "myfunc",
"Uptime": 6807,
"Ver": "2023.4.2.5",
"Started": "01.08.2023.20.00.05",
"Connections": 0,
"ErrorsScripts": 0,
"StatConfMsgCount": 0,
"MaxConnects": 200,
"StatBBSMsgCount": 0,
"FTPPublicFolderSize": 0,
"OnlineUsers": 0,
"StatPrivMsgCount": 0,
"InTraffic": 0,
"NetInterfacesList": [
"192.168.1.26",
"192.168.199.1",
"192.168.22.1"
],
"RegUsers": 18148,
"Free": false,
"OutTraffic": 0,
"FTPUsersFoldersSize": 0,
"MaxOnline": 0,
"ServicesList": [
"autofind,true,udp,2004-2005,all",
"core,true,tcp,2004,all",
"ftp,true,tcp,20000-20100,all",
"web,true,tcp,443,all,http",
"turn,true,tcp/udp,8888,0.0.0.0",
"nodejs control,true,tcp,2015,127.0.0.1",
"email,true,tcp,587,smtp.dreamhost.com"
],
"VerDate": "21.07.2023",
"MyChatGuestInvites": 74,
"RegBy": "Network Software Solutions",
"StatBroadcastMsgCount": 0,
"ConfCount": 0
}
|
Field |
Type |
Value |
|
cmd |
string |
HEX of the command that was successfully executed; |
|
context |
string |
any text sent to a server as a request; |
|
Uptime |
integer |
time of the server's uninterruptible work in seconds; |
|
Ver |
string |
full server's version; |
|
Started |
string |
the date of the server launch in the format "dd.mm.yyyy.hh.nn.ss"; |
|
Connections |
integer |
number of active connections; |
|
ErrorsScripts |
integer |
number of errors occurred in scripts during the current server work session; |
|
StatConfMsgCount |
integer |
number of sent messages in conferences during a current server work session; |
|
MaxConnects |
integer |
maximum number of connections in a license; |
|
StatBBSMsgCount |
integer |
messages on the Bulletin board during the current work session; |
|
FTPPublicFolderSize |
int64 |
total folder size with public files of the built-in FTP server; |
|
OnlineUsers |
integer |
total number of online users; |
|
StatPrivMsgCount |
integer |
private messages in the current work session; |
|
InTraffic |
int64 |
total size of the server's incoming traffic; |
|
OutTraffic |
int64 |
total size of the server's outgoing traffic (usually this number is bigger); |
|
NetInterfacesList |
array |
list of local network interfaces on the server; |
|
RegUsers |
integer |
total nu,ber of registered users on the server; |
|
Free |
boolean |
true, if the server is free, false — if it is a commercial version; |
|
FTPUsersFoldersSize |
int64 |
total size of users' personal FTP folders on the server; |
|
MaxOnline |
integer |
maximum number of online connections in the current work session; |
|
ServicesList |
array |
list of MyChat working services with titles, statuses, types (udp/tcp), ports (or ranges) and other Help information; |
|
VerDate |
string |
the date of the server's release in the format "dd.mm.yyyy"; |
|
MyChatGuestInvites |
integer |
total number of sent invitations in MyChat Guest; |
|
RegBy |
string |
if a commercial version,to whom registered on; |
|
StatBroadcastMsgCount |
integer |
total number of sent notifications during the current work session; |
|
ConfCount |
integer |
total number of created conferences. |
Possible errors
#5, MCIAPI_Error_WrongIntegrationKey
Created with the Personal Edition of HelpNDoc: Streamline your documentation process with HelpNDoc's WinHelp HLP to CHM conversion feature