6.1.3 Описание запроса
Параметры запроса:
| № | Параметр | Тип | Обязательный | Описание |
|---|---|---|---|---|
| 1 | abonentOperId | Число | Да | id оператора, отправившего HSM-сообщение, он будет обрабатывать созданное обращение. Для получения user_id используется Запрос списка сотрудников ВАТС (Ext. API ВАТС) |
| 2 | timeDelay | Число | Нет | Указывается время, через сколько отправится первое сообщение. Время считается в минутах. По умолчанию 0, максимум 1440 |
| 3 | cascade | Массив объектов | Не указано | |
| 3.1 | cascade[].type | Строка | Да | Тип элемента каскада. Может иметь значения: wa, sms |
| 3.2 | cascade[].text | Строка | Да | Текст сообщения должен быть в кавычках. Для сообщений через WA используются настроенные текстовые HSM шаблоны. Ограничения (независимо от языка): wa - 1000 символов; sms - 70 символов |
| 3.3 | cascade[].number | Строка | Да | Номер, на который будет отправлено сообщение. Ограничение по количеству символов: от 3 до 20 цифр |
| 3.4 | cascade[].order | Число | Да | Приоритет отправки сообщения по каналам: от 1 и выше, где 1 самый приоритетный |
| 3.5 | cascade[].timeDelayCheck | Число | Нет | Указывается время в минутах, через которое будет проверятся статус по отправленному сообщению. Параметр получает статусы только по WA. Минимум 1, максимум 1440, по умолчанию 60 |
| 3.6 | cascade[].channelId | Число | Обязательное для WA, не обязательное для sms | Метод для получения channelId. Значение channelId можно получить с помощью метода «Получить список виджетов» (см. раздел) |
Примечание. Согласно модели взаимодействия, в POST-запросах отправляются обязательные поля vpbx_api_key и sign. Подробнее об этих обязательных полях…
Пример запроса:
POST https://app.mango-office.ru/cc/send_text_message
vpbx_api_key=1234567890qwerty
sign=1234567890qwerty
json =
{
"abonentOperId": 300185616,
"cascade": [
{
"type": "wa",
"text": "Добрый день, Пётр! Ваша заявка выполнена...",
"number": "111",
"order": 1,
"timeDelayCheck": 1,
"channelId": 29606
},
{
"type": "sms",
"text": "asd",
"number": "111",
"order": 2
}
]
}
Параметры ответа:
| № | Параметр | Тип | Обязательный | Описание |
|---|---|---|---|---|
| 1 | result | Число | Да | Код результата |
| 2 | error | Строка | Нет | Сообщение, поясняющее код результата |
Пример ответа:
{
"result": 1000
}
Пример сообщения об ошибке:
{
"result": 5000,
"error": "У элемента каскада нет необходимых свойств"
}
Была ли статья полезна?
Предыдущая