Asynchronous sending of messages

Example of a request for sending messages asynchronously. A large packet of messages can be sent asynchronously. The system accepts all messages to be sent, and in response it gives a task ID, by which you can find out the status and result of its execution.

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 message-asynctagrequired 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 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-async>
        <msg id="1234" recipient="+380971234567" sender="SMSTest" type="0">Message text to be sent via SMS</msg>
        <msg id="4321" recipient="+380501234567" sender="SMSTest" type="0">Message text to be sent via SMS</msg>
    </message-async>
</package>

Response parameters

packagetag Tag to transmit the credentials required for authorization message-asynctag Tag specifying the type of request jobtag | varchar(64) Tag containing task ID

Response examples

Successful

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

<?xml version="1.0" encoding="utf-8" ?>
<package>
    <message-async>
        <job>8714ea91e9bb454d25ef42ba6f18ea4e</job>
    </message-async>
</package>