Протокол интеграции Flash call and Voice code

Протокол интеграции Flash call and Voice code

ВНИМАНИЕ!

Для использования данного вида интеграции, вам необходимо зарегистрироваться на серверной платформе Stream Telecom, либо с помощью менеджера компании.

Получение услуги доступно только по API.

Пароль для интеграции задается в настройках пользователя во вкладке Настройки API.

ОПИСАНИЕ УСЛУГИ

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

- Flash Call – передача кода подтверждения, как последние 4 цифры номера телефона, с которого осуществляется вызов конечному абоненту.

- Voice Code – передача кода подтверждения путем диктовки кода в рамках звонка конечному абоненту.

Отправка кодов Flash Call и Voice Code возможна только на телефонные номера РФ.

Вы можете использовать каскадную отправку кода подтверждения: при неполучении кода описанными выше способами, он будет отправлен абоненту посредством СМС. Каскадная отправка СМС возможна только на мобильные телефонные номера РФ. Для отправки СМС необходимо зарегистрировать имя отправителя. Зарегистрировать имя отправителя вы можете в разделе «СМС» личного кабинета, или обратившись к менеджеру Stream Telecom.

По умолчанию для услуги настроен следующий AntiFraud-механизм: блокируется отправка более 1 кода на один номер телефона чаще одного раза в минуту и 100 кодов на любые номера за 10 минут. Для изменения настроек AntiFraud-механизмов обратитесь в техническую поддержку.

ОБЩИЕ ПОЛОЖЕНИЯ

Серверная платформа Stream Telecom (далее Платформа) и клиент сервиса (далее Клиент) обмениваются HTTPS URL – encoded запросами, используя форматы передач данных JSON, в соответствии с принципами REST. Действие над данными задается с помощью методов GET или POST в кодировке UTF-8.

ТОЧКА ДОСТУПА

Запросы Клиента должны передаваться на Платформу по URL: http://gateway.api.sc/rest (ssl: https://gateway.api.sc/rest).

ПРОВЕРКА КОРРЕКТНОСТИ ЗАПРОСОВ

Корректность формирования запросов и ответов можно проверить по адресу: https://gateway.api.sc/test_post.php

Stream_Telecom_FlashCall__1.0.3.pdf

Функции

ЗАПРОС НА ИНИЦИАЦИЮ FLASH CALL ИЛИ VOICE CODE


Пример GET-запроса Flash Сall:

https://gateway.api.sc/rest/flash/?login=userlogin&pass=userpassword&type=flash&code=2424&phone=79999999999


Пример GET-запроса Voice Code:

https://gateway.api.sc/rest/flash/?login=userlogin&pass=userpassword&type=voice&code=2424&phone=79999999999


Пример GET-запроса Flash Сall с каскадной отправкой СМС:

https://gateway.api.sc/rest/flash/?login=userlogin&pass=userpassword&type=flash&code=2424&phone=79999999999&sms_originator=RUSInfo&sms_text="Ваш код подтверждения 2424"


Пример GET-запроса Voice Code с каскадной отправкой СМС:

https://gateway.api.sc/rest/flash/?login=userlogin&pass=userpassword&type=voice&code=2424&phone=79999999999&sms_originator=RUSInfo&sms_text="Ваш код подтверждения 2424"


Пример POST запроса Flash Сall:

HTTP/1.1

HOST: http://gateway.api.sc/rest/flash/

Content-Type: application/x-www-form-urlencoded

HTTP/1.1 100 Continue

login=testuser

&pass=userpassword

&type=flash

&code=2424

&phone=79999999999


Пример POST запроса Voice Code:

HTTP/1.1

HOST: http://gateway.api.sc/rest/flash/

Content-Type: application/x-www-form-urlencoded

HTTP/1.1 100 Continue

login=testuser

&pass=userpassword

&type=voice

&code=2424

&phone=79999999999


Пример POST запроса Flash Сall с каскадной отправкой СМС:

HTTP/1.1

HOST: http://gateway.api.sc/rest/flash/

Content-Type: application/x-www-form-urlencoded

HTTP/1.1 100 Continue

login=testuser

&pass=userpassword

&type=flash

&code=2424

&phone=79999999999

&sms_originator=RUSInfo

&sms_text="Ваш код подтверждения 2424"


Пример POST запроса Voice Code с каскадной отправкой СМС:

HTTP/1.1

HOST: http://gateway.api.sc/rest/flash/

Content-Type: application/x-www-form-urlencoded

HTTP/1.1 100 Continue

login=testuser

&pass=userpassword

&type=voice

&code=2424

&phone=79999999999

&sms_originator=RUSInfo

&sms_text="Ваш код подтверждения 2424"


Описание параметров запроса:

Название Обязательное поле Тип данных Описание
login Да String Логин от учетной записи Stream Telecom
pass Да String Пароль API от учетной записи Stream Telecom
type Да String Способ передачи кода:
"flash" – Flash Call
"voice" – Voice Code
code Да Integer Четырёхзначный код для передачи
phone Да String Номер телефона конечного абонента
sms_originator Нет String Имя отправителя для каскадной отправки СМС. Передача данного параметра определяет, будет ли отправлено каскадное сообщение. Если параметр не передан, то СМС отправлено не будет
sms_text Нет String Текст СМС для каскадной отправки

Примеры ответов:

{

"result": "Success",

}


{

"result": "Error",

"message": "Tariff error. No price for this direction."

}


Описание параметров ответа:

Параметр Описание
result Описание результата
message Текст сообщения об ошибке (при возникновении)

ПЕРЕЧЕНЬ ТИПОВЫХ СООБЩЕНИЙ ОБ ОШИБКАХ И ИХ ОПИСАНИЕ

Message Описание
Error during request processing Ошибка при выполнении запроса
Not correct phone Некорректный номер телефона
Invalid source address Неверное имя отправителя
Invalid SMS text Неверный текст SMS
Tariff error. No price for this direction Не указан тариф для выбранного направления
Direction is closed Данное направление закрыто
No input data Нет входящих данных
%Field% cannot be empty or not string Поле не может быть пустым, значение поля должно быть строкой %Field% - имя поля
Incorrect login or password Неправильный логин или пароль
Access denided Доступ запрещен
User blocked Ваш аккаунт заблокирован
Too many requests Превышен лимит количества запросов
System Failed Ошибка сервера
Code must be four digits Код должен быть из 4-х цифр
Type must be flash or voice Тип должен быть flash или voice