breakout_room

Broadcast a chat message to all breakout rooms

post/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}/broadcast

Path parameters

apiVersion'v1' required
tokenstring required

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Request body

messagestring required

Message to broadcast

Response

Chat message broadcasted successfully

Changes

Changed in 8 of the 62 revisions of this API.210

    • added the required property ocs/data/items/tagIds to the response with the 201 status

      response-required-property-added

    • removed the required property ocs/data/items/tagIds from the response with the 201 status

      response-required-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property ocs/data/items/tagIds to the response with the 201 status

      response-required-property-added

    • added the optional property ocs/data/items/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToActorDisplayName to the response with the 201 status

      response-optional-property-added

    • added the optional property ocs/data/items/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToConversationName to the response with the 201 status

      response-optional-property-added

    • added the optional property ocs/data/items/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToConversationToken to the response with the 201 status

      response-optional-property-added

    • added the optional property ocs/data/items/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToMessageId to the response with the 201 status

      response-optional-property-added

    • added the required property ocs/data/items/attributes to the response with the 201 status

      response-required-property-added

    • added the optional property ocs/data/items/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/threadId to the response with the 201 status

      response-optional-property-added

    • added the optional property ocs/data/items/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/threadTitle to the response with the 201 status

      response-optional-property-added

    • the ocs/data/items/hasScheduledMessages response's property type/format changed from boolean/ to integer/int64 for status 201

      response-property-type-changed

    • added the required property ocs/data/items/hasScheduledMessages to the response with the 201 status

      response-required-property-added