Заплановане повідомлення

Приклад запиту для відправки запланованого повідомлення.

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>