MyChat Integration API: MCIAPI_CS_AddBBSMessage, размещение сообщения на доске объявлений
Разместить сообщение на доске объявлений.
Синтаксис
{
"cmd" : "0008",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"context" : "myfunc",
"UserFrom" : "user@mycompany.com",
"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 |
пользователь-отправитель. Можно задавать UIN, email или ник обычного либо доменного пользователя (domain\login). Пользователь обязательно должен реально существовать. Если вы пропустите этот параметр, отправителем будет считаться встроенный робот с UIN = 0; |
Expired |
string |
дата и время актуальности объявления в формате "dd.mm.yyyy.hh.nn.ss". Если пропустить этот параметр (либо указать там неправильные данные), датой актуальности будет автоматически считаться последняя секунда текущих суток, после этого времени объявление будет автоматически перенесено в архив. Время указывается в UTC; |
Sticky |
boolean |
сделать объявление "прилепленным" (разместить выше всех на доске). Принимает значение true или false. Если не указать ничего, по умолчанию считается 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