8 800 500-80-16
ЗВОНКИ И ГОЛОСОВЫЕ ОПОВЕЩЕНИЯ
МОБИЛЬНЫЙ ID
- SIM-PUSH аутентификация
TELEGRAM
КАСКАД
ТОКЕН
SIM-PUSH аутентификация
Запрос на авторизацию SIM-PUSH:
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/push/send
Метод отправки запроса:
POST
Content-Type: application/json
Список
обязательных
параметров JSON-запроса:| Имя параметра | Значение параметра |
|---|---|
| auth {...} | Блок авторизации: |
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| number | Телефонный номер абонента производящего авторизацию в международном формате без символа "+". |
| statusCallbackUrl | URL-адрес для получения уведомления с финальным статусом (Webhook) |
| smsCodeRequestUrl | URL-адрес для получения уведомления о том, что нужно запросить у абонента код из SMS (Webhook)
(Если абоненту не пришло SIM-PUSH уведомление или абонент его проигнорировал) |
Пример отправляемого JSON-запроса (развернуть)...
{
"auth": {
"user": "XXXXX",
"pass": "PASSWORD"
},
"number": "79XXXXXXXXX",
"statusCallbackUrl": "http(s)://some-url-name/final-status/",
"smsCodeRequestUrl": "http(s)://some-url-name/need-sms/"
}
Пример ответа сервера на запрос (развернуть)...
{
"status": "success",
"pushId": "xxxxxxxxxxxxxxxxxxxxxxxx"
}
Запрос на получение статуса авторизации:
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/push/status
Метод отправки запроса:
GET
Список
обязательных
параметров:| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| pushId | ID пуша, параметр "pushId" из ответа, полученного при отправке запроса на авторизацию. |
Пример ответа сервера на запрос, если ожидается действие абонента на SIM-PUSH (развернуть)...
{
"pushStatus": "AWAITING_CLIENT_ACTION"
}
Пример ответа сервера на запрос, если абонент ответил положительно на SIM-PUSH (развернуть)...
{
"pushStatus": "CLIENT_ACCEPTED"
}
Пример ответа сервера на запрос, если абоненту отправлен SMS-код (развернуть)...
{
"pushStatus": "SMS_CODE_REQUESTED"
}
Запрос на проверку SMS-кода, введенного абонентом:
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/push/verifySmsCode
Метод отправки запроса:
POST
Content-Type: application/json
Список
обязательных
параметров JSON-запроса:| Имя параметра | Значение параметра |
|---|---|
| auth {...} | Блок авторизации: |
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| pushId | ID пуша, параметр "pushId" из ответа, полученного при отправке запроса на авторизацию. |
| code | Код, полученный абонентом из SMS. |
Пример ответа сервера на запрос (развернуть)...
{
"status": "success"
}