Создание одиночного сообщения SMS

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

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

Параметр	Тип	Обязательный	Описание
signature_id	string	Да	Идентификатор подписи отправителя
phone	string	Да	Номер телефона в международном формате
message	string	Да	Текст сообщения
schedule	datetime	Нет	Дата и время отправки в формате ISO 8601
expire	datetime	Нет	Дата и время окончания срока жизни в формате ISO 8601

Пример запроса

{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "sms-create",
    "data": {
        "signature_id": "08b05080-ec96-4554-b294-16ccf4d87675",
        "phone": "+79401234567",
        "message": "SMS test message",
        "schedule": "2024-01-31T12:34:56+03:00",
        "expire": "2024-01-31T18:00:00+03:00"
    }
}

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

Параметр	Тип	Описание
id	string	Идентификатор SMS
created	datetime	Дата и время создания SMS в формате ISO 8601
updated	datetime	Дата и время обновления SMS в формате ISO 8601
signature	string	Подпись отправителя SMS
phone	string	Номер телефона в международном формате
message	string	Текст сообщения SMS
parts	integer	Количество частей SMS
price	double	Стоимость одной части SMS
total	double	Полная стоимость SMS
status	string	Статус SMS
paused	boolean	Приостановка отправки SMS
paid	boolean	Состояние списания средств за SMS

Пример ответа

{
    "success": true,
    "data": {
        "id": "0cd2d91a-559a-4e11-8bb7-ebdbaa4f324a",
        "created": "2024-01-31T08:10:32+03:00",
        "updated": "2024-01-31T08:10:32+03:00",
        "signature": "TestSMS",
        "phone": "+79401234567",
        "message": "SMS test message",
        "parts": 1,
        "price": 2.49,
        "total": 2.49,
        "status": "delivered",
        "paused": false,
        "paid": false
    }
}

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

Ошибка	Описание
SMS-CREATE-SIGNATURE-ID-REQUIRED	Не указан параметр signature_id
SMS-CREATE-SIGNATURE-ID-INVALID-TYPE	Параметр signature_id имеет недопустимый тип
SMS-CREATE-SIGNATURE-ID-INVALID-FORMAT	Параметр signature_id не соответствует формату
SMS-CREATE-SIGNATURE-ID-NOT-FOUND	Подпись отправителя не найдена
SMS-CREATE-PHONE-REQUIRED	Не указан параметр phone
SMS-CREATE-PHONE-INVALID-TYPE	Параметр phone имеет недопустимый тип
SMS-CREATE-PHONE-INVALID-FORMAT	Параметр phone не соответствует формату
SMS-CREATE-PHONE-BLACKLISTED	Номер телефона находится в черном списке
SMS-CREATE-PHONE-OPERATOR-NOT-FOUND	Невозможно определить оператора
SMS-CREATE-PHONE-ROUTE-NOT-FOUND	Отсутствует подходящий маршрут
SMS-CREATE-MESSAGE-REQUIRED	Не указан параметр message
SMS-CREATE-MESSAGE-INVALID-TYPE	Параметр message имеет недопустимый тип
SMS-CREATE-MESSAGE-INVALID-FORMAT	Параметр message не соответствует формату
SMS-CREATE-SCHEDULE-INVALID-TYPE	Параметр schedule имеет недопустимый тип
SMS-CREATE-SCHEDULE-INVALID-FORMAT	Параметр schedule не соответствует формату
SMS-CREATE-SCHEDULE-INVALID-RANGE	Время отправки не может быть в прошлом, а также быть в будущем больше, чем на 30 суток
SMS-CREATE-EXPIRE-INVALID-TYPE	Параметр expire имеет недопустимый тип
SMS-CREATE-EXPIRE-INVALID-FORMAT	Параметр expire не соответствует формату
SMS-CREATE-EXPIRE-INVALID-RANGE	Срок жизни не может быть меньше часа или больше 3 суток