FlashingCall (VoiceCode)#

Запрос FlashingCall (VoiceCode)#

Для передачи сообщения с типом FlashingCall необходимо выполнить запрос.

Для отправки VoiceCode необходимо указать тип сообщения FlashingCall и передать запрос, содержащий код. Указанный код (без сопутствующего текста) будет передан оператору, который вставит его в текст шаблона сообщения.

 1{
 2"login": "ВАШ_ЛОГИН",
 3"password": "ВАШ_ПАРОЛЬ",
 4"destAddr": "НОМЕР_АБОНЕНТА",
 5"message": {
 6   "type": "FLASHINGCALL",
 7   "data": {
 8      "text": "1234",
 9      "ttl": 1
10   }
11}
12}

Параметр

Обязат.

Тип

Описание

login

да

string

Имя Партнера.

password

да

string

Пароль Партнера для отправки сообщений.

destAddr

да

string

Номер телефона абонента.

Подробнее

Содержит код страны, код оператора и номер телефона.

Для РФ код может быть 8, 7 или +7.

Примеры: 72101234567, +72101234567, 8-210-123-45-67, 82101234567.

message

да

object

Параметры отправляемого сообщения.

message/type

да

enum

Тип сообщения.

Подробнее

Передается значение FLASHINGCALL.

message/data

да

object

Параметры отправляемых данных.

message/data/text

да

string

Текст отправляемого сообщения.

Подробнее

Количество символов: не более 2000.

Текст должен содержать код, используемый для звонка на номер абонента сотового оператора.

message/data/ttl

да

integer

Срок жизни сообщения FLASHINGCALL (Voice Code).

Подробнее

Интервал ожидания ответа о совершении звонка - от 1 до 5 минут.

Примечание

При ttl = 0 или отсутствии параметра в запросе берётся значение из настроек по умолчанию, которые задаются при настройке интеграции отдельно для каждого клиента.

Результат запроса FlashingCall#

Результатом выполнения запроса FlashingCall будет звонок на телефон абонента со специальной номерной ёмкости.
Последними цифрами номера вызывающего абонента является код, который передается в тексте сообщения.
Передаваемый код сообщения в тексте должен состоять из четырёх, либо шести цифр.
Интервал ожидания ответа (ttl) о совершении звонка — от 1 до 5 минут.
После отправки сообщения Сервис-провайдер синхронно возвращает ответ.

Результат запроса VoiceCode#

Результатом запроса VoiceCode будет звонок на телефон абонента. Когда абонент снимет трубку, он услышит голосовое сообщение, которое будет содержать четырёх- или шестизначный цифровой код.
Для подключения данной услуги необходимо обратиться в службу технической поддержки и согласовать текст шаблона голосового сообщения.

Ошибки при отправке FlashingCall (VoiceCode)-сообщений#

Для ошибочных результатов HTTP-код ответа будет отличный от 200 OK (см. Коды ошибок отправки).

1{
2   "error": {
3      "code": 4,
4      "description": "Invalid request"
5   },
6   "extendedDescription": "FlashingCall text should contain a 4-digit code."
7}

Коды ошибок отправки#

Код

Описание

HTTP-код

1

Service is unavailable

503

2

Invalid IP-address

403

3

Too many connections

429

4

Invalid request

400

5

Invalid login

401

6

Invalid password

401

7

serviceNumber is not defined

400

8

destAddr is not correct

406

9

Message type is not correct

406

10

Prohibited sending duplicates

409

11

Invalid TTL

406

100

100

500

Статусы доставки FlashingCall (VoiceCode)-сообщений#

Для получения статусов FlashingCall (VoiceCode)-сообщений необходимо настроить Сервис получения статусов доставки сообщений.

Коды ошибок доставки#

Коды ошибок доставки, в зависимости от типа сообщения, приведены в соответствующей вкладке в разделе Описание кодов ошибок.