Документация API Webcom Mobi
  • Общая информация
  • История изменений
  • Отправка сообщения
  • Проверка статуса сообщения
    • POST запрос
    • Webhook
  • Проверка баланса
  • Регистрация
  • Получение списка отправителей
  • Добавление отправителей
  • Получение входящих сообщений
  • Получение информации по номеру телефона
  • Получение списка баз
  • Изменение параметров, добавление/удаление баз
  • Получение списка абонентов базы
  • Добавление/редактирование/удаление абонентов базы
  • Получение списка номеров из СТОП-листа
  • Добавление/удаление абонентов в СТОП-лист
  • Получение списка запланированных сообщений
  • Удаление запланированного сообщения
  • Получение времени изменения чего-либо
  • Проверка времени
  • Пополнение баланса пользователям
  • Загрузка файлов
  • Протокол SMPP v.3.4
    • Руководство по взаимодействию с сервисом
    • Спецификация
    • Описание статусов ошибок
Powered by GitBook

Проверка баланса

Спецификации для проверки баланса: JSON, XML

Метод отправки POST

Кодировка XML-документов: UTF-8

Обязательный заголовок: Content-type: text/xml; charset=utf-8;

Адрес для запроса: https://my3.webcom.mobi/xml/balance.php

Параметры запроса на отправку сообщения

Параметр
Тип
Описание

request

.security

.login

[value]*

String

Ваш логин в системе

request

.security

.password

[value]*

String

Ваш пароль в системе

request

.security

.token

[value]*

String

Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру

*- обязательный параметр

В случае получения правильного XML-документа

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>150</money>
     <sms area="Россия">111</sms>
     <sms area="Украина">111</sms>
</response>
Параметр
Тип
Описание

response

.money

Int

Остаток средств

response

.sms

Int

Количество доступных SMS сообщений для данного направления

response

.sms

[area]

String

Направление, в котором может быть отправлено данное количество сообщений

В случае возникновения ошибки в отправленном XML-документе

<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>текст ошибки</error>
</response>
Параметр
Тип
Описание

response

.error

String

Текст ошибки может принимать следующие значения:

  • Неправильный формат XML документа

  • Ваш аккаунт заблокирован

  • Неправильный логин или пароль

  • POST данные отсутствуют

Пример XML запроса

<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="логин" />
      <password value="пароль" />
   </security>
</request>

Метод отправки POST

Кодировка JSON-документов: UTF-8

Обязательный заголовок: Content-type: text/json; charset=utf-8;

Адрес для запроса: https://my3.webcom.mobi/json/balance.php

Параметры запроса на отправку сообщения

Параметр
Тип
Описание

login*

String

Ваш логин в системе

password*

String

Ваш пароль в системе

token*

String

Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру

*- обязательный параметр

В случае получения правильного JSON-документа

{
    "money": "19023.9",
    "currency": "RUR",
    "information": 
        [
            {
                "type_sms": "sms",
                "area": "Tele2",
                "num_sms": "72029"
            }, 
            {
                "type_sms": "sms",
                "area": "Россия",
                "num_sms": "Безлимит"
            }
        ]
}
Параметр
Тип
Описание

money

Int

Остаток средств

currency

String

Валюта

information

.type_sms

String

Тип сообщения

information

.area

String

Направление, в котором может быть отправлено данное количество сообщений

information

.num_sms

Int/String

Количество доступных сообщений для данного направления

В случае возникновения ошибки в отправленном JSON-документе

{
    "error": "Текст ошибки."
}
Параметр
Тип
Описание

error

String

Текст ошибки может принимать следующие значения:

  • Неправильный формат JSON документа

  • Ваш аккаунт заблокирован

  • Неправильный логин или пароль

  • POST данные отсутствуют

Пример JSON запроса

{
    "login": "логин",
    "password": "пароль",
}

Last updated 1 year ago