85670017f5155f3fbaec56af2156b24aa7316530
[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 #define AST_CDR_FAILED                          (1 << 3)
27
28 //! AMA Flags
29 #define AST_CDR_OMIT                            (1)
30 #define AST_CDR_BILLING                         (2)
31 #define AST_CDR_DOCUMENTATION                   (3)
32
33 #define AST_MAX_USER_FIELD                      256
34
35 struct ast_channel;
36
37 //! Responsible for call detail data
38 struct ast_cdr {
39         /*! Caller*ID with text */
40         char clid[AST_MAX_EXTENSION];           
41         /*! Caller*ID number */
42         char src[AST_MAX_EXTENSION];            
43         /*! Destination extension */
44         char dst[AST_MAX_EXTENSION];            
45         /*! Destination context */
46         char dcontext[AST_MAX_EXTENSION];       
47         
48         char channel[AST_MAX_EXTENSION];
49         /*! Destination channel if appropriate */
50         char dstchannel[AST_MAX_EXTENSION];     
51         /*! Last application if appropriate */
52         char lastapp[AST_MAX_EXTENSION];        
53         /*! Last application data */
54         char lastdata[AST_MAX_EXTENSION];       
55         
56         struct timeval start;
57         
58         struct timeval answer;
59         
60         struct timeval end;
61         /*! Total time in system, in seconds */
62         int duration;                           
63         /*! Total time call is up, in seconds */
64         int billsec;                            
65         /*! What happened to the call */
66         int disposition;                        
67         /*! What flags to use */
68         int amaflags;                           
69         /*! What account number to use */
70         char accountcode[20];                   
71         /*! Whether or not the record has been posted */
72         int posted;                             
73         /* Unique Channel Identifier */
74         char uniqueid[32];
75         /* User field */
76         char userfield[AST_MAX_USER_FIELD];
77 };
78
79 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
80
81 //! Allocate a record
82 /*! 
83  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
84  */
85 extern struct ast_cdr *ast_cdr_alloc(void);
86
87 //! Free a record
88 /* \param cdr ast_cdr structure to free
89  * Returns nothing important
90  */
91 extern void ast_cdr_free(struct ast_cdr *cdr);
92
93 //! Initialize based on a channel
94 /*! 
95  * \param cdr Call Detail Record to use for channel
96  * \param chan Channel to bind CDR with
97  * Initializes a CDR and associates it with a particular channel
98  * Return is negligible.  (returns 0 by default)
99  */
100 extern int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
101
102 //! Initialize based on a channel
103 /*! 
104  * \param cdr Call Detail Record to use for channel
105  * \param chan Channel to bind CDR with
106  * Initializes a CDR and associates it with a particular channel
107  * Return is negligible.  (returns 0 by default)
108  */
109 extern int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
110
111 //! Register a CDR handling engine
112 /*!
113  * \param name name associated with the particular CDR handler
114  * \param desc description of the CDR handler
115  * \param be function pointer to a CDR handler
116  * Used to register a Call Detail Record handler.
117  * Returns -1 on error, 0 on success.
118  */
119 extern int ast_cdr_register(char *name, char *desc, ast_cdrbe be);
120
121 //! Unregister a CDR handling engine
122 /*!
123  * \param name name of CDR handler to unregister
124  * Unregisters a CDR by it's name
125  */
126 extern void ast_cdr_unregister(char *name);
127
128 //! Start a call
129 /*!
130  * \param cdr the cdr you wish to associate with the call
131  * Starts all CDR stuff necessary for monitoring a call
132  * Returns nothing important
133  */
134 extern void ast_cdr_start(struct ast_cdr *cdr);
135
136 //! Answer a call
137 /*!
138  * \param cdr the cdr you wish to associate with the call
139  * Starts all CDR stuff necessary for doing CDR when answering a call
140  */
141 extern void ast_cdr_answer(struct ast_cdr *cdr);
142
143 //! Busy a call
144 /*!
145  * \param cdr the cdr you wish to associate with the call
146  * Returns nothing important
147  */
148 extern void ast_cdr_busy(struct ast_cdr *cdr);
149
150 //! Fail a call
151 /*!
152  * \param cdr the cdr you wish to associate with the call
153  * Returns nothing important
154  */
155 extern void ast_cdr_failed(struct ast_cdr *cdr);
156
157 //! Save the result of the call based on the AST_CAUSE_*
158 /*!
159  * \param cdr the cdr you wish to associate with the call
160  * Returns nothing important
161  * \param cause the AST_CAUSE_*
162  */
163 extern int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
164         
165 //! End a call
166 /*!
167  * \param cdr the cdr you have associated the call with
168  * Registers the end of call time in the cdr structure.
169  * Returns nothing important
170  */
171 extern void ast_cdr_end(struct ast_cdr *cdr);
172
173 //! Post the detail record
174 /*! 
175  * \param cdr Which cdr to post
176  * Actually outputs the CDR record to the CDR plugins installed
177  * Returns nothing
178  */
179 extern void ast_cdr_post(struct ast_cdr *cdr);
180
181 //! Set the destination channel, if there was one
182 /*!
183  * \param cdr Which cdr it's applied to
184  * Sets the destination channel the CDR is applied to
185  * Returns nothing
186  */
187 extern void ast_cdr_setdestchan(struct ast_cdr *cdr, char *chan);
188
189 //! Set the last executed application
190 /*!
191  * \param cdr which cdr to act upon
192  * \param app the name of the app you wish to change it to
193  * \param data the data you want in the data field of app you set it to
194  * Changes the value of the last executed app
195  * Returns nothing
196  */
197 extern void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
198
199 //! Convert a string to a detail record AMA flag
200 /*!
201  * \param flag string form of flag
202  * Converts the string form of the flag to the binary form.
203  * Returns the binary form of the flag
204  */
205 extern int ast_cdr_amaflags2int(char *flag);
206
207 //! Disposition to a string
208 /*!
209  * \param flag input binary form
210  * Converts the binary form of a disposition to string form.
211  * Returns a pointer to the string form
212  */
213 extern char *ast_cdr_disp2str(int disposition);
214
215 //! Reset the detail record, optionally posting it first
216 /*!
217  * \param cdr which cdr to act upon
218  * \param post whether or not to post the cdr first before resetting it
219  */
220 extern void ast_cdr_reset(struct ast_cdr *cdr, int post);
221
222 //! Flags to a string
223 /*!
224  * \param flags binary flag
225  * Converts binary flags to string flags
226  * Returns string with flag name
227  */
228 extern char *ast_cdr_flags2str(int flags);
229
230 extern int ast_cdr_setaccount(struct ast_channel *chan, char *account);
231
232
233 extern int ast_cdr_setuserfield(struct ast_channel *chan, char *userfield);
234 extern int ast_cdr_appenduserfield(struct ast_channel *chan, char *userfield);
235
236
237 /* Update CDR on a channel */
238 extern int ast_cdr_update(struct ast_channel *chan);
239
240
241 extern int ast_default_amaflags;
242
243 extern char ast_default_accountcode[20];
244
245 #endif /* _CDR_H */