Создание и использование slash-commands
В пространстве должно быть разрешено создание слеш-команд
Слеш-команды - это специальные команды, которые можно активировать введя команду и добавив префикс /
. Когда вы вызываете такую команду, сервер отправляет запрос на ваш веб-сервер.
Для создания бота в Time, выполните следующие шаги:
-
Откройте меню (𓃑) слева вверху и выберите "Integrations".
-
В открывшемся меню выберите "Slash-Commands". Это позволит вам перейти к созданию новой команды.
-
Нажмите "Add Slash Command". Это действие откроет форму для создания новой команды.
-
Настройте параметры команды.
-
После создания команды, будет выдан его токен. Благодаря токену, вы можете убедиться, что взаимодействие с интеграцией происходит от достоверного источника
-
Сохраните токен, так как вы не сможете посмотреть его повторно.
В запросе будут содержаться параметры запроса. В зависимости от настроек слеш-команды:
- Метод отправки:
GET
— будут отправлены Query параметры в URL - Метод отправки
POST
— будут отправлены Query параметры вBody
запроса сContent-Type: application/x-www-form-urlencoded
Пример структуры запроса:
Имя | Тип | Описание | Пример |
---|---|---|---|
channel_id | string | ID канала в котором была вызвана команда | 9ayyzd4nciyc3ptamsk6g4s3dy |
channel_name | string | Название канала в котором была вызвана команда | Town Square |
command | string | Использованная команда | /help |
response_url | string | URL ответа | https://time.tbank.ru/hooks/commands/7manpact9pnf5kwy45fo5qy7rw |
team_domain | string | Название пространства | T-Bank |
team_id | string | ID пространства | w3in81d847bs9dpc8agfnympnr |
text | string | Написанный после команды текст | Hello! |
token | string | Токен слеш-команды, который используется для валидации запроса | dzcnm3gn97rypfrc8ncpzs58ah |
user_id | string | ID вызвавшего команду пользователя | 9ugwhafrbbro9pgjn1xywh5mja |
user_name | string | Имя вызвавшего команду пользователя | i.ivanov |
root_id | string | ID корневого сообщения, если команда была вызвана в обсуждении | 8hxm9s3ui7bkic4iway6p66a8r |
Поле token будет содержать токен слеш-команды, который используется для валидации запроса. Сервер может отправить ответ, на основе которого может быть создан, например: новый пост.
Имя | Тип | Описание | Пример |
---|---|---|---|
response_type | string | Тип ответа | in_channel , ephemeral |
text | string | Написанный после команды текст | Hello! |
username | string | Отображаемое имя в сообщении от слеш-команды | Helper |
channel_id | string | Канал для ответа | z49mscpgx3re7rhjstsu88yfio |
icon_url | string | URL картинки аватара интеграции при ответе на команду | - |
type | string | Тип создаваемого поста | - |
props | Map with string as a key, any type value | Дополнения к посту | - |
goto_location | string | URL на который будет перенаправлен пользователь | https://time-messenger.ru/ |
skip_slack_parsing | bool | Установите значение true , чтобы пропустить обработку Текста с учетом совместимости со Slack. | false |
extra_responses | Array of this struct | Используется для ответа несколько раз за одно взаимодействие | - |