MyChat Integration API: MCIAPI_CS_SendChannelMessage, надсилання повідомлення до конференції
Надіслати текстове повідомлення без оформлення шрифту в конференцію від імені довільного користувача. Цей користувач повинен бути онлайн і знаходитись у цій конференції.
Синтаксис
{
"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 |
користувач-відправник. Усталено — "0". Можна задавати UIN, email або нік користувача. Користувач обов'язково має бути учасником у конференції; |
|
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