0b9681035bfae9cc049191a074c3f1ad309efd2c
[asterisk/asterisk.git] / include / asterisk / cdr.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Call Detail Record API 
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License.
12  *
13  * Includes code and algorithms from the Zapata library.
14  *
15  */
16
17 #ifndef _CDR_H
18 #define _CDR_H
19
20 #include <asterisk/channel.h>
21 #include <sys/time.h>
22
23 #define AST_CDR_NOANSWER                        (1 << 0)
24 #define AST_CDR_BUSY                            (1 << 1)
25 #define AST_CDR_ANSWERED                        (1 << 2)
26
27 //! AMA Flags
28 #define AST_CDR_OMIT                            (1)
29 #define AST_CDR_BILLING                         (2)
30 #define AST_CDR_DOCUMENTATION           (3)
31
32 struct ast_channel;
33
34 //! Responsible for call detail data
35 struct ast_cdr {
36         /*! Caller*ID with text */
37         char clid[AST_MAX_EXTENSION];           
38         /*! Caller*ID number */
39         char src[AST_MAX_EXTENSION];            
40         /*! Destination extension */
41         char dst[AST_MAX_EXTENSION];            
42         /*! Destination context */
43         char dcontext[AST_MAX_EXTENSION];       
44         
45         char channel[AST_MAX_EXTENSION];
46         /*! Destination channel if appropriate */
47         char dstchannel[AST_MAX_EXTENSION];     
48         /*! Last application if appropriate */
49         char lastapp[AST_MAX_EXTENSION];        
50         /*! Last application data */
51         char lastdata[AST_MAX_EXTENSION];       
52         
53         struct timeval start;
54         
55         struct timeval answer;
56         
57         struct timeval end;
58         /*! Total time in system, in seconds */
59         int duration;                           
60         /*! Total time call is up, in seconds */
61         int billsec;                            
62         /*! What happened to the call */
63         int disposition;                        
64         /*! What flags to use */
65         int amaflags;                           
66         /*! What account number to use */
67         char accountcode[20];                   
68         /*! Whether or not the record has been posted */
69         int posted;                             
70         /* Unique Channel Identifier */
71         char uniqueid[32];
72 };
73
74 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
75
76 //! Allocate a record
77 /*! 
78  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
79  */
80 extern struct ast_cdr *ast_cdr_alloc(void);
81
82 //! Free a record
83 /* \param cdr ast_cdr structure to free
84  * Returns nothing important
85  */
86 extern void ast_cdr_free(struct ast_cdr *cdr);
87
88 //! Initialize based on a channel
89 /*! 
90  * \param cdr Call Detail Record to use for channel
91  * \param chan Channel to bind CDR with
92  * Initializes a CDR and associates it with a particular channel
93  * Return is negligible.  (returns 0 by default)
94  */
95 extern int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
96
97 //! Initialize based on a channel
98 /*! 
99  * \param cdr Call Detail Record to use for channel
100  * \param chan Channel to bind CDR with
101  * Initializes a CDR and associates it with a particular channel
102  * Return is negligible.  (returns 0 by default)
103  */
104 extern int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
105
106 //! Register a CDR handling engine
107 /*!
108  * \param name name associated with the particular CDR handler
109  * \param desc description of the CDR handler
110  * \param be function pointer to a CDR handler
111  * Used to register a Call Detail Record handler.
112  * Returns -1 on error, 0 on success.
113  */
114 extern int ast_cdr_register(char *name, char *desc, ast_cdrbe be);
115
116 //! Unregister a CDR handling engine
117 /*!
118  * \param name name of CDR handler to unregister
119  * Unregisters a CDR by it's name
120  */
121 extern void ast_cdr_unregister(char *name);
122
123 //! Start a call
124 /*!
125  * \param cdr the cdr you wish to associate with the call
126  * Starts all CDR stuff necessary for monitoring a call
127  * Returns nothing important
128  */
129 extern void ast_cdr_start(struct ast_cdr *cdr);
130
131 //! Answer a call
132 /*!
133  * \param cdr the cdr you wish to associate with the call
134  * Starts all CDR stuff necessary for doing CDR when answering a call
135  */
136 extern void ast_cdr_answer(struct ast_cdr *cdr);
137
138 //! Busy a call
139 /*!
140  * \param cdr the cdr you wish to associate with the call
141  * Returns nothing important
142  */
143 extern void ast_cdr_busy(struct ast_cdr *cdr);
144
145 //! End a call
146 /*!
147  * \param cdr the cdr you have associated the call with
148  * Registers the end of call time in the cdr structure.
149  * Returns nothing important
150  */
151 extern void ast_cdr_end(struct ast_cdr *cdr);
152
153 //! Post the detail record
154 /*! 
155  * \param cdr Which cdr to post
156  * Actually outputs the CDR record to the CDR plugins installed
157  * Returns nothing
158  */
159 extern void ast_cdr_post(struct ast_cdr *cdr);
160
161 //! Set the destination channel, if there was one
162 /*!
163  * \param cdr Which cdr it's applied to
164  * Sets the destination channel the CDR is applied to
165  * Returns nothing
166  */
167 extern void ast_cdr_setdestchan(struct ast_cdr *cdr, char *chan);
168
169 //! Set the last executed application
170 /*!
171  * \param cdr which cdr to act upon
172  * \param app the name of the app you wish to change it to
173  * \param data the data you want in the data field of app you set it to
174  * Changes the value of the last executed app
175  * Returns nothing
176  */
177 extern void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
178
179 //! Convert a string to a detail record AMA flag
180 /*!
181  * \param flag string form of flag
182  * Converts the string form of the flag to the binary form.
183  * Returns the binary form of the flag
184  */
185 extern int ast_cdr_amaflags2int(char *flag);
186
187 //! Disposition to a string
188 /*!
189  * \param flag input binary form
190  * Converts the binary form of a disposition to string form.
191  * Returns a pointer to the string form
192  */
193 extern char *ast_cdr_disp2str(int disposition);
194
195 //! Reset the detail record, optionally posting it first
196 /*!
197  * \param cdr which cdr to act upon
198  * \param post whether or not to post the cdr first before resetting it
199  */
200 extern void ast_cdr_reset(struct ast_cdr *cdr, int post);
201
202 //! Flags to a string
203 /*!
204  * \param flags binary flag
205  * Converts binary flags to string flags
206  * Returns string with flag name
207  */
208 extern char *ast_cdr_flags2str(int flags);
209
210 extern int ast_cdr_setaccount(struct ast_channel *chan, char *account);
211 /* Update CDR on a channel */
212 extern int ast_cdr_update(struct ast_channel *chan);
213
214
215 extern int ast_default_amaflags;
216
217 extern char ast_default_accountcode[20];
218
219 #endif /* _CDR_H */