Evolutrix CRM Rest API | TelegramBot (1.0.0)
Download OpenAPI specification:Download
Описание Rest API — методов для взаимодействия с серверной стороной модуля TelegramBot.
Ниже перечислены соответствующие изменения:
- Метод получения классов уведомлений возвращает дополнительный канал уведомлений
telegram.
status
Возвращает статус конфигурации Telegram-бота и информацию о нем (если Telegram-бот сконфигурирован).
Требуются права доступа:
- INTERNAL_TELEGRAM_BOT_ACCESS_TOKEN_STORE
Authorizations:
BearerToken
Responses
Response samples
- 200
- 401
- 403
Content type
application/json
{- "success": true,
- "data": {
- "is_connected": true,
- "bot_info": {
- "id": 5782049176,
- "first_name": "ZdravBotTest",
- "username": "ZdravTestBot"
}, - "commands": " schedule_today - Расписание на сегодня\n schedule_tomorrow - Расписание на завтра\n birthday_today - Дни рождения клиентов на сегодня\n birthday_tomorrow - Дни рождения клиентов на завтра"
}, - "message": "ОК"
}set access token
Выполняет подключение Telegram-бота по его токену.
Требуются права доступа:
- INTERNAL_TELEGRAM_BOT_ACCESS_TOKEN_STORE
Authorizations:
BearerToken
Request Body schema: application/jsonrequired
Данные Telegram-бота
| access_token required | string Access token Telegram-бота, полученный от BotFather. |
Responses
Request samples
- Payload
Content type
application/json
{- "access_token": "123456789:ABCdefGHIjklMNOPqrstUVWXYZ"
}Response samples
- 200
- 400
- 401
- 403
Content type
application/json
{- "success": true,
- "data": { },
- "message": "ОК"
}connect to profile
Связывает чат Telegram-бота с сотрудником для возможности получения уведомлений и прочего взаимодействия.
Authorizations:
BearerToken
Request Body schema: application/jsonrequired
Данные Telegram чата
| chat_id required | number Идентификатор чата с Telegram-ботом (для получения необходимо выполнить коману |
Responses
Request samples
- Payload
Content type
application/json
{- "chat_id": 123456789
}Response samples
- 200
- 400
- 401
- 403
Content type
application/json
{- "success": true,
- "data": { },
- "message": "ОК"
}