Sign in
room

Get a room

get/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}

Path parameters

apiVersion'v4' required
tokenstring required

Token of the room

Headers

x-nextcloud-federationstring

Set to 1 when the request is performed by another Nextcloud Server to indicate a federation request

talk-sipbridge-randomstring

Random seed (at least 32 bytes) used together with the room token to generate the SHA256-HMAC request checksum

talk-sipbridge-checksumstring

SHA256-HMAC checksum over the concatenation of the random seed and the room token, signed with the shared SIP bridge secret, to verify authenticity from the SIP bridge

OCS-APIRequestboolean required

Required to be true for the API request to pass

Response

Room returned

Changes

Changed in 20 of the 54 revisions of this API.2926

  • cd070ba68c821See the full diff
    • ○

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

      response-required-property-added

  • 443f5db672864See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • eeb6ee29c4951See the full diff
    • ○

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

      response-required-property-added

  • b1a8bbc5dd9d2See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • bd777c5db0a71See the full diff
    • ▲

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

      response-property-type-changed

  • e21cdb8341871See the full diff
    • ○

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

      response-required-property-added

  • 25d1acbcaf691See the full diff
    • ○

      added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/pinnedAt to the response with the 200 status

      response-optional-property-added

  • c24d1d3bcbba3See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

  • ff7cef0e09732See the full diff
    • ○

      added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/threadReplies to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • deea17b161581See the full diff
    • ○

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

      response-required-property-added