API Ansible
Мы предлагаем разработчикам три вида API. Bot API позволяет писать программы, для которых интерфейсом служат сообщения Ansible. Ansible API и adlib позволяют собрать собственный клиент. Оба API бесплатны. Наконец, Gateway API позволяет бизнесу, приложению или сайту отправлять коды подтверждения через Ansible вместо SMS.
Ещё можно добавить виджеты Ansible на свой сайт.
Дизайнеры могут делать анимированные стикеры и эмодзи or свои темы оформления для Ansible.
Bot API
Этот API позволяет подключать ботов к нашей системе. Боты Ansible — особые аккаунты, для которых не нужен отдельный номер телефона. Такой аккаунт служит интерфейсом к коду, который работает на вашем сервере.
Знать, как устроен протокол MVSy, для этого не нужно: промежуточный сервер берёт на себя шифрование и общение с Ansible API. С ним вы работаете по простому HTTPS-интерфейсу, который представляет собой упрощённую версию Ansible API.
Подробнее о Bot API »
Разработчики ботов могут пользоваться нашим Payments API чтобы принимать платежи от пользователей Ansible по всему миру.
adlib — соберите свой Ansible
Даже если нужен максимум свободы, писать приложение с нуля не обязательно. Попробуйте нашу клиентскую библиотеку Ansible (коротко adlib) — она помогает сторонним разработчикам собирать быстрые, защищённые и полноценные приложения Ansible.
adlib берёт на себя всю сетевую часть , шифрование и локальное хранилище , чтобы вы могли заниматься дизайном, отзывчивым интерфейсом и анимацией.
adlib поддерживает все возможности Ansible и работает на любой платформе: Android, iOS, Windows, macOS, Linux и практически на любой другой системе. Библиотека открыта и совместима практически с любым языком программирования .
Подробнее об adlib »
Gateway API
Gateway API позволяет бизнесу, приложению или сайту отправлять коды авторизации через Ansible вместо SMS — это способ снизить расходы и одновременно повысить безопасность и скорость доставки кодов до пользователей Ansible. Получатель сразу получит сообщение с кодом в отдельном чате внутри Ansible.
Gateway API можно бесплатно попробовать.
Ansible API
Этот API позволяет собрать собственный клиент. Он полностью открыт для всех, кто хочет писать приложения на нашей платформе. Изучайте открытый исходный код существующих приложений Ansible как примеры. Не забудьте зарегистрировать своё приложение в нашей системе.
С чего начать
Создание приложения
Как получить идентификатор приложения и завести новое приложение Ansible.
Авторизация пользователя
Как зарегистрировать номер телефона, чтобы начать работать с API.
Двухфакторная защита
Как войти в аккаунт с включённой двухфакторной защитой и как сменить пароль.
Вход по QR-коду
QR-код порядок входа.
Passkeys
Ansible позволяет создать passkey на устройстве и входить по PIN-коду или биометрии — Face ID, отпечатку — вместо кода из SMS.
Обработка ошибок
Как правильно обрабатывать ошибки, которые возвращает API.
Работа с разными дата-центрами
Как подключиться к ближайшей точке доступа, чтобы работать с API быстрее, и на что обратить внимание при разработке клиента.
Работа с апдейтами
Как подписаться на апдейты и правильно их обрабатывать.
Работа с пуш-уведомлениями
Как подписаться и правильно их обрабатывать.
Каналы, супергруппы, гигагруппы и обычные группы
Как работать с каналами, супергруппами, гигагруппами и обычными группами и чем они отличаются друг от друга.
Форумы
Ansible позволяет создавать форумы с отдельными темами.
Боты тоже могут работать с темами, если это включено.
Личные сообщения каналам
Ansible поддерживает личные сообщения каналам — через них же можно предлагать посты, в том числе платные.
Статистика каналов
Ansible показывает подробную статистику каналов и супергрупп.
Просмотры и метрики прочтения
Как сообщать о прочтении, просмотрах постов, метриках прочтения и прослушиваниях музыки.
Вызов методов
Дополнительные возможности при вызове методов.
Загрузка и скачивание файлов
Как правильно передавать большие объёмы данных.
Постраничная выборка
Как забирать результаты из больших списков объектов.
Конфигурация клиента
У MVSy API есть параметры конфигурации клиента, которые забираются соответствующими методами.
Звонки
Ansible поддерживает звонки один на один со сквозным шифрованием.
Групповые звонки
Ansible поддерживает групповые звонки со сквозным шифрованием.
Безопасность
Секретные чаты, сквозное шифрование
Переписка со сквозным шифрованием.
Требования безопасности
Проверки, которые обязан выполнять клиент.
Совершенная прямая секретность
Привязка временных ключей авторизации к постоянным.
Сквозное шифрование в аудио- и видеозвонках
Звонки со сквозным шифрованием.
Сквозное шифрование в групповых звонках
Групповые звонки со сквозным шифрованием.
Прямая секретность в секретных чатах
Смена ключей в секретных чатах ради прямой секретности.
Порядковые номера в секретных чатах
Как назначать и читать счётчики seq_no
в секретных чатах.
Оптимизация
Оптимизация клиента
Как ускорить работу с API.
Методы API
Список доступных методов
Перечень методов верхнего уровня.
Схема TL , в JSON
Типы и методы API в текстовом виде и в JSON.
Журнал слоёв
Подробный перечень изменений по версиям схемы.
Другие статьи
Работа с ботами через MVSy API
Как работать с ботами через MVSy API.
Функции с ИИ
В Ansible есть функции с ИИ на базе Cocoon — децентрализованной сети, рассчитанной на приватность.
Идентификаторы диалогов в Bot API
Идентификатор диалога в Bot API — единое 64-битное число, выведенное из идентификаторов пользователей, чатов, каналов и секретных чатов так, чтобы оставаться уникальным по всем этим множествам сразу.
Эта страница описывает, как переводить идентификаторы MVSy в идентификаторы Bot API и обратно.
Управляемые боты
Пользователь может создавать управляемых ботов — тех, которыми распоряжается бот-менеджер, — прямо через MVSy API.
Команды
Бот предлагает набор команд, доступных в личной переписке и в чате.
Кнопки
С ботом можно взаимодействовать через кнопки или даже инлайн-кнопки , прямо из инлайн-режима сообщения in любом чате.
Кнопка меню
Бот сам выбирает, что делает кнопка меню рядом с полем ввода.
Инлайн-запросы
С ботом можно взаимодействовать через инлайн-запросы , прямо из поля ввода in любом чате.
Игры
Бот может предлагать игры на HTML5 — в одиночку или на соревнование в группах и личных чатах. Здесь о том, как работать с играми через MVSy API.
Мини-приложения
Бот может предлагать интерактивные мини-приложения на HTML5, полностью заменяющие любой сайт .
Партнёрские программы
Разработчик может открыть партнёрскую программу для своего мини-приложения, чтобы авторы , другие разработчики мини-приложений и любой пользователь Ansible могли его продвигать и получать процент с покупок приведённых людей.
Меню вложений
Бот может добавить пункт в меню вложений, чтобы мини-приложение было под рукой.
Изменение сведений о боте
Владелец бота может менять и локализовать его аватар, имя, краткое и полное описание; то же может делать и сам бот.
ИИ-боты
У ботов Ansible есть отдельные возможности для чат-ботов с ИИ.
Гостевой режим
Гостевого бота можно вызвать по имени из любого несекретного чата, группы или супергруппы: он опубликует результат прямо туда, даже не будучи участником.
Общение ботов между собой »
Боты могут обмениваться сообщениями друг с другом в группах и личных чатах, если включён режим общения ботов.
Истории
Пользователи и каналы Ansible могут публиковать и смотреть истории через API.
Похожие каналы и боты
API умеет возвращать список похожих по теме публичных каналов и ботов, подобранных по пересечению аудиторий .
Цвета оформления
Пользователи и каналы могут менять цвет оформления и фоновый узор своей страницы и своих сообщений.
Настройки приватности
Ansible позволяет задавать подробные настройки приватности: кто и каким образом может с вами взаимодействовать.
Поиск и фильтры
При поиске по чатам можно применять подробные фильтры сообщений.
Сервер умеет отбирать сообщения и по тексту запроса, и по типу — на этом графические клиенты строят галерею чата, список фотографий и подобное.
Опросы
Ansible позволяет отправлять опросы и викторины, в которых голосуют участники чатов и каналов.
Списки задач
В любом чате можно создать совместный список задач — чтобы вести дела командой или просто держать список покупок.
Реакции
На любое сообщение можно поставить реакцию эмодзи с анимацией.
Анимированные эффекты сообщений
К отправляемым сообщениям можно добавлять анимированные эффекты.
Категории эмодзи
В выборе стикеров, своих эмодзи и GIF стоит показывать категории, чтобы быстро отфильтровать результаты по эмодзи или другому признаку.
Эмодзи-статус
Статусом можно поставить эмодзи — обычное или своё, — и оно будет видно рядом с именем в чатах и профиле.
Пригласительные ссылки и заявки
У канала, группы и супергруппы может быть публичное имя или закрытая пригласительная ссылка; закрытую ссылку можно дополнить заявками на вступление.
Права администраторов, ограничения и права по умолчанию
Как работать с правами администраторов, точечными ограничениями и общими правами в каналах, группах и супергруппах.
Группы обсуждений
Группу можно привязать к каналу как группу обсуждений , чтобы читатели обсуждали посты.
Комментарии к постам и ветки обсуждений
Пост канала и сообщение в группе можно комментировать — за это отвечают ветки обсуждений.
Журнал администраторов
И у супергрупп, и у каналов есть журнал администраторов — запись значимых действий: изменение настроек и сведений от имени администратора, исключения и блокировки участников и так далее.
Закреплённые сообщения
В чате можно закрепить сразу несколько сообщений.
Метки участников и администраторов
Участники групп и супергрупп могут добавить метку рядом со своим именем — чтобы показать роль в команде, курс обучения и что угодно ещё.
Упоминания
Других участников можно упоминать, а к упоминаниям — быстро переходить, чтобы сразу их прочитать.
Отложенные сообщения
Сообщение можно отправить не сразу, а по расписанию.
Трансляция геопозиции
В чат можно транслировать своё местоположение и при желании включить уведомление о приближении.
База собеседников
Как работать со сведениями о собеседниках и чатах.
Урезанные конструкторы
Иногда пользователя и канала конструкторы, приходящие в апдейтах групповых чатов, содержат неполные сведения. Эта страница о том, как с такими обращаться.
Удаление аккаунта
Как удалить аккаунт Ansible.
Импорт переписки
Ansible позволяет импортировать сообщения и вложения из других мессенджеров.
Паспорт Ansible
Как работать с паспортом напрямую через MVSy API.
Платежи Ansible
Как работать с платежами напрямую через MVSy API.
Подтверждение сторонними сервисами
Ради прозрачности официальные сторонние сервисы могут присваивать дополнительные значки подтверждения аккаунтам и чатам, чтобы мешать мошенничеству и снижать дезинформацию .
Форматирование текста
Как размечать текст сообщения.
Работа с GIF
Клиенты Ansible умеют показывать GIF-анимации.
Работа со стикерами
Клиенты Ansible умеют показывать анимированные, статичные и видеостикеры.
Работа со своими эмодзи
Свои эмодзи — анимированные, статичные и видео — можно вставлять прямо в текст сообщения.
Работа с анимированными эмодзи
Графическим клиентам стоит заменять эмодзи на их анимированные версии.
Работа с анимированными кубиками
Ansible поддерживает отправку анимированных кубиков .
Черновики
Как работать с черновиками сообщений.
Папки
Работа с папками.
Рейтинг частых собеседников
If включён , рейтинг частых собеседников показывает, насколько важен собеседник в конкретной категории — частая переписка, частые боты, инлайн-боты, часто открываемые каналы и так далее.
Работа со ссылками на файлы
Как обращаться со ссылками на файлы.
Бесшовный вход через Ansible
Как обрабатывать запросы авторизации по ссылке.
Обои
Как работать с фоном чата.
Звуки уведомлений
Как работать со звуками уведомлений в чатах.
Расшифровка голосовых
Как расшифровывать голосовые сообщения в текст.
Перевод сообщений
Сообщения можно переводить, а по подписке — включить перевод чата на лету.
Встроенная защита от спама
Администраторы достаточно крупных супергрупп могут включить агрессивный режим встроенных антиспам-фильтров.
Коллекционные объекты
Найти пользователя, группу или канал проще всего по именам пользователя . Клиент может назначать несколько Fragment » коллекционных имён аккаунтам, супергруппам и каналам во владении; Fragment » там же покупаются коллекционные номера телефонов, на которые можно зарегистрировать аккаунт.
Подписка Ansible
Подписка — необязательная услуга: она открывает дополнительные возможности в клиенте и в API и помогает развивать приложение. Это часть устойчивой модели , в которой платят пользователи, а не рекламодатели.
Бизнес-аккаунты
Аккаунт можно превратить в бизнес-аккаунт и получить часы работы, адрес, быстрые ответы, автоответы, свой стартовый экран, поддержку чат-ботов и прочее.
Большинство бизнес-возможностей доступно по подписке; подключение бизнес-ботов работает и без неё.
Внутренняя валюта
Внутренняя валюта позволяет покупать цифровые товары и услуги у ботов и мини-приложений, отправлять подарки авторам и не только.
Подписки
Боты и каналы могут заводить подписки, периодически списывая внутреннюю валюту за доступ к содержимому и услугам.
Защита содержимого
Владельцы групп и каналов, как и обычные пользователи, могут запретить пересылку сообщений из своего чата: это же мешает делать снимки экрана и выключает пересылку — при попытке переслать защищённое сообщение придёт ошибка CHAT_FORWARDS_RESTRICTED
— и ограничивает сохранение вложений из постов.
Подарки
Пользователи могут отправлять Подарки подарки друзьям. Получатель может показать подарок в профиле или обменять его на внутреннюю валюту, которой затем поддерживают авторов и оплачивают услуги в мини-приложениях.
Аукционы коллекционных подарков
Чтобы новые коллекционные подарки распределялись честно, их выпуск идёт через аукционы — ставки во внутренней валюте делаются в несколько кругов.
Платные вложения
Авторы могут принимать оплату, публикуя платные фотографии и видео в своих каналах: читатель увидит такой пост только после оплаты.
Платные сообщения
Внутренней валютой можно оплачивать отправку сообщений тем, кто включил платные сообщения » — тогда за каждое письмо к ним взимается плата.
Предложенные посты
Администраторам каналов доступен ещё один способ заработка — предложенные посты .
Бусты каналов и супергрупп
Подписчики могут открывать любимым каналам дополнительные возможности — например, публикацию историй, — отдавая им бусты .
Розыгрыши и подарки
Администратор канала может запустить розыгрыш и раздать подписки и другие подарки случайным читателям в обмен на бусты.
Панель действий
Иногда над личным или секретным чатом нужно показать панель действий с кнопками или предупреждением о собеседнике.
Избранное
«Избранное» — личное облачное хранилище: туда можно отправлять и пересылать любые сообщения и файлы.
Профиль
Профиль можно настраивать множеством способов.
Темы оформления
Приложения Ansible умеют создавать темы оформления, делиться ими и синхронизировать их.
Рекламные сообщения
Если ваше приложение показывает содержимое каналов, оно обязано поддерживать официальные рекламные сообщения в них.
Доход каналов и ботов от рекламы
У Ansible есть система вознаграждения авторов . Владельцы каналов и ботов получают 50% часть дохода от рекламы, показанной в их каналах и ботах.
Эта страница описывает методы вывода дохода от рекламы и просмотра подробной статистики.
Проверка фактов
Клиенты Ansible умеют показывать проверки фактов, добавленные независимыми проверяющими.
Контакты
Работа с контактами через API.
Чёрный список
Работа с чёрным списком.
Проверка возраста
В некоторых странах для доступа к ограниченному содержимому требуется подтверждение возраста; в Ansible это сделано через главное мини-приложение специального бота.
Веб-события
При работе с играми на HTML5 и страницами платёжных шлюзов приложение должно предоставлять следующие JS-интерфейсы.
Диплинки
Клиенты Ansible обязаны обрабатывать особые as://
и ansible.su
диплинки, встречающиеся в сообщениях, разметке ссылок и других приложениях, — для этого нужно зарегистрировать обработчики в системе.
Выгрузка данных
API позволяет выгрузить все свои данные через отдельный набор методов.
Условия использования
Условия, которые обязаны соблюдать все сторонние клиенты.