Merge pull request #484 from signalwire/devon/calling-api-username

feat: add SIP authentication parameters to call API

Author: Devon-White

fern/apis/signalwire-rest/openapi.yaml

@@ -450,9 +450,11 @@ paths:
                   command: dial
                   params:
                     from: '+15551234567'
-                    to: '+15559876543'
+                    to: sip:alice@sip.example.com
                     url: https://example.com/swml
                     caller_id: '+15551234567'
+                    username: alice
+                    password: s3cr3t
                     status_url: https://example.com/status_callback
                     status_events:
                       - answered
@@ -17121,6 +17123,16 @@ components:
           description: Destination address. Accepts E.164 (`+xxxxxxxxxxx`), SIP URI (`sip:` / `sips:`), Verto URI (`verto:`), client address (`client:`), or a fabric address. Required unless `to_script` is provided.
           examples:
             - sip:from-sip@example-112233445567.sip.signalwire.com
+        username:
+          type: string
+          description: SIP authentication username, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.
+          examples:
+            - alice
+        password:
+          type: string
+          description: SIP authentication password, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.
+          examples:
+            - s3cr3t
         to_script:
           anyOf:
             - type: string
@@ -17242,6 +17254,16 @@ components:
           description: Destination address. Accepts E.164 (`+xxxxxxxxxxx`), SIP URI (`sip:` / `sips:`), Verto URI (`verto:`), client address (`client:`), or a fabric address. Required unless `to_script` is provided.
           examples:
             - sip:from-sip@example-112233445567.sip.signalwire.com
+        username:
+          type: string
+          description: SIP authentication username, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.
+          examples:
+            - alice
+        password:
+          type: string
+          description: SIP authentication password, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.
+          examples:
+            - s3cr3t
         to_script:
           anyOf:
             - type: string
@@ -17368,6 +17390,16 @@ components:
           description: Destination address. Accepts E.164 (`+xxxxxxxxxxx`), SIP URI (`sip:` / `sips:`), Verto URI (`verto:`), client address (`client:`), or a fabric address. Required unless `to_script` is provided.
           examples:
             - sip:from-sip@example-112233445567.sip.signalwire.com
+        username:
+          type: string
+          description: SIP authentication username, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.
+          examples:
+            - alice
+        password:
+          type: string
+          description: SIP authentication password, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.
+          examples:
+            - s3cr3t
         to_script:
           anyOf:
             - type: string

specs/signalwire-rest/calling-api/calls/models/examples.tsp

@@ -15,9 +15,11 @@ const dialCallExample = #{
     command: "dial",
     params: #{
       from: "+15551234567",
-      to: "+15559876543",
+      to: "sip:alice@sip.example.com",
       url: "https://example.com/swml",
       caller_id: "+15551234567",
+      username: "alice",
+      password: "s3cr3t",
       status_url: "https://example.com/status_callback",
       status_events: #["answered", "ended"],
       codecs: #[OutboundCallCodec.PCMU, OutboundCallCodec.PCMA],

specs/signalwire-rest/calling-api/calls/models/requests.tsp

@@ -417,6 +417,14 @@ model CallCreateParamsBase {
   @example("sip:from-sip@example-112233445567.sip.signalwire.com")
   to?: string;
 
+  @doc("SIP authentication username, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.")
+  @example("alice")
+  username?: string;
+
+  @doc("SIP authentication password, forwarded to the destination when `to` is a SIP URI. Ignored for PSTN and WebRTC/Verto destinations. Write-only — never returned in the call response.")
+  @example("s3cr3t")
+  password?: string;
+
   @doc("Inline SWML document (JSON or YAML string), or an `http(s)://` URL that returns one, executed at the destination end. Useful for directing the call to a RelayBin / external SWML handler. When present, `to` may be omitted.")
   @example("https://example.com/destination.swml.json")
   to_script?: string | SWMLObject;