8 800 500-80-16
ЗВОНКИ И ГОЛОСОВЫЕ ОПОВЕЩЕНИЯ
- Flash Call (коды в номере)
- Voice Code (коды голосом)
- Voice (голосовая рассылка)
- Call Me (авторизация исходящим звонком)
МОБИЛЬНЫЙ ID
TELEGRAM
КАСКАД
ТОКЕН
Call Me (авторизация исходящим звонком)
Запрос на авторизацию исходящим звонком:
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/calls/callMe/send
Метод отправки запроса:
POST
Content-Type: application/json
Список
обязательных
и необязательных
параметров JSON-запроса:| Имя параметра | Значение параметра |
|---|---|
| auth {...} | Блок авторизации: |
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| number | Телефонный номер абонента производящего авторизацию в международном формате без символа "+". |
| callbackUrl | URL-адрес для получения финального статуса авторизации (Webhook) |
| ttl | Время ожидания авторизации абонента в секундах. Значение по умолчанию 120 сек. |
Пример отправляемого JSON-запроса (развернуть)...
{
"auth": {
"user": "XXXXX",
"pass": "PASSWORD"
},
"number": "79XXXXXXXXX",
"callbackUrl": "http(s)://some-url-name/",
"ttl": "120"
}
Пример ответа сервера на запрос (развернуть)...
{
"status": "success",
"callId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"callTo": "7XXXXXXXXXX"
}
Формат получаемого ответа:
Content-Type: application/json
Список параметров JSON-ответа:
| Имя параметра | Значение параметра |
|---|---|
| status | Статус отправки запроса:
"success" - успешно "failure" - неудачно |
| callId | ID звонка. |
| callTo | Номер, на который необходимо перезвонить клиенту для успешной авторизации. |
| error | Описание ошибки в случае неудачного запроса, когда "status": "failure" |
Webhook отправляется на адрес указанный в параметре: callbackUrl
Метод отправки запроса:
POST
Content-Type: application/json
Список параметров обратного JSON-запроса:
| Имя параметра | Значение параметра |
|---|---|
| callId | [string] ID звонка из ответа API |
| success | [boolean] Статус авторизации клиента:
true - успешно false - неудачно |
| expired | [boolean] (опционально)
true - в случае если ошибка связана с истечением времени ожидания авторизации клиента |
Запрос на получение статуса авторизации:
Запрос отправляется на адрес: https://webapi.smsgold.ru/v1/calls/callMe/status
Метод отправки запроса:
GET
Список
обязательных
параметров:| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| callId | ID звонка, параметр "callId" из ответа, полученного при отправке запроса на авторизацию. |
Пример ответа сервера на запрос (развернуть)...
{
"callStatus": "CLIENT_CALLED"
}
Формат получаемого ответа:
Content-Type: application/json
Список параметров JSON-ответа:
| Имя параметра | Значение параметра |
|---|---|
| callStatus | Статус авторизации клиента:
"NOT_INITIALIZED" - запрос звонка в очереди на отправку. "NTERNAL_PROCESSING_ERROR" - ошибка обработки на стороне платформы, например недостаточно средств. "AWAITING_CLIENT_CALL" - запрос звонка зарегистрирован, ожидание вызова клиента на номер из параметра "callTo". "CLIENT_CALLED" - успешно, клиент осуществил вызов на номер из параметра "callTo". "CLIENT_CALL_TIMEOUT" - неудачно, клиент не осуществил вызов на номер из параметра "callTo" в течении времени ожидания авторизации. "REQUEST_FAILED_OR_CLIENT_NEVER_CALLED" - любое другое состояние ошибки (терминальное). |