Отримати коротку статистику працюючого сервера MyChat.

 

Синтаксис
{
  "cmd"       : "0012",
  "ServerKey" : "iddqd",
  "APIStype"  : "mydata",
  "context"   : "myfunc"
}

 

Параметри

Параметр

Тип

Значення

cmd

string

"0012", номер команди MCIAPI_CS_GetServerStat;

ServerKey

string

ключ Integration API, задається у налаштуваннях сервера;

APIStype

string

тип інтеграції. Можна задавати довільний рядок;

context

string

необов'язковий параметр, будь-який текст, що повернеться у команді-відповіді;

 


Результат роботи
{
  "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
}


Поле

Тип

Значення

cmd

string

HEX-номер команди, що була успішно виконана;

context

string

довільний текст, що був переданий серверу в команді запиту;

Uptime

integer

час безперервної роботи сервера за секунди;

Ver

string

повна версія сервера;

Started

string

дата запуску сервера у форматі "dd.mm.yyyy.hh.nn.ss";

Connections

integer

кількість активних підключень;

ErrorsScripts

integer

кількість помилок, що відбулися у скриптах під час роботи поточного сеансу сервера;

StatConfMsgCount

integer

кількість надісланих повідомлень у конференціях під час роботи поточного сеансу сервера;

MaxConnects

integer

максимально допустима кількість підключень до ліцензії;

StatBBSMsgCount

integer

повідомлення на дошці оголошень у поточному сеансі роботи сервера;

FTPPublicFolderSize

int64

загальний розмір папки з публічними файлами вбудованого сервера FTP;

OnlineUsers

integer

скільки зараз користувачів онлайн;

StatPrivMsgCount

integer

приватних повідомлень у поточному сеансі роботи сервера;

InTraffic

int64

загальний розмір вхідного трафіку сервера;

OutTraffic

int64

загальний розмір вихідного трафіку сервера (зазвичай ця цифра є кратно більшою);

NetInterfacesList

array

список локальних інтерфейсів сервера;

RegUsers

integer

скільки користувачів зареєстровано на сервері;

Free

boolean

true, якщо сервер безкоштовний, false — якщо комерційна ліцензія;

FTPUsersFoldersSize

int64

загальний розмір особистих FTP папок користувачів сервера;

MaxOnline

integer

максимальна кількість онлайн-підключень у поточному сеансі роботи сервера;

ServicesList

array

список працюючих сервісів MyChat Server з назвами, статусом, типом (udp/tcp), портами (або діапазонами) та іншою довідковою інформацією;

VerDate

string

дата релізу сервера у форматі "dd.mm.yyyy";

MyChatGuestInvites

integer

скільки всього було надіслано запрошень MyChat Guest;

RegBy

string

на кого зареєстровано сервер, якщо це комерційна версія;

StatBroadcastMsgCount

integer

скільки надіслано оповіщень у поточному сеансі роботи сервера;

ConfCount

integer

скільки конференцій створено.

 

Можливі помилки

#5, MCIAPI_Error_WrongIntegrationKey

#9, MCIAPI_Error_API_Disabled

#21, MCIAPI_Error_WrongData