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