Внешний вид
Оценка стоимости массовой рассылки SMS
Метод sms-calculate-bulk предназначен для оценки стоимости массовой рассылки SMS.
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
signature_id | string | Да | Идентификатор подписи отправителя |
phonebook_type | string | Да | Тип телефонного справочника. Допустимые значения: phonebook phonelist. |
phonebook_id | string | ? | Идентификатор телефонного справочника. Обязателен, если параметр phonebook_type имеет значение phonebook. |
phonelist | array | ? | Список номеров телефонов в международном формате. Обязателен, если параметр phonebook_type имеет значение phonelist. |
message | string | Да | Текст сообщения |
filters | object | Нет | Фильтр записей телефонного справочника. Применяется, если параметр phonebook_type имеет значение phonebook. |
filters.birthday | object | Нет | Фильтр записей телефонного справочника по дате рождения |
filters.birthday.min | string | Нет | Минимальная дата рождения в формате 31-01 |
filters.birthday.max | string | Нет | Максимальная дата рождения в формате 31-01 |
filters.gender | string | Нет | Фильтр записей телефонного справочника по полу. Допустимые значения: male female. |
Пример запроса #1
json
{
"api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
"action": "sms-calculate-bulk",
"data": {
"signature_id": "08b05080-ec96-4554-b294-16ccf4d87675",
"phonebook_type": "phonebook",
"phonebook_id": "1eefedfa-5c51-48e2-9425-e0df52196673",
"filters": {
"birthday": {
"min": "02-01",
"max": "02-29"
},
"gender": "female"
},
"message": "Test phonebook params: {first_name} {middle_name}"
}
}Пример запроса #2
json
{
"api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
"action": "sms-create-bulk",
"data": {
"signature_id": "08b05080-ec96-4554-b294-16ccf4d87675",
"phonebook_type": "phonelist",
"phonelist": [
"+79401234567",
"+79402345678",
"+79403456789"
],
"message": "Test phonelist"
}
}Параметры ответа
| Параметр | Тип | Описание |
|---|---|---|
num | integer | Количество SMS |
Пример ответа #1
json
{
"success": true,
"data": {
"num": 2,
"total": 4.98
}
}Пример ответа #2
json
{
"success": true,
"data": {
"num": 3,
"total": 7.47
}
}Возможные ошибки
| Ошибка | Описание |
|---|---|
| SMS-CALCULATE-BULK-SIGNATURE-ID-REQUIRED | Не указан параметр signature_id |
| SMS-CALCULATE-BULK-SIGNATURE-ID-INVALID-TYPE | Параметр signature_id имеет недопустимый тип |
| SMS-CALCULATE-BULK-SIGNATURE-ID-INVALID-FORMAT | Параметр signature_id не соответствует формату |
| SMS-CALCULATE-BULK-SIGNATURE-ID-NOT-FOUND | Подпись отправителя не найдена |
| SMS-CALCULATE-BULK-PHONEBOOK-TYPE-REQUIRED | Не указан параметр phonebook |
| SMS-CALCULATE-BULK-PHONEBOOK-TYPE-INVALID-TYPE | Параметр phonebook имеет недопустимый тип |
| SMS-CALCULATE-BULK-PHONEBOOK-TYPE-NOT-SUPPORTED | Параметр phonebook не соответствует формату |
| SMS-CALCULATE-BULK-PHONEBOOK-ID-REQUIRED | Не указан параметр phonebook_id |
| SMS-CALCULATE-BULK-PHONEBOOK-ID-INVALID-TYPE | Параметр phonebook_id имеет недопустимый тип |
| SMS-CALCULATE-BULK-PHONEBOOK-ID-INVALID-FORMAT | Параметр phonebook_id не соответствует формату |
| SMS-CALCULATE-BULK-PHONEBOOK-ID-NOT-FOUND | Телефонный справочник не найден |
| SMS-CALCULATE-BULK-PHONELIST-REQUIRED | Не указан параметр phonelist |
| SMS-CALCULATE-BULK-PHONELIST-INVALID-TYPE | Параметр phonelist имеет недопустимый тип |
| SMS-CALCULATE-BULK-PHONELIST-INVALID-FORMAT | Параметр phonelist не соответствует формату |
| SMS-CALCULATE-BULK-MESSAGE-REQUIRED | Не указан параметр message |
| SMS-CALCULATE-BULK-MESSAGE-INVALID-TYPE | Параметр message имеет недопустимый тип |
| SMS-CALCULATE-BULK-MESSAGE-INVALID-FORMAT | Параметр message не соответствует формату |
| SMS-CALCULATE-BULK-FILTERS-INVALID-TYPE | Параметр filters имеет недопустимый тип |
| SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-INVALID-TYPE | Параметр birthday имеет недопустимый тип |
| SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-TYPE | Параметр min имеет недопустимый тип |
| SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-FORMAT | Параметр min не соответствует формату |
| SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-TYPE | Параметр max имеет недопустимый тип |
| SMS-CALCULATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-FORMAT | Параметр max не соответствует формату |
| SMS-CALCULATE-BULK-FILTERS-GENDER-INVALID-TYPE | Параметр gender имеет недопустимый тип |
| SMS-CALCULATE-BULK-FILTERS-GENDER-NOT-SUPPORTED | Параметр gender имеет недопустимое значение |