MyChat Integration API: MCIAPI_CS_SendChannelMessage, отправка сообщения в конференцию
Отправить сообщение в конференцию от имени произвольного пользователя. Он должен быть членом конференции.
Если нужно гарантированно отправить сообщение, но неизвестно, какая учётная запись будет присутствовать в той или иной конференции, то можно использовать встроенного робота (UIN=0).
Синтаксис
{
"cmd" : "0004",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"context" : "myfunc",
"UserFrom" : "0",
"UID" : 12,
"Msg" : "bla-bla-bla",
"MsgType" : 1
}
Параметры
Параметр |
Тип |
Значение |
cmd |
string |
"0004", номер команды MCIAPI_CS_SendChannelMessage; |
ServerKey |
string |
ключ Integration API, задаётся в настройках сервера; |
APIStype |
string |
тип интеграции. Можно задавать произвольную строку; |
context |
string |
необязательный параметр, любой текст, который вернётся в ответной команде; |
UserFrom |
string |
пользователь-отправитель. Можно задавать UIN, email, ник или доменный логин (domain\login). Пользователь обязательно должен реально присутствовать в конференции. Если пропустить параметр, то будет использоваться UIN=0 (не важно, есть робот в конференции или нет); |
UID |
integer |
уникальный числовой идентификатор текстовой конференции (UID). Можно посмотреть в списке активных конференций на сервере; |
Msg |
string |
текст сообщения; |
MsgType |
integer |
тип сообщения, необязательный параметр. Если тип сообщения — не простой текст, тогда в поле "Msg" будет JSON объект или многострочный текст. |
Результат работы
{
"сmd" : "0004",
"сontext" : "myfunc",
"UINFrom" : 0,
"UID" : 12
}
Поле |
Тип |
Значение |
cmd |
string |
HEX-номер команды, которая была успешно выполнена; |
context |
string |
произвольный текст, который был передан серверу в команде запроса; |
UINFrom |
integer |
уникальный идентификатор отправителя сообщения (UIN), который определил сервер по входящему параметру UserFrom; |
UID |
integer |
уникальный идентификатор текстовой конференции, куда было успешно отправлено сообщение. |
Возможные ошибки
#5, MCIAPI_Error_WrongIntegrationKey
#7, MCIAPI_Error_UserNotInChannel
#10, MCIAPI_Error_ParameterAbsent
#43, MCIAPI_Error_UnknownDomainUser