MiniChat API

Текущая версия: 0.12.X Последнее обновление: 26.08.24

Для подключения к серверу чата следует использовать websocket соединение по адресу: ws://localhost:4848/Chat

Порт по умолчанию: 4848, но зависит от настройки в MiniChat.

Общий тип JSON сообщения:

{
  "Type": "EventType", // Тип события.
  "Data": {Object} // Полезные данные.
}

Типы событий (EventType):

• Unknown - По умолчанию, не используется.
• Message - Обычное сообщение.
• Live - Событие на сервисе (Отслеживание, подписка, подарок, рейд, хотс и т.д.).
• DeleteMessage - Удаление сообщения.
• UserBan - Постоянная блокировка пользователя.
• UserMute - Временная блокировка пользователя.
• SettingsTheme - Настройки темы.
• Await - Ожидание подключения к чату, если чат не перманентный.
• Connect - Подключение к сервису и информация о канале.
• State - Информация о чате сервиса. (Роли в чате, доступные методы для вызова).
• Reconnect - Переподключение к чату сервиса.
• Disconnect - Отключение от сервиса.
• NotFound - Не найден пользователь для подключения.
• UnknownError - Неизвестная ошибка.
• Speak - Синтез речи.
• Avatar - Аватар.

Обычное сообщение (Message):

{
  "Service": "Service", // Сервис.
  "GUID": "4da6dd37-158c-4c17-bf8c-2277d568417d", // Идентификатор сообщения.
  "Date": "1973-01-01T00:00:00.000+00:00", // Время получения сообщения. Время в формате ISO 8601 Extended.
  "UserName": "MegaXa", // Имя пользователя.
  "UserID": "0", // Идентификатор пользователя.
  "Color": "#323232", // Цвет имени пользователя.
  "Badges": [
    {
      "Text": "Новый спонсор",
      "Image": {
        "Default": "https://megaxa.ru/badge.png", // Ссылка на изображение бейджика.
        "Large": "https://megaxa.ru/badge2X.png" // Ссылка на увеличенное изображение бейджика.
      }
    }
  ],
  "MessageKit": [ // Конструктор сообщения.
    {
      "Type": "MessageKitType", // Тип части сообщения (Text, Emoticon, URL, Image, Sticker).
      "Data": {
        "Text": ":200IQ:", // Текст.
        "URL": "https://megaxa.ru/", // Ссылка (Image, URL, Sticker).
        "Image": {
          "Default": "https://megaxa.ru/emoticon.png",
          "Large": "https://megaxa.ru/emoticon2X.png"
        }
      }
    }
  ],
  "Avatar": {
    "Default": "https://megaxa.ru/avatar.png",
    "Large": "https://megaxa.ru/avatar2X.png"
  },
  "Roles": [ // Список ролей отправителя сообщения.
    "Owner",
    "Subscriber"
  ],
  "Reply": false, // Содержит ли сообщение обращение к владельцу канала.
  "Meta": { // Метаданные для сообщения.
    "Me": false, // Сообщение отправлено с тегом "/me" (Twitch).
    "Login": "megaxa", // Логин автора, если доступен.
    "Highlighted": false, // Выделенное сообщение.
    "Announcement": false, // Сообщение-анонс (Twitch).
    "FirstMessage": false // Первое сообщение от автора (Twitch. VKPlay).
  }
}

Список сервисов (Service):

• Unknown - По умолчанию.
• MiniChat
• Twitch
• YouTube
• GoodGame
• DonationAlerts
• VK
• DonatePay
• Nuum
• Steam
• Facebook
• OK
• Trovo
• Peka2
• DLive
• YouNow
• Tango
• Rutube
• Telegram
• Discord
• VKPlay
• Boosty
• QIWIDonate
• Donatty
• DonateStream
• Bigo
• Kick
• StreamEngine

Список типов для конструктора сообщения (MessageKitType):

• Unknown - По умолчанию.
• Text - Текст.
• Emoticon - Смайлик.
• URL - Ссылка.
• Image - Изображение.
• Sticker - Стикер.

Типы "Live"событий (LiveType):

• Follow
• UnFollow
• Subscription
• GiftSubscription
• Donation
• Reward
• Support
• Host
• Raid
• Winner
• Custom

Типы валют для "Live"событий типа "Reward" или "Support" (CurrencyType):

• ChannelPoints - "Баллы канала (Twitch)".
• Mana - "Мана (Trovo)".
• Lemon - "Лимоны (DLive)".
• Bits - "Bits (Twitch)".
• Elixir - "Эликсир (Trovo)".
• Diamond - "Алмазы (Bigo)".
• OK - "OK (Одноклассники)".

Удаление сообщения (DeleteMessage):

{
  "Type": "DeleteMessage",
  "Data": {
    "GUID": "00000000-0000-0000-0000-000000000000"
  }
}

Запрос на получение настроек виджета (WidgetProperties):

{
  "Type": "WidgetProperties", // Тип виджета (Chat, Widget, Plugin).
  "Data": {
    "Type": "Chat",
    "FolderName": "Dev", // Имя каталога с виджетом.
    "ID": 0 // Номер профиля виджета.
  }
}

Запрос на отправку сообщения (Message):

{
  "Type": "Message",
  "Data": {
    "Service": "Service",
    "Message": "Сообщение для отправки.",
    "Hide": false  // Не отображать отправленное сообщение в MiniChat.
  }
}

Запрос на отправку сообщения в MiniChat (Message):

{
  "Type": "Message",
  "Data": {
    "Service": "MiniChat",
    "UserName": "MegaXa",
    "Message": "Тест."
  }
}

Запрос на удаление сообщения (DeleteMessage):

{
  "Type": "DeleteMessage",
  "Data": {
    "Service": "Service",
    "GUID": "00000000-0000-0000-0000-000000000000"
  }
}

Запрос на блокировку пользователя (UserBan):

{
  "Type": "UserBan",
  "Data": {
    "Service": "Service",
    "UserID": "00000000"
  }
}

Запрос на временную блокировку пользователя (UserMute):

{
  "Type": "UserMute",
  "Data": {
    "Service": "Service",
    "UserID": "00000000",
    "Duration": 10 // На сколько поместить пользователя в тайм-аут. Если временная блокировка не поддерживается сервисом, то запрос игнорируется.
  }
}

Запрос на снаятие блокировки пользователя (UserUnban):

{
  "Type": "UserUnban",
  "Data": {
    "Service": "Service",
    "UserID": "00000000"
  }
}

Запрос на создание пользовательского события (Live):

{
  "Type": "Live",
  "Data": {
    "Type": "Custom",
    "Service": "MiniChat",
    "Title": "MegaXa", // Заголовок события.
    "Message": "Что-то получил.", // Сообщение события.
    "Data": { "Item": "" } // JSON объект c полезными данными.
  }
}

Также можно указать остальные стандартные поля (UserName, Avatar, UserID, Login и т.п.).

Запрос на синтез речи (Speak):

Актуальный список голосов можно получить из соответствующего виджета.

VoiceArray = [ 'Maxim', 'Tatyana', 'Alice', 'Marusia', 'Svetlana', 'Dmitry', 'Ermilov', 'Zahar', 'Jane', 'Alyss', 'Omazh', 'Oksana' ]

{
  "Type": "Speak",
  "Data": {
    "GUID": "00000000-0000-0000-0000-000000000000", // Идентификатор сообщения. Для идентификации ответа (Не обязательно).
    "Message": "Тест озвучки", // Текст сообщения.
    "Voice": "Голос", // Голос.
    "Pitch": "0" // Тон голоса (Если поддерживается, не обязательно).
  }
}

Пример:

{"Type":"Speak","Data":{"Voice":"Alice","Message":"1% 2% 3% 4% 5% 6% 7% 8% 9% 10%"}}

Запрос на получение истории (History):

{
  "Type": "History",
  "Data": {
    "Type": "Live", // Тип истории (Live).
    "Limit": 100, // Максимальное количество элементов.
    "Filter": {
      "Follow": false // Типы событий (Что не исключено) (По умолчанию возврат всех возможных типов).
    }
  }
}

Пример:

{"Type":"History","Data":{"Type":"Live","Limit":10,"Filter": {"Follow": false,"UnFollow": false}}}

Запрос на получение статистики (Statistics):

{
  "Type": "Statistics",
  "Data": {
    "Type": "Live", // Тип статистики (Live).
    "LiveType": "Unknown", // Если тип статистики "Live", то можно указать для фильтрации коллекции. Обязательный, если происходит фильтрация по специфичным свойствам события (Например по сумме поддержки).
    "Query": [
      {
        "Operator": "Count",
        "Expression": "UserName == @0",
        "Variables": ["MegaXa"]
      }
    ]
  }
}

Доступные операторы в данный момент: Where, Cast, GroupBy, Select, OrderBy, Reverse, Skip, Take, Count. Подробнее про работу Dynamic Linq можно почитать тут: Dynamic Linq

Примеры:

Получить количество донатов с определенного сервиса.
{"Type":"Statistics","Data":{"Type":"Live","Query":[{"Operator":"Count","Expression":"x => x.Service == @0","Variables":["DonationAlerts"]}]}}

Получить топ поддержаших за все время.
{"Type":"Statistics","Data":{"Type":"Live","LiveType":"Donation","Query":[{"Operator":"GroupBy","Expression":"UserName"},{"Operator":"Select","Expression":"new(Key as Name, Sum(Amount) as Amount)"},{"Operator":"OrderBy","Expression":"Amount"}]}}

Воспроизведение аудио (Playback):

Приходит, когда начинается и заканчивается воиспроизведение аудио, в данный момент только из MiniChat. Возможные состояния: None, Paused, Playing. Также возможно отправить запрос, например:

{"Type":"Playback","Data":{"Service":"MiniChat"}}

Ответ:

{
  "Type": "Playback",
  "Data": {
    "Service": "MiniChat",
    "State":"None"
  }
}

REST API:

Принимаются POST запросы на адрес http://localhost:4848/api

Формат как в случае с WebSockets. В данный момент поддерживаются: Message, DeleteMessage, UserBan, UserUnban, Speak (Речь будет отправлена в первый виджет синтеза речи).

PubSub:

Используется для взаимодействия плагинов друг с другом. Для подключения к серверу PubSub следует использовать WebSocket соединение по адресу: ws://localhost:4848/PubSub

Типы событий (PubSubType):

• Unknown - По умолчанию, зарезервирован.
• Subscribe - Подписаться на события.
• UnSubscribe - Отписаться от событий.
• Echo - Эхо (Вернуть запрос в клиент).
• Ping - Пинг.

При указании другого типа события данные будут отправлены всем подписавшимся клиентам на данное событие, например:

{"Type":"SoundPlay","Data":{"Play":"test.mp3"}}

Подписаться на события (Subscribe):

{
  "Type": "Subscribe",
  "Data": {
    "Events": [
      "SoundPlay",
      "SoundPause"
    ]
  }
}

Отписаться от событий (UnSubscribe):

{
  "Type": "UnSubscribe",
  "Data": {
    "Events": [
      "SoundPause"
    ]
  }
}

Ответ на событие Subscribe, UnSubscribe:

При успешном запросе вернется список с текущими подписками:

{"Type":"Subscribed","Data":{"Events":["SoundPlay","SoundPause"]}}

Вернуть данные в клиент (Echo):

{
  "Type": "Echo",
  "Data": {
    "Test": "Kappa"
  }
}

Пинг сервера (Ping):

{
  "Type": "Ping"
}