MyChat Integration API: MCIAPI_CS_GetServerInfo, довідкова інформація про сервер
Отримати коротку довідкову інформацію про сервер, що працює.
Можна використовувати для перевірки працездатності сервера MyChat у програмах моніторингу типу Zabbix.
Синтаксис
{
"cmd" : "000E",
"ServerKey" : "iddqd",
"APIStype" : "Zabbix",
"context" : "myfunc"
}
Параметри
Параметр |
Тип |
Значення |
cmd |
string |
"000E", номер команди 000E: MCIAPI_CS_GetServerInfo; |
ServerKey |
string |
ключ Integration API, задається у налаштуваннях сервера; |
APIStype |
string |
тип інтеграції. Можна задавати довільний рядок, наприклад, "Zabbix". |
context |
string |
необов'язковий параметр, будь-який текст, що повернеться у команді-відповіді; |
Результат роботи
{
"cmd" : "000E",
"context" : "myfunc",
"Name" : "Copper",
"AdminName" : "John Smith",
"AdminEmail" : "[email protected]",
"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 |
дата та час старту сервера у форматі "рік.місяць.день години:хвилини:секунди"; |
Uptime |
string |
час безперервної роботи сервера (аптайм) у форматі "дні: години: хвилини: секунди". |