YESMS

Внешний вид

Создание массовой рассылки SMS ​

Метод sms-create-bulk предназначен для создания массовой рассылки SMS для последующей отправки, сразу или по расписанию.

Параметры запроса ​

ПараметрТипОбязательныйОписание
signature_idstringДаИдентификатор подписи отправителя
phonebook_typestringДаТип телефонного справочника. Допустимые значения: phonebook phonelist.
phonebook_idstring?Идентификатор телефонного справочника. Обязателен, если параметр phonebook_type имеет значение phonebook.
phonelistarray?Список номеров телефонов в международном формате. Обязателен, если параметр phonebook_type имеет значение phonelist.
messagestringДаТекст сообщения
filtersobjectНетФильтр записей телефонного справочника. Применяется, если параметр phonebook_type имеет значение phonebook.
filters.birthdayobjectНетФильтр записей телефонного справочника по дате рождения
filters.birthday.minstringНетМинимальная дата рождения в формате 31-01
filters.birthday.maxstringНетМаксимальная дата рождения в формате 31-01
filters.genderstringНетФильтр записей телефонного справочника по полу. Допустимые значения: male female.
scheduleobjectНетРасписание рассылки
schedule.fromdatetimeНетДата и время начала рассылки в формате ISO 8601
schedule.tilldatetimeНетДата и время окончания рассылки в формате ISO 8601
expiredatetimeНетДата и время окончания срока жизни сообщений в формате ISO 8601

Пример запроса #1 ​

json
{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "sms-create-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}",
        "schedule": {
            "from": "2024-01-31T12:00:00+03:00",
            "till": "2024-01-31T18:00:00+03:00"
        },
        "expire": "2024-02-01T18:00:00+03:00"
    }
}

Пример запроса #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",
            "+79409876543"
        ],
        "message": "Test phonelist"
    }
}

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

ПараметрТипОписание
idstringИдентификатор рассылки
createddatetimeДата и время создания рассылки в формате ISO 8601
updateddatetimeДата и время обновления рассылки в формате ISO 8601
signaturestringПодпись отправителя SMS
messagestringТекст сообщения SMS
numintegerКоличество SMS
totaldoubleПолная стоимость рассылки
statusstringСтатус рассылки
paidbooleanСостояние списания средств за рассылку

Пример ответа #1 ​

json
{
    "success": true,
    "data": {
        "id": "8a482981-787e-494a-9b1a-63696cd208fe",
        "created": "2024-01-31T09:18:46+03:00",
        "updated": "2024-01-31T09:18:46+03:00",
        "signature": "TestSMS",
        "message": "Test phonebook params: {first_name} {middle_name}",
        "num": 2,
        "total": 4.98,
        "status": "init",
        "paid": false
    }
}

Пример ответа #2 ​

json
{
    "success": true,
    "data": {
        "id": "cb761bb2-58b8-4cd2-8842-354592d50f3b",
        "created": "2024-01-31T09:18:46+03:00",
        "updated": "2024-01-31T09:18:46+03:00",
        "signature": "TestSMS",
        "message": "Test phonelist",
        "num": 2,
        "total": 4.98,
        "status": "init",
        "paid": false
    }
}

Возможные ошибки ​

ОшибкаОписание
SMS-CREATE-BULK-SIGNATURE-ID-REQUIREDНе указан параметр signature_id
SMS-CREATE-BULK-SIGNATURE-ID-INVALID-TYPEПараметр signature_id имеет недопустимый тип
SMS-CREATE-BULK-SIGNATURE-ID-INVALID-FORMATПараметр signature_id не соответствует формату
SMS-CREATE-BULK-SIGNATURE-ID-NOT-FOUNDПодпись отправителя не найдена
SMS-CREATE-BULK-PHONEBOOK-TYPE-REQUIREDНе указан параметр phonebook
SMS-CREATE-BULK-PHONEBOOK-TYPE-INVALID-TYPEПараметр phonebook имеет недопустимый тип
SMS-CREATE-BULK-PHONEBOOK-TYPE-NOT-SUPPORTEDПараметр phonebook не соответствует формату
SMS-CREATE-BULK-PHONEBOOK-ID-REQUIREDНе указан параметр phonebook_id
SMS-CREATE-BULK-PHONEBOOK-ID-INVALID-TYPEПараметр phonebook_id имеет недопустимый тип
SMS-CREATE-BULK-PHONEBOOK-ID-INVALID-FORMATПараметр phonebook_id не соответствует формату
SMS-CREATE-BULK-PHONEBOOK-ID-NOT-FOUNDТелефонный справочник не найден
SMS-CREATE-BULK-PHONELIST-REQUIREDНе указан параметр phonelist
SMS-CREATE-BULK-PHONELIST-INVALID-TYPEПараметр phonelist имеет недопустимый тип
SMS-CREATE-BULK-PHONELIST-INVALID-FORMATПараметр phonelist не соответствует формату
SMS-CREATE-BULK-MESSAGE-REQUIREDНе указан параметр message
SMS-CREATE-BULK-MESSAGE-INVALID-TYPEПараметр message имеет недопустимый тип
SMS-CREATE-BULK-MESSAGE-INVALID-FORMATПараметр message не соответствует формату
SMS-CREATE-BULK-FILTERS-INVALID-TYPEПараметр filters имеет недопустимый тип
SMS-CREATE-BULK-FILTERS-BIRTHDAY-INVALID-TYPEПараметр birthday имеет недопустимый тип
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-TYPEПараметр min имеет недопустимый тип
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MIN-INVALID-FORMATПараметр min не соответствует формату
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-TYPEПараметр max имеет недопустимый тип
SMS-CREATE-BULK-FILTERS-BIRTHDAY-MAX-INVALID-FORMATПараметр max не соответствует формату
SMS-CREATE-BULK-FILTERS-GENDER-INVALID-TYPEПараметр gender имеет недопустимый тип
SMS-CREATE-BULK-FILTERS-GENDER-NOT-SUPPORTEDПараметр gender имеет недопустимое значение
SMS-CREATE-BULK-SCHEDULE-INVALID-TYPEПараметр schedule имеет недопустимый тип
SMS-CREATE-BULK-SCHEDULE-FROM-REQUIREDНе указан параметр from
SMS-CREATE-BULK-SCHEDULE-FROM-INVALID-TYPEПараметр from имеет недопустимый тип
SMS-CREATE-BULK-SCHEDULE-FROM-INVALID-FORMATПараметр from не соответствует формату
SMS-CREATE-BULK-SCHEDULE-FROM-INVALID-RANGEВремя отправки не может быть в прошлом, а также быть в будущем больше, чем на 30 суток
SMS-CREATE-BULK-SCHEDULE-TILL-INVALID-TYPEПараметр till имеет недопустимый тип
SMS-CREATE-BULK-SCHEDULE-TILL-INVALID-FORMATПараметр till не соответствует формату
SMS-CREATE-BULK-SCHEDULE-TILL-INVALID-RANGEВремя отправки не может быть в прошлом, а также быть в будущем больше, чем на 30 суток
SMS-CREATE-BULK-EXPIRE-INVALID-TYPEПараметр expire имеет недопустимый тип
SMS-CREATE-BULK-EXPIRE-INVALID-FORMATПараметр expire не соответствует формату
SMS-CREATE-BULK-EXPIRE-INVALID-RANGEСрок жизни не может быть меньше часа или больше 3 суток