Skip to content

Add relay_conference_id to RELAY Recordings Response #419

Open
cassieemb wants to merge 2 commits into
mainfrom
cassie/recordings/add_field
Open

Add relay_conference_id to RELAY Recordings Response #419
cassieemb wants to merge 2 commits into
mainfrom
cassie/recordings/add_field

Conversation

@cassieemb

@cassieemb cassieemb commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

This PR adds the optional relay_conference_id to the serialized response from the api/relay/rest/recordings endpoint. This field is only present if the recording belongs to a RELAY/SWML Conference.

Type of Change

  • New feature

Related Issues

https://github.com/signalwire/cloud-product/issues/19111

Testing

Tested manually by ensuring that list recordings/show recording both show the relay conference ID if one exists.

List Recordings
(scrubbed UUIDs)

curl --location 'https://SPACE.signalwire.com/api/relay/rest/recordings' \
--header 'Authorization: Basic '

{
    "links": {
        "self": "/api/relay/rest/recordings?page_number=0&page_size=50",
        "first": "/api/relay/rest/recordings?page_size=50"
    },
    "data": [
        {
            "id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "project_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "relay_conference_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "created_at": "Wed, 17 Jun 2026 16:25:14 +0000",
            "updated_at": "Wed, 17 Jun 2026 16:25:23 +0000",
            "duration_in_seconds": 4,
            "error_code": null,
            "price": 0.0,
            "price_unit": "USD",
            "status": "finished",
            "url": "/api/relay/rest/recordings/2d7333d1-dff4-4000-8353-a2e3540d2227",
            "stereo": false,
            "byte_size": 71084,
            "track": "both"
        },
        {
            "id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "project_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "relay_pstn_leg_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "created_at": "Thu, 15 Jan 2026 22:48:38 +0000",
            "updated_at": "Thu, 15 Jan 2026 22:49:47 +0000",
            "duration_in_seconds": 69,
            "error_code": null,
            "price": 0.0,
            "price_unit": "USD",
            "status": "finished",
            "url": "/api/relay/rest/recordings/2d7333d1-dff4-4000-8353-a2e3540d2227",
            "stereo": false,
            "byte_size": 135168,
            "track": "both"
        },
        {
            "id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "project_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "relay_sip_leg_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
            "created_at": "Thu, 22 May 2025 19:52:28 +0000",
            "updated_at": "Thu, 22 May 2025 19:52:36 +0000",
            "duration_in_seconds": 7,
            "error_code": null,
            "price": 0.0,
            "price_unit": "USD",
            "status": "finished",
            "url": "/api/relay/rest/recordings/2d7333d1-dff4-4000-8353-a2e3540d2227",
            "stereo": false,
            "byte_size": 94208,
            "track": "both"
        },
    ]
}

Retrieve Recording

curl --location 'https://SPACE.signalwire.com/api/relay/rest/recordings/2d7333d1-dff4-4000-8353-a2e3540d2227' \
--header 'Authorization: Basic '

{
    "id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
    "project_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
    "relay_conference_id": "2d7333d1-dff4-4000-8353-a2e3540d2227",
    "created_at": "Wed, 17 Jun 2026 16:25:14 +0000",
    "updated_at": "Wed, 17 Jun 2026 16:25:23 +0000",
    "duration_in_seconds": 4,
    "error_code": null,
    "price": 0.0,
    "price_unit": "USD",
    "status": "finished",
    "url": "/api/relay/rest/recordings/2d7333d1-dff4-4000-8353-a2e3540d2227",
    "stereo": false,
    "byte_size": 71084,
    "track": "both"
}

Screenshots

Screenshot 2026-06-17 at 12 23 36 PM Screenshot 2026-06-17 at 12 23 48 PM

@github-actions

github-actions Bot commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

🌿 Preview

https://signalwire-preview-bf6ef9c9-8bf8-4136-b3a6-2a93d6af4773.docs.buildwithfern.com/docs

View workflow run

cassieemb
cassieemb commented Jun 17, 2026
View reviewed changes
Comment thread fern/apis/signalwire-rest/openapi.yaml
Comment on lines +36885 to 36944
speakingRate:
anyOf:
- type: number
- $ref: '#/components/schemas/SWMLVar'
minimum: 0.5
maximum: 1.5
description: 'Adjusts how quickly the voice speaks. Values below `1.0` slow the voice down; values above `1.0` speed it up. IMPORTANT: Only works with the Inworld TTS engine.'
default: 1
temperature:
anyOf:
- type: number
- $ref: '#/components/schemas/SWMLVar'
minimum: 0
maximum: 2
description: 'Controls the randomness and expressiveness of the generated speech. Lower values produce a more consistent, predictable delivery; higher values introduce more variation. IMPORTANT: Only works with the Inworld TTS engine.'
default: 1
speed:
anyOf:
- type: number
- $ref: '#/components/schemas/SWMLVar'
minimum: 0.5
maximum: 2
description: 'How quickly the voice speaks. Values below `1.0` slow the voice down; values above `1.0` speed it up. IMPORTANT: Only works with the MiniMax TTS engine.'
default: 1
vol:
anyOf:
- type: number
- $ref: '#/components/schemas/SWMLVar'
minimum: 0.1
maximum: 1
description: 'The speaking volume. Lower values are quieter. IMPORTANT: Only works with the MiniMax TTS engine.'
default: 1
pitch:
anyOf:
- type: integer
format: int32
- $ref: '#/components/schemas/SWMLVar'
minimum: -12
maximum: 12
description: 'The pitch shift in semitones. Negative values lower the pitch; positive values raise it. IMPORTANT: Only works with the MiniMax TTS engine.'
default: 0
emotion:
type: string
enum:
- happy
- sad
- angry
- fearful
- disgusted
- surprised
- neutral
description: |-
A fixed emotional tone for the generated speech.
To vary the emotion automatically during a conversation, use [`languages[].emotion`](#languagesemotion) set to `auto` instead.
IMPORTANT: Only works with the MiniMax TTS engine.
examples:
- happy
unevaluatedProperties:
not: {}
title: LanguageParams

@cassieemb cassieemb Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got these (and a few others) when running TSP compile - not sure if I should remove this from this PR, or commit them to fix the drift? @Devon-White how would you like me to proceed?

@cassieemb cassieemb requested review from a team, Devon-White and hey-august June 17, 2026 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jpsantosbh jpsantosbh jpsantosbh approved these changes

@Devon-White Devon-White Awaiting requested review from Devon-White

@hey-august hey-august Awaiting requested review from hey-august

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cassieemb @jpsantosbh