Methods 1.1:getTraffic/ru

From Aviberry API

Jump to: navigation, search

К содержанию
Другие методы
Возникли вопросы?


getTraffic - Метод возвращает информацию о трафике пользователя.

Contents

Сигнатура 

object getTraffic()

Параметры

Отсутствуют.

Возвращаемое значение

Тип: object.
Результат вызова метода - объект , содержащий пары ключ=значение, где ключ - это тип трафика, а значение - объект, содержащий информацию об использовании данного типа трафика.

Типы трафика:

  • total - суммарный трафик;
  • tariffed - трафик, который входит в тарифный план пользователя;
  • purchased - докупленный трафик.



Свойства каждого объекта, содержащего информацию об использованном трафике:

limit

limit - Лимит доступного трафика, в байтах.
Тип: string.

usage

usage - Уже использованный трафик, в байтах.
Тип: string.

Т.к. значения limit и usage в байтах могут быть достаточно большими и выходить за пределы "стандартного" integer в 4 байта, то значения возвращается как строки. Пользователь сам должен преобразовать их в требуемое численное представление, если необходимо.

Примеры

XML-RPC

Вызов getTraffic 

<?xml version='1.0'?>
<methodCall>
<methodName>getTraffic</methodName>
</methodCall>

Возвращаемое значение 

<methodResponse>
    <params>
        <param>
            <value><struct>
                <member>
                    <name>total</name>
                    <value><struct>
                        <member>
                            <name>usage</name>
                            <value><i4>542325328</i4></value>
                        </member>
                        <member>
                            <name>limit</name>
                            <value><double>5368709120000000</double></value>
                        </member>
                    </struct></value>
                </member>
                <member>
                    <name>tariffed</name>
                    <value><struct>
                        <member>
                            <name>usage</name>
                            <value><string>542325328</string></value>
                        </member>
                        <member>
                            <name>limit</name>
                            <value><string>5368709120000000</string></value>
                        </member>
                    </struct></value>
                </member>
                <member>
                    <name>purchased</name>
                    <value><struct>
                        <member>
                            <name>usage</name>
                            <value><string>0</string></value>
                        </member>
                        <member>
                            <name>limit</name>
                            <value><string>0</string></value>
                        </member>
                    </struct></value>
                </member>
            </struct></value>
        </param>
    </params>
</methodResponse>

JSON-RPC

Вызов getTraffic 

{
	"version":"1.1",
	"method":"getTraffic",
	"id":1
}

Возвращаемое значение 

{
    "version":"1.1",
    "id":1,
    "result":
    {
        "total":
        {
            "usage":542325328,
            "limit":5368709120000000
        },
        "tariffed":
        {
            "usage":"542325328",
            "limit":"5368709120000000"
        },
        "purchased":
        {
            "usage":"0",
            "limit":"0"
        }
    }
}


К содержанию
Другие методы
Возникли вопросы?

Retrieved from "http://api.aviberry.com/Methods_1.1:getTraffic/ru"
Views
Personal tools
In other languages