Message status

Example of a request to get the status of a message. Message statuses contain information about the current status of the message, are updated regularly and can be requested by the user at any time.

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 statustagrequired 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 sms_idattribute | integer Numeric message identifier assigned by the gateway

Request example

<?xml version="1.0" encoding="utf-8" ?>
<package key="bb56a4369eb19***cfec6d1776bd25">
    <status>
        <msg id="1234"></msg>
        <msg sms_id="1234569"></msg>
    </status>
</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 date_completedattribute | datetime Date of assignment of final status in ISO 8601 format

Response examples

Successful

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

<?xml version="1.0" encoding="utf-8" ?>
<package>
    <status>
        <msg id="1234" sms_id="1234568" sms_count="1" date_completed="2024-11-11T12:00:00">102</msg>
        <msg id="4321" sms_id="1234569" sms_count="1">1</msg>
    </status>
</package>