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

ЗАПРОС НА ИНИЦИАЦИЮ FLASH CALL ИЛИ VOICE CODE C ИСПОЛЬЗОВАНИЕМ КАСКАДНОЙ ОТПРАВКИ СМС

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

Для использования каскадной отправки кода подтверждения необходимо указать в запросе значение параметра sms_originator.

Текст СМС с кодом определяется следующим образом:

1. Если в запросе указан текст СМС для каскадной отправки (параметр sms_text), будет отправлен этот текст.
2. Вы можете задать общий текст СМС для каскадной отправки. Для этого обратитесь в службу поддержки. Этот текст будет отправлен, если текст сообщения не передан в запросе.
3. В случае если текст не передан в запросе и не задан общий текст, будет отправлен единый для всех текст сообщения: "Ваш код авторизации: #code#".

Примеры запроса

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

   https://gateway.api.sc/flash/?login=testuser&pass=userpassword&type=flash
         &code_gen=true&phone=79999999999&sms_originator=RUSInfo&sms_text="Ваш код подтверждения #code#"
         &callback_url=https://my.site.com/

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

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

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

   HTTP/1.1
           HOST: http://gateway.api.sc/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"
           &callback_url=https://my.site.com/

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

   HTTP/1.1
           HOST: http://gateway.api.sc/flash/
           Content-Type: application/x-www-form-urlencoded
           HTTP/1.1 100 Continue
           login=testuser
           &pass=userpassword
           &type=voice
           &code_gen=true
           &phone=79999999999
           &sms_originator=RUSInfo
           &sms_text="Ваш код подтверждения #code#"
           &callback_url=https://my.site.com/

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

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

  
    {
      "result": "Success",
      "code": "2424",
    }
  

  
    {
      "result": "Error",
      "message": "Tariff error. No price for this direction."
    }
  

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

СТАТУС ОКАЗАНИЯ УСЛУГИ

Для получения конечного статуса оказания услуги укажите в запросе значение параметра callback_url.

Примеры сообщений о статусе оказания услуги

1. Успешная отправка кода методом Voice Code

   
         {
           id: "171",
           user_id: 0,
           status: "ANSWERED",
           phone: "79999999999",
           time_change_state: 2022-06-04 11:03:00,
           type: "voice_code"
         }
       

2. Неуспешная отправка кода методом Flash Call

   
         {
           id: "171",
           user_id: 0,
           status: "NO ANSWER",
           phone: "79999999999",
           time_change_state: 2022-06-04 11:03:00,
           type: "flash_call"
         }
       

3. Успешная доставка каскадного СМС

   
         {
           id: "12313212380892930409",
           user_id: 0,
           status: "deliver",
           phone: "79999999999",
           time_change_state: 2022-06-04 11:03:00,
           type: "sms"
         }
       

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