Получить краткую справочную информацию о работающем сервере.

 

Можно использовать для проверки работоспособности сервера MyChat в программах мониторинга типа Zabbix.

 

Синтаксис

{
  "cmd"       : "000E",
  "ServerKey" : "iddqd",
  "APIStype"  : "Zabbix",
  "context"   : "myfunc"
}

 

Параметры

Параметр

Тип

Значение

cmd

string

"000E", номер команды MCIAPI_CS_GetServerInfo;

ServerKey

string

ключ Integration API, задаётся в настройках сервера;

APIStype

string

тип интеграции. Можно задавать произвольную строку, например "Zabbix";

context

string

необязательный параметр, любой текст, который вернётся в ответной команде.

 

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

{
  "cmd"        : "000E",
  "context"    : "myfunc",
  "Name"       : "Copper",
  "AdminName"  : "John Smith",
  "AdminEmail" : "admin@company.com",
  "AdminWWW"   : "www.company.com",
  "ConnectMsg" : "Hello everybody!",
  "Started"    : "2023-07-19 18:44:35",
  "Uptime"     : "0:03:02:40"
}

 

Поле

Тип

Значение

cmd

string

HEX-номер команды, которая была успешно выполнена;

context

string

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

Name

string

название сервера MyChat;

AdminName

string

имя администратора сервера;

AdminEmail

string

адрес электронной почты администратора сервера;

ConnectMsg

string

сообщение-приветствие сервера MyChat для подключающихся пользователей;

Started

string

дата и время старта сервера в ISO формате "год-месяц-день часы:минуты:секунды";

Uptime

string

время непрерывной работы сервера (аптайм) в формате "дни:часы:минуты:секунды".

 

Возможные ошибки

#5, MCIAPI_Error_WrongIntegrationKey

#9, MCIAPI_Error_API_Disabled

#21, MCIAPI_Error_WrongData