В этой статье я хочу описать простой пример работы мультипротокольного бота через Microsoft Bot Connector API — v3.0. На тему skype подобных ботов уже есть статьи на Хабре: «Как создать своего бота для Skype. Что не написано в документации» от and7ey и «Hello, Bot! Чат-боты – следующее поколение приложений?» от shwars. Но в первой идёт речь про работу через apis.skype и описанный там вариант не мультипротокольный, а во второй описана реализация через C#, а я в него не умею.
Кому и зачем нужна эта статья
Во-первых, «тому парню», который хочет сделать своего бота, но не умеет в C#, а умеет в REST.
Во-вторых, мне, так как я потратил изрядное кол-во времени на разбор нескольких версий API и понимание того, какой API и как мне нужно использовать. Поэтому я хотел бы закрепить свой опыт на бумаге в статье (ок, я больше не буду использовать фишку с зачеркиванием текста).
Авторизация
В полной мере (на сколько я смог оценить) рассмотрена в статье, которую я упомянул выше — в этой. Делаем как описано, получаем token и начало положено — мы «на первой базе» (это не общепринятая аналогия про базы, где на третьей нам дадут жмакнуть сиську, нет, это не она).
Получение сообщений
У бота должен быть endpoint, куда будут приходить запросы с json-телом. Например, отправленное для бота сообщение через skype с текстом «Привет» придет таким:
{
"type":"message",
"id":"1q80QckzCi3wL6zg",
"timestamp":"2016-08-16T12:56:16.49Z",
"serviceUrl":"https://skype.botframework.com",
"channelId":"skype",
"from":{
"id":"29:1Phe2HAxz6CD9uc1O_PVl_Zih6doxIe_KuyrQ9eANUbs",
"name":"avvero"
},
"conversation":{
"id":"29:1Phe2HAxz6CD9uc1O_PVl_Zih6doxIe_KuyrQ9eANUbs"
},
"recipient":{
"id":"28:300cbb48-78e0-4998-8e85-4f4c7ccb5aee",
"name":"notify_bot"
},
"text":"привет, бот",
"entities":[
]
}
Что нам особенно важно в этом запросе:
- conversation.id — идентификатор беседы
- channelId — идентификатор канала
Эти два параметра особенно важны, потому что на основе их определяется url для отправки запросов в botframework. При этом, роль conversationId упомянута в описании API (swagger), а вот с channelId не все так очевидно, точнее нифига (технический термин) не очевидно. Например, сообщения от бота для канала skype должный пойти сюда:
https://skype.botframework.com/v3/conversations/{conversationId}/activities,
А для telegram сюда:
https://telegram.botframework.com/v3/conversations/{conversationId}/activities.
В документации я этого не увидел и это плохо, так как на выявление этой особенности было потрачено основное время.
Отправка сообщений
Для skype минимальное тело запроса будет таким:
{
"type":"message",
"text":"hello"
}
А для telegram таким (нужен объект from):
{
"type":"message",
"from":{
"id":"avvero_notify_bot",
"name":"avvero"
},
"text":"hello"
}
Карточки
Не текстами едиными. Можно отправлять и карточки (здесь приведен пример сообщения для telegram, для skype можно без from):
{
"type":"message",
"from":{
"id":"avvero_notify_bot",
"name":"avvero"
},
"text":"hello",
"attachments":[
{
"contentType":"application/vnd.microsoft.card.hero",
"content":{
"title":"title",
"subtitle":"subtitle",
"text":"text",
"images":[
{
"url":"https://pp.vk.me/c7011/v7011856/3160d/HVELORSo5KM.jpg",
"alt":"hello thumb"
}
],
"buttons":[
{
"type":"imBack",
"title":"Да",
"value":"yes <context offer="..."/>"
},
{
"type":"imBack",
"title":"Нет",
"value":"no"
},
{
"type":"openUrl",
"title":"Загуглить",
"value":"https://disney.radisson.com"
}
]
}
}
]
}
В skype это выглядит так:
В telegram так:
Конец
Ну вот в принципе и все, что я хотел рассказать. Стоит упомянуть проблемы при использовании такого бота.
Для skype:
- нужна последняя свежая версия клиента (на linux совсем старая и боты там не пойдут)
- одного бота я добавил как простой контакт — через поиск, второго бота так добавить не получилось, получилось только через ссылку типа такой join.skype.com/bot/6877d5c8-dc4f-4eda-9aac-29b19e1761f0
Для telegram:
- Не получается обращаться к боту в группе через знак @, сообщения боту не идут, сообщения идут боту если перед сообщением ставить знак /, т.е. так "/привет бот"
Спасибо за внимание!
Автор: Avvero
