Requesting the results of an asynchronous task

Example of requesting the results of an asynchronous task. Once the sms is set to send, you can request the status of task completion. For each task, the results of execution are stored for 12 hours.

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 jobtagrequired Task ID received during asynchronous sending

Request example

<?xml version="1.0" encoding="utf-8" ?>
<package key="bb56a4369eb19***cfec6d1776bd25">
    <job>8714ea91e9bb454d25ef42ba6f18ea4e</job>
</package>

Response parameters

packagetag Tag to transmit the credentials required for authorization jobtag Tag specifying the type of request progresstag | int(0,100) Numerical value in percentage of the number of processed messages statustag | string Current task status: WAITING - task is waiting in the execution queue RUNNING - task in progress FAILED - error during task execution. Perhaps some of the messages are accepted for sending. This can be found out by requesting message delivery statuses by user ID COMPLETE - task completed NOTFOUND - task not found

Response examples

Successful

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

<?xml version="1.0" encoding="utf-8" ?>
<package>
    <job>
        <progress>50</progress>
        <status>RUNNING</status>
    </job>
</package>