TEL-912: Return TransferSIPParticipantResponse on TransferSIPParticipantRequests

livekit-api/livekit/api/sip_service.py

@@ -31,6 +31,7 @@
     DeleteSIPDispatchRuleRequest,
     CreateSIPParticipantRequest,
     TransferSIPParticipantRequest,
+    TransferSIPParticipantResponse,
     SIPParticipantInfo,
     SIPTransport,
     SIPMediaConfig,
@@ -832,8 +833,8 @@ async def transfer_sip_participant(
         transfer: TransferSIPParticipantRequest,
         *,
         timeout: Optional[float] = None,
-    ) -> SIPParticipantInfo:
-        """Transfer a SIP participant to a different room.
+    ) -> TransferSIPParticipantResponse:
+        """Transfer a SIP participant to another number or SIP endpoint.
 
         Args:
             transfer: Request containing transfer details
@@ -842,7 +843,10 @@ async def transfer_sip_participant(
                 longer timeout when unset.
 
         Returns:
-            Updated SIP participant information
+            The outcome of the transfer: its id, status, reason, and the SIP
+            status when the outcome came from a SIP response. A status other
+            than successful means the transfer did not complete, even when no
+            error was raised.
         """
         # Transferring a call dials a phone, which takes longer than a normal
         # call, so keep the request alive past ringing. Pin the ring window so the
@@ -861,7 +865,7 @@ async def transfer_sip_participant(
                     ),
                     sip=SIPGrants(call=True),
                 ),
-                SIPParticipantInfo,
+                TransferSIPParticipantResponse,
                 timeout=client_timeout,
             )
         except ServerError as e: