MyChat Integration API: MCIAPI_CS_SendPrivateMessage, отправить приватное сообщение
Отправить приватное сообщение любому пользователю MyChat.
Синтаксис
{
"cmd" : "0002",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"сontext" : "myfunc",
"UserFrom" : "0",
"UserTo" : "user@test.com",
"Msg" : "bla-bla-bla",
"MsgType" : 1
}
Поля "UserFrom" и "UserTo" не должны совпадать (нельзя отправить сообщение самому себе).
Пример адресной строки для браузера
http://192.168.10.1:8080/API/?data={"cmd":"0002","UserFrom":0,"UserTo":"user@test.com","MsgType":1,"Msg":"Hello from browser","APIStype":"mydata","context":"myfunc","ServerKey":"iddqd"}
Параметры
|
Параметр |
Тип |
Значение |
|
cmd |
string |
"0002", номер команды MCIAPI_CS_SendPrivateMessage; |
|
ServerKey |
string |
ключ Integration API, задаётся в настройках сервера; |
|
APIStype |
string |
тип интеграции. Можно задавать произвольную строку; |
|
context |
string |
необязательный параметр, любой текст, который вернётся в ответной команде; |
|
UserFrom |
string |
пользователь-отправитель. Можно задавать UIN, email, ник пользователя или доменный логин (domain\login). Если пропустить параметр, то будет использоваться UIN=0; |
|
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