Project

General

Profile

Accounting guide » History » Version 1

Tijmen de Mes, 11/26/2012 11:28 AM

1 1 Tijmen de Mes
h1. Accounting guide
2
3
4
"!http://cdrtool.ag-projects.com/raw-attachment/wiki/WikiStart/OpenSIPS-accounting.png(http://cdrtool.ag-projects.com/raw-attachment/wiki/WikiStart/OpenSIPS-accounting.png)!":http://cdrtool.ag-projects.com/raw-attachment/wiki/WikiStart/OpenSIPS-accounting.png
5
6
The platform generates usage information in the form of rated Call Detail Records (CDR). It is the responsibility of the Operator to import the rated CDRs into its own billing system and to generate printable invoices out of them.
7
8
The CDRs can be easily searched and grouped by various criteria and exported into comma separated value files. Accounting can be done postpaid (default option) or prepaid (enabled per SIP account). Postpaid accounts can have a monthly quota assigned to prevent fraud.
9
10
h2. CDR Generation
11
12
Call detail records (CDRs) are generated from the SIP sessions established through the platform. A CDR contains relevant information about a SIP session from both signaling and data planes. The CDR is generated by combining several Radius requests from OpenSIPS and MediaProxy as follows:
13
14
15
|*Radius request*|*When*|*Component*|*Description*|
16
|FAILED|First INVITE with negative code|OpenSIPS|Zero second (failed) session|
17
|START|First INVITE with positive code|OpenSIPS|Start of new session|
18
|STOP|BYE|OpenSIPS|Stop of existing session|
19
|UPDATE|RTP stop|MediaProxy|Stop or timeout of existing RTP stream|
20
21
22
h3. Radius logs
23
24
Radius requests generated by the platform are logged by the Freeradius server in the following places:
25
26
27
|*Directory*|*Log type*|
28
|/var/log/freeradius/radacct/IP/detail-YYYYMM|Radius tickets contents|
29
|/var/log/freeradius/radacct/radius.log|Radius errors|
30
31
32
The most relevant attribute of a CDR is the session duration. The cost for the session depends on this session duration. The sessions duration is determined by the Stop time and Start time of the SIP session. The Start time is considered the moment when the answer for the first INVITE has entered the SIP Proxy. Stop time is determined either by the presence of BYE message or in case BYE is missing from the last moment RTP has ben relayed though MediaProxy.
33
34
bq. It is not possible to determine the stop time of a session in the following situation:
35
36
37
38
# First INVITE is answered with a positive code
39
# No BYE is received
40
# No RTP data has been relayed
41
42
h3. Media timeout
43
44
If the RTP media has timed out (both parties stopped sending RTP) while no BYE has been received by the SIP Proxy:
45
46
# MediaProxy will set in the Radius UPDATE the MediaInfo Radius attribute to *timeout*
47
# MediaProxy will trigger the sending of a a BYE message via the dialog module of OpenSIPS
48
49
In this situation, the actual duration of the SIP session contains the period of the RTP stream plus the value of the timeout. The value of the timeout is determined by the connection tracking logic in the Linux kernel. At this moment there is no mechanism to store into the Radius database the value of this timeout, which is typically 180 seconds.
50
51
h3. CDR tables
52
53
CDRs are stored in monthly tables in radius database. The tables are named radacctYYYYMM. Tables are automatically created by the Radius server at the beginning of each month.
54
55
h3. CDR fields
56
57
58
|*Field*|*Type*|*Description*|Notes|
59
|RadAcctId|bigint(21)|MySQL unque index auto-incremented|
60
|AcctSessionId|varchar(255)|SIP call-id header|
61
|AcctUniqueId|varchar(255)|Radius internal session id|
62
|UserName|varchar(64)|SIP Username|Matched against billing_customers.subscriber|
63
|Realm|varchar(64)|SIP domain|Matched against billing_customers.domain|
64
|NASIPAddress|varchar(15)|SIP Proxy IP|
65
|NASPortId|varchar(50)|SIP Proxy port|
66
|NASPortType|varchar(255)|not used|
67
|AcctStartTime|datetime|Session start time|
68
|AcctStopTime|datetime|Session stop time|
69
|AcctSessionTime|int(12)|Session duration used for rating|
70
|AcctAuthentic|varchar(32)|not used|
71
|ConnectInfo_start|varchar(32)|not used|
72
|ConnectInfo_stop|varchar(32)|not used|
73
|AcctInputOctets|bigint(12)|Relayed RTP through MediaProxy|
74
|AcctOutputOctets|bigint(12)|Relayed RTP through MediaProxy|
75
|CalledStationId|varchar(50)|SIP To header, the original dialed number|
76
|CallingStationId|varchar(50)|SIP From header|
77
|AcctTerminateCause|varchar(32)|SIP response code|
78
|ServiceType|varchar(32)|Sip-Session|
79
|ENUMtld|varchar(64)|ENUM top level domain used for lookup|
80
|FramedIPAddress|varchar(15)|not used|
81
|AcctStartDelay|int(12)|not used|
82
|AcctStopDelay|int(12)|not used|
83
|SipMethod|varchar(50)|SIP method|
84
|SipResponseCode|smallint(5) unsigned|Response code for INVITE|
85
|SipToTag|varchar(128)|SIP to tag|
86
|SipFromTag|varchar(128)|SIP from tag|
87
|SipTranslatedRequestURI|varchar(255)|Final network address after DNS lookup|
88
|SipUserAgents|varchar(255)|SIP user agents/servers reported by MediaProxy|
89
|SipApplicationType|varchar(255)|Media type (e.g. audio)|
90
|SipCodecs|varchar(255)|RTP codecs report by MediaProxy|
91
|SipRPID|varchar(255)|PSTN caller id|
92
|SipRPIDHeader|varchar(255)|not used|
93
|SourceIP|varchar(255)|Source IP of the session|Matched against billing_customers.gateway|
94
|SourcePort|varchar(255)|Source port of the session|
95
|CanonicalURI|varchar(255)|Final logical destination used for rating|Matched against destinations table|
96
|DelayTime|varchar(5)|not used|
97
|Timestamp|bigint(20)|Packet timestamp|
98
|DestinationId|varchar(15)|Normalized E.164 prefix|Calculated during normalization|
99
|Rate|text|Description of rate calculation|Calculated during normalization|
100
|Price|double(20,4)|Cost of the session|Calculated during normalization|
101
|Normalized|enum('0','1')|If the CDR has been normalized|
102
|BillingId|varchar(255)|Reseller id used by trusted peers and SIP domains|Calculated during normalization|
103
|MediaInfo|varchar(32)|Mediaproxy information|
104
|RTPStatistics|text|RTP statistics reported by some devices|
105
|FromHeader|varchar(128)|not used|
106
|UserAgent|varchar(128)|SIP User Agent and Server headers|
107
|Contact|varchar(128)|not used|
108
109
110
h2. CDR Normalization
111
112
A CDR is considered closed when the stop time has been determined. Once the CDR is closed, a normalization process cleans up the CDR fields and calculates the price of the session. The price and the way its was calculated is saved together with the CDR in the same table. It is possible to re-normalize the sessions at a later time, for instance when the tariffs need to be changed for the past period.
113
114
Normalization is performed periodically:
115
116
# Whenever CDRTool web search is used
117
# By the cron job /var/www/CDRTool/script/normalize.php
118
119
Once normalized, the CDRs are no longed modified, the normalization process marks each CDR that has been processed.
120
121
122
|*Operation*|*When*|*Platform component*|*Description*|
123
|NORMALIZE|After CDR was closed|CDRTool|Rating is applied|
124
125
126
h3. Un-normalized sessions
127
128
Some SIP sessions can remain in the CDR database in an un-normalized state. They show in CDRTool as "in progress". Such sessions have a start date but no end date. Such sessions cannot be normalized automatically by the CDR normalization process because there is no indication when they have actually stopped. A SIP session is considered stopped when either a BYE message has been received by the SIP Proxy or when the RTP media has stopped flowing between the end-points, which is detected by the MediaProxy. If the RTP media has not started yet and no BYE has arrived after the initial INVITE/200 OK/ACK, there is no physical indication for when the session has started or when it ended. Due to the nature of the SIP protocol and in particular the fact that the RTP media is carried separately from the SIP signaling, it is always possible to have SIP sessions that from a call completion perspective have started but never ended. Such situations occur outside the control of the operator responsible for the SIP service. You may chose to apply your own policy for such sessions like deleting or archiving them.
129
130
h2. CDR Search
131
132
CDRs can be searched and displayed in CDRTool. Access to CDRTool can be provided to resellers or end-users of the platform.
133
134
"!http://cdrtool.ag-projects.com/raw-attachment/wiki/WikiStart/CDRTool-CallSearch.jpg(http://cdrtool.ag-projects.com/raw-attachment/wiki/WikiStart/CDRTool-CallSearch.jpg)!":http://cdrtool.ag-projects.com/raw-attachment/wiki/WikiStart/CDRTool-CallSearch.jpg
135
136
Last placed and received calls are also available for every SIP account using SOAP/XML functions:
137
138
* SipPort->getCalls()
139
140
h2. CDR Export
141
142
CDRs can be exported from CDRTool in comma separated values (CSV) format or by selecting the raw content of the MySQL radacctYYYYMM tables. Such operation can take time to complete and is advisable to use always a MySQL slave server for these queries.
143
144
h2. Rating Logic
145
146
CDRTool provides on-the-fly rating of CDRs generated by the platform.
147
148
A Call Detail Record (CDR) is one record from the radius radacct table. The CDR contains all information related to a session, its duration, the calling and called party and media information. The rating engine calculates the price of the session. The calculation is done once and its results are saved in the CDR table for later use. It is possible to re-calculated the prices at a later time for example when having to change the tariffs.
149
150
Based on exceptions, different rates may be applied per:
151
152
# Caller party (SIP account)
153
# Caller domain
154
# Source IP address
155
156
Rating is applied only after the call has ended. CDRTool considers that a call has ended when there is a stop time. In case of missing BYEs, CDRTool relies on the fact that MediaProxy will update the CDR with the proper stop time information based on the last moment the media stream passed through the media proxy.
157
158
The rates are linked with profiles corresponding with different time of the day, day of the week or holidays. For rating calls, which span multiple profiles, the right rate is selected and applied for the call duration within each profile. Each customer may be assigned its own dedicated rating plans destination id and names. Chained profiles are possible to enable exception based rating. Multiple customers may share a common rate list, while some destinations may be rated differently, only the differences must be provisioned. Multiple time zones are supported for multiple billing parties hosted on the same platform.
159
160
Different customers can have different rating plans. A rating plan is a unique combination of holidays, day of week, time of day, destination ids, and associated costs.
161
162
The following steps are performed to rate a CDR:
163
164
# Determination of the billing party
165
# Determination of the destination id
166
# Determination of the costs
167
168
The steps are described in detail below.
169
170
h3. Determination of the billing party
171
172
To be able to calculate the Price for a call the rating engine must determine whose rating plan to use.
173
174
The rating engine does this by performing a match against entries in the billing_customers table for the the BillingPartyId field of the the CDR (radacct.UserName for radius based datasources) in the following order:
175
176
# SIP account user@domain
177
# SIP domain of the SIP account
178
# Source IP of the session
179
# Default (when none of the above matches)
180
181
The first match is considered to be the billing party for which the rating plan is determined.
182
183
The rating plan is further derived from the profiles associated with the entry found in the billing_customers.
184
185
bq. The billing_customers table field that matches the Source IP is called gateway. "gateway" or "trusted peer" terms are used interchangeably in this document. They both relate to the source IP address that generated the SIP session.
186
187
188
189
h3. Determination of the destination id
190
191
The rating engine identifies the 'destination id', which has associated rates depending on day of week and time of day.
192
193
The 'destination id' is for example a country prefix like '31' for the Netherlands. This 'destination id' has prices associated with it so all calls to the Netherlands will have prices associated with prefix '31'.
194
195
The 'destination id' is derived from the logical destination the SIP session has been routed to. In SIP headers and Radius records there are multiple places that contain information related to the destination. Some of them are generated by the SIP User-Agents (hence cannot be trusted and must not be used for accounting purposes) and others are generated by the SIP Proxy configured by the operator and are suitable for accounting purposes.
196
197
The rating engine considers the destination to be the first non-empty CDR field in this order:
198
199
# CanonicalURI (the destination after all lookups inside the SIP Proxy)
200
# SipTranslatedRequestURI (the Request URI as presented by the SIP UA)
201
# CalledStationId (the content of the To header, used as a last resort)
202
203
The CanonicalURI is the preferred because is reliable information generated by the operator based on the logic configured in the SIP Proxy and the subscriber cannot control it. OpenSIPS must be configured to send the CanonicalURI Radius attribute when creating the radius accounting START record. Instructions for this are available in INSTALL.txt file.
204
205
The 'destination id' is then calculated based on the longest match of this destination field in the billing_destinations table.
206
207
The longest match for the chosen destination field is performed by the E164_class, which by default uses E164_Europe that defines an European numbering plan. It assumes the destinations start with a zero for a national call and with double zero for an international call. See cdr_generic.php for the actual logic.
208
209
If your dialing plan is different, you must use other provided class like E164_US or create a custom class and point to it in global.inc for each datasource as follows:
210
211
bc(wiki). 'E164_class'=>'MyE164Class',
212
213
214
For example the pre-defined E164_US class from cdr_generic.php matches the American dialing plan.
215
216
h3. Determination of the costs
217
218
The following steps are taken to determine the cost for the calls based on the 'destination id' and the billing party determined at the previous steps.
219
220
# Lookup the billing profiles in cdrtool.billing_customers table in the following order: subscriber,domain,gateway (based on $this->dayofweek), as explained in "Determination of the billing party" above:
221
222
* profile_name1 matches week days [1-5]
223
* profile_name1_alt matches week days [1-5] if no rates for profile_name1 are found
224
* profile_name2 matches week-ends [6-0]
225
* profile_name2_alt matches week-ends [6-0] if no rates for profile_name2 are found
226
* profile_name2 matches also holidays from billing_holidays table
227
228
The week starts with 0 (Sunday) and ends with 6 (Saturday). This step determines which rates should be applied based on the day of the week when the call started.
229
230
<ol start="2">
231
<li>Using the profile&#95;name found, lookup the rate&#95;name based on $this-&gt;hourofday in cdrtool.billing&#95;profiles table</li>
232
</ol>
233
234
If no rate&#95;name is found for the given profiles a second set of profiles are used, profile&#95;name1&#95;alt and profile&#95;name2&#95;alt.
235
236
* the day may be split in maximum 4 periods
237
* the days starts with hour 0 and ends with hour 24
238
* rate&#95;name1 defines the first interval after hour 0
239
* rate&#95;name2 defines the first interval after rate&#95;name1
240
* rate&#95;name3 defines the first interval after rate&#95;name2
241
* rate&#95;name4 defines the first interval after rate&#95;name3
242
243
When the hour matches an interval use the rate&#95;nameX found to lookup the rate in billing&#95;rates, if no record is found use the rate called 'default'. This step determines which rate should be applied for the time of day when the call started.
244
245
<ol start="3">
246
<li>Lookup in the cdrtool.billing&#95;rates table the record having same name found at point 2 having billing&#95;rates.destination = 'destination id' and billing&#95;rates.application = application type found in the steps above.</li>
247
</ol>
248
249
* return an array with all the rating values and the duration rated
250
251
No rate will be returned if no 'destination id' is found. Make sure each possible destination has a 'corresponding id' and name in the destinations table.
252
253
This step determines the costs within the current time span associated with the time of day and destination id. If the call duration exceeds this time span (that is a new interval for which another rate applies is reached), step 4 is performed.
254
255
<ol start="4">
256
<li>If the duration rated at point 3 is less than total call duration, apply point 3 again for the remaining call duration in the next profile. A maximum of 10 spans (different rates depending of time of day, day of the week) can be calculated using this mechanism. After 10 spans, the engine bails out to avoid loops caused by invalid tables provisioning.</li>
257
</ol>
258
259
<ol start="5">
260
<li>Calculate the total call Price based on its duration and connection fees.</li>
261
</ol>
262
263
In global.inc there are several variables that affect how the price is calculated. These settings are global per CDRTool installation but some can be overwritten with per customer values in the billing&#95;customers table.
264
265
bc(wiki).    $RatingEngine=array(
266
           "priceDenominator"        => 10000, // Rates units (global setting)
267
           "priceDecimalDigits"      => 4,     // Decimal information (global setting)
268
           "minimumDurationCharged"  => 0,     // Rate a minimum of X seconds (per customer)
269
           "minimumDuration"         => 0,     // Minimum duration to rate, if call duration is shorter the price is zero (per customer)
270
           "durationPeriodRated"     => 60     // Rate is per 60 seconds (global setting)
271
           "trafficSizeRated"        => 1024,  // Default we rate per 1 MB (global setting)
272
           "reportMissingRates"      => 0      // Send emails to administrator in case of missing rates
273
            );
274
275
276
Pricing formula:
277
278
<pre class="wiki">
279
   if min_duration then
280
        minimumDurationCharged = min_duration
281
   else if minimumDurationCharged set in global inc
282
        use minimumDurationCharged from global.inc
283
   else
284
        minimumDurationCharged = call duration
285
286
   if increment then
287
        durationForRating = round to the next increment
288
   else
289
        durationForRating = call duration
290
291
   if durationForRating &gt;= minimumDurationCharged then
292
        Price = connectCost/priceDenominator+
293
        durationRate*durationForRating/durationPeriodRated/priceDenominator
294
   else
295
        Price = 0
296
</pre>
297
298
ENUM discounts
299
300
The rating engine can apply a discount associated with the ENUM top level domain that returned the final destination.
301
302
bc(wiki). Price = Price - Price * ENUM discount / 100
303
304
305
To apply ENUM based discounts, the ENUM TLD must be saved with each CDR and the TLDs with their corespondent discounts must be provisioned in the Rating tables section. See ENUM TLD discounts section for more information.
306
307
Purchasing price
308
309
A second price called 'Price in' is calculated using the same formula but based on connectCostIn and durationRateIn values. It can be used to match the purchasing price and calculate the margin between purchasing and selling prices. The information about both prices is stored in the RateInfo field of the CDR. The values for connectCostIn and durationRateIn must be provisioned in the billing&#95;rates and billing&#95;rates&#95;history tables using the web interface or by importing csv files.
310
311
<ol start="7">
312
<li>Save the calculated Price, billing party and 'destination id' for each call in the CDR table. Having the price stored in the database, it is possible to build statistics to display consolidated revenues per country code, network or subscriber.</li>
313
</ol>
314
315
h3. Rating files
316
317
To generate billable CDRs from the SIP traffic that goes through the platform you must provision the rating plans in CDRTool software that is responsible for CDR mediation and rating.
318
319
Before provisioning CDRTool, is important that you understand how the rating engine works. The modus operandi of the rating engine is described at:
320
321
" https://mdns.sipthor.net/CDRTool/doc/RATING.txt":https://mdns.sipthor.net/CDRTool/doc/RATING.txt
322
323
After you read and understand the document, you will need to generate the following files:
324
325
# destinations.csv
326
# customers.csv
327
# billing&#95;profiles.csv
328
# billing&#95;rates.csv
329
330
The file formats are described in 'Importing and exporting of rating files' section of RATING.txt document.
331
332
Samples files can be found in the CDRTool software archive available at:
333
334
" http://download.ag-projects.com/CDRTool/sample&#95;rating&#95;files/":http://download.ag-projects.com/CDRTool/sample_rating_files/
335
336
The files must then be uploaded in CDRTool rating engine, once the software is operational on your platform.
337
338
The operator is responsable for creating the files. The initial provisioning is performed by AG Projects.
339
340
The content of the rating tables can be edited in the web interface provided by CDRTool application.
341
342
h3. Importing and exporting of rating files
343
344
There are different data files needed for rating. The data files are imported into their corresponding MySQL tables. The files must be uploaded to /var/spool/cdrtool directory. To load the files into the database run the following command:
345
346
bc(wiki). /var/www/CDRTool/scripts/importRatingTables.php
347
348
349
The import script knows to import the files only once so you may dump several files there and safely run the import script from cron. The import script detects whether each file have been imported by building a unique key out of the filename and the hash of the file content. So you may use the same filenames as long as the content differs and viceversa. If the import file has changed any records, the rating engine is automatically instructed to reload the changes.
350
351
Sample csv files are found in the setup directory. The CSV field order is described in setup/&#42;.csv sample files. The first element on each line specifies the operation will be performed with the current record. The operation can be 2 (update/insert), 1 (insert) or 3 (delete).
352
353
The updates are performed based on a unique key present in each table:
354
355
bc(wiki). billing_customers     - cust_idx      (gateway,domain,subscriber)
356
destinations          - cust_dest_idx (gateway,domain,subscriber,dest_id)
357
billing_profiles      - profile_idx   (name)
358
billing_rates         - rate_idx      (name,destination,application)
359
billing_rates_history - rate_idx      (name,destination,application,startDate,endDate)
360
361
362
The content of the rating tables can be exported in the Rating tables page.
363
364
The import script detects the type of file to import based on its filename.
365
366
The filename must comply with the following naming convention:
367
368
# Must start with the name of the table without the billing&#95;
369
# May optionally contain extra characters after the name
370
# Must end with .csv extension
371
372
Examples:
373
374
* rates.csv or rates20061201.cvs will be loaded into the rates table
375
* profiles.csv or profiles20061201.cvs will be loaded into the profiles table
376
* destinations200601.csv will be loaded in the destinations table
377
* ratesHistory200801.csv will be loaded in the rates&#95;history table
378
379
Do not use 'billing&#95;' prefix in front of the file name.
380
381
It is advisable to name the files in a consistent manner like tableYYYYMMDD.csv
382
383
The results of the import operation is logged in the database and can be viewed in the Log section of the web interface and the syslog.
384
385
h3. Renormalizing CDRs
386
387
Sometime is useful to be able to change the rates for calls that have been already normalized and rated, for example after changing the rating tables you wish to apply the changes for the previous month for a customer.
388
389
To re-rate the CDRs do the following:
390
391
# Change the current rates by using cvs files/WEB interface or add rates valid for specific dates/destinations in the rates&#95;history table
392
393
<ol start="2">
394
<li>Re-normalize the calls to be re-rated by either selecting ReNormalize check-box in the search screen or by changing the Normalized field in the CDR MySQL table (e.g. radacct):</li>
395
</ol>
396
397
Examples:
398
399
# Re-rate calls for this month (2004-12) SIP domain example.com:
400
401
bc(wiki).    UPDATE radacct set Normalized = '0' where Realm = 'example.com'
402
   and AcctStartTime >= '2004-12-01'
403
404
405
<ol start="2">
406
<li>Re-rate calls for SIP subscriber " sip01&#64;example.com":mailto:sip01@example.com:</li>
407
</ol>
408
409
bc(wiki).    UPDATE radacct set Normalized = '0' where UserName = 'sip01@example.com'
410
411
412
<ol start="3">
413
<li>Apply rating again using command:</li>
414
</ol>
415
416
bc(wiki). /var/www/CDRTool/scripts/normalize.php
417
418
419
Notes
420
421
Renormalization process can take long time during which your database (radacct table) will be intermitently locked. Perform this operation only during low traffic periods.
422
423
It is advisable to re-rate only the CDRs for destinations that have different rates. To do this, select a filter in the CDR search screen, if the selection is right re-run the query by selecting Re-normalize button.
424
425
After renormalization, the monthly usage information used by the quota system will be out of date. At the next run of the quotaCheck script, a full table scan will be performed. See QuotaSystem.txt for more information about quota.
426
427
Holidays must be added as individual days YYYY-MM-DD in table billing&#95;holidays. The profile applied for holidays is the same as for week-ends. Holidays are global and cannot be specified per customer.
428
429
Renormalization process does not affect the balance of prepaid users. Prepaid is a real time un-reversible process, it goes in one direction. The prepaid balance is changed only by placing a call or adding credit to it. There are several reasons for this:
430
431
* The balance before and after each CDR is not known to be able to roll it back at a later time
432
* Re-rating correctly is mathematically not possible for prepaid users that have calls in progress
433
* If the prices are higher than previously debited and end up with a negative balance, the software cannot force the user to pay more retroactively
434
435
Re-normalization for the purpose of re-rating is useful only for postpaid accounts where you send an invoice at the end of the month and your can change things back and forth. If you need to perform manual credit/debit operations to some prepaid users because of faulty pricing, you can edit in CDRTool in the prepaid table the balance by using + or -.
436
437
h2. Rating Assignment
438
439
To asign a particular rating plan to a SIP account, SIP domain of Trusted Peer:
440
441
h3. SOAP/XML functions
442
443
* RatingPort-&gt;setEntityProfiles()
444
* RatingPort-&gt;deleteEntityProfiles()
445
* RatingPort-&gt;getEntityProfiles()
446
447
h3. Graphical clients
448
449
bc(wiki). CDRTool->Rating->Customers
450
451
452
bc(wiki). SIP settings page->Settings tab->Billing Profiles
453
454
455
h2. Prepaid Accounts
456
457
"!http://callcontrol.ag-projects.com/raw-attachment/wiki/WikiStart/CallControl.png(http://callcontrol.ag-projects.com/raw-attachment/wiki/WikiStart/CallControl.png)!":http://callcontrol.ag-projects.com/raw-attachment/wiki/WikiStart/CallControl.png
458
459
Prepaid functionality can be enabled by setting the SIP account prepaid attribute to 'true'. As a result, a new record is created in CDRTool application, in the prepaid table. This record is used to maintain the balance of the prepaid account. A SIP account marked as prepaid can make PSTN calls within the limits of the balance associated with the CDRTool prepaid account.
460
461
Every credit and debit operation is logged into the prepaid&#95;history table, which can be queried using SOAP functions or can be accessed using CDRTool web pages.
462
463
h3. SOAP/XML functions
464
465
* SipPort-&gt;addBalance()
466
* SipPort-&gt;getPrepaidStatus()
467
* SipPort-&gt;getCreditHistory()
468
469
h3. Graphical client
470
471
bc(wiki). CDRTool->Rating->Prepaid
472
473
474
"!/raw-attachment/wiki/AccountingGuide/cdrtool-prepaid-accounts.png!":/attachment/wiki/AccountingGuide/cdrtool-prepaid-accounts.png
475
476
bc(wiki). CDRTool->Rating->Prepaid history
477
478
479
"!/raw-attachment/wiki/AccountingGuide/cdrtool-prepaid-history.png!":/attachment/wiki/AccountingGuide/cdrtool-prepaid-history.png
480
481
h3. Voice prompts
482
483
Voice prompts can be played when the balance is not sufficient to make a new session. This feature must be enabled in the " SIP Proxy configuration":http://msp-documentation.ag-projects.com/wiki/ConfigurationGuide#SIPProxy:
484
485
<pre class="wiki">
486
define(`USE_FAILURE_PROMPTS', `1')
487
488
# Voice message prompts for prepaid failure conditions.
489
define(`PREPAID_NO_CREDIT_PROMPT', `sip:800301@MEDIA_SERVER')
490
define(`PREPAID_ERROR_PROMPT',     `sip:800399@MEDIA_SERVER')
491
</pre>
492
493
h2. Prepaid Cards
494
495
You may generate prepaid cards with designated values. The cards are randomly generated, identified by a combination of ID and NUMBER combination that can be safely sold to end-users or resellers in the form of scratch cards.
496
497
h3. SOAP/XML functions
498
499
Each prepaid card has a value, the value is transfered to the SIP account when the correct ID and NUMBER are supplied to the function:
500
501
* SipPort-&gt;addBalanceFromVoucher()
502
503
h3. Graphical client
504
505
The Batches with prepaid cards can be exported in comma separated values format to external systems, for example to a printer that makes scratch cards.
506
507
@CDRTool->Rating->Prepaid cards@
508
509
"!/raw-attachment/wiki/AccountingGuide/cdrtool-prepaid-cards.png!":/attachment/wiki/AccountingGuide/cdrtool-prepaid-cards.png