* Move LaTeX docs into a tex/ subdirectory of the doc/ dir
[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
19 \section{Fields of the CDR in Asterisk}
20
21 \begin{itemize}
22    \item accountcode:   What account number to use, (string, 20 characters)
23    \item src:           Caller*ID number (string, 80 characters)
24    \item dst:           Destination extension (string, 80 characters)
25    \item dcontext:              Destination context (string, 80 characters)
26    \item clid:          Caller*ID with text (80 characters)
27    \item channel:               Channel used (80 characters)
28    \item dstchannel:    Destination channel if appropriate (80 characters)
29    \item lastapp:               Last application if appropriate (80 characters)
30    \item lastdata:              Last application data (arguments) (80 characters)
31    \item start:         Start of call (date/time)
32    \item answer:                Answer of call (date/time)
33    \item end:           End of call (date/time)
34    \item duration:              Total time in system, in seconds (integer), from dial to hangup
35    \item billsec:               Total time call is up, in seconds (integer), from answer to hangup
36    \item disposition:   What happened to the call: ANSWERED, NO ANSWER, BUSY
37    \item amaflags:              What flags to use: DOCUMENTATION, BILL, IGNORE etc, 
38                         specified on a per channel basis like accountcode.
39    \item user field:    A user-defined field, maximum 255 characters 
40 \end{itemize}
41
42 In some cases, uniqueid is appended:
43
44 \begin{itemize}
45    \item uniqueid:              Unique Channel Identifier (32 characters) 
46       This needs to be enabled in the source code at compile time
47 \end{itemize}
48
49 NOTE: If you use IAX2 channels for your calls, and allow 'full' transfers
50 (not media-only transfers), then when the calls is transferred the server
51 in the middle will no longer be involved in the signaling path, and thus
52 will not generate accurate CDRs for that call. If you can, use media-only
53 transfers with IAX2 to avoid this problem, or turn off transfers completely
54 (although this can result in a media latency increase since the media packets
55 have to traverse the middle server(s) in the call).
56
57 \section{CDR Variables}
58
59 If the channel has a cdr, that cdr record has its own set of variables which 
60 can be accessed just like channel variables. The following builtin variables
61 are available.
62
63 \begin{verbatim}
64 ${CDR(clid)}                    Caller ID
65 ${CDR(src)}                     Source 
66 ${CDR(dst)}                     Destination
67 ${CDR(dcontext)}                Destination context
68 ${CDR(channel)}                 Channel name
69 ${CDR(dstchannel)}              Destination channel
70 ${CDR(lastapp)}                 Last app executed
71 ${CDR(lastdata)}                Last app's arguments
72 ${CDR(start)}                   Time the call started.
73 ${CDR(answer)}                  Time the call was answered.
74 ${CDR(end)}                     Time the call ended.
75 ${CDR(duration)}                Duration of the call.
76 ${CDR(billsec)}                 Duration of the call once it was answered.
77 ${CDR(disposition)}             ANSWERED, NO ANSWER, BUSY
78 ${CDR(amaflags)}                DOCUMENTATION, BILL, IGNORE etc
79 ${CDR(accountcode)}             The channel's account code.
80 ${CDR(uniqueid)}                The channel's unique id.
81 ${CDR(userfield)}               The channels uses specified field.
82 \end{verbatim}
83
84 In addition, you can set your own extra variables by using Set(CDR(name)=value).
85 These variables can be output into a text-format CDR by using the cdr\_custom
86 CDR driver; see the cdr\_custom.conf.sample file in the configs directory for
87 an example of how to do this.