Skip to content

Верификация телеграмм

📡 Верификация телеграм и телефона#

Ручка#

ws /ws/v1/verify_telegram

Полный адрес в сети#

Среда URL
🧪 Dev ws://web-socket-gateway.devterra.ru/ws/v1/verify_telegram
🚀 Prod ws://web-socket-gateway.terraprod.ru/ws/v1/verify_telegram

Входные данные для верификации#

Поле Тип Описание Обязательное Пример
apiKey string Ключ авторизации ✅ 47f44e56-2e4f-407e-8b07-115ea8783be7
method string Метод верификации ✅ SignUp
phone string Телефон пользователя ❌ 79144746534

При регистрации поле method должно быть SignUp

В случае если необходим вход и подтверждение тг, в поле method должно быть SignIn

Номер телефона можно ввести в любом формате. Он будет провалидирован и отформатирован

Телефон пользователя при передаче, также будет верифицирован

Пример JSON запроса#

{
  "apiKey": "86116c76-eafe-4f15-876b-ab1f3660da28",
  "method": "SignIn",
  "phone": null
}

Выходные данные, которые будут в ответе#

Поле Тип Описание Обязательное Пример
username string Юзернейм пользователя ❌ @my_username
apiKey string Авторизационный токен ❌ c7324355-20fd-432a-8a73-f048c88da67b
tgURL string Ссылка на тг бота для перехода ❌ https://t.me/terra_app_auth_bot?start=e3b19ca9-cab7-4387-a42e-3f5ad48326ab
isPing bool Является ли данное сообщение пингом ✅ true

Пример JSON ответов#

Первое сообщение отправляемое пользователю 
{
    "username": null,
    "tgURL": "https://t.me/working_12bot?start=7b4ae464-8353-4f3b-821b-f286ed6fb00f",
    "apiKey": "86116c76-eafe-4f15-876b-ab1f3660da28",
    "isPing": false
}
Пока пользователь не верифицировал тг

Будет отправляться пользователю с периодичностью раз в 10 секунд

{
  "username": null,
  "tgURL": "https://t.me/working_12bot?start=7b4ae464-8353-4f3b-821b-f286ed6fb00f",
  "apiKey": "86116c76-eafe-4f15-876b-ab1f3660da28",
  "isPing": true
}
Когда пользователь верифицировал телеграм 
{
  "username": "@Seva5434",
  "apiKey": "86116c76-eafe-4f15-876b-ab1f3660da28",
  "tgURL": null,
  "isPing": false
}
В случае ошибки 
{
    "showError": true,
    "message": "Пользователь не найден",
    "statusCode": 404,
    "traceID": "c8c30b0c531d50fa76544284bead568a",
    "description": "AUTH_SERVICE.USER_NOT_FOUND"
}