diff --git a/docs/apicalls.rst b/docs/apicalls.rst index 9a25d1c48..cecc6aec2 100644 --- a/docs/apicalls.rst +++ b/docs/apicalls.rst @@ -1,9 +1,9 @@ -6.1. API Calls -============== +API Calls +========= The general API usage of the CGRateS involves creating a CallDescriptor structure sending it to the balancer via JSON/GOB RPC and getting a response from the balancer in form of a CallCost structure or a numeric value for requested information. -6.1.1. CallDescriptor structure -------------------------------- +CallDescriptor structure +------------------------ - Direction, TOR, Tenant, Subject, Account, DestinationPrefix string - TimeStart, TimeEnd Time - Amount float64 @@ -28,8 +28,8 @@ Amount The **Subject** field is used usually used to identify both the client in the detailed cost list and the user in the balances database. When there is some additional info added to the subject for the call price list then the **Account** attribute is used to specify the balance for the client. For example: the subject can be rif:from:ha or rif:form:mu and for both we would use the rif account. -6.1.2. CallCost structure -------------------------- +CallCost structure +------------------ - TOR int - CstmId, Subject, DestinationPrefix string - Cost, ConnectFee float64 @@ -77,8 +77,8 @@ In the stress folder you can find a better example of python client using a clas result = rpc.call("Responder.Get", cd) print result -6.1.3. Call API ---------------- +Call API +-------- GetCost Creates a CallCost structure with the cost information calculated for the received CallDescriptor. @@ -116,8 +116,8 @@ FlushCache Cleans all internal cached (Destinations, RatingProfiles) -6.1.4. Tariff plan importer APIs --------------------------------- +Tariff plan importer APIs +------------------------- These operate on a tpid and are used to import the tariff plan content into storDb. @@ -212,8 +212,8 @@ AccountActions api_tpaccountactions -6.1.5. Management API ---------------------- +Management API +-------------- These operate on live data. GetDestination diff --git a/docs/ratinglogic.rst b/docs/ratinglogic.rst index e24ab9391..f5a09a109 100644 --- a/docs/ratinglogic.rst +++ b/docs/ratinglogic.rst @@ -1,5 +1,5 @@ -6.2. Rating logic -================= +Rating logic +============ Let's start with the most important function: finding the cost of a certain call. @@ -91,8 +91,8 @@ At this point in rating process the engine will start splitting the call into va The result of this splitting will be a list of *TimeSpan* structures each having attached the MinuteInfo or the RateInterval that gave the price for it. The *CallDuration* attribute will select the right *Price* from the *RateInterval* *Prices* list. The final cost for the call will be the sum of the prices of these times spans plus the *ConnectionFee* from the first time span of the call. -6.2.1 User balances -------------------- +User balances +------------- The user account contains a map of various balances like money, sms, internet traffic, internet time, etc. Each of these lists contains one or more Balance structure that have a wheight and a possible expiration date.