Skip to content

Commit

Permalink
doc: specify CDRs location
Browse files Browse the repository at this point in the history
  • Loading branch information
razvancrainea committed Jan 25, 2017
1 parent cebc7f7 commit 492ffc1
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
19 changes: 13 additions & 6 deletions modules/cgrates/README
Expand Up @@ -69,12 +69,15 @@ Chapter 1. Admin Guide
postpaid and prepaid rating. It may also be use to generate and
aggragate CDRs in multiple formats.

This module provides an interface for OpenSIPS to communicate
directly with the CGRateS engine, using efficient JSON-RPC APIs
in both synchronous and asynchronous ways. For each command the
user can provide a set of parameters that will be forwarded to
the CGRateS engine, using the $cgr() variable. You can find
usage examples in the following sections.
This module can be used to communicate with the CGRates engine
in order to do call authorization and accounting for billing
purposes. The OpenSIPS module does not do any billing by
itself, but provides an interface to communicate with the
CGRateS engine using efficient JSON-RPC APIs in both
synchronous and asynchronous ways. For each command the user
can provide a set of parameters that will be forwarded to the
CGRateS engine, using the $cgr() variable. You can find usage
examples in the following sections.

The module can be used to implement the following features:

Expand Down Expand Up @@ -129,6 +132,10 @@ Chapter 1. Admin Guide
cgrate_acc("cdr", "$fU", "$rU");
...

Note that when using the cdr flag, CDRs are exported by the
CGRateS engine in various formats, not by OpenSIPS. Check the
CGRateS documentation for more information.

1.4. Other Commands

You can use the cgrates_cmd() to send arbitrary commands to the
Expand Down
11 changes: 9 additions & 2 deletions modules/cgrates/doc/cgrates_admin.xml
Expand Up @@ -14,8 +14,10 @@
</para>

<para>
This module provides an interface for &osips; to communicate directly with
the CGRateS engine, using efficient <ulink url='http://json-rpc.org/'>JSON-RPC</ulink>
This module can be used to communicate with the CGRates engine in order to do
call authorization and accounting for billing purposes. The &osips; module does
not do any billing by itself, but provides an interface to communicate with the
CGRateS engine using efficient <ulink url='http://json-rpc.org/'>JSON-RPC</ulink>
APIs in both synchronous and asynchronous ways. For each command the user can
provide a set of parameters that will be forwarded to the CGRateS engine, using
the <emphasis>$cgr()</emphasis> variable. You can find usage examples in the
Expand Down Expand Up @@ -85,6 +87,11 @@
...
</programlisting>
</para>
<para>
Note that when using the <emphasis>cdr</emphasis> flag, CDRs are exported by
the CGRateS engine in various formats, not by &osips;. Check the CGRateS
documentation for more information.
</para>
</section>

<section>
Expand Down

0 comments on commit 492ffc1

Please sign in to comment.