FlashingCall (VoiceCode)#

Запрос FlashingCall (VoiceCode)#

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

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

 1{
 2"login": "ВАШ_ЛОГИН",
 3"password": "ВАШ_ПАРОЛЬ",
 4"destAddr": "НОМЕР_АБОНЕНТА",
 5"notifyUrl":"URL_для_передачи_статусов",
 6"message": {
 7   "type": "FLASHINGCALL",
 8   "data": {
 9      "text": "1234",
10      "ttl": 1
11   }
12}
13}

Параметр

Обязат.

Тип

Описание

login

да

string

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

password

да

string

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

destAddr

да

string

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

Подробнее

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

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

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

notifyUrl

нет

string

Имя хоста входящего API для получения отчета о доставке (см. Сервис получения статусов доставки сообщений).

Подробнее

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

Длина строки notifyUrl не должна превышать 2048 символов.

При невыполнении любого из указанных условий будет сгенерирована ошибка, запрос не будет выполнен.

message

да

object

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

message/type

да

enum

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

The value of FLASHINGCALL is transmitted.

message/data

да

object

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

message/data/text

да

string

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

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

Подробнее

По умолчанию настроена передача четырёхзначного кода.

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

При передаче сообщения без кода запрос будет отклонён с ошибкой 400, Invalid request. Flashing Call text should contain a 4(6)-digit code.

Количество символов в сообщении: не более 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)-сообщений необходимо настроить Сервис получения статусов доставки сообщений.

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

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