MyChat Integration API: MCIAPI_CS_SendBroadcastMessage, отправить оповещение
Отправить оповещение для любого количества пользователей MyChat.
Синтаксис
{
"cmd" : "0013",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"context" : "myfunc",
"UserFrom" : "17",
"UsersList" : "6,14,21",
"MustRead" : true,
"ReadNofify" : false,
"ActualTo" : "2021.12.12.10.00.00",
"Msg" : "bla-bla-bla"
}
Параметры
Параметр |
Тип |
Значение |
cmd |
string |
"0013", номер команды MCIAPI_CS_SendBroacastMessage; |
ServerKey |
string |
ключ Integration API, задаётся в настройках сервера; |
APIStype |
string |
тип интеграции. Можно задавать произвольную строку; |
context |
string |
необязательный параметр, любой текст, который вернётся в ответной команде; |
UserFrom |
string |
UIN, email, ник либо "domain\login" пользователя-отправителя. Если не указать ничего, либо "0" — будет использоваться робот Elisa в качестве отправителя; |
UsersList |
string |
список UIN-ов получателей сообщения через запятую; |
MustRead |
boolean |
сообщение обязательно к прочтению, по умолчанию false, необязательный параметр; |
ReadNotify |
boolean |
уведомить отправителя, когда получатель прочитает оповещение, по умолчанию false, необязательный параметр; |
ActualTo |
string |
дата, до которой оповещение актуально, в формате "yyyy.mm.dd.hh.nn.ss". Если пропустить этот параметр (либо указать там неправильные данные), датой актуальности будет автоматически считаться последняя секунда текущих суток, после этого, если оно не будет получено пользователем, оповещение будет автоматически удалено. Время указывается в UTC; |
Msg |
string |
текст сообщения, можно многострочный, строки разделяются CRLF. |
Результат работы
{
"cmd" : "0013",
"context" : "myfunc",
"ID" : 1749,
"ActualTo" : "17.07.2023.18.00.00"
}
Поле |
Тип |
Значение |
cmd |
string |
HEX-номер команды, которая была успешно выполнена; |
context |
string |
произвольный текст, который был передан серверу в команде запроса; |
ID |
integer |
уникальный числовой идентификатор созданного оповещения; |
ActualTo |
string |
дата и время актуальности оповещения в формате "dd.mm.yyyy.hh.nn.ss" в UTC. |
Возможные ошибки
#5, MCIAPI_Error_WrongIntegrationKey
#26, MCIAPI_Error_WrongUINSList
#33, MCIAPI_Error_UserListIsEmpty
#43, MCIAPI_Error_UnknownDomainUser