跳到主要内容

ONLYOFFICE DocSpace Rooms API

The browsable version of this reference, with a request builder and code samples, is published at https://api.onlyoffice.com/docspace/api-backend/usage-api/.

All URIs are relative to https://yourportal.onlyoffice.com, where the host is the address of your DocSpace instance.

Rooms​

MethodHTTP requestDescription
addRoomTagsPUT /api/2.0/files/rooms/{id}/tagsAttach tags to a room
archiveRoomPUT /api/2.0/files/rooms/{id}/archiveArchive a room
changeRoomCoverPOST /api/2.0/files/rooms/{id}/coverChange the room cover
createRoomPOST /api/2.0/files/roomsCreate a room
createRoomFromTemplatePOST /api/2.0/files/rooms/fromtemplateCreate a room from the template
createRoomLogoPOST /api/2.0/files/rooms/{id}/logoSet the room logo
createRoomTagPOST /api/2.0/files/tagsCreate a room tag
createRoomTemplatePOST /api/2.0/files/roomtemplateCreate a room template
createRoomThirdPartyPOST /api/2.0/files/rooms/thirdparty/{id}Create a third-party room
deleteCustomTagsDELETE /api/2.0/files/tagsDelete the custom room tags
deleteRoomDELETE /api/2.0/files/rooms/{id}Remove a room
deleteRoomLogoDELETE /api/2.0/files/rooms/{id}/logoRemove a room logo
deleteRoomTagsDELETE /api/2.0/files/rooms/{id}/tagsDetach tags from a room
getExternalDbSyncStatusGET /api/2.0/files/rooms/{id}/externaldbsyncGet external DB sync status
getNewRoomItemsGET /api/2.0/files/rooms/{id}/newsGet new items in a room
getPublicSettingsGET /api/2.0/files/roomtemplate/{id}/publicGet room template public access
getRoomAiFolderGET /api/2.0/files/rooms/{id}/aiGet the .ai folder of a room
getRoomCoversGET /api/2.0/files/rooms/coversGet room cover gallery
getRoomCreatingStatusGET /api/2.0/files/rooms/fromtemplate/statusGet the room creation progress
getRoomIndexExportGET /api/2.0/files/rooms/indexexportGet the room index export
getRoomInfoGET /api/2.0/files/rooms/{id}Get room information
getRoomLinksGET /api/2.0/files/rooms/{id}/linksGet the room links
getRoomSecurityInfoGET /api/2.0/files/rooms/{id}/shareGet the room access rights
getRoomTagsInfoGET /api/2.0/files/tagsGet available room tags
getRoomTemplateCreatingStatusGET /api/2.0/files/roomtemplate/statusGet room template creation status
getRoomsFolderGET /api/2.0/files/roomsGet rooms
getRoomsNewItemsGET /api/2.0/files/rooms/newsGet new items in all rooms
getRoomsPrimaryExternalLinkGET /api/2.0/files/rooms/{id}/linkGet the room primary external link
hasTagLinksGET /api/2.0/files/tags/{tagName}/haslinksCheck room tag usage
pinRoomPUT /api/2.0/files/rooms/{id}/pinPin a room
reorderRoomPUT /api/2.0/files/rooms/{id}/reorderReorder room contents
resendEmailInvitationsPOST /api/2.0/files/rooms/{id}/resendResend the room invitations
searchRoomsPOST /api/2.0/files/rooms/searchSearch the rooms by metadata
setPublicSettingsPUT /api/2.0/files/roomtemplate/publicSet room template public access
setRoomLinkPUT /api/2.0/files/rooms/{id}/linksSet the room external or invitation link
setRoomSecurityPUT /api/2.0/files/rooms/{id}/shareSet the room access rights
startExternalDbSyncPOST /api/2.0/files/rooms/{id}/externaldbsyncStart external DB sync
startRoomIndexExportPOST /api/2.0/files/rooms/{id}/indexexportStart the room index export
terminateRoomIndexExportDELETE /api/2.0/files/rooms/indexexportTerminate the room index export
unarchiveRoomPUT /api/2.0/files/rooms/{id}/unarchiveUnarchive a room
unpinRoomPUT /api/2.0/files/rooms/{id}/unpinUnpin a room
updateRoomPUT /api/2.0/files/rooms/{id}Update a room
updateRoomTagPUT /api/2.0/files/tagsRename a room tag
uploadRoomLogoPOST /api/2.0/files/logosUpload a room logo image

Groups​

MethodHTTP requestDescription
addRoomGroupPOST /api/2.0/files/groupAdd a new room group
changeRoomGroupIconPOST /api/2.0/files/group/{id}/iconChange room group icon
deleteRoomGroupDELETE /api/2.0/files/group/{id}Delete a room group
getRoomGroupInfoGET /api/2.0/files/group/{id}Get room group info
getRoomGroupsGET /api/2.0/files/groupList room groups
updateRoomGroupPUT /api/2.0/files/group/{id}Update room group

Privacy room​

MethodHTTP requestDescription
deleteKeysDELETE /api/2.0/privacyroom/keys/{id}Delete an encryption key
getUserKeysGET /api/2.0/privacyroom/keysGet own encryption keys
getUserKeysForRoomGET /api/2.0/privacyroom/{roomId}/accessGet private room access keys
replaceKeyPUT /api/2.0/privacyroom/keysRotate an encryption key
setKeysPOST /api/2.0/privacyroom/keysCreate an encryption key

Authorization​

cookieAuth​

  • Type: API key
  • API key parameter name: asc_auth_key
  • Location:

bearerAuth​

  • Type: HTTP Bearer Token authentication

asc_auth_key​

  • Type: API key
  • API key parameter name: asc_auth_key
  • Location:

Basic​

  • Type: HTTP basic authentication

Bearer​

  • Type: HTTP Bearer Token authentication (JWT)

ApiKeyBearer​

  • Type: API key
  • API key parameter name: ApiKeyBearer
  • Location: HTTP header

OAuth2​

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes:
    • read: Read access to protected resources
    • write: Write access to protected resources

OpenId​

x-signature​

  • Type: API key
  • API key parameter name: x-signature
  • Location: