1eXosip2 INVITE and Call Management(l3i)beXosiepX2osip2 INVITE and Call Management(3)
2
6 eXosip2 INVITE and Call Management -
7 Functions
9 int eXosip_call_set_reference (int id, void *reference)
10 int eXosip_call_build_initial_invite (osip_message_t **invite, const
11 char *to, const char *from, const char *route, const char *subject)
12 int eXosip_call_send_initial_invite (osip_message_t *invite)
13 int eXosip_call_build_request (int did, const char *method,
14 osip_message_t **request)
15 int eXosip_call_build_ack (int did, osip_message_t **ack)
16 int eXosip_call_send_ack (int did, osip_message_t *ack)
17 int eXosip_call_build_refer (int did, const char *refer_to,
18 osip_message_t **request)
19 int eXosip_call_build_info (int did, osip_message_t **request)
20 int eXosip_call_build_options (int did, osip_message_t **request)
21 int eXosip_call_build_update (int did, osip_message_t **request)
22 int eXosip_call_build_notify (int did, int subscription_status,
23 osip_message_t **request)
24 int eXosip_call_send_request (int did, osip_message_t *request)
25 int eXosip_call_build_answer (int tid, int status, osip_message_t
26 **answer)
27 int eXosip_call_send_answer (int tid, int status, osip_message_t
28 *answer)
29 int eXosip_call_terminate (int cid, int did)
30 int eXosip_call_build_prack (int tid, osip_message_t **prack)
31 int eXosip_call_send_prack (int tid, osip_message_t *prack)
32 int eXosip_transfer_send_notify (int did, int subscription_status, char
33 *body)
34 int eXosip_call_get_referto (int did, char *refer_to, size_t
35 refer_to_len)
36 int eXosip_call_find_by_replaces (char *replaces)
37
39 int eXosip_call_set_reference (int id, void * reference)
40 Set a new application context for an existing call
41 Parameters:
43 id call-id or dialog-id of call
44 reference New application context.
45 int eXosip_call_build_initial_invite (osip_message_t ** invite, const char
47 * to, const char * from, const char * route, const char * subject)
48 Build a default INVITE message for a new call.
49 Parameters:
51 invite Pointer for the SIP element to hold.
52 to SIP url for callee.
53 from SIP url for caller.
54 route Route header for INVITE. (optionnal)
55 subject Subject for the call.
56 int eXosip_call_send_initial_invite (osip_message_t * invite)
58 Initiate a call.
59 Parameters:
61 invite SIP INVITE message to send.
62 int eXosip_call_build_request (int did, const char * method, osip_message_t
64 ** request)
65 Build a default request within a call. (INVITE, OPTIONS, INFO, REFER)
66 Parameters:
68 did dialog id of call.
69 method request type to build.
70 request The sip request to build.
71 int eXosip_call_build_ack (int did, osip_message_t ** ack)
73 Build a default ACK for a 200ok received.
74 Parameters:
76 did dialog id of call.
77 ack The sip request to build.
78 int eXosip_call_send_ack (int did, osip_message_t * ack)
80 Send the ACK for the 200ok received..
81 Parameters:
83 did dialog id of call.
84 ack SIP ACK message to send.
85 int eXosip_call_build_refer (int did, const char * refer_to, osip_message_t
87 ** request)
88 Build a default REFER for a call transfer.
89 Parameters:
91 did dialog id of call.
92 refer_to url for call transfer (Refer-To header).
93 request The sip request to build.
94 int eXosip_call_build_info (int did, osip_message_t ** request)
96 Build a default INFO within a call.
97 Parameters:
99 did dialog id of call.
100 request The sip request to build.
101 int eXosip_call_build_options (int did, osip_message_t ** request)
103 Build a default OPTIONS within a call.
104 Parameters:
106 did dialog id of call.
107 request The sip request to build.
108 int eXosip_call_build_update (int did, osip_message_t ** request)
110 Build a default UPDATE within a call.
111 Parameters:
113 did dialog id of call.
114 request The sip request to build.
115 int eXosip_call_build_notify (int did, int subscription_status,
117 osip_message_t ** request)
118 Build a default NOTIFY within a call.
119 Parameters:
121 did dialog id of call.
122 subscription_status Subscription status of the request.
123 request The sip request to build.
124 int eXosip_call_send_request (int did, osip_message_t * request)
126 send the request within call. (INVITE, OPTIONS, INFO, REFER, UPDATE)
127 Parameters:
129 did dialog id of call.
130 request The sip request to send.
131 int eXosip_call_build_answer (int tid, int status, osip_message_t **
133 answer)
134 Build default Answer for request.
135 Parameters:
137 tid id of transaction to answer.
138 status Status code to use.
139 answer The sip answer to build.
140 int eXosip_call_send_answer (int tid, int status, osip_message_t * answer)
142 Send Answer for invite.
143 Parameters:
145 tid id of transaction to answer.
146 status response status if answer is NULL. (not allowed for 2XX)
147 answer The sip answer to send.
148 int eXosip_call_terminate (int cid, int did)
150 Terminate a call. send CANCEL, BYE or 603 Decline.
151 Parameters:
153 cid call id of call.
154 did dialog id of call.
155 int eXosip_call_build_prack (int tid, osip_message_t ** prack)
157 Build a PRACK for invite.
158 Parameters:
160 tid id of the invite transaction.
161 prack The sip prack to build.
162 int eXosip_call_send_prack (int tid, osip_message_t * prack)
164 Send a PRACK for invite.
165 Parameters:
167 tid id of the invite transaction.
168 prack The sip prack to send.
169 int eXosip_transfer_send_notify (int did, int subscription_status, char *
171 body)
172 Send a NOTIFY containing the information about a call transfer.
173 THIS METHOD WILL BE REPLACED or REMOVED, please use the new API to
175 build NOTIFY.
176 Parameters:
178 did dialog id of call.
179 subscription_status the subscription status.
180 body the body to attach to NOTIFY.
181 int eXosip_call_get_referto (int did, char * refer_to, size_t refer_to_len)
183 Get Refer-To header with Replace parameter from dialog.
184 Parameters:
186 did id of the dialog.
187 refer_to buffer to be filled with refer-to info.
188 refer_to_len size of refer_to buffer.
189 int eXosip_call_find_by_replaces (char * replaces)
191 Return did (or cid) for the replace header.
192 Parameters:
194 replaces buffer to be filled with refer-to info.
195Version 3.0.1 30 Aug 2e0X0o7sip2 INVITE and Call Management(3)