Methods 1.1:getTraffic

From Aviberry API

Jump to: navigation, search
Languages Language: 

English  • Русский

Contents
Other methods
Still have a question?


getTraffic - returns information about user traffic.

Contents

Signature 

object getTraffic()

Parameters

None.

Return value

Type: object.
Method call result is object containing matches key=value, where key is traffic type, and value is object containing information about usage of this traffic type.

Traffic types:

  • total - total traffic;
  • tariffed - traffic included into user's tariff plan;
  • purchased - additionally purchased traffic.



Properties of every object containing information about consumed traffic:

limit

limit - user traffic limit in bytes.
Type: string.

usage

usage - traffic consumed by user in bytes.
Type: string.

Since limit and usage values in bytes can be large enough to exceed "standard" integer by 4 bytes, the values are returned as strings. Client should convert them manually in required numeric value, if needed.

Examples

XML-RPC

getTraffic 

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

Return value 

<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
}

Return value 

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


Contents
Other methods
Still have a question?

Languages Language: 

English  • Русский

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