\section{eXosip2 INVITE and Call Management}
\label{group__eXosip2__call}\index{eXosip2 INVITE and Call Management@{eXosip2 INVITE and Call Management}}
\subsection*{Functions}
\begin{CompactItemize}
\item
int {\bf eXosip\_\-call\_\-set\_\-reference} (int id, void $\ast$reference)
\item
int {\bf eXosip\_\-call\_\-build\_\-initial\_\-invite} (osip\_\-message\_\-t $\ast$$\ast$invite, const char $\ast$to, const char $\ast$from, const char $\ast$route, const char $\ast$subject)
\item
int {\bf eXosip\_\-call\_\-send\_\-initial\_\-invite} (osip\_\-message\_\-t $\ast$invite)
\item
int {\bf eXosip\_\-call\_\-build\_\-request} (int did, const char $\ast$method, osip\_\-message\_\-t $\ast$$\ast$request)
\item
int {\bf eXosip\_\-call\_\-build\_\-ack} (int did, osip\_\-message\_\-t $\ast$$\ast$ack)
\item
int {\bf eXosip\_\-call\_\-send\_\-ack} (int did, osip\_\-message\_\-t $\ast$ack)
\item
int {\bf eXosip\_\-call\_\-build\_\-refer} (int did, const char $\ast$refer\_\-to, osip\_\-message\_\-t $\ast$$\ast$request)
\item
int {\bf eXosip\_\-call\_\-build\_\-info} (int did, osip\_\-message\_\-t $\ast$$\ast$request)
\item
int {\bf eXosip\_\-call\_\-build\_\-options} (int did, osip\_\-message\_\-t $\ast$$\ast$request)
\item
int {\bf eXosip\_\-call\_\-build\_\-update} (int did, osip\_\-message\_\-t $\ast$$\ast$request)
\item
int {\bf eXosip\_\-call\_\-build\_\-notify} (int did, int subscription\_\-status, osip\_\-message\_\-t $\ast$$\ast$request)
\item
int {\bf eXosip\_\-call\_\-send\_\-request} (int did, osip\_\-message\_\-t $\ast$request)
\item
int {\bf eXosip\_\-call\_\-build\_\-answer} (int tid, int status, osip\_\-message\_\-t $\ast$$\ast$answer)
\item
int {\bf eXosip\_\-call\_\-send\_\-answer} (int tid, int status, osip\_\-message\_\-t $\ast$answer)
\item
int {\bf eXosip\_\-call\_\-terminate} (int cid, int did)
\item
int {\bf eXosip\_\-call\_\-build\_\-prack} (int tid, osip\_\-message\_\-t $\ast$$\ast$prack)
\item
int {\bf eXosip\_\-call\_\-send\_\-prack} (int tid, osip\_\-message\_\-t $\ast$prack)
\item
int {\bf eXosip\_\-transfer\_\-send\_\-notify} (int did, int subscription\_\-status, char $\ast$body)
\item
int {\bf eXosip\_\-call\_\-get\_\-referto} (int did, char $\ast$refer\_\-to, size\_\-t refer\_\-to\_\-len)
\item
int {\bf eXosip\_\-call\_\-find\_\-by\_\-replaces} (char $\ast$replaces)
\end{CompactItemize}
\subsection{Function Documentation}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-set\_\-reference@{eXosip\_\-call\_\-set\_\-reference}}
\index{eXosip\_\-call\_\-set\_\-reference@{eXosip\_\-call\_\-set\_\-reference}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-set\_\-reference}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-set\_\-reference (int {\em id}, \/ void $\ast$ {\em reference})}\label{group__eXosip2__call_gc064e54c7dd68c73ec793dc9d5e4d0ba}
Set a new application context for an existing call
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]call-id or dialog-id of call \item[{\em reference}]New application context. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-initial\_\-invite@{eXosip\_\-call\_\-build\_\-initial\_\-invite}}
\index{eXosip\_\-call\_\-build\_\-initial\_\-invite@{eXosip\_\-call\_\-build\_\-initial\_\-invite}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-initial\_\-invite}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-initial\_\-invite (osip\_\-message\_\-t $\ast$$\ast$ {\em invite}, \/ const char $\ast$ {\em to}, \/ const char $\ast$ {\em from}, \/ const char $\ast$ {\em route}, \/ const char $\ast$ {\em subject})}\label{group__eXosip2__call_g86f502b61ae37a8504811618c74896fc}
Build a default INVITE message for a new call.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em invite}]Pointer for the SIP element to hold. \item[{\em to}]SIP url for callee. \item[{\em from}]SIP url for caller. \item[{\em route}]Route header for INVITE. (optionnal) \item[{\em subject}]Subject for the call. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-send\_\-initial\_\-invite@{eXosip\_\-call\_\-send\_\-initial\_\-invite}}
\index{eXosip\_\-call\_\-send\_\-initial\_\-invite@{eXosip\_\-call\_\-send\_\-initial\_\-invite}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-send\_\-initial\_\-invite}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-send\_\-initial\_\-invite (osip\_\-message\_\-t $\ast$ {\em invite})}\label{group__eXosip2__call_g5bae2085b87eca68265eac5b7770c2c1}
Initiate a call.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em invite}]SIP INVITE message to send. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-request@{eXosip\_\-call\_\-build\_\-request}}
\index{eXosip\_\-call\_\-build\_\-request@{eXosip\_\-call\_\-build\_\-request}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-request}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-request (int {\em did}, \/ const char $\ast$ {\em method}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em request})}\label{group__eXosip2__call_g6f6e99f5f5f410e3ff5fa74e5f4819e4}
Build a default request within a call. (INVITE, OPTIONS, INFO, REFER)
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em method}]request type to build. \item[{\em request}]The sip request to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-ack@{eXosip\_\-call\_\-build\_\-ack}}
\index{eXosip\_\-call\_\-build\_\-ack@{eXosip\_\-call\_\-build\_\-ack}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-ack}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-ack (int {\em did}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em ack})}\label{group__eXosip2__call_g862b62b7e0e21294d3d0e38b2006af3b}
Build a default ACK for a 200ok received.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em ack}]The sip request to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-send\_\-ack@{eXosip\_\-call\_\-send\_\-ack}}
\index{eXosip\_\-call\_\-send\_\-ack@{eXosip\_\-call\_\-send\_\-ack}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-send\_\-ack}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-send\_\-ack (int {\em did}, \/ osip\_\-message\_\-t $\ast$ {\em ack})}\label{group__eXosip2__call_gad048f1b0b252f9b83e8508190a67a43}
Send the ACK for the 200ok received..
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em ack}]SIP ACK message to send. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-refer@{eXosip\_\-call\_\-build\_\-refer}}
\index{eXosip\_\-call\_\-build\_\-refer@{eXosip\_\-call\_\-build\_\-refer}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-refer}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-refer (int {\em did}, \/ const char $\ast$ {\em refer\_\-to}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em request})}\label{group__eXosip2__call_g129738ca894e2adf5ace2d03f361784a}
Build a default REFER for a call transfer.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em refer\_\-to}]url for call transfer (Refer-To header). \item[{\em request}]The sip request to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-info@{eXosip\_\-call\_\-build\_\-info}}
\index{eXosip\_\-call\_\-build\_\-info@{eXosip\_\-call\_\-build\_\-info}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-info}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-info (int {\em did}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em request})}\label{group__eXosip2__call_g8ab3c615d85eba761f6d69a50bce3fdf}
Build a default INFO within a call.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em request}]The sip request to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-options@{eXosip\_\-call\_\-build\_\-options}}
\index{eXosip\_\-call\_\-build\_\-options@{eXosip\_\-call\_\-build\_\-options}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-options}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-options (int {\em did}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em request})}\label{group__eXosip2__call_gcb5e43238ccc5dd17d83191380f735e0}
Build a default OPTIONS within a call.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em request}]The sip request to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-update@{eXosip\_\-call\_\-build\_\-update}}
\index{eXosip\_\-call\_\-build\_\-update@{eXosip\_\-call\_\-build\_\-update}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-update}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-update (int {\em did}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em request})}\label{group__eXosip2__call_g7eab6580829f14c42d68550a53808007}
Build a default UPDATE within a call.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em request}]The sip request to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-notify@{eXosip\_\-call\_\-build\_\-notify}}
\index{eXosip\_\-call\_\-build\_\-notify@{eXosip\_\-call\_\-build\_\-notify}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-notify}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-notify (int {\em did}, \/ int {\em subscription\_\-status}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em request})}\label{group__eXosip2__call_gb01f644f14d643e42f03f7d0d3b5a297}
Build a default NOTIFY within a call.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em subscription\_\-status}]Subscription status of the request. \item[{\em request}]The sip request to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-send\_\-request@{eXosip\_\-call\_\-send\_\-request}}
\index{eXosip\_\-call\_\-send\_\-request@{eXosip\_\-call\_\-send\_\-request}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-send\_\-request}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-send\_\-request (int {\em did}, \/ osip\_\-message\_\-t $\ast$ {\em request})}\label{group__eXosip2__call_g2e34520786d63be4246c96cbef0c26f8}
send the request within call. (INVITE, OPTIONS, INFO, REFER, UPDATE)
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em request}]The sip request to send. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-answer@{eXosip\_\-call\_\-build\_\-answer}}
\index{eXosip\_\-call\_\-build\_\-answer@{eXosip\_\-call\_\-build\_\-answer}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-answer}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-answer (int {\em tid}, \/ int {\em status}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em answer})}\label{group__eXosip2__call_g47c8fd974b269bc7b1c1a44f2252c420}
Build default Answer for request.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em tid}]id of transaction to answer. \item[{\em status}]Status code to use. \item[{\em answer}]The sip answer to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-send\_\-answer@{eXosip\_\-call\_\-send\_\-answer}}
\index{eXosip\_\-call\_\-send\_\-answer@{eXosip\_\-call\_\-send\_\-answer}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-send\_\-answer}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-send\_\-answer (int {\em tid}, \/ int {\em status}, \/ osip\_\-message\_\-t $\ast$ {\em answer})}\label{group__eXosip2__call_g62bd1c0ff354fe3baf362b6539f66d24}
Send Answer for invite.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em tid}]id of transaction to answer. \item[{\em status}]response status if answer is NULL. (not allowed for 2XX) \item[{\em answer}]The sip answer to send. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-terminate@{eXosip\_\-call\_\-terminate}}
\index{eXosip\_\-call\_\-terminate@{eXosip\_\-call\_\-terminate}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-terminate}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-terminate (int {\em cid}, \/ int {\em did})}\label{group__eXosip2__call_g79da38a9e1e2a617ca32eea1fa505987}
Terminate a call. send CANCEL, BYE or 603 Decline.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cid}]call id of call. \item[{\em did}]dialog id of call. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-build\_\-prack@{eXosip\_\-call\_\-build\_\-prack}}
\index{eXosip\_\-call\_\-build\_\-prack@{eXosip\_\-call\_\-build\_\-prack}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-build\_\-prack}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-build\_\-prack (int {\em tid}, \/ osip\_\-message\_\-t $\ast$$\ast$ {\em prack})}\label{group__eXosip2__call_gc1e34921f8dc462717efab20c60b0752}
Build a PRACK for invite.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em tid}]id of the invite transaction. \item[{\em prack}]The sip prack to build. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-send\_\-prack@{eXosip\_\-call\_\-send\_\-prack}}
\index{eXosip\_\-call\_\-send\_\-prack@{eXosip\_\-call\_\-send\_\-prack}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-send\_\-prack}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-send\_\-prack (int {\em tid}, \/ osip\_\-message\_\-t $\ast$ {\em prack})}\label{group__eXosip2__call_gca00251a89ad35cec7e47ac14eb27d9c}
Send a PRACK for invite.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em tid}]id of the invite transaction. \item[{\em prack}]The sip prack to send. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-transfer\_\-send\_\-notify@{eXosip\_\-transfer\_\-send\_\-notify}}
\index{eXosip\_\-transfer\_\-send\_\-notify@{eXosip\_\-transfer\_\-send\_\-notify}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-transfer\_\-send\_\-notify}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-transfer\_\-send\_\-notify (int {\em did}, \/ int {\em subscription\_\-status}, \/ char $\ast$ {\em body})}\label{group__eXosip2__call_ga09f706cd75e6a68c30468c22e500a71}
Send a NOTIFY containing the information about a call transfer.
THIS METHOD WILL BE REPLACED or REMOVED, please use the new API to build NOTIFY.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]dialog id of call. \item[{\em subscription\_\-status}]the subscription status. \item[{\em body}]the body to attach to NOTIFY. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-get\_\-referto@{eXosip\_\-call\_\-get\_\-referto}}
\index{eXosip\_\-call\_\-get\_\-referto@{eXosip\_\-call\_\-get\_\-referto}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-get\_\-referto}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-get\_\-referto (int {\em did}, \/ char $\ast$ {\em refer\_\-to}, \/ size\_\-t {\em refer\_\-to\_\-len})}\label{group__eXosip2__call_g449bf82bf54fbf0bb1cecffc2a137d93}
Get Refer-To header with Replace parameter from dialog.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em did}]id of the dialog. \item[{\em refer\_\-to}]buffer to be filled with refer-to info. \item[{\em refer\_\-to\_\-len}]size of refer\_\-to buffer. \end{description}
\end{Desc}
\index{eXosip2\_\-call@{eXosip2\_\-call}!eXosip\_\-call\_\-find\_\-by\_\-replaces@{eXosip\_\-call\_\-find\_\-by\_\-replaces}}
\index{eXosip\_\-call\_\-find\_\-by\_\-replaces@{eXosip\_\-call\_\-find\_\-by\_\-replaces}!eXosip2_call@{eXosip2\_\-call}}
\subsubsection[{eXosip\_\-call\_\-find\_\-by\_\-replaces}]{\setlength{\rightskip}{0pt plus 5cm}int eXosip\_\-call\_\-find\_\-by\_\-replaces (char $\ast$ {\em replaces})}\label{group__eXosip2__call_gea701eed5a2d5482152b7eec521fa3c1}
Return did (or cid) for the replace header.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em replaces}]buffer to be filled with refer-to info. \end{description}
\end{Desc}
