Для запуска бота/сценария бота через API Sherlock Platform сначала надо авторизоваться. Для выполнения действия предназначен метод GET или POST контроллера Bots https://<sherlock_url>/API/V2/Bots/RunBot. Полученный токен надо передать в заголовке как Bearer Token.
Оба запроса принимают идентичные параметры в query строке:
requestId - идентификатор диалога для запуска бота
botId - идентификатор бота
botThemeId - идентификатор сценария. Опциональное значение. Если не указано, то бот запускается без конкретного сценария
botEventTypeId - идентификатор события бота. Для запуска сценария просто указывать пустое значение. При запуске бота может указываться значение в соответствии со списком ниже
text - сохраняется в переменную контекста бота System.Text до выполнения бота/сценария
Параметры botId и botThemeId можно найти в модуле боты:
Значения типов события бота:
[Description("Инициализация")]
Init = 1,
[Description("Сообщение клиента")]
ClientMessage = 2,
[Description("Сообщение оператора")]
OperatorMessage = 3,
[Description("Установка статуса")]
SetStatus = 4,
//[Description("Закрытие бота")]
//CloseBot = 5,
[Description("Постановка в очередь")]
Queuing = 5,
[Description("Передача оператору / начало диалога")]
TransferToOperator = 6,
[Description("Прочтение сообщения клиентом")]
ReadByClient = 7,
[Description("Запуск по таймеру")]
StartByTimer = 8,
[Description("Пользовательское/внешнее событие")]
// конкретный тип определяется переданным текстом. Системные варианты:
// SYSTEM_BLOCK - блокировка, SYSTEM_UNBLOCK - разблокирока
CustomEvent = 9,
[Description("Получен файл от клиента")]
FileReceived = 10,
[Description("Участник группы добавлен")]
MemberAdded = 11,
[Description("Участник группы удален")]
MemberRemoved = 12,
[Description("Событие окна чата")]
ChatWindowEvent = 13,
[Description("Переход по реферной ссылке")]
RefCodeEvent = 14,
[Description("Просмотр информации о канале")] // Например, в Viber при открытии окна канала до первого сообщения/подписки
Welcome = 15,
[Description("Запуск рассылки")]
Broadcast = 16,
[Description("Перезапуск бота")]
Restart = 17,
[Description("Запуск по кнопке")]
StartByButton = 18