Manage Space

Only registered Avaya Spaces users can create a new space. To create a space make a POST request to /api/spaces/invite. To just create a space with no invitees, just leave the invitee array empty. Example:

 fetch("https://spacesapis.avayacloud.com/api/spaces/invite", {
  "headers": {
    "accept": "application/json",
    "accept-version": "1.2",
    "authorization": "bearer 9e15d37b97d414bc84f9804c32397f1236c2e8ff",
    "content-type": "application/json",
  },
  "referrer": "https://spaces.avayacloud.com/",
  "referrerPolicy": "strict-origin-when-cross-origin",
  "body": "{"topic":{"title":"Your space title","type":"group","id":null},"invitees":[]}",
  "method": "POST",
  "mode": "cors"
}); 

Note: Members can be added and removed at any time after the space is created.

Note: To obtain an access_token see here.

If we want Avaya Spaces to send invites to each member when we create the space make a request to /api/spaces/invite instead.

To get a list of the spaces the current user is a member of (including direct spaces), make a request to /api/users/me/spaces. For example:

GET https://spacesapis.avayacloud.com/api/users/me/spaces?topicstatus=0&topictype=group

This example will return a list of group spaces that are not archived. The spaces are ordered such that the most recently accessed spaces will be first. See the api reference for more information and options.

Once a user has been invited to join a space, they must join it. Joining the space notifies other members we have joined and retrieves information about the space so that the user can participate. This includes retrieving the media server to join audio/video communications. To join a space make a request to /api/spaces/{spaceId}/join. For example:

GET https://spacesapis.avayacloud.com/api/spaces/{spaceId}/join

To add users to an existing space we must invite them, even if they are not users of Avaya Spaces they will be able to join our space as a guest. To send invites make a POST request to /api/spaces/{spaceId}/invite. For example:

$.ajax({
    url: 'https://spacesapis.avayacloud.com/api/spaces/59381425e8466d05641bb80f/invite',
    type: 'POST',
    headers: {
        'Authorization': 'bearer ' + access_token
    },
    data: {
        "invitees": [
            {
                "inviteeType": "email",   // this is not registered user
                "invitee": "example.user@avaya.com",
                "role": "guest"  //optional: 'member' (default), 'admin', 'guest'
            },
            {
                "inviteeType": "userId",   // this is a registered user
                "invitee": "5890b1243bab0e18ff044943", // this is the user id
                "role": "member" //optional: 'member' (default), 'admin', 'guest'
            }
        ]
    },
    success: function(response) {
        console.log(response);
    }
});

When invites are sent, users will be notified by email with a link to directly join the space.

An admin of a space can change the settings of a space, for example the title. To do this make a POST request to /api/spaces/{spaceId}. The following example will update the title to Emergency Meeting.

$.ajax({
    url: 'https://spacesapis.avayacloud.com/api/spaces/{spaceId}',
    type: 'POST',
    headers: {
        'Authorization': 'bearer ' + access_token
    },
    data: {
        title: 'Emergency Meeting'
    },
    success: function(response) {
        console.log(response);
    }
});

Also, any member of a space can favorite a space and toggle notifications for a space. These are individual user settings for a space and can be updated by making a POST request to /api/users/me/topics/{spaceId}/preference. For example:

$.ajax({
    url: 'https://spacesapis.avayacloud.com/api/spaces/{spaceId}',
    type: 'POST',
    headers: {
        'Authorization': 'bearer ' + access_token
    },
    data: {
        isPinned: true,
        notification: true
    },
    success: function(response) {
        console.log(response);
    }
});

This example will favorite the space and enable notifications for it.

To remove a member from a space. Send a DELETE request to /api/spaces/{spaceId}/attendees/{attendeeType}/{userId}. For example:

$.ajax({
    url: 'https://spacesapis.avayacloud.com/api/spaces/59381425e8466d05641bb80f/attendees/userid/588d08e53bab0e18ff043f12',
    type: 'DELETE',
    headers: {
        'Authorization': 'bearer ' + access_token
    },
    success: function(response) {
        console.log(response);
    }
});

Note: Members cannot be removed from a direct space.

Note: There must be 1 admin in a space, so an admin cannot remove himself/herself if there is no other admin.

There are 3 role types in a space: admin, member and guest. To change the role of an attendee of a space, make a POST request to/api/spaces/{spaceId}/attendees/{attendeeType}/{userId}. This example will promote the user to admin.

$.ajax({
    url: 'https://spacesapis.avayacloud.com/api/spaces/59381425e8466d05641bb80f/attendees/userid/588d08e53bab0e18ff043f12',
    type: 'POST',
    headers: {
        'Authorization': 'bearer ' + access_token
    },
    data: {
        role: 'admin'
    },
    success: function(response) {
        console.log(response);
    }
});

Admins

have full control of a space.

Members

can create posts, tasks and see the full history of a space.

Guests

can view/send messages and participate in audio/video session.

Direct spaces are used to communicate between two parties only. The following API endpoint is used to get or create a direct space between the current user and another user: /api/spaces/direct/{userType}/{userId}. This example will return the spaceId and other details for a space between the current user and another spaces user:

GET https://spacesapis.avayacloud.com/api/spaces/direct/user/588d08e53bab0e18ff043f12

The following actions are not available on direct spaces:

• Invite members
• Remove members
• Change settings (favorite, notifications)

This API allows an admin to delete a space. To do this make a DELETE request to /api/spaces/{spaceId}.

Note: This space and all of its content will be deleted permanently!.

$.ajax({
    url: 'https://spacesapis.avayacloud.com/api/spaces/{spaceId}',
    type: 'DELETE',
    headers: {
        'Authorization': 'bearer ' + access_token
    },
    success: function(response) {
        console.log(response);
    }
});

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

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

This API allows a user to hide a direct space from direct-spaces list.
To hide a Space make a POST request to /api/users/me/spaces/{spaceId}/hide.

Note:

• All contents for the space identified by spaceId is preserved and visible to the other party.
• The other party will still see this user's Direct Space in his/her list of direct spaces.
• The other party can initiate chat with this user anytime.
• If a user re-enters the hidden Direct Space that space will become active and visible again.

$.ajax({
    url: 'https://spacesapis.avayacloud.com/api/users/spaces/{spaceId}/hide',
    type: 'POST',
    headers: {
        'Authorization': 'bearer ' + access_token
    },
    success: function(response) {
        console.log(response);
    }
});

The Spaces-Server would send the following Socket event to the user. So, other apps would hide this space from the user's Direct Spaces list.

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

Un-Hiding of direct spaces is done by accessing hidden direct-spaces via the following apis:

• Get/Create Direct Space with Another User
  by requesting GET /spaces/direct/{userType}/{userId}
• Join hidden space by spaceId
  by requesting GET /spaces/{spaceId}/join

User can re-enter the hidden Direct Space by:

• searching colleagues. (Read Finding People in Spaces guide)
• searching people with whom the user had a prior direct conversation with. (Read Finding People in Spaces guide)
• by opening direct-messages sent by the other parties

Upon re-entering a hidden direct-space, the Spaces-Server would send the following Socket event to the user. So, other apps would add this space to the user's Direct Spaces list.

var message = {      
  "category":"app.event.topic.new",
  "content":{     
    "_id":"fake_topicid1",
    "uid":"DT_user_fake_userid1&user_fake_userid2",
    "cid":"fake_userid2",
    //... more topic data
  },
  "sender":{  
    "_id":"fake_userid1",
    "type":"user",
    "displayname":"user1"
  }
}