livekit-api 1.1.1__tar.gz → 1.2.0__tar.gz

{livekit_api-1.1.1 → livekit_api-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: livekit-api
-Version: 1.1.1
+Version: 1.2.0
 Summary: Python Server API for LiveKit
 Project-URL: Documentation, https://docs.livekit.io
 Project-URL: Website, https://livekit.io/
@@ -22,7 +22,7 @@ Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.9.0
 Requires-Dist: aiohttp>=3.9.0
-Requires-Dist: livekit-protocol<2.0.0,>=1.1.17
+Requires-Dist: livekit-protocol<2.0.0,>=1.1.19
 Requires-Dist: protobuf>=4
 Requires-Dist: pyjwt>=2.0.0
 Requires-Dist: types-protobuf>=4

{livekit_api-1.1.1 → livekit_api-1.2.0}/livekit/api/__init__.py

@@ -36,7 +36,13 @@ from livekit.protocol.sip import *
 from livekit.protocol.connector_whatsapp import *
 from livekit.protocol.connector_twilio import *
 
-from .twirp_client import TwirpError, TwirpErrorCode
+from .twirp_client import (
+    ServerError,
+    ServerErrorCode,
+    SipCallError,
+    TwirpError,
+    TwirpErrorCode,
+)
 from .livekit_api import LiveKitAPI
 from .access_token import (
     InferenceGrants,
@@ -64,6 +70,9 @@ __all__ = [
     "AccessToken",
     "TokenVerifier",
     "WebhookReceiver",
+    "ServerError",
+    "ServerErrorCode",
     "TwirpError",
     "TwirpErrorCode",
+    "SipCallError",
 ]

livekit_api-1.2.0/livekit/api/_dial_timeout.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+from typing import Optional, Union
+
+from livekit.protocol.sip import CreateSIPParticipantRequest, TransferSIPParticipantRequest
+
+# Requests that carry ringing_timeout and share the phone-dialing timeout behavior.
+DialRequest = Union[
+    CreateSIPParticipantRequest,
+    TransferSIPParticipantRequest,
+]
+"""@private"""
+
+# Ring window (seconds) assumed when a request doesn't set ringing_timeout;
+# matches the server default. A dialing request must outlast it.
+DEFAULT_RINGING_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 ringing timeout.
+RINGING_TIMEOUT_MARGIN = 2.0
+"""@private"""
+
+
+def pin_ringing_timeout(request: DialRequest) -> None:
+    """Set the ring window explicitly on a dialing request when the caller left it
+    unset, so the derived request timeout doesn't depend on the server's default
+    (which could change out from under us).
+
+    @private
+    """
+    if not request.HasField("ringing_timeout"):
+        request.ringing_timeout.seconds = int(DEFAULT_RINGING_TIMEOUT)
+
+
+def dial_timeout(user_timeout: Optional[float], request: DialRequest) -> float:
+    """Request timeout (seconds) for a phone-dialing call: the ring window plus a
+    margin, so the request doesn't abort before the call can be answered. The
+    ring window is the request's ringing_timeout when set, else
+    DEFAULT_RINGING_TIMEOUT. A longer user_timeout is honored; a shorter one is
+    raised to the floor.
+
+    @private
+    """
+    if request.HasField("ringing_timeout"):
+        ring: float = request.ringing_timeout.seconds
+    else:
+        ring = DEFAULT_RINGING_TIMEOUT
+    floor = ring + RINGING_TIMEOUT_MARGIN
+    return max(user_timeout if user_timeout else floor, floor)

livekit_api-1.2.0/livekit/api/_failover.py

@@ -0,0 +1,162 @@
+# Copyright 2026 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Region failover for the Twirp API clients.
+
+On a retryable failure (any transport error or HTTP 5xx) the client discovers
+alternative LiveKit Cloud regions via ``/settings/regions`` and replays the
+request against the next region, with exponential backoff. 4xx responses are
+returned immediately.
+"""
+
+from __future__ import annotations
+
+import time
+from dataclasses import dataclass
+from typing import Dict, List, Optional
+from urllib.parse import urlparse
+
+import aiohttp
+
+FAILOVER_MAX_ATTEMPTS = 3
+FAILOVER_BACKOFF_BASE = 0.2  # seconds
+# Below this per-request timeout (seconds) a retry is unlikely to help and many
+# clients would retry in lockstep across regions, so a short request gets a
+# single attempt (thundering-herd guard).
+MIN_FAILOVER_TIMEOUT = 5.0
+
+
+def failover_attempts(
+    enabled: bool,
+    host: Optional[str],
+    force: bool = False,
+    timeout: Optional[float] = None,
+) -> int:
+    """Total request attempts for a host; 1 means no failover. Failover only
+    engages when enabled, the host is a LiveKit Cloud domain, and the request
+    timeout is long enough to retry. ``force`` bypasses the cloud-host check and
+    is for internal testing only.
+    """
+    if not (enabled and (force or (host is not None and is_cloud(host)))):
+        return 1
+    if timeout is not None and 0 < timeout < MIN_FAILOVER_TIMEOUT:
+        return 1
+    return FAILOVER_MAX_ATTEMPTS
+
+
+def is_cloud(host: str) -> bool:
+    # Failover only engages for LiveKit Cloud project domains.
+    return host.endswith(".livekit.cloud")
+
+
+def to_http(url: str) -> str:
+    """Normalizes a region URL to an http(s) scheme (ws -> http, wss -> https)."""
+    if url.startswith("ws"):
+        return "http" + url[2:]
+    return url
+
+
+def origin_of(url: str) -> str:
+    """Returns the scheme://host[:port] origin of a URL, dropping any path."""
+    parsed = urlparse(url)
+    return f"{parsed.scheme}://{parsed.netloc}"
+
+
+def host_key(url: str) -> str:
+    """A stable key identifying a host (including port) for dedup across attempts."""
+    return urlparse(url).netloc.lower()
+
+
+def pick_next(region_origins: List[str], attempted: set[str]) -> Optional[str]:
+    """Returns the first region origin whose host has not yet been attempted."""
+    for origin in region_origins:
+        if host_key(origin) not in attempted:
+            return origin
+    return None
+
+
+@dataclass
+class _CacheEntry:
+    origins: List[str]
+    fetched_at: float
+    ttl: float
+
+
+class RegionCache:
+    """Process-wide cache of the LiveKit Cloud region list, keyed by host."""
+
+    def __init__(self) -> None:
+        self._entries: Dict[str, _CacheEntry] = {}
+
+    async def region_origins(
+        self,
+        session: aiohttp.ClientSession,
+        origin: str,
+        headers: Dict[str, str],
+    ) -> List[str]:
+        """Returns alternative region origins for ``origin``, fetching
+        ``/settings/regions`` if the cache is stale. Best-effort: on a fetch
+        failure it serves a stale cached list when available, otherwise an empty
+        list. Forwards ``headers`` so a valid token — and any test directives —
+        reach the discovery endpoint."""
+        key = host_key(origin)
+        entry = self._entries.get(key)
+        if entry is not None and (time.monotonic() - entry.fetched_at) < entry.ttl:
+            return entry.origins
+
+        try:
+            origins, ttl = await self._fetch(session, origin, headers)
+        except Exception:
+            return entry.origins if entry is not None else []
+
+        # A zero TTL (e.g. Cache-Control: max-age=0) means "do not cache".
+        if ttl > 0:
+            self._entries[key] = _CacheEntry(origins, time.monotonic(), ttl)
+        return origins
+
+    async def _fetch(
+        self,
+        session: aiohttp.ClientSession,
+        origin: str,
+        headers: Dict[str, str],
+    ) -> tuple[List[str], float]:
+        fetch_headers = {
+            k: v for k, v in headers.items() if k.lower() not in ("content-type", "content-length")
+        }
+        # Short timeout so a slow/unreachable discovery endpoint doesn't stall
+        # the failover path.
+        async with session.get(
+            f"{origin}/settings/regions",
+            headers=fetch_headers,
+            timeout=aiohttp.ClientTimeout(total=2),
+        ) as resp:
+            if resp.status != 200:
+                raise RuntimeError(f"region discovery failed: {resp.status}")
+            ttl = _parse_max_age(resp.headers.get("Cache-Control"))
+            body = await resp.json()
+        origins = [origin_of(to_http(r["url"])) for r in body.get("regions", []) if r.get("url")]
+        return origins, ttl
+
+
+def _parse_max_age(cache_control: Optional[str]) -> float:
+    if not cache_control:
+        return 0.0
+    for directive in cache_control.split(","):
+        directive = directive.strip().lower()
+        if directive.startswith("max-age="):
+            try:
+                return float(int(directive[len("max-age=") :]))
+            except ValueError:
+                return 0.0
+    return 0.0

livekit_api-1.2.0/livekit/api/_service.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+import aiohttp
+from abc import ABC
+from .twirp_client import TwirpClient
+from .access_token import AccessToken, VideoGrants, SIPGrants
+
+AUTHORIZATION = "authorization"
+
+
+class Service(ABC):
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        host: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        self._client = TwirpClient(session, host, "livekit", failover=failover)
+        self.api_key = api_key
+        self.api_secret = api_secret
+        # A pre-signed token set by LiveKitAPI for token auth; sent verbatim,
+        # skipping per-call signing. Per-service constructors stay key/secret-only.
+        self._token: str | None = None
+
+    def _auth_header(
+        self, grants: VideoGrants | None, sip: SIPGrants | None = None
+    ) -> dict[str, str]:
+        # A pre-signed token is sent verbatim; the caller is responsible for its grants.
+        if self._token:
+            return {AUTHORIZATION: "Bearer {}".format(self._token)}
+
+        tok = AccessToken(self.api_key, self.api_secret)
+        if grants:
+            tok.with_grants(grants)
+        if sip is not None:
+            tok.with_sip_grants(sip)
+
+        token = tok.to_jwt()
+        return {AUTHORIZATION: "Bearer {}".format(token)}

{livekit_api-1.1.1 → livekit_api-1.2.0}/livekit/api/access_token.py

@@ -271,9 +271,10 @@ class TokenVerifier:
 
         if claims.get("roomPreset"):
             grant_claims.room_preset = claims.get("roomPreset")
-        if claims.get("roomConfig"):
+        room_config = claims.get("roomConfig")
+        if room_config:
             grant_claims.room_config = ParseDict(
-                claims.get("roomConfig"),
+                room_config,
                 RoomConfiguration(),
                 ignore_unknown_fields=True,
             )

{livekit_api-1.1.1 → livekit_api-1.2.0}/livekit/api/agent_dispatch_service.py

@@ -26,8 +26,15 @@ class AgentDispatchService(Service):
     ```
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def create_dispatch(self, req: CreateAgentDispatchRequest) -> AgentDispatch:
         """Create an explicit dispatch for an agent to join a room.

{livekit_api-1.1.1 → livekit_api-1.2.0}/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 @@ from livekit.protocol.connector_twilio import (
     ConnectTwilioCallResponse,
 )
 from ._service import Service
+from ._dial_timeout import DEFAULT_RINGING_TIMEOUT
 from .access_token import VideoGrants
 
 SVC = "Connector"
@@ -35,8 +37,15 @@ class ConnectorService(Service):
     ```
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def dial_whatsapp_call(
         self, request: DialWhatsAppCallRequest
@@ -99,23 +108,41 @@ class ConnectorService(Service):
         )
 
     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 the inbound party to join (wait_until_answered), it defaults
+                to the standard ring window.
 
         Returns:
             AcceptWhatsAppCallResponse with the room name
         """
+        client_timeout: Optional[aiohttp.ClientTimeout] = None
+        if request.wait_until_answered:
+            # Waiting for the inbound party to join can block, so default the
+            # request timeout to the standard ring window; the caller overrides
+            # via timeout.
+            client_timeout = aiohttp.ClientTimeout(
+                total=timeout if timeout else DEFAULT_RINGING_TIMEOUT
+            )
+        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-1.1.1 → livekit_api-1.2.0}/livekit/api/egress_service.py

@@ -33,8 +33,15 @@ class EgressService(Service):
     Also see https://docs.livekit.io/home/egress/overview/
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def start_room_composite_egress(self, start: RoomCompositeEgressRequest) -> EgressInfo:
         """Starts a composite recording of a room."""

{livekit_api-1.1.1 → livekit_api-1.2.0}/livekit/api/ingress_service.py

@@ -28,8 +28,15 @@ class IngressService(Service):
     Also see https://docs.livekit.io/home/ingress/overview/
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def create_ingress(self, create: CreateIngressRequest) -> IngressInfo:
         return await self._client.request(

{livekit_api-1.1.1 → livekit_api-1.2.0}/livekit/api/livekit_api.py

@@ -29,42 +29,95 @@ class LiveKitAPI:
         api_key: Optional[str] = None,
         api_secret: Optional[str] = None,
         *,
+        token: Optional[str] = None,
         timeout: Optional[aiohttp.ClientTimeout] = None,
         session: Optional[aiohttp.ClientSession] = None,
+        failover: bool = True,
     ):
         """Create a new LiveKitAPI instance.
 
+        Authenticate with an API key and secret (recommended for backend use).
+        For token auth (client-side use, where the API secret must not be
+        exposed), prefer the :meth:`with_token` constructor.
+
         Args:
             url: LiveKit server URL (read from `LIVEKIT_URL` environment variable if not provided)
             api_key: API key (read from `LIVEKIT_API_KEY` environment variable if not provided)
             api_secret: API secret (read from `LIVEKIT_API_SECRET` environment variable if not provided)
-            timeout: Request timeout (default: 60 seconds)
+            token: Pre-signed access token (read from `LIVEKIT_TOKEN` environment variable if not provided)
+            timeout: Request timeout (default: 10 seconds)
             session: aiohttp.ClientSession instance to use for requests, if not provided, a new one will be created
         """
         url = url or os.getenv("LIVEKIT_URL")
-        api_key = api_key or os.getenv("LIVEKIT_API_KEY")
-        api_secret = api_secret or os.getenv("LIVEKIT_API_SECRET")
+
+        # Only fall back to environment credentials when none were provided
+        # explicitly, so an ambient LIVEKIT_TOKEN can't silently override an
+        # explicit api_key/secret (or vice versa).
+        if not token and not api_key and not api_secret:
+            token = os.getenv("LIVEKIT_TOKEN")
+        if not token and not api_key and not api_secret:
+            api_key = os.getenv("LIVEKIT_API_KEY")
+            api_secret = os.getenv("LIVEKIT_API_SECRET")
 
         if not url:
             raise ValueError("url must be set")
 
-        if not api_key or not api_secret:
-            raise ValueError("api_key and api_secret must be set")
+        if not token and (not api_key or not api_secret):
+            raise ValueError("either token, or api_key and api_secret, must be set")
 
         self._custom_session = True
         self._session = session
         if not self._session:
             self._custom_session = False
             if not timeout:
-                timeout = aiohttp.ClientTimeout(total=60)
+                timeout = aiohttp.ClientTimeout(total=10)
             self._session = aiohttp.ClientSession(timeout=timeout)
 
-        self._room = RoomService(self._session, url, api_key, api_secret)
-        self._ingress = IngressService(self._session, url, api_key, api_secret)
-        self._egress = EgressService(self._session, url, api_key, api_secret)
-        self._sip = SipService(self._session, url, api_key, api_secret)
-        self._agent_dispatch = AgentDispatchService(self._session, url, api_key, api_secret)
-        self._connector = ConnectorService(self._session, url, api_key, api_secret)
+        # In token mode there is no key/secret; pass empty strings and rely on
+        # the token, injected into each service below.
+        key = api_key or ""
+        secret = api_secret or ""
+        self._room = RoomService(self._session, url, key, secret, failover)
+        self._ingress = IngressService(self._session, url, key, secret, failover)
+        self._egress = EgressService(self._session, url, key, secret, failover)
+        self._sip = SipService(self._session, url, key, secret, failover)
+        self._agent_dispatch = AgentDispatchService(self._session, url, key, secret, failover)
+        self._connector = ConnectorService(self._session, url, key, secret, failover)
+
+        if token:
+            for svc in (
+                self._room,
+                self._ingress,
+                self._egress,
+                self._sip,
+                self._agent_dispatch,
+                self._connector,
+            ):
+                svc._token = token
+
+    @classmethod
+    def with_token(
+        cls,
+        token: str,
+        url: Optional[str] = None,
+        *,
+        timeout: Optional[aiohttp.ClientTimeout] = None,
+        session: Optional[aiohttp.ClientSession] = None,
+        failover: bool = True,
+    ) -> "LiveKitAPI":
+        """Create a LiveKitAPI authenticated with a pre-signed token.
+
+        The token is sent verbatim and must already carry the grants for the calls
+        it's used with. Since it needs no secret, this is suitable for client-side
+        use. `url` falls back to the `LIVEKIT_URL` environment variable.
+
+        Args:
+            token: Pre-signed access token
+            url: LiveKit server URL (read from `LIVEKIT_URL` if not provided)
+            timeout: Request timeout (default: 10 seconds)
+            session: aiohttp.ClientSession to use; a new one is created if omitted
+        """
+        return cls(url, token=token, timeout=timeout, session=session, failover=failover)
 
     @property
     def agent_dispatch(self) -> AgentDispatchService:

{livekit_api-1.1.1 → livekit_api-1.2.0}/livekit/api/room_service.py

@@ -45,8 +45,15 @@ class RoomService(Service):
     Also see https://docs.livekit.io/home/server/managing-rooms/ and https://docs.livekit.io/home/server/managing-participants/
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def create_room(
         self,

{livekit_api-1.1.1 → livekit_api-1.2.0}/livekit/api/sip_service.py

@@ -33,14 +33,28 @@ from livekit.protocol.sip import (
     TransferSIPParticipantRequest,
     SIPParticipantInfo,
     SIPTransport,
+    SIPMediaConfig,
 )
 from ._service import Service
+from .twirp_client import SipCallError, ServerError
+from ._dial_timeout import (
+    dial_timeout as _dial_timeout,
+    pin_ringing_timeout as _pin_ringing_timeout,
+)
 from .access_token import VideoGrants, SIPGrants
 
 SVC = "SIP"
 """@private"""
 
 
+def _as_sip_error(err: ServerError) -> ServerError:
+    """Surface a SIP dialing failure as a SipCallError so callers can branch on
+    the SIP status; other failures (auth, validation) are returned unchanged."""
+    if "sip_status_code" in err.metadata:
+        return SipCallError.from_server_error(err)
+    return err
+
+
 class SipService(Service):
     """Client for LiveKit SIP Service API
 
@@ -53,8 +67,15 @@ class SipService(Service):
     ```
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def create_inbound_trunk(
         self, create: CreateSIPInboundTrunkRequest
@@ -156,6 +177,7 @@ class SipService(Service):
         auth_password: Optional[str] = None,
         name: Optional[str] = None,
         metadata: Optional[str] = None,
+        media: Optional[SIPMediaConfig] = None,
     ) -> SIPInboundTrunkInfo:
         """Updates specific fields of an existing SIP inbound trunk.
 
@@ -166,6 +188,7 @@ class SipService(Service):
             auth_password=auth_password,
             name=name,
             metadata=metadata,
+            media=media,
         )
         if numbers is not None:
             if isinstance(numbers, ListUpdate):
@@ -335,6 +358,7 @@ class SipService(Service):
         auth_password: str | None = None,
         name: str | None = None,
         metadata: str | None = None,
+        media: Optional[SIPMediaConfig] = None,
     ) -> SIPOutboundTrunkInfo:
         """Updates specific fields of an existing SIP outbound trunk.
 
@@ -347,6 +371,7 @@ class SipService(Service):
             auth_password=auth_password,
             name=name,
             metadata=metadata,
+            media=media,
         )
         if numbers is not None:
             if isinstance(numbers, ListUpdate):
@@ -774,17 +799,15 @@ class SipService(Service):
             SIPError: If the SIP operation fails
         """
         client_timeout: Optional[aiohttp.ClientTimeout] = None
-        if timeout:
-            # obay user specified timeout
+        if create.wait_until_answered:
+            # Dialing a phone and waiting for an answer takes longer than a
+            # normal call, and the request must outlast ringing. Pin the ring
+            # window so the timeout doesn't depend on the server's default.
+            _pin_ringing_timeout(create)
+            client_timeout = aiohttp.ClientTimeout(total=_dial_timeout(timeout, create))
+        elif timeout:
+            # obey user specified timeout
             client_timeout = aiohttp.ClientTimeout(total=timeout)
-        elif create.wait_until_answered:
-            # ensure default timeout isn't too short when using sync mode
-            if (
-                self._client._session.timeout
-                and self._client._session.timeout.total
-                and self._client._session.timeout.total < 20
-            ):
-                client_timeout = aiohttp.ClientTimeout(total=20)
 
         if trunk_id:
             create.sip_trunk_id = trunk_id
@@ -792,39 +815,57 @@ class SipService(Service):
         if outbound_trunk_config:
             create.trunk = outbound_trunk_config
 
-        return await self._client.request(
-            SVC,
-            "CreateSIPParticipant",
-            create,
-            self._auth_header(VideoGrants(), sip=SIPGrants(call=True)),
-            SIPParticipantInfo,
-            timeout=client_timeout,
-        )
+        try:
+            return await self._client.request(
+                SVC,
+                "CreateSIPParticipant",
+                create,
+                self._auth_header(VideoGrants(), sip=SIPGrants(call=True)),
+                SIPParticipantInfo,
+                timeout=client_timeout,
+            )
+        except ServerError as e:
+            raise _as_sip_error(e) from None
 
     async def transfer_sip_participant(
-        self, transfer: TransferSIPParticipantRequest
+        self,
+        transfer: TransferSIPParticipantRequest,
+        *,
+        timeout: Optional[float] = None,
     ) -> SIPParticipantInfo:
         """Transfer a SIP participant to a different room.
 
         Args:
             transfer: Request containing transfer details
+            timeout: Optional request timeout in seconds. Transferring dials a
+                phone, which takes longer than normal, so it defaults to a
+                longer timeout when unset.
 
         Returns:
             Updated SIP participant information
         """
-        return await self._client.request(
-            SVC,
-            "TransferSIPParticipant",
-            transfer,
-            self._auth_header(
-                VideoGrants(
-                    room_admin=True,
-                    room=transfer.room_name,
+        # 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
+        # timeout doesn't depend on the server's default.
+        _pin_ringing_timeout(transfer)
+        client_timeout = aiohttp.ClientTimeout(total=_dial_timeout(timeout, transfer))
+        try:
+            return await self._client.request(
+                SVC,
+                "TransferSIPParticipant",
+                transfer,
+                self._auth_header(
+                    VideoGrants(
+                        room_admin=True,
+                        room=transfer.room_name,
+                    ),
+                    sip=SIPGrants(call=True),
                 ),
-                sip=SIPGrants(call=True),
-            ),
-            SIPParticipantInfo,
-        )
+                SIPParticipantInfo,
+                timeout=client_timeout,
+            )
+        except ServerError as e:
+            raise _as_sip_error(e) from None
 
     def _admin_headers(self) -> dict[str, str]:
         return self._auth_header(VideoGrants(), sip=SIPGrants(admin=True))

livekit_api-1.2.0/livekit/api/twirp_client.py

@@ -0,0 +1,284 @@
+# Copyright 2023 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import asyncio
+import logging
+from typing import Dict, List, Optional, Type, TypeVar
+
+import aiohttp
+from google.protobuf.message import Message
+from urllib.parse import urlparse
+
+from ._failover import (
+    FAILOVER_BACKOFF_BASE,
+    RegionCache,
+    failover_attempts,
+    host_key,
+    origin_of,
+    pick_next,
+)
+from .version import __version__
+
+DEFAULT_PREFIX = "twirp"
+
+logger = logging.getLogger("livekit")
+
+# Identifies the SDK and version to the server on every request.
+_USER_AGENT = f"livekit-server-sdk-python/{__version__}"
+
+# Shared across all clients in the process so the region list is fetched once.
+_REGION_CACHE = RegionCache()
+
+
+class ServerError(Exception):
+    def __init__(
+        self,
+        code: str,
+        msg: str,
+        *,
+        status: int,
+        metadata: Optional[Dict[str, str]] = None,
+    ) -> None:
+        self._code = code
+        self._msg = msg
+        self._status = status
+        self._metadata = metadata or {}
+
+    @property
+    def code(self) -> str:
+        return self._code
+
+    @property
+    def message(self) -> str:
+        return self._msg
+
+    @property
+    def status(self) -> int:
+        """HTTP status code"""
+        return self._status
+
+    @property
+    def metadata(self) -> Dict[str, str]:
+        """Server-provided error metadata"""
+        return self._metadata
+
+    def __str__(self) -> str:
+        result = f"ServerError(code={self.code}, message={self.message}, status={self.status}"
+        if self.metadata:
+            result += f", metadata={self.metadata}"
+        result += ")"
+        return result
+
+
+class SipCallError(ServerError):
+    """A :class:`ServerError` from a SIP dialing call (``create_sip_participant`` /
+    ``transfer_sip_participant``) that failed with a SIP response status. The SIP
+    code and reason are exposed as properties; any other error metadata remains
+    available via :attr:`metadata`."""
+
+    @property
+    def sip_status_code(self) -> Optional[int]:
+        """The SIP response code of the failed call, e.g. 486 (Busy Here)."""
+        raw = self.metadata.get("sip_status_code")
+        if raw is None:
+            return None
+        try:
+            return int(raw)
+        except ValueError:
+            return None
+
+    @property
+    def sip_status(self) -> Optional[str]:
+        """The SIP reason phrase of the failed call, e.g. "Busy Here"."""
+        return self.metadata.get("sip_status")
+
+    @classmethod
+    def from_server_error(cls, err: ServerError) -> "SipCallError":
+        return cls(err.code, err.message, status=err.status, metadata=err.metadata)
+
+    def __str__(self) -> str:
+        code = self.metadata.get("sip_status_code")
+        if code is None:
+            return super().__str__()
+        # A clear, SIP-specific representation, including any extra metadata.
+        reason = self.metadata.get("sip_status")
+        result = f"SIP call failed: {code}"
+        if reason:
+            result += f" {reason}"
+        result += f" ({self.code})"
+        extra = {
+            k: v
+            for k, v in self.metadata.items()
+            if k not in ("sip_status_code", "sip_status", "error_details")
+        }
+        if extra:
+            result += " [" + ", ".join(f"{k}={v}" for k, v in extra.items()) + "]"
+        return result
+
+
+# Deprecated alias for :class:`ServerError`, kept for backwards compatibility.
+TwirpError = ServerError
+
+
+class ServerErrorCode:
+    CANCELED = "canceled"
+    UNKNOWN = "unknown"
+    INVALID_ARGUMENT = "invalid_argument"
+    MALFORMED = "malformed"
+    DEADLINE_EXCEEDED = "deadline_exceeded"
+    NOT_FOUND = "not_found"
+    BAD_ROUTE = "bad_route"
+    ALREADY_EXISTS = "already_exists"
+    PERMISSION_DENIED = "permission_denied"
+    UNAUTHENTICATED = "unauthenticated"
+    RESOURCE_EXHAUSTED = "resource_exhausted"
+    FAILED_PRECONDITION = "failed_precondition"
+    ABORTED = "aborted"
+    OUT_OF_RANGE = "out_of_range"
+    UNIMPLEMENTED = "unimplemented"
+    INTERNAL = "internal"
+    UNAVAILABLE = "unavailable"
+    DATA_LOSS = "dataloss"
+
+
+# Deprecated alias for :class:`ServerErrorCode`, kept for backwards compatibility.
+TwirpErrorCode = ServerErrorCode
+
+
+T = TypeVar("T", bound=Message)
+
+
+class TwirpClient:
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        host: str,
+        pkg: str,
+        prefix: str = DEFAULT_PREFIX,
+        failover: bool = True,
+        *,
+        _failover_force: bool = False,
+        _failover_backoff: float = FAILOVER_BACKOFF_BASE,
+    ) -> None:
+        parse_res = urlparse(host)
+        scheme = parse_res.scheme
+        if scheme.startswith("ws"):
+            scheme = scheme.replace("ws", "http")
+
+        host = f"{scheme}://{parse_res.netloc}/{parse_res.path}"
+        self.host = host.rstrip("/")
+        self.pkg = pkg
+        self.prefix = prefix
+        self._session = session
+        # _failover_force / _failover_backoff are internal test-only knobs.
+        self._failover = failover
+        self._failover_force = _failover_force
+        self._failover_backoff = _failover_backoff
+        self._origin = origin_of(self.host)
+
+    async def request(
+        self,
+        service: str,
+        method: str,
+        data: Message,
+        headers: Dict[str, str],
+        response_class: Type[T],
+        *,
+        timeout: Optional[aiohttp.ClientTimeout] = None,
+    ) -> T:
+        """Issues a Twirp request, failing over to alternative regions on
+        retryable errors. On any transport error or HTTP 5xx it discovers
+        regions via ``/settings/regions`` and replays the request — body and
+        headers intact — against the next untried region, with exponential
+        backoff. A 4xx is returned immediately."""
+        path = f"{self.prefix}/{self.pkg}.{service}/{method}"
+        headers = dict(headers)
+        headers["User-Agent"] = _USER_AGENT
+        forward_headers = dict(headers)  # for the discovery fetch (no content-type yet)
+        headers["Content-Type"] = "application/protobuf"
+        serialized_data = data.SerializeToString()
+
+        # The effective per-attempt timeout is the per-call override, or the
+        # session default; used to gate failover for short requests.
+        effective_timeout = timeout.total if timeout else None
+        if effective_timeout is None and self._session.timeout is not None:
+            effective_timeout = self._session.timeout.total
+        host = urlparse(self._origin).hostname
+        max_attempts = failover_attempts(
+            self._failover, host, self._failover_force, effective_timeout
+        )
+        attempted = {host_key(self._origin)}
+        region_origins: Optional[List[str]] = None
+        current_origin = self._origin
+
+        for attempt in range(max_attempts):
+            is_last = attempt + 1 >= max_attempts
+            url = f"{current_origin}/{path}"
+
+            transport_exc: Optional[BaseException] = None
+            retryable_status: Optional[int] = None
+            error_data: Dict = {}
+            try:
+                async with self._session.post(
+                    url, headers=headers, data=serialized_data, timeout=timeout
+                ) as resp:
+                    if resp.status == 200:
+                        return response_class.FromString(await resp.read())
+                    # Twirp encodes errors as JSON regardless of content type.
+                    try:
+                        error_data = await resp.json()
+                    except Exception:
+                        error_data = {}
+                    if resp.status < 500:
+                        # 4xx is terminal.
+                        raise self._server_error(error_data, resp.status)
+                    retryable_status = resp.status
+            except (aiohttp.ClientError, asyncio.TimeoutError) as e:
+                transport_exc = e
+
+            # Only retryable failures (5xx or transport error) reach this point.
+            next_origin = None
+            if not is_last:
+                if region_origins is None:
+                    region_origins = await _REGION_CACHE.region_origins(
+                        self._session, self._origin, forward_headers
+                    )
+                next_origin = pick_next(region_origins, attempted)
+
+            if next_origin is None:
+                if transport_exc is not None:
+                    raise transport_exc
+                raise self._server_error(error_data, retryable_status or 500)
+
+            reason = transport_exc if transport_exc is not None else f"status {retryable_status}"
+            logger.warning(
+                "livekit API request to %s failed (%s), retrying with fallback url %s",
+                current_origin,
+                reason,
+                next_origin,
+            )
+            await asyncio.sleep(self._failover_backoff * (2**attempt))
+            attempted.add(host_key(next_origin))
+            current_origin = next_origin
+
+        raise RuntimeError("failover loop exited without returning")  # unreachable
+
+    @staticmethod
+    def _server_error(error_data: Dict, status: int) -> "ServerError":
+        return ServerError(
+            error_data.get("code", "unknown"),
+            error_data.get("msg", ""),
+            status=status,
+            metadata=error_data.get("meta"),
+        )

livekit_api-1.2.0/livekit/api/version.py

@@ -0,0 +1 @@
+__version__ = "1.2.0"

{livekit_api-1.1.1 → livekit_api-1.2.0}/pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
     "aiohttp>=3.9.0",
     "protobuf>=4",
     "types-protobuf>=4",
-    "livekit-protocol>=1.1.17,<2.0.0",
+    "livekit-protocol>=1.1.19,<2.0.0",
 ]
 
 [project.urls]

livekit_api-1.1.1/livekit/api/_service.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-import aiohttp
-from abc import ABC
-from .twirp_client import TwirpClient
-from .access_token import AccessToken, VideoGrants, SIPGrants
-
-AUTHORIZATION = "authorization"
-
-
-class Service(ABC):
-    def __init__(self, session: aiohttp.ClientSession, host: str, api_key: str, api_secret: str):
-        self._client = TwirpClient(session, host, "livekit")
-        self.api_key = api_key
-        self.api_secret = api_secret
-
-    def _auth_header(
-        self, grants: VideoGrants | None, sip: SIPGrants | None = None
-    ) -> dict[str, str]:
-        tok = AccessToken(self.api_key, self.api_secret)
-        if grants:
-            tok.with_grants(grants)
-        if sip is not None:
-            tok.with_sip_grants(sip)
-
-        token = tok.to_jwt()
-
-        headers = {}
-        headers[AUTHORIZATION] = "Bearer {}".format(token)
-        return headers

livekit_api-1.1.1/livekit/api/twirp_client.py

@@ -1,134 +0,0 @@
-# Copyright 2023 LiveKit, Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from typing import Dict, Type, TypeVar, Optional
-
-import aiohttp
-from google.protobuf.message import Message
-from urllib.parse import urlparse
-
-DEFAULT_PREFIX = "twirp"
-
-
-class TwirpError(Exception):
-    def __init__(
-        self,
-        code: str,
-        msg: str,
-        *,
-        status: int,
-        metadata: Optional[Dict[str, str]] = None,
-    ) -> None:
-        self._code = code
-        self._msg = msg
-        self._status = status
-        self._metadata = metadata or {}
-
-    @property
-    def code(self) -> str:
-        return self._code
-
-    @property
-    def message(self) -> str:
-        return self._msg
-
-    @property
-    def status(self) -> int:
-        """HTTP status code"""
-        return self._status
-
-    @property
-    def metadata(self) -> Dict[str, str]:
-        """Twirp metadata"""
-        return self._metadata
-
-    def __str__(self) -> str:
-        result = f"TwirpError(code={self.code}, message={self.message}, status={self.status}"
-        if self.metadata:
-            result += f", metadata={self.metadata}"
-        result += ")"
-        return result
-
-
-class TwirpErrorCode:
-    CANCELED = "canceled"
-    UNKNOWN = "unknown"
-    INVALID_ARGUMENT = "invalid_argument"
-    MALFORMED = "malformed"
-    DEADLINE_EXCEEDED = "deadline_exceeded"
-    NOT_FOUND = "not_found"
-    BAD_ROUTE = "bad_route"
-    ALREADY_EXISTS = "already_exists"
-    PERMISSION_DENIED = "permission_denied"
-    UNAUTHENTICATED = "unauthenticated"
-    RESOURCE_EXHAUSTED = "resource_exhausted"
-    FAILED_PRECONDITION = "failed_precondition"
-    ABORTED = "aborted"
-    OUT_OF_RANGE = "out_of_range"
-    UNIMPLEMENTED = "unimplemented"
-    INTERNAL = "internal"
-    UNAVAILABLE = "unavailable"
-    DATA_LOSS = "dataloss"
-
-
-T = TypeVar("T", bound=Message)
-
-
-class TwirpClient:
-    def __init__(
-        self,
-        session: aiohttp.ClientSession,
-        host: str,
-        pkg: str,
-        prefix: str = DEFAULT_PREFIX,
-    ) -> None:
-        parse_res = urlparse(host)
-        scheme = parse_res.scheme
-        if scheme.startswith("ws"):
-            scheme = scheme.replace("ws", "http")
-
-        host = f"{scheme}://{parse_res.netloc}/{parse_res.path}"
-        self.host = host.rstrip("/")
-        self.pkg = pkg
-        self.prefix = prefix
-        self._session = session
-
-    async def request(
-        self,
-        service: str,
-        method: str,
-        data: Message,
-        headers: Dict[str, str],
-        response_class: Type[T],
-        *,
-        timeout: Optional[aiohttp.ClientTimeout] = None,
-    ) -> T:
-        url = f"{self.host}/{self.prefix}/{self.pkg}.{service}/{method}"
-        headers["Content-Type"] = "application/protobuf"
-
-        serialized_data = data.SerializeToString()
-        async with self._session.post(
-            url, headers=headers, data=serialized_data, timeout=timeout
-        ) as resp:
-            if resp.status == 200:
-                return response_class.FromString(await resp.read())
-            else:
-                # when we have an error, Twirp always encode it in json
-                error_data = await resp.json()
-                raise TwirpError(
-                    error_data.get("code", "unknown"),
-                    error_data.get("msg", ""),
-                    status=resp.status,
-                    metadata=error_data.get("meta"),
-                )

livekit_api-1.1.1/livekit/api/version.py

@@ -1 +0,0 @@
-__version__ = "1.1.1"