Skip to content

Обновление/добавление/подтверждение номера телефона в профиле

📡 Обновление/добавление/подтверждение номера телефона в профиле#

Ручка#

ws /ws/v1/add_contact_with_call_password

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

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

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

Поле Тип Описание Обязательное Пример
contact string Введенный номер телефона ✅ +7 999 123-12-12
apiKey string Ключ авторизации пользователя ✅ 099c3e4a-ce83-456f-b71c-53310806cba3

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

Система держит в пямяти подтвержденный телефон какое-то время. Это значит, что при повторном запросе пользователю сразу будет возвращен ключ авторизации

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

Стандартная строка 

{
  "contact": "+7 999 123-45-67"
}

Base64 формат 

{
  "contact": "Nzk1MDEwNTk2NjI="
}

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

Поле Тип Описание Обязательное Пример
qrCodeURI string Ссылка на qr код для звонка ❌ https://files.new-tel.net/cv/qr/03a2ab09-b974-47f3-b6c8-17be5cea92ea.png
confirmationNumber string Телефон на который нужно позвонить ❌ 74997547005
isUserCall bool Позвонил ли пользователь на данный момент ✅ true
isPing bool Является ли данное сообщение пингом ✅ true

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

Первое сообщение отправляемое пользователю 
{
  "qrCodeURI": "https://api.new-tel.net/files/qr-code/call-password-id/3310a0df-bb42-4dd1-a4a5-3bc742f65291.png",
  "confirmationNumber": "74997547005",
  "isUserCall": false,
  "isPing": false
}
Пока пользователь не позвонил

Будет отправляться пользователю с периодичностью раз в 10 секунд (клиенту следует отправлять на сервер понговое сообщение в любом формате)

{
  "qrCodeURI": "https://api.new-tel.net/files/qr-code/call-password-id/3310a0df-bb42-4dd1-a4a5-3bc742f65291.png",
  "confirmationNumber": "74997547005",
  "isUserCall": false,
  "isPing": true
}
Когда пользователь позвонил и было произведено обновление/добавление контакта 
{
  "qrCodeURI": "https://api.new-tel.net/files/qr-code/call-password-id/3310a0df-bb42-4dd1-a4a5-3bc742f65291.png",
  "confirmationNumber": "74997547005",
  "isUserCall": true,
  "isPing": false
}
В случае ошибки 
{
    "showError": true,
    "message": "Пользователь не найден",
    "statusCode": 404,
    "traceID": "c8c30b0c531d50fa76544284bead568a",
    "description": "AUTH_SERVICE.USER_NOT_FOUND"
}