MyChat Scripts Language: "Message types"
List of possible message types in MyChat.
UNICODE characters and special symbols (slashes, inverted commas, etc.) must be escaped in all JSON objects.
|
An image. The text is divided into lines by CRLF. The Symbols "//" and text after them is an explanation, and they are not in the message.
01baeef3a5b9c339aebf2511e9b5ab819df713be // SHA1 file hash Screenshot (Alexey Pikurov) 2020-12-09 19-12-39.png // filename 61959556.737768 // file's date and time stamp in UTC 94147 // file's size in bytes 1087x600 // image resolution in pixels |
|
A link for calling the function for MyChat automation. JSON object.
{ "ActionIdx" : 16 // action number ... // can be other fields, depends on action type } |
|
The link on the resource in a local network. JSON object. Example:
c:\folder\ d:\folder\file.txt Z:\ file:///E:/Doc/%D0%94%D0%BE%D0%BA/ \\COMP\Folder\ \\COMP\Folder\file.exe
"\\TOSHIBA-PC\test\mcclient77to8Test\7z.dll" "\\TOSHIBA-PC\backup\txt"
{ "Link" : "https://nsoft-s.com", // link text "Desc" : "blah-blah-blah" // link description. Unnecessary parameter, // when it's absent, insert description in the chat, // equal to the link text } |
|
Internet link. JSON object. Example:
http:// https:// ftp:// www.nsoft-s.com ya.ru domain.google internal.yandex домен.укр { "Link" : "https://nsoft-s.com", // link text "Desc" : "blah-blah-blah" // link description. Unnecessary parameter, // when it's absent, insert description in the chat, // equal to the link text }
|
9. MSG_TYPE_PREVIEW_CUSTOM_LINK
|
Common UNICODE multi-line text. This type is used when a command for Integration API message sending (e.g., MCIAPI_CS_SendPrivateMessage or MCIAPI_CS_SendChannelMessage) has no message type specified. |
|
Media call (voice or video). JSON object.
{ "UINFrom" : 17, // who called "UINTo" : 23, // who is the recipient "dtUTC" : "12.11.2019.17.37.55", // call date and time in UTC "Type" : 0, // call type (voice, video, screen sharing) "Duration" : 0, // call duration in seconds, // if 0, the call failed "State" : 0, // call status, constant, mediastate_.... "Error" : "", // error text, if any "UINFromClientType" : "win32", // application type, who called, can be empty "UINToClientType" : "android" // application type, the recipient, can be empty } |
13. MSG_TYPE_IGNORE
14. MSG_TYPE_SERVICE
17. MSG_TYPE_CONF_CHANGE_TOPIC
|
Punishment for a user for any action. JSON object.
{ "bantype" : 1, // ban type, 1 - sending messages is forbidden, // 2 - entering the conference is forbidden "reason" : "blah-blah-blah", // ban reason "banneduin" : 1, // UIN of the punished user "dtutcuntil" : "09.12.2020.20.54.56"} // date and time when the punishment expires, in UTC |
|
Kicking a user from a conference. JSON object.
{ "UIN" : 17 // ID of a kicked user "Display" : "John Smith" // displayed name of a kicked user } |
21. MSG_TYPE_COMMENT
|
Just a multi-line text; a comment that is not displayed in the WEB chat for website support, but visible in all MyChat applications. |
|
A notification about the event on the Kanban board. JSON object.
{ "Avatar": 1178101805, "UIN": 3, "Sex": 1, "OldStageName": "test stage", "TaskID": 641, "StageName": "in work", "DisplayName": "Andrey Rakov", "ProjectID": 12, "What": 4, // what happened: // 1: KANBAN_NOTIFY_TASK_ADDED // 2: KANBAN_NOTIFY_TASK_PERFORMER_CHANGED // 3: KANBAN_NOTIFY_COMMENT_ADDED // 4: KANBAN_NOTIFY_TASK_MOVED // 5: KANBAN_NOTIFY_TASK_CHANGED // 6: KANBAN_NOTIFY_TASK_DELETED // 7: KANBAN_NOTIFY_PROJECT_CLOSED // 8: KANBAN_NOTIFY_TASK_TAKEN "TaskName": "Bla-bla-bla" } |
23. MSG_TYPE_FILE
|
A file. A multi-line UNICODE text, divided by CRLF. Symbols "//" and the text after them is the explanation, and they not in the real message.
34ad8f64d45ae5e9f8f98aa66b13e8110a9a36d9 // SHA1 file hash C:\Users\hobit\OneDrive\Документы\документ.docx // name and a full path to the file on the sender's device 36201701.737550 // date and time stamp of a file in UTC 19149 // file's size in bytes |
|
Geographical position, JSON object.
{ "Address" : "Fastiv, Kyiv region., Ukraine, 08500", // address in text representation "Latitude" : "51.53543533", // Latitude "Longitude" : "47.55158556" // Longitude } |
25. MSG_TYPE_CONTACT
|
A contact in vCard format, JSON object.
{ "Name" : "Hobit", // contact name "Data" : "xurhdctkues5hmthm5yi8csd5y" // vCard-string } |
26. MSG_TYPE_AUDIO
27. MSG_TYPE_VIDEO
28. MSG_TYPE_ADM_DELETE_MESSAGE
|
Deleting any message by its index. A message is generated by the server only. JSON object.
{ "Type" : 0, // 0 - delete for all, 1 - delete for myself only "Idx" : 1745 // message index that should be deleted } |
|
A notification about the event on the built-in forum. JSON object.
{ "Avatar": 1178101805, "UIN": 3, "Sex": 1, "DisplayName": "Andrey Rakov", "PostID": 458, "Topic": "MyChat internal documentation", "What": 1, // whta happened: // 1: FORUM_NOTIFY_POST_CREATED // 2: FORUM_NOTIFY_POST_CHANGED "Path": "s8\/t10" } |
|
The conversation is redirected from one user to another. JSON object.
{ "UIN" : 17, // a user who you need to redirect to another user "UINTo" : 3, // a user to whom you redirect the conversation "UINFrom" : 6, // a user who perform redirect process "DisplayName" : "User1", "DisplayNameTo" : "Andy", "DisplayNameFrom" : "Alex" } |
31. MSG_TYPE_FORWARD
|
Clipboard content as an MS Excel spreadsheet text. Text strings are divided by CRLF. The symbols "//" and the text after them is the explanation and they not in the real message
819ce3ba3278be1e88086f177b82a3f65292f3e4 // SHA1 screenshot file hash Table data (Alexey Pikurov) 2020-12-09 23-32-21.png // screenshot file name 77541357.737768 // date and time stamp of a file in UTC 7148 // image file size in bytes 929x115 // image resolution in pixels Text // table text content by cells divided by tabs (#9) and string divided by CRLF |
33. MSG_TYPE_BARCODE
|
QR code or Barcode. JSON object.
{ "Data" : "https://nsoft-s.com/forum/", // barcode data "Body" : "kdjfnbgsk,sjdngfkjdnfgkjdnkgdg", // inage, PNG 128х128 "Format" : "AZTEC" // format } |
|
A link to the common folder on the FTP server. If the Link is empty, move to the root folder. Make a link on the folder on a specific file located on the public FTP server. JSON object.
{ "Link" : "" // link text } |
|
The link to the personal FTP. If the Link is empty, move to the root folder. Make a link on the folder on a specific file located on the public FTP server. JSON object.
{ "Link" : "", // link text "UIN" : 17 // owner ID of the private FTP account } |
|
A link to the text conference, JSON object.
{ "name" : "my conference", // conference name "conftype" : 1 // conference type, 1 - common, 2 - secured by password, 3 - hidden } |
37. MSG_TYPE_CLEAR_TEXT_WINDOW
|
Clear the chat window completely; only works in chats; displayed as a technical message when viewing the history, and the window is not cleared. JSON object.
{ "Total" : false // false - clear the chat for a sender only, // true - clear for both dialogue participants // or for all members of the text conference } |
38. MSG_TYPE_CONF_JUST_CREATED
|
Information about the created conference and invited members, JSON object.
{ "Name" : "Conference", // conference name at the moment of its creation "Topic" : "blah-blah-blah", // conference topic
"ConfType" : 1, // conference type: 1 - common, 2 - зsecured by password, // 3 - hidden, via invite only
"JoinUsers":"17,1,3" // invited users. This parameter can be absent // or empty. It means, // that nobody was invited } |
|
Incoming broadcast, JSON object.
{ "Msg": "Test message with some files", // broadcast text "Files": [ // array of files attached to the broadcast, can be empty { "UTCWriteTime": "81201711.737768", "OriginalFileName": "free_serv_versions.sql", "Size": 6219, "Hash": "5c8c5f2629aa17504fbcef3783f8edbfc411e41f" }, { "UTCWriteTime": "81206099.737768", "OriginalFileName": "web_clients.sql", "Size": 1714, "Hash": "673223386a1c811aaee2c497de2746cde09f654b" } ] } |
40.
|
|
41.
|
|
42.
|
|
43.
|
|
44.
|
|
45.
|
|
46.
|
|
47.
|
|
48. MSG_TYPE_MYCHAT_GUEST_SENT
|
A user was successfully invited to the chat via the service MyChat Guest, JSON object.
{ "Email" : "test@test.com", // user's email;
"UserName" : "User1", // username "Link" : "https://......", // the link for entering the chat "in one click" "dtUTC" : "2021.08.17.15.44.27", // date and time in UTC, expiration time in the format year.month.day.hours.minutes.seconds "Type" : 1, // invitation type, 0 one-time, 1 reusable "UID" : 17, // conference ID, if a user is invited not in a private dialogue. Otherwise, -1 "ConfName" : "TestConf" // name of the conference with an invited user. It can be empty if UID = -1 } |
49. MSG_TYPE_CONF_PERSONAL_MESSAGE
|
Text message for a list of users or one specific person in a conference; JSON object
{ "Text" : "Bla-bla-bla", // message text "Users" : "17,2,194" // message recipients; who must show this message. Others just skip it "ShowTop" : false, // show application window on top of all windows "Switch" : true // force switching to a conference } |