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