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 |
необов'язковий параметр, будь-який текст, що повернеться у команді-відповіді; |
UsersList |
string |
список UIN-ів отримувачів повідомлення через кому; |
MustRead |
boolean |
повідомлення обов'язкове для прочитання; |
ReadNotify |
boolean |
повідомити відправника, коли одержувач прочитає оповіщення; |
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