Меню

Как настроить приемник сигналов iris callback api

Iris Callback API 2.0

С помощью Iris Callback API вы можете получать сигналы из бесед, на которые вы подписались. Это поможет вам обрабатывать информацию способом, который удобен для вас без каких-либо ограничений.

Для этого необходимо создать свой сервер, который будет принимать запросы от серверов Iris.

Исходные коды примеров Приёмника Iris Callback API здесь:

1. Регистрация API для пользователя

У вас должен быть адрес страницы, на которую Ирис будет отправлять сигналы.
Для этого вам нужно написать в л/с Ириса следующую команду:

<секретная_фраза>будет отправляться при каждом сигнале от Ириса. Её смысл в проверке достоверности запроса. Никому не говорите секретную фразу.
Синонимы команды: +сигналы, +апи

После успешной регистрации API для вашего пользователя, вы сможете подписываться на сигналы в конкретных беседах.

2. Подписка на сигналы в нужных беседах

Если вы являетесь администратором беседы, вы сможете подписаться на сигналы от беседы. Для этого вам необходимо в нужной беседе

Синонимы команды: +api, +апи, +дежурный

Проверить, кто дежурный в беседе можно командой «кто дежурный»

3. Структура сигналов Ириса

Сигналы от Ириса приходят в формате json. Структура объекта следующая:

  • user_id — id пользователя, который подписался на уведомления.
  • secret — секретная фраза, которая подтверждает достоверность
  • method — тип сигнала
  • object — информация, разной структуры для разных типов сигналов
  • message — информация о сообщении, в котором была вызвана команда

4. Перечень сигналов

Приведены названия типов сигналов (method) и описание их объектов (object).

Ирис отправляет этот сигнал для проверки доступности адреса, на который зарегистрирован Iris Callback API.

«banExpired»

Отправляется в случае истечения бана пользователя в беседе.

Структура object:

  • user_id — id пользователя, срок бана которого истёк
  • chat — код беседы, в которой произошло событие

«addUser»

Отправляется в случае команды «добавить @ссылка»

Структура object:

  • user_id — id пользователя, срок бана которого истёк
  • chat — код беседы, в которой произошло событие
  • source — необязательный параметр. Источник добавления. По умолчанию источник сигнала — беседа.
    Также сигнал может подаваться со страницы беседы на сайте iris-cm.ru (Значение «site»)

«subscribeSignals»

Отправляется в случае, если пользователь отправил в конкретной беседе команду подписаться на сигналы беседы.

Отправляется только 1 раз в конкретной беседе для конкретного пользователя. Задача пользователя привязать код беседы, передаваемый в сигнале к своему номеру беседы (обычно номер беседы в адресной строке) по реквизитам сообщения беседы.

Структура object:

  • chat — код беседы, в которой произошло событие
  • conversation_message_id — локальный id сообщения
  • text — текст передаваемого сообщения
  • from_id — автор сообщения

«deleteMessages»

Отправляется, когда модератор беседы ввёл команду удаления сообщений.

Структура object:

  • chat — код беседы, в которой произошло событие
  • local_ids — локальные идентификаторы сообщений в беседе
  • is_spam — пометить спамом при удалении

«deleteMessagesFromUser»

Отправляется, когда модератор беседы ввёл команду удаления сообщений для определённого пользователя.

Структура object:

  • chat — код беседы, в которой произошло событие
  • user_id — id пользователя, чьи сообщения нужно удалить
  • amount — количество последних сообщений пользователя. (необязательный параметр)
  • is_spam — пометить спамом при удалении. (необязательный параметр)

««deleteMessagesFromUser»

Отправляется, когда модератор беседы ввёл команду удаления сообщений для определённого пользователя.

Читайте также:  Как настроить управление блюстакс майнкрафт

Структура object:

  • chat — код беседы, в которой произошло событие
  • user_id — id пользователя, чьи сообщения нужно удалить
  • amount — количество последних сообщений пользователя. (необязательный параметр)
  • is_spam — пометить спамом при удалении. (необязательный параметр)

«printBookmark»

Отправляется, когда требуется получить сообщение из истории.

Структура object:

  • chat — код беседы, в которой произошло событие
  • conversation_message_id— локальные идентификаторы сообщений в беседе
  • description — подпись к заметке

«forbiddenLinks»

Отправляется, когда в беседе было обнаружено сообщение с запрещёнными ссылками.

Структура object:

  • chat — код беседы, в которой произошло событие
  • local_ids— локальные идентификаторы сообщений в беседе

««sendSignal»

Отправляется при команде «дежурный <произвольный текст>»

Структура object:

  • chat — код беседы, в которой произошло событие
  • from_id — id пользователя, вызвавшего сигнал
  • value — произвольный текст, переданный в команде после ключевого слова «сигнал»
  • conversation_message_id — локальный идентификатор сообщения в беседе

««sendMySignal»

Отправляется на сервис-приёмник Iris Callback API того пользователя, который вызвал команду.

Отправляется при команде «сигнал <произвольный текст>»

Структура object:

  • chat — код беседы, в которой произошло событие
  • from_id — id пользователя, вызвавшего сигнал
  • value — произвольный текст, переданный в команде после ключевого слова «сигнал»
  • conversation_message_id — локальный идентификатор сообщения в беседе

««hireApi»

Отправляется, когда владелец беседы хочет нанять приёмника сигналов от Ириса.

Структура object:

  • chat — код беседы, в которой произошло событие
  • price — число ирисок, которые пользователь готов заплатить

Сервер должен вернуть json объект либо успеха, в котором содержится поле «days», указывающее, на какое время продляется наём Приёмника ICA, либо ошибки.

««banGetReason»

Отправляется, когда модератор вызывает команду «причина» и хочет перейти на место выданного бана.

Структура object:

  • chat — код беседы, в которой произошло событие
  • group_id — группа, в которой нужно сделать пост
  • local_id — локальный id сообщения в беседе, место выдачи бана

««toGroup»

Отправляется, когда пользователь хочет отправить своему серверу команду отправить пост с пересланными сообщениями из беседы

Структура object:

  • chat — код беседы, в которой произошло событие
  • local_id — локальный id сообщения в беседе, место выдачи бана

Будут вопросы по работе Iris Callback API 2.0, обращайтесь к нам в л/с

Источник

Iris Callback API 2.0

С помощью Iris Callback API вы можете получать сигналы из бесед, на которые вы подписались. Это поможет вам обрабатывать информацию способом, который удобен для вас без каких-либо ограничений.

1. Регистрация API для пользователя

У вас должен быть адрес страницы, на которую Ирис будет отправлять сигналы.
Для этого вам нужно написать в л/с Ириса следующую команду:

<секретная_фраза>будет отправляться при каждом сигнале от Ириса. Её смысл в проверке достоверности запроса. Никому не говорите секретную фразу.
Синонимы команды: +сигналы, +апи

После успешной регистрации API для вашего пользователя, вы сможете подписываться на сигналы в конкретных беседах.

2. Подписка на сигналы в нужных беседах

Если вы являетесь администратором беседы, вы сможете подписаться на сигналы от беседы. Для этого вам необходимо в нужной беседе

Синонимы команды: +api, +апи, +дежурный

Проверить, кто дежурный в беседе можно командой «кто дежурный»

3. Структура сигналов Ириса

Сигналы от Ириса приходят в формате json. Структура объекта следующая:

Читайте также:  Как настроить свои чакры

  • user_id — id пользователя, который подписался на уведомления.
  • secret — секретная фраза, которая подтверждает достоверность
  • method — тип сигнала
  • object — информация, разной структуры для разных типов сигналов

4. Перечень сигналов

Приведены названия типов сигналов (method) и описание их объектов (object).

Ирис отправляет этот сигнал для проверки доступности адреса, на который зарегистрирован Iris Callback API.

«banExpired»

Отправляется в случае истечения бана пользователя в беседе.

Структура object:

  • user_id — id пользователя, срок бана которого истёк
  • chat — код беседы, в которой произошло событие

«addUser»

Отправляется в случае команды «добавить @ссылка»

Структура object:

  • user_id — id пользователя, срок бана которого истёк
  • chat — код беседы, в которой произошло событие

«subscribeSignals»

Отправляется в случае, если пользователь отправил в конкретной беседе команду подписаться на сигналы беседы.

Отправляется только 1 раз в конкретной беседе для конкретного пользователя. Задача пользователя привязать код беседы, передаваемый в сигнале к своему номеру беседы (обычно номер беседы в адресной строке) по реквизитам сообщения беседы.

Структура object:

  • chat — код беседы, в которой произошло событие
  • conversation_message_id — локальный id сообщения
  • text — текст передаваемого сообщения
  • from_id — автор сообщения

«deleteMessages»

Отправляется, когда модератор беседы ввёл команду удаления сообщений.

Структура object:

  • chat — код беседы, в которой произошло событие
  • local_ids — локальные идентификаторы сообщений в беседе

«printBookmark»

Отправляется, когда требуется получить сообщение из истории.

Структура object:

  • chat — код беседы, в которой произошло событие
  • conversation_message_id— локальные идентификаторы сообщений в беседе
  • description — подпись к заметке

Будут вопросы по работе Iris Callback API 2.0, обращайтесь к нам в л/с

Источник

Iris | Callback API

Iris | Чат-менеджер запускает инструмент для программистов Iris | Callback API

Острая необходимость в нём появилась после того, как ВКонтакте перестанет предоставлять сторонним приложениям доступ к блоку сообщений пользователей. Таким образом, не нарушая правил ВК мы больше не сможем легально предоставлять услугу обслуживания юзерботов.

Оглавление

Введение

Callback API — стандартный механизм оповещения сервера пользователя о событиях, произошедших в системе (в нашем случае системе Iris CM).

Вам необходимо предоставить адрес, на который будут отправляться запросы от сервиса Iris CM.

Настройка Iris Callback API

Шаг 1. Настроить скрипт обработки получения сообщений от сервиса Iris CM

По вашему адресу будут приходить сообщения в формате JSON. Общий вид полей каждого сообщения выглядит так:

  • type — тип сообщения (пока 2: confirmation, user_add)
  • userbot_id — id юзербота, для которого передаётся информация
  • secret — ключ подтверждения подлинности сообщения, привязанный к юзерботу. Его знает только сервис Iris CM и ваш сервер
  • object — данные сообщения

Типы сallback сообщений

Вам необходимо обработать всего 2 типа сообщений, которые будут приходить вам на сервер:

  • confirmation — подтверждение установки адреса для Callback API. В этом сообщении будет передаваться параметр «secret» (секретный ключ), который будет передаваться в будущих сообщениях для подтверждения подлинности сообщений.
    Параметр object не содержится
  • user_add — событие, которое уведомляет, что в беседу нужно добавить пользователя.
    Параметр object содержит поля:
    user_id — номер пользователя в системе ВК, которого нужно добавить в беседу;
    chat — единый код беседы. Он отправляется в момент команды установки юзербота в беседе. Либо его можно повторно запросить, введя от имени юзербота или модераторов рангом 4+ команду «код беседы»
Читайте также:  Как настроить получение адреса автоматически dhcp

После обработки данных, вам нужно отправлять в ответ текст «ok». Единственное исключение — ответ на сообщение типа confirmation, должен быть возвращением секретного ключа secret.

Простейший код скрипта выглядит так:

Шаг 2. Отправить команду на привязку беседы к адресу, обрабатывающему Callback API

Команда привязки юзербота к адресу обработки сообщений:

  • — адрес по которому вы расположили свой обрабатывающий скрипт из шага 2.

На этом пока всё. Инструмент пришлось создавать в срочном порядке. Надеемся на ваше понимание, если что-то пойдёт не так.

А также не знаем, что произойдёт после 15 февраля. Судьбоносный день. Готовимся как можем.

Источник



Подключение и настройка Callback API ВКонтакте

Что такое Callback API ВК вы уже знаете, теперь пришло время его подключить и настроить.

Подключение

Подключать можно только свои группы, то есть группы в которых вы являетесь администратором.

В вашей группе должны быть включены и разрешены сообщения. Если вы не знаете, как включить и разрешить сообщения в своей группе, просто посмотрите наш двухминутный ролик:

Видео: Как подключить Callback API ВКонтакте за 2 минуты

  1. Чтобы система вывела список администрируемых вами групп, авторизуйтесь, если вы еще не авторизованы.
  2. Выберите из списка нужную группу и нажмите кнопку «Подключить Callback API».

Это все, как видите ничего сложного в подключении нет. Если подключение прошло успешно, ваша группа отправит вам тестовое сообщение. Если у группы не получилось отправить вам сообщение, сервис покажет ошибку и подскажет как ее исправить.

Настройка

Настраивается Callback API еще проще, чем подключается, вы можете в этом убедиться посмотрев наш минутный ролик:

Видео: Как настроить Callback API ВКонтакте за 1 минуту

  1. Выберите из списка нужную группу и откройте вкладку «Настроить».
  2. Отметьте события о которых вас надо извещать и нажмите кнопку «Сохранить изменения».

Если вы настраивали уведомления на сервере ВКонтакте, вы можете импортировать эти настройки нажав на ссылку «загрузить настройки».

В любой момент вы можете изменить настройки или отключить группу от сервиса.

Модераторы

Вы можете подключить к сервису своих модераторов и тогда они тоже смогут получать уведомления о событиях в вашей группе.

  1. На вкладке «Модераторы» вставьте в форму адрес страницы модератора и нажмите кнопку «Подключить модератора»
  2. После того как модератор появится в списке, отправьте ему тестовое сообщение нажав кнопку «Тест».
  3. На вкладке «Настроить» отметьте события, о которых надо извещать модератора.

Фильтры

Чтобы админ(вы) и модераторы не получали лишних сообщений, мы добавили в настройки фильтры. По умолчанию фильтры включены, но для тестирования вы можете их отключить.

Помощь проекту

Вы пользуетесь нашим сервисом совершенно бесплатно и мы ничего не требуем от вас взамен. Проект не коммерческий, поэтому все расходы на его поддержку мы несем сами. Если у вас есть желание и возможность подержать наш проект финансово, мы будем очень признательны.

Источник