also handle whatsapp dial timeout

Author: davidzhao

livekit-api/livekit/api/_dial_timeout.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import Optional
+
+# Calls that dial a phone (SIP CreateSIPParticipant with wait_until_answered and
+# TransferSIPParticipant; WhatsApp AcceptWhatsAppCall with wait_until_answered)
+# take longer than a normal request.
+DIAL_TIMEOUT = 30.0
+"""@private"""
+
+# A dialing request must outlast the ringing window, or it would abort before
+# the call can be answered. Keep the request timeout at least this many seconds
+# above the request's ringing_timeout.
+RINGING_TIMEOUT_MARGIN = 2.0
+"""@private"""
+
+
+def dial_timeout(user_timeout: Optional[float], request) -> float:
+    """Request timeout (seconds) for a phone-dialing call: the user-supplied
+    value (or the dial default) raised, when needed, to stay at least
+    RINGING_TIMEOUT_MARGIN above the request's ringing_timeout.
+
+    @private
+    """
+    effective = user_timeout if user_timeout else DIAL_TIMEOUT
+    if request.HasField("ringing_timeout"):
+        effective = max(effective, request.ringing_timeout.seconds + RINGING_TIMEOUT_MARGIN)
+    return effective

livekit-api/livekit/api/connector_service.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import aiohttp
+from typing import Optional
 
 from livekit.protocol.connector_whatsapp import (
     DialWhatsAppCallRequest,
@@ -17,6 +18,7 @@
     ConnectTwilioCallResponse,
 )
 from ._service import Service
+from ._dial_timeout import dial_timeout
 from .access_token import VideoGrants
 
 SVC = "Connector"
@@ -106,23 +108,39 @@ async def connect_whatsapp_call(
         )
 
     async def accept_whatsapp_call(
-        self, request: AcceptWhatsAppCallRequest
+        self,
+        request: AcceptWhatsAppCallRequest,
+        *,
+        timeout: Optional[float] = None,
     ) -> AcceptWhatsAppCallResponse:
         """
         Accept an inbound WhatsApp call
 
         Args:
             request: AcceptWhatsAppCallRequest containing call parameters and SDP
+            timeout: Optional request timeout in seconds. When the request waits
+                for an answer (wait_until_answered), it defaults to a longer value
+                (dialing takes time) and is raised, if needed, to stay above the
+                request's ringing_timeout.
 
         Returns:
             AcceptWhatsAppCallResponse with the room name
         """
+        client_timeout: Optional[aiohttp.ClientTimeout] = None
+        if request.wait_until_answered:
+            # Waiting for the call to be answered dials a phone, which takes
+            # longer than a normal request and must outlast ringing.
+            client_timeout = aiohttp.ClientTimeout(total=dial_timeout(timeout, request))
+        elif timeout:
+            client_timeout = aiohttp.ClientTimeout(total=timeout)
+
         return await self._client.request(
             SVC,
             "AcceptWhatsAppCall",
             request,
             self._auth_header(VideoGrants(room_create=True)),
             AcceptWhatsAppCallResponse,
+            timeout=client_timeout,
         )
 
     async def connect_twilio_call(

livekit-api/livekit/api/sip_service.py

@@ -2,7 +2,7 @@
 
 import aiohttp
 import warnings
-from typing import Optional, Union
+from typing import Optional
 
 from livekit.protocol.models import ListUpdate
 from livekit.protocol.sip import (
@@ -35,35 +35,12 @@
     SIPTransport,
 )
 from ._service import Service
+from ._dial_timeout import dial_timeout as _dial_timeout
 from .access_token import VideoGrants, SIPGrants
 
 SVC = "SIP"
 """@private"""
 
-# Calls that dial a phone (CreateSIPParticipant with wait_until_answered,
-# TransferSIPParticipant) take longer than a normal request.
-SIP_DIAL_TIMEOUT = 30.0
-"""@private"""
-
-# A dialing request must outlast the ringing window, or it would abort before
-# the call can be answered. Keep the request timeout at least this many seconds
-# above the request's ringing_timeout.
-RINGING_TIMEOUT_MARGIN = 2.0
-"""@private"""
-
-
-def _dial_timeout(
-    user_timeout: Optional[float],
-    request: Union[CreateSIPParticipantRequest, TransferSIPParticipantRequest],
-) -> float:
-    """Request timeout (seconds) for a phone-dialing call: the user-supplied
-    value (or the dial default) raised, when needed, to stay at least
-    RINGING_TIMEOUT_MARGIN above the request's ringing_timeout."""
-    effective = user_timeout if user_timeout else SIP_DIAL_TIMEOUT
-    if request.HasField("ringing_timeout"):
-        effective = max(effective, request.ringing_timeout.seconds + RINGING_TIMEOUT_MARGIN)
-    return effective
-
 
 class SipService(Service):
     """Client for LiveKit SIP Service API