Remove places that say if no language is specified it will default to english......
[asterisk/asterisk.git] / doc / tex / billing.tex
1 \section{Applications}
2
3 \begin{itemize}
4     \item SetAccount - Set account code for billing
5     \item SetAMAFlags - Sets AMA flags
6     \item NoCDR - Make sure no CDR is saved for a specific call
7     \item ResetCDR - Reset CDR
8     \item ForkCDR - Save current CDR and start a new CDR for this call
9     \item Authenticate - Authenticates and sets the account code
10     \item SetCDRUserField - Set CDR user field
11     \item AppendCDRUserField - Append data to CDR User field 
12 \end{itemize}
13
14 For more information, use the "core show application <application>" command.
15 You can set default account codes and AMA flags for devices in 
16 channel configuration files, like sip.conf, iax.conf etc.
17
18 \section{Fields of the CDR in Asterisk}
19
20 \begin{itemize}
21    \item accountcode:  What account number to use, (string, 20 characters)
22    \item src:  Caller*ID number (string, 80 characters)
23    \item dst:  Destination extension (string, 80 characters)
24    \item dcontext:  Destination context (string, 80 characters)
25    \item clid:  Caller*ID with text (80 characters)
26    \item channel:  Channel used (80 characters)
27    \item dstchannel:  Destination channel if appropriate (80 characters)
28    \item lastapp:  Last application if appropriate (80 characters)
29    \item lastdata:  Last application data (arguments) (80 characters)
30    \item start:  Start of call (date/time)
31    \item answer:  Answer of call (date/time)
32    \item end:  End of call (date/time)
33    \item duration:  Total time in system, in seconds (integer), from dial to hangup
34    \item billsec:  Total time call is up, in seconds (integer), from answer to hangup
35    \item disposition:  What happened to the call: ANSWERED, NO ANSWER, BUSY
36    \item amaflags:  What flags to use: DOCUMENTATION, BILL, IGNORE etc, 
37             specified on a per channel basis like accountcode.
38    \item user field:  A user-defined field, maximum 255 characters 
39 \end{itemize}
40
41 In some cases, uniqueid is appended:
42
43 \begin{itemize}
44    \item uniqueid:  Unique Channel Identifier (32 characters) 
45       This needs to be enabled in the source code at compile time
46 \end{itemize}
47
48 NOTE: If you use IAX2 channels for your calls, and allow 'full' transfers
49 (not media-only transfers), then when the calls is transferred the server
50 in the middle will no longer be involved in the signaling path, and thus
51 will not generate accurate CDRs for that call. If you can, use media-only
52 transfers with IAX2 to avoid this problem, or turn off transfers completely
53 (although this can result in a media latency increase since the media packets
54 have to traverse the middle server(s) in the call).
55
56 \section{CDR Variables}
57
58 If the channel has a cdr, that cdr record has its own set of variables which 
59 can be accessed just like channel variables. The following builtin variables
60 are available.
61
62 \begin{verbatim}
63 ${CDR(clid)}         Caller ID
64 ${CDR(src)}          Source 
65 ${CDR(dst)}          Destination
66 ${CDR(dcontext)}     Destination context
67 ${CDR(channel)}      Channel name
68 ${CDR(dstchannel)}   Destination channel
69 ${CDR(lastapp)}      Last app executed
70 ${CDR(lastdata)}     Last app's arguments
71 ${CDR(start)}        Time the call started.
72 ${CDR(answer)}       Time the call was answered.
73 ${CDR(end)}          Time the call ended.
74 ${CDR(duration)}     Duration of the call.
75 ${CDR(billsec)}      Duration of the call once it was answered.
76 ${CDR(disposition)}  ANSWERED, NO ANSWER, BUSY
77 ${CDR(amaflags)}     DOCUMENTATION, BILL, IGNORE etc
78 ${CDR(accountcode)}  The channel's account code.
79 ${CDR(uniqueid)}     The channel's unique id.
80 ${CDR(userfield)}    The channels uses specified field.
81 \end{verbatim}
82
83 In addition, you can set your own extra variables by using Set(CDR(name)=value).
84 These variables can be output into a text-format CDR by using the cdr\_custom
85 CDR driver; see the cdr\_custom.conf.sample file in the configs directory for
86 an example of how to do this.