Scheduled SMS

Example of a request to send a scheduled message.

URI: /api/xml.php

All requests to API are sent in XML format using the POST method.

Request parameters

packagetagrequired Tag to transmit the credentials required for authorization keyattribute | varcharrequired Your API key, which can be obtained in your personal cabinet messagetagrequired Tag specifying the type of request msgtag Message tag. The message text is passed as a parameter idattribute | integer User numeric message identifier. When used, the user must ensure that this identifier is unique within their account recipientattribute | varchar(21)required Phone number of the recipient of the message senderattribute | varchar(11)required Signature in the message date_begattribute | datetime Date the message was sent in ISO 8601 format date_endattribute | datetime The date when the message will be canceled without waiting for the recipient, in ISO 8601 format. Specified to limit the lifetime of SMS messages. Minimum +1 minute, maximum +5 days from the moment of SMS sending. By default +1 day. typeattribute | integerrequired Type of message: 0 - usual message 1 - flash message 2 - wap-push message 3 - voice message (only to home phones in Ukraine)

Request example

<?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">Message text to be sent via SMS</msg>
    </message>
</package>

Response parameters

packagetag Tag to transmit the credentials required for authorization messagetag Tag specifying the type of request msgtag Message tag. Message status is returned as a parameter idattribute | integer User numeric message identifier sms_idattribute | integer Numeric message identifier assigned by the gateway sms_countattribute | integer Number of messages used to send the specified text

Response examples

Successful

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>

Wrong message ID

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>