Запланированное сообщение

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

URI: /api/xml.php

Все запросы к API отправляются в формате XML с помощью метода POST.

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

packagetagобязательный Тег для передачи учетных данных, необходимых для авторизации keyattribute | varcharобязательный Ваш API-ключ, который можно получить в личном кабинете messagetagобязательный Тег, который определяет тип запроса msgtag Тег сообщения. Текст сообщения передается как параметр idattribute | integer Числовой идентификатор сообщения пользователя. При использовании пользователь должен убедиться, что этот идентификатор является уникальным в пределах его аккаунта recipientattribute | varchar(21)обязательный Номер телефона получателя сообщения senderattribute | varchar(11)обязательный Подпись в сообщении date_begattribute | datetime Дата отправки сообщения в формате ISO 8601 date_endattribute | datetime Дата, когда сообщение, не дождавшись получателя, будет аннулировано, в формате ISO 8601. Указывается для ограничения времени жизни SMS-сообщений. Минимум +1 минута, максимум +5 дней с момента отправки SMS. По умолчанию +1 день typeattribute | integerобязательный Тип сообщения: 0 - обычное сообщение 1 - flash сообщение 2 - wap-push сообщение 3 - голосовое сообщение (только на домашние телефоны в Украине)

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

<?xml version="1.0" encoding="utf-8" ?>
<package key="bb56a4369eb19***cfec6d1776bd25">
    <message>
        <msg id="1234" recipient="+380971234567" sender="SMSTest" date_beg="2024-11-30T12:00" date_end="2024-11-31T12:00" type="0">Текст сообщения для отправки по SMS</msg>
    </message>
</package>

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

packagetag Тег для передачи учетных данных, необходимых для авторизации messagetag Тег, который определяет тип запроса msgtag Тег сообщения. Статус сообщения возвращается как параметр idattribute | integer Числовой идентификатор сообщения пользователя sms_idattribute | integer Числовой идентификатор сообщения, назначенный шлюзом sms_countattribute | integer Количество сообщений, использованных для отправки указанного текста

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

Успешный

HTTP Status Code: 200
Content Type: JSON application/json

<?xml version="1.0" encoding="utf-8" ?>
<package>
    <message>
        <msg id="1234" sms_id="1234568" sms_count="1">1</msg>
    </message>
</package>

Неверный идентификатор сообщения

HTTP Status Code: 200
Content Type: JSON application/json

<?xml version="1.0" encoding="utf-8" ?>
<package>
    <message>
        <msg id="7777" sms_id="0" sms_count="1">201</msg>
    </message>
</package>