MyChat Integration API: MCIAPI_CS_SendPrivateMessage, надіслати приватне повідомлення
Надіслати текстове приватне повідомлення будь-якому користувачеві MyChat.
Синтаксис
{
"cmd" : "0002",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"сontext" : "myfunc",
"UserFrom" : "0",
"UserTo" : "[email protected]",
"Msg" : "bla-bla-bla",
"MsgType" : 1
}
Поля "UserFrom" та "UserTo" не повинні збігатися (не можна надіслати повідомлення самому собі).
Параметри
|
Параметр |
Тип |
Значення |
|
cmd |
string |
"0002", номер команди MCIAPI_CS_SendPrivateMessage; |
|
ServerKey |
string |
ключ Integration API, задається в налаштуваннях сервера; |
|
APIStype |
string |
тип інтеграції. Можна задавати довільний рядок; |
|
context |
string |
необов'язковий параметр, будь-який текст, що повернеться у команді-відповіді; |
|
UserFrom |
string |
користувача-відправник. Усталено: "0". Можна задавати UIN, email або нік користувача; |
|
UserTo |
string |
отримувач повідомлення. Можна задавати UIN, email або нік користувача; |
|
Msg |
string |
текст повідомлення; |
|
MsgType |
integer |
тип повідомлення, необов'язковий параметр. Якщо тип повідомлення - не простий текст, тоді в Msg буде об'єкт JSON або багаторядковий текст. |
Результат роботи
{
"cmd" : "0002",
"context" : "myfunc",
"UINTo" : 17,
"State" : 0
}
|
Поле |
Тип |
Значення |
|
cmd |
string |
HEX-номер команди, що була успішно виконана; |
|
context |
string |
довільний текст, що був переданий серверу в команді запиту; |
|
State |
integer |
поточний мережевий статус отримувача повідомлення; |
|
UINTo |
integer |
унікальний ідентифікатор отримувача повідомлення, UIN. |
Можливі помилки
#2, MCIAPI_Error_WrongSenderUser
#3, MCIAPI_Error_WrongReceiverUser
#5, MCIAPI_Error_WrongIntegrationKey
#11, MCIAPI_Error_WrongDomainUserReceiver
#12, MCIAPI_Error_WrongDomainUserSender
#17, MCIAPI_Error_CantSendMessageToSelf