---
title: "Get the signaling settings"
method: GET
path: "/ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/settings"
tags: ["internal_signaling", "external_signaling"]
---

# Get the signaling settings

`GET /ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/settings`

## Path parameters

- `apiVersion` 'v3', required

## Query parameters

- `token` string

## Headers

- `talk-recording-random` string
- `talk-recording-checksum` string
- `talk-sipbridge-random` string
- `talk-sipbridge-checksum` string
- `OCS-APIRequest` boolean, required

## Response `200`

Signaling settings returned

- object
  - `ocs` object, required
    - `meta` OCSMeta, required
      - `status` string, required
      - `statuscode` integer, required
      - `message` string
      - `totalitems` string
      - `itemsperpage` string
    - `data` SignalingSettings, required
      - `federation` SignalingFederationSettings, required
        - `server` string, required — URL of the signaling server for federation
        - `nextcloudServer` string, required — URL of the Nextcloud server for federation
        - `helloAuthParams` object, required — Authentication parameters for the hello request
          - `token` string, required
        - `roomId` string, required — Room id on the federated server
      - `helloAuthParams` object — Authentication parameters for the hello request
        - `1.0` object, required
          - `userid` string, nullable, required
          - `ticket` string, required
        - `2.0` object, required
          - `token` string, required
      - `hideWarning` boolean, required — Whether the warning about the signaling server should be hidden
      - `server` string, required — URL of the signaling server
      - `signalingMode` string, required — Signaling mode (see [constants list](https://nextcloud-talk.readthedocs.io/en/latest/constants#signaling-modes))
      - `sipDialinInfo` string, required — SIP dial-in information
      - `stunservers` object[], required — STUN servers
        - `urls` string[], required
      - `ticket` string — Authentication ticket for the signaling server
      - `turnservers` object[], required — TURN servers
        - `urls` string[], required
        - `username` string, required
        - `credential` string, required
      - `userId` string, nullable, required — User id of the current user

## Other responses

- `401` — Recording request invalid
- `404` — Room not found

## Changes

- **2026-05-27** `4dee43a527f2` — 2 info
  - added the new optional `header` request parameter `talk-sipbridge-checksum`
  - added the new optional `header` request parameter `talk-sipbridge-random`
- **2026-04-01** `ced006242a99` — 2 breaking
  - the response property `ocs/data/helloAuthParams` became optional for the status `200`
  - the response property `ocs/data/ticket` became optional for the status `200`
- **2026-03-10** `5675bffad91f` — 1 breaking
  - the `ocs/data/turnservers/items/credential` response's property type/format changed from `object`/`` to `string`/`` for status `200`

[Change history](https://skmtc.dev/nextcloud/apis/spreed-full/changes/ocs/v2.php/apps/spreed/api/:apiVersion/signaling/settings/get.md)

---

[API](https://skmtc.dev/nextcloud/apis/spreed-full.md) · [All operations](https://skmtc.dev/nextcloud/apis/spreed-full/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nextcloud/spreed-full/revisions/41d6458d6d6e/schema)