settings

Get the welcome message from a signaling server

Only available for logged-in users because guests can not use the apps right now. This endpoint requires admin access

get/ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/welcome/{serverId}

Path parameters

apiVersion'v3' required
serverIdinteger required

ID of the signaling server

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Response

Welcome message returned

Changes

Changed in 4 of the 45 revisions of this API.16

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the optional property ocs/data/features to the response with the 200 status

      response-optional-property-added

    • added the optional property ocs/data/warning to the response with the 200 status

      response-optional-property-added

    • added the required property ocs/data/version to the response with the 200 status

      response-required-property-added

    • the response property ocs/data became nullable for the status 404

      response-property-became-nullable

    • api operation id settings-get-welcome-message removed and replaced with signaling-get-welcome-message

      api-operation-id-removed