DELETE /spaces/{spaceId}

Delete a specified space and all its contents.

URL Parameters

Body Parameters

None.

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator, ServiceAppAuthenticator

Authorization

isInviteCreatorByParams

Example Request

URL

For Production: DELETE https://spacesapis.avayacloud.com/api/spaces/{spaceId}

For Staging: DELETE https://loganstagingapis.esna.com/api/spaces/{spaceId}

Headers

Authorization: "jwt eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Or

Authorization: "service_app eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Example Response

{
   "settings":{
      "mpaasSettings":{
         "eventConference":{
            "enable":false
         },
         "mixerMode":"OPTIMIZED_PROCESSED",
         "maxResolution":"720P"
      },
      "mdSrv":"mpaas",
      "mdOpts":[

      ],
      "confId":"125718368",
      "confPin":"",
      "encryptedPassword":"",
      "allowPasswordInURL":false,
      "passwordRequired":{
         "allGuests":true
      },
      "memberOnly":false,
      "autoStart":false,
      "hideAutoStartPrompt":false
   },
   "type":"group",
   "status":2,
   "restrict":[
      "deny_guest_access_history_msg"
   ],
   "_id":"5f11852cbb6b301b9f757469",
   "cid":"5eeb4e49aa4a347af9c7bd13",
   "members":[
      {
         "phone_numbers":[

         ],
         "member":"5eeb4e49aa4a347af9c7bd13",
         "memberType":"userId",
         "role":"admin",
         "joinTime":"2020-07-17T11:02:04.392Z",
         "username": "user@avaya.com",
         "displayname": "Username",
         "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_85c55d13-6f87-42f4-a576-c1a5a87dc150"
      }
   ],
   "title":"testing",
   "created":"2020-07-17T11:02:04.396Z",
   "parents":[

   ],
   "companies":[

   ],
   "modified":"2020-07-17T11:16:04.472Z",
   "msgRetention":{
      "notInheritParentPolicy":false,
      "retentionType":"delete_after_days",
      "retentionLength":730,
      "policy":{
         "from":"system",
         "retentionType":"delete_after_days",
         "retentionLength":730,
         "limitCustomLength":false
      }
   }
}

Socket Event

The Spaces-Server would send the following Socket event to all members of the deleted space.

var message = {
    sender: {
        _id: '{senderId}',
        type: 'user',
        displayname: 'Sender display name'
    },
    category: 'topic.deleted',
    topicId: '{spaceId}'
};