Коды авторизации Telegram Gateway#

В данном разделе приведено описание особенностей передачи авторизационных кодов через платформу в Telegram Gateway.

Подробнее

Сервис Telegram Gateway предназначен для доставки пользователям мессенджера Telegram авторизационных и верификационных цифровых кодов.

Отправка кодов происходит от имени официального канала Verification Codes.

Если пользователь скрывает свой номер телефона в настройках Telegram, это не влияет на доставку сообщения. Также на доставку кодов не влияет наличие или отсутствие у пользователя подписки Telegram Premium.

Отправка цифровых кодов в сообщениях Telegram возможна в текстах сообщений любого типа. В процессе обработки сообщения будут конвертированы в TG-формат и переданы в Telegram.

На данный момент сервис поддерживает:

  • отправку сообщений с кодами авторизации через Telegram;
  • получение статусов доставки сообщений;
  • каскадную передачу сообщений на альтернативные каналы в случае недоставки в Telegram (при необходимости).

Подключение#

Подключение сервиса осуществляет служба технической поддержки Сервис-провайдера.

Для подключения Партнеру и Сервис-провайдеру необходимо согласовать данные:

  • сервисное имя;

  • время жизни сообщения (ttl).

Запрос на отправку#

В запросе на передачу авторизационного кода (в т.ч. в основном канале при каскадной отправке) необходимо указывать сервисное имя, отдельно согласованное со службой технической поддержки.

В запросе рекомендуется указать параметры и значения, относящиеся к типу сообщения SMS.

 1 {
 2   "login":"ВАШ_ЛОГИН",
 3   "password":"ВАШ_ПАРОЛЬ",
 4   "destAddr":"НОМЕР_АБОНЕНТА",
 5   "id":"8770630",
 6   "registeredDelivery":"1",
 7   "notifyUrl":"URL_для_передачи_статусов",
 8   "extraParam":"место=турбаза,название=гостевой дом 3",
 9   "message":{
10     "type":"SMS",
11     "data":{
12       "text":"Текст. Код 12345",
13       "serviceNumber":"СПЕЦИАЛЬНОЕ_ИМЯ_ОТПРАВИТЕЛЯ",
14       "ttl":120,
15       "ttlUnit":"SECONDS"
16     }
17   }
18 }

Ответ на запрос#

После отправки сообщения Сервис-провайдер синхронно возвращает ответ.

Ответ при успешной отправке#

В случае успешной отправки возвращается HTTP-code 200 OK.

1  {
2     "mtNum": "7390612217"
3     "id": "8770630"
4  }

Ошибки при отправке#

Для ошибочных результатов HTTP-код ответа будет отличный от 200 (см. Коды ошибок отправки).

1  {
2      "error": {
3          "code": 9,
4          "description": "Message type is not correct"
5      },
6      "extendedDescription": "SMS sending is not allowed for *user*."
7  }

Коды ошибок отправки#

Код

Описание

HTTP-код

1

Service is unavailable

503

2

Invalid IP-address

403

3

Too many connections

429

4

Invalid request

400

5

Invalid login

401

6

Invalid password

401

7

serviceNumber is not defined

400

8

destAddr is not correct

406

9

Message type is not correct

406

10

Prohibited sending duplicates

409

11

Invalid TTL

406

100

100

500

Статусы доставки сообщений#

Для получения статусов необходимо настроить Сервис получения статусов доставки сообщений.

Важно

При отправке абоненту в мессенджер Telegram авторизационных кодов возможно получение только следующих статусов:

  • «доставлено»;

  • «не доставлено».