Merge branch 'main' of github.com:signalwire/docs into august-20260623-whatsapp-messaging

Author: hey-august

fern/apis/signalwire-rest/openapi.yaml

@@ -339,7 +339,7 @@ paths:
       description: |-
         Unified JSON-RPC style endpoint for executing call methods through command-based dispatch.
         Send a request with the appropriate `command` field to invoke the desired call operation.
-        All async-safe RELAY methods can be sent through this endpoint without a WebSocket connection.
+        Only the commands listed below are supported. Most operate on an already-active call; `dial` creates a new one. All commands are sent over HTTP (no persistent WebSocket connection required) and return immediately; operations that continue asynchronously deliver their results to your `status_url` webhooks.
 
         ## Supported Commands
 
@@ -353,7 +353,6 @@ paths:
         | `calling.end` | Terminate an active call immediately |
         | `calling.transfer` | Transfer a call to a new destination (SIP URI, phone number, or inline SWML) |
         | `calling.disconnect` | Disconnect bridged calls without hanging up either leg |
-        | `calling.join_conference` | Join the call to an ad-hoc audio conference, optionally attaching a WebSocket stream |
         | `calling.play` | Play audio, TTS, silence, or ringtone to a call |
         | `calling.play.pause` | Pause active playback |
         | `calling.play.resume` | Resume paused playback |
@@ -723,21 +722,6 @@ paths:
                   id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                   params:
                     control_id: tap-control-1
-              calling.join_conference:
-                summary: calling.join_conference
-                description: Join a conference and attach a bidirectional WebSocket stream
-                value:
-                  command: calling.join_conference
-                  id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
-                  params:
-                    name: team_meeting
-                    beep: onEnter
-                    start_on_enter: true
-                    stream:
-                      url: wss://example.com/conference-audio
-                      codec: PCMU
-                      realtime: true
-                      status_url: https://example.com/stream-status
               calling.transcribe:
                 summary: calling.transcribe
                 description: Start background transcription on an active call
@@ -17789,185 +17773,6 @@ components:
       unevaluatedProperties:
         not: {}
       title: calling.ai_hold
-    Calling.CallJoinConferenceRequest:
-      type: object
-      required:
-        - id
-        - command
-        - params
-      properties:
-        id:
-          allOf:
-            - $ref: '#/components/schemas/uuid'
-          description: The unique identifying ID of a existing call.
-          examples:
-            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
-        command:
-          type: string
-          enum:
-            - calling.join_conference
-          description: The `calling.join_conference` command joins the call to an ad-hoc audio conference.
-          examples:
-            - calling.join_conference
-        params:
-          type: object
-          properties:
-            name:
-              type: string
-              description: Name of the conference. All calls joining the same name are placed in the same conference.
-              examples:
-                - team_meeting
-            muted:
-              type: boolean
-              description: Whether to join the conference in a muted state.
-              examples:
-                - false
-            beep:
-              type: string
-              enum:
-                - 'true'
-                - 'false'
-                - onEnter
-                - onExit
-              description: Sets the behavior of the beep sound when joining or leaving the conference.
-              examples:
-                - onEnter
-            start_on_enter:
-              type: boolean
-              description: Start the conference when this participant joins, without waiting for other participants.
-              examples:
-                - true
-            end_on_exit:
-              type: boolean
-              description: End the conference when this participant leaves, without waiting for other participants.
-              examples:
-                - false
-            wait_url:
-              type: string
-              format: uri
-              description: HTTP or HTTPS URL to fetch audio to play while waiting for the conference to start. Default hold music is played if not set.
-              examples:
-                - https://example.com/hold-music.mp3
-            max_participants:
-              type: integer
-              description: The maximum number of participants allowed in the conference.
-              examples:
-                - 50
-            record:
-              type: string
-              enum:
-                - do-not-record
-                - record-from-start
-              description: Enables or disables recording of the conference.
-              examples:
-                - record-from-start
-            region:
-              type: string
-              enum:
-                - global
-                - us
-                - eu
-                - ch
-              description: The geographical region where the conference is hosted.
-              examples:
-                - us
-            trim:
-              type: string
-              enum:
-                - trim-silence
-                - do-not-trim
-              description: Whether to trim silence from the start of the conference recording.
-              examples:
-                - trim-silence
-            acl:
-              type: string
-              enum:
-                - private
-                - public-read
-              description: Access control level for the conference.
-              examples:
-                - private
-            coach:
-              type: string
-              description: Call SID of a call currently connected to an in-progress conference. The coach can hear but not be heard (coaching mode).
-              examples:
-                - b3877ee3-6f3c-4985-8066-6d24e3f65e12
-            status_callback_event:
-              type: string
-              description: |-
-                Space-separated list of one or more events to send to the status callback URL.
-                Possible values: `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, `announcement`.
-              examples:
-                - join leave
-            status_callback_event_type:
-              type: string
-              enum:
-                - cxml
-                - laml
-                - relay
-              description: Content type for status callback requests.
-              examples:
-                - relay
-            status_callback:
-              type: string
-              format: uri
-              description: HTTP or HTTPS URL to which status events will be sent.
-              examples:
-                - https://example.com/conference-status
-            status_callback_method:
-              type: string
-              enum:
-                - GET
-                - POST
-              description: The HTTP method to use when sending status events to the status callback URL.
-              examples:
-                - POST
-            recording_status_callback_event:
-              type: string
-              description: |-
-                Space-separated list of one or more events to send to the recording status callback URL.
-                Possible values: `in-progress`, `completed`, `absent`.
-              examples:
-                - completed
-            recording_status_callback_event_type:
-              type: string
-              enum:
-                - cxml
-                - laml
-                - relay
-              description: Content type for recording status callback requests.
-              examples:
-                - relay
-            recording_status_callback:
-              type: string
-              format: uri
-              description: HTTP or HTTPS URL to which recording status events will be sent.
-              examples:
-                - https://example.com/recording-status
-            recording_status_callback_method:
-              type: string
-              enum:
-                - GET
-                - POST
-              description: The HTTP method to use when sending recording status events to the recording status callback URL.
-              examples:
-                - POST
-            stream:
-              allOf:
-                - $ref: '#/components/schemas/Calling.ConferenceStreamParams'
-              description: Attach a bidirectional WebSocket stream to the conference audio.
-          required:
-            - name
-          unevaluatedProperties:
-            not: {}
-          description: An object of parameters that will be utilized by the active command.
-      unevaluatedProperties:
-        not: {}
-      description: |-
-        Join an ad-hoc audio conference. The conference is created automatically if it
-        does not already exist; multiple calls join the same conference by `name`.
-        Optionally attach a bidirectional WebSocket `stream` to the conference audio.
-      title: calling.join_conference
     Calling.CallLeg:
       type: object
       required:
@@ -18725,7 +18530,6 @@ components:
         - $ref: '#/components/schemas/Calling.CallTranscribeStopRequest'
         - $ref: '#/components/schemas/Calling.CallStreamRequest'
         - $ref: '#/components/schemas/Calling.CallStreamStopRequest'
-        - $ref: '#/components/schemas/Calling.CallJoinConferenceRequest'
         - $ref: '#/components/schemas/Calling.CallDenoiseRequest'
         - $ref: '#/components/schemas/Calling.CallDenoiseStopRequest'
         - $ref: '#/components/schemas/Calling.CallLiveTranscribeRequest'
@@ -18771,7 +18575,6 @@ components:
           calling.transcribe.stop: '#/components/schemas/Calling.CallTranscribeStopRequest'
           calling.stream: '#/components/schemas/Calling.CallStreamRequest'
           calling.stream.stop: '#/components/schemas/Calling.CallStreamStopRequest'
-          calling.join_conference: '#/components/schemas/Calling.CallJoinConferenceRequest'
           calling.denoise: '#/components/schemas/Calling.CallDenoiseRequest'
           calling.denoise.stop: '#/components/schemas/Calling.CallDenoiseStopRequest'
           calling.live_transcribe: '#/components/schemas/Calling.CallLiveTranscribeRequest'
@@ -18783,7 +18586,7 @@ components:
           calling.user_event: '#/components/schemas/Calling.CallUserEventRequest'
       description: |-
         Call request union for JSON-RPC style method dispatch. Use the `command` field to specify which call method to invoke.
-        All async-safe RELAY methods can be sent through this endpoint without a WebSocket connection.
+        Only the commands listed here are supported. Most operate on an already-active call; `dial` creates a new one. Commands return immediately; operations that continue asynchronously deliver their results to your `status_url` webhooks.
     Calling.CallResponse:
       anyOf:
         - $ref: '#/components/schemas/Calling.CallLeg'
@@ -19508,59 +19311,6 @@ components:
       unevaluatedProperties:
         not: {}
       description: Parameters for collecting speech input.
-    Calling.ConferenceStreamParams:
-      type: object
-      required:
-        - url
-      properties:
-        url:
-          type: string
-          format: uri
-          description: Secure WebSocket URL to stream conference audio to. Must start with `wss://` (TLS is required; plain `ws://` is rejected).
-          examples:
-            - wss://example.com/conference-audio
-        name:
-          type: string
-          description: Optional human-readable name to identify the stream at the endpoint.
-          examples:
-            - conference-audio
-        codec:
-          type: string
-          description: Audio codec to request. Freeform; endpoint-specific. Common values include `PCMU`, `PCMA`, `G722`, `L16`.
-          examples:
-            - PCMU
-        realtime:
-          type: boolean
-          description: When `true`, enables bidirectional audio so your endpoint can stream audio back into the conference (not just receive it).
-          examples:
-            - true
-        authorization_bearer_token:
-          type: string
-          description: 'Bearer token included as `Authorization: Bearer <token>` when establishing the WebSocket connection.'
-          examples:
-            - my-secret-token
-        custom_parameters:
-          type: object
-          unevaluatedProperties: {}
-          description: Arbitrary JSON object passed through to the WebSocket endpoint as connection metadata.
-          examples:
-            - session_id: abc123
-        status_url:
-          type: string
-          format: uri
-          description: HTTP or HTTPS URL that receives stream lifecycle webhooks.
-          examples:
-            - https://example.com/stream_callback
-        status_url_method:
-          allOf:
-            - $ref: '#/components/schemas/Calling.StreamStatusUrlMethod'
-          description: HTTP method used for the `status_url` webhook.
-          examples:
-            - POST
-          default: POST
-      unevaluatedProperties:
-        not: {}
-      description: Stream configuration for attaching a WebSocket stream to a conference.
     Calling.DetectConfig:
       type: object
       required:

specs/signalwire-rest/calling-api/calls/main.tsp

@@ -31,7 +31,7 @@ namespace SignalWireAPI.Calling.Calls {
     @doc("""
       Unified JSON-RPC style endpoint for executing call methods through command-based dispatch.
       Send a request with the appropriate `command` field to invoke the desired call operation.
-      All async-safe RELAY methods can be sent through this endpoint without a WebSocket connection.
+      Only the commands listed below are supported. Most operate on an already-active call; `dial` creates a new one. All commands are sent over HTTP (no persistent WebSocket connection required) and return immediately; operations that continue asynchronously deliver their results to your `status_url` webhooks.
       
       ## Supported Commands
       
@@ -45,7 +45,6 @@ namespace SignalWireAPI.Calling.Calls {
       | `calling.end` | Terminate an active call immediately |
       | `calling.transfer` | Transfer a call to a new destination (SIP URI, phone number, or inline SWML) |
       | `calling.disconnect` | Disconnect bridged calls without hanging up either leg |
-      | `calling.join_conference` | Join the call to an ad-hoc audio conference, optionally attaching a WebSocket stream |
       | `calling.play` | Play audio, TTS, silence, or ringtone to a call |
       | `calling.play.pause` | Pause active playback |
       | `calling.play.resume` | Resume paused playback |
@@ -198,13 +197,6 @@ namespace SignalWireAPI.Calling.Calls {
         description: "Start background transcription on an active call",
       }
     )
-    @opExample(
-      #{ parameters: joinConferenceCallExample },
-      #{
-        title: "calling.join_conference",
-        description: "Join a conference and attach a bidirectional WebSocket stream",
-      }
-    )
     @opExample(
       #{ parameters: tapStopCallExample },
       #{

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

@@ -403,25 +403,6 @@ const streamStopCallExample = #{
   },
 };
 
-// Conference examples
-const joinConferenceCallExample = #{
-  request: #{
-    command: "calling.join_conference",
-    id: callId,
-    params: #{
-      name: "team_meeting",
-      beep: "onEnter",
-      start_on_enter: true,
-      stream: #{
-        url: "wss://example.com/conference-audio",
-        codec: "PCMU",
-        realtime: true,
-        status_url: "https://example.com/stream-status",
-      },
-    },
-  },
-};
-
 // Denoise examples
 const denoiseCallExample = #{
   request: #{ command: "calling.denoise", id: callId, params: #{} },