MyChat Integration API: MCIAPI_CS_AddBBSMessage, розміщення повідомлення на дошці оголошень
Розмістити повідомлення на дошці оголошень.
Синтаксис
{
"cmd" : "0008",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"context" : "myfunc",
"UserFrom" : "[email protected]",
"Expired" : "10.07.2023.17.34.15",
"Sticky" : false,
"Msg" : "bla-bla-bla"
}
Параметри
Параметр |
Тип |
Значення |
cmd |
string |
"0008", номер команди MCIAPI_CS_AddBBSMessage; |
ServerKey |
string |
ключ Integration API, задається у налаштуваннях сервера; |
APIStype |
string |
тип інтеграції. Можна задавати довільний рядок; |
context |
string |
необов'язковий параметр, будь-який текст, що повернеться у команді-відповіді; |
UserFrom |
string |
Користувач-відправник. Усталено — "0". Можна задавати UIN, email або нік користувача. Користувач обов'язково має реально існувати. Якщо ви пропустите цей параметр, відправником буде вважатися вбудований робот із UIN = 0; |
Expired |
string |
дата та час актуальності оголошення у форматі "dd.mm.yyyy.hh.nn.ss". Якщо пропустити цей параметр, датою актуальності буде вважатися остання секунда поточної доби, після чого оголошення буде автоматично перенесено в архів; |
Sticky |
boolean |
зробити оголошення "приліпленим" (розмістити вище за всіх на дошці). Приймає значення true чи false; |
Msg |
string |
текст повідомлення. |
Результат роботи
{
"сmd" : "0008",
"context" : "myfunc",
"UINFrom" : 1954,
"Expired" : "19.07.2023.23.59.59"
}
Поле |
Тип |
Значення |
cmd |
string |
номер команди, що була успішно виконана; |
context |
string |
довільний текст, що був переданий серверу в команді запиту; |
UINFrom |
integer |
отриманий унікальний ідентифікатор відправника повідомлення (UIN). |
Expired |
string |
дата та час закінчення дії оголошення у форматі "dd.mm.yyyy.hh.nn.ss" в UTC. |
Можливі помилки
#5, MCIAPI_Error_WrongIntegrationKey
#43, MCIAPI_Error_UnknownDomainUser