НТТP протокол для взаимодействия с Telegram
Получить список подключенных ботов
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/telegram/bot/bots/
Метод отправки запроса: GET
Список обязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
Получить список подписчиков бота
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/telegram/bot/subscribers/
Метод отправки запроса: GET
Список обязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| botId | Идентификатор бота. Значение параметра "id" из предыдущего запроса "Получить список подключенных ботов" или колонка "Идентификатор" напротив необходимого Telegram бота в таблице меню "Чат-боты \ Боты и каналы" личного кабинета. |
Отправка сообщения подписчику Telegram бота
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/telegram/bot/sendMessage/
Метод отправки запроса: POST Content-Type: application/json
Список параметров JSON запроса:
| Имя параметра | Значение параметра |
|---|---|
| subscriberId | Идентификатор пользователя. Значение параметра "id" из предыдущего запроса "Получить список подписчиков бота" или меню личного кабинета "Чат-боты \ Боты и каналы" ссылка "Управление" у нужного бота, затем значение в колонке "Идентификатор" напротив имени пользователя. (параметры subscriberId и botId взаимоисключающие, можно использовать только один!) |
| botId | Идентификатор Telegram бота. Значение параметра "id" из предыдущего запроса "Получить список подключенных ботов" или меню личного кабинета "Чат-боты \ Боты и каналы" колонка "Идентификатор" напротив необходимого Telegram бота (подключается непосредственно пользователем - кнопка "Добавить канал" далее иконка "Telegram бот"). (параметры botId и subscriberId взаимоисключающие, можно использовать только один!) |
| number | Телефонный номер получателя сообщения в международном формате без символа "+". ВАЖНО: Параметр number указывается обязательно и только при использовании параметра botId. (если указаны все три параметра - subscriberId, botId, number, то преимущество будет иметь только параметр subscriberId) |
| text | Текст передаваемого сообщения. |
| buttons [{...}, {...}, ...] | Массив c кнопками. Кнопок может быть несколько. Параметр не обязательный: |
| text | Текст, отображаемый на кнопке. |
| url | URL-адрес для перехода по кнопке. |
| auth {...} | Блок авторизации: |
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
Пример отправляемого JSON запроса (развернуть)...
{
"subscriberId": "XXXXXXXXXXXXXXXXXXXXXXXX",
"text": "Текст Вашего сообщения",
"buttons": [
{
"text": "Текст на кнопке 1",
"url": "https:// ссылка для кнопки 1"
},
{
"text": "Текст на кнопке 2",
"url": "https:// ссылка для кнопки 2"
}
],
"auth": {
"user": "XXXXX",
"pass": "PASSWORD"
}
}
Отправка сообщения пользователю Telegram, используя номер телефона или имя пользователя.
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/telegram/private/sendMessage/
Метод отправки запроса: POST Content-Type: application/json
Список параметров JSON запроса:
| Имя параметра | Значение параметра |
|---|---|
| connectionId | Идентификатор личного Telegram аккаунта. Меню личного кабинета "Чат-боты \ Боты и каналы" колонка "Идентификатор" напротив необходимого личного Telegram аккаунта (подключается непосредственно пользователем для своего мобильного номера - кнопка "Добавить канал" далее иконка "Личный Telegram аккаунт"). |
| username | Имя абонента в Telegram. Можно передавать оба параметра username и number или один из них. Если передаются оба, то сначала идёт попытка связаться с пользователем по имени абонента, как безопасный вариант, потом уже по номеру телефона. |
| number | Телефонный номер получателя сообщения в международном формате без символа "+". ВАЖНО: Начинать диалог по номеру (т.е. без указания username) можно не раньше чем раз в 3 минуты. |
| text | Текст передаваемого сообщения. |
| auth {...} | Блок авторизации: |
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
Пример отправляемого JSON запроса (развернуть)...
{
"connectionId": "YYYYYYYYYYYYYYYYYYYYYYYY",
"username": "USERNAME",
"number": "79XXXXXXXXX",
"text": "Текст Вашего сообщения",
"auth": {
"user": "XXXXX",
"pass": "PASSWORD"
}
}