Webcom Mobi API Docs
RU
  • Introduction
  • СПОСОБЫ ВЗАИМОДЕЙСТВИЯ С A2P ПЛАТФОРМОЙ
    • JSON specification
      • Sending SMS, Viber, Flash SMS, WAP-Push
      • SMS status request
        • POST request
        • Webhook
      • Balance check request
    • HTTP GET specification
      • Sending SMS
      • Sending Viber
      • Sending Cascade
      • Request message status
      • Registration
    • XML specification
      • Sending SMS, Viber, Flash SMS, WAP-Push
      • SMS status request
        • POST request
        • Webhook
      • Balance check request
      • Request to receive a list of senders
      • Request to add senders
      • Request for incoming SMS
      • Request for information by phone number
      • Request for obtaining the list of bases
      • Request to change parameters, add/remove bases
      • Request for receiving the list of subscribers of the base
      • Request to add/edit/delete subscribers of the base
      • Request to get the list of numbers from the STOP list
      • Request to add/remove subscribers to the STOP list
      • Request to receive the list of scheduled SMS
      • Request to delete a scheduled SMS
      • Request to get the time of change of something
      • Request for time verification
      • File upload request
      • Request to refill users' balance
    • ВЗАИМОДЕЙСТВИЕ С ПЛАТФОРМОЙ MSG (НЕОФ КАНАЛЫ)
    • Specification JSON
      • Чекинг базы номеров
Powered by GitBook
On this page
  • Balance check request
  • Deciphering parameters in query responses
  • Example XML request
  • Example
  1. СПОСОБЫ ВЗАИМОДЕЙСТВИЯ С A2P ПЛАТФОРМОЙ
  2. XML specification

Balance check request

Balance check request

POST http://lk.mysmpp.ru/xml/balance.php

Headers

Name
Type
Description

Content-type*

String

text/xml; charset=utf-8;

Request Body

Name
Type
Description

login.value*

String

Your login in the system

password.value*

String

Your password in the system

token.value*

String

You can use a secret key instead of login and password. To obtain it, please contact your manager

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>150</money>
     <sms area="Russia">111</sms>
     <sms area="Ukraine">111</sms>
</response>
<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>Error message</error>
</response>

Deciphering parameters in query responses

Parameter
Data type
Description

money

Int

Fund balance

sms

Int

Number of available SMS messages for this destination

sms.area

String

The direction in which a given quantity of SMS can be shipped

error

String

The error text can take the following values:

  • Incorrect XML document format

  • Incorrect login or password

  • POST data is missing

Example XML request

<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="login" />
      <password value="password" />
   </security>
</request>

The number of SMS cannot be summarized for different directions. When sending SMS in one direction, the number of available SMS messages in all other directions is reduced according to their cost.

Example

You have 10 y.e. on your balance.

The cost of SMS message sent to Russia is 1 y.e.

The cost of SMS message sent to Ukraine is 2 y.e.

The following XML document will be returned to you:

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>10</money>
     <sms area="Russia">10</sms>
     <sms area="Ukraine">5</sms>
</response>

If you send two sms to Russia, the XML document will change as follows:

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>8</money>
     <sms area="Russia">8</sms>
     <sms area="Ukraine">4</sms>
</response>

Last updated 1 year ago