# RainbowEnduserPortal.RoomsOpenInviteApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**sendJoinRoomInvitationUsingOpenInviteiId**](RoomsOpenInviteApi.md#sendJoinRoomInvitationUsingOpenInviteiId) | **POST** /api/rainbow/enduser/v1.0/rooms/open-invites | Join a room using an openInviteId



## sendJoinRoomInvitationUsingOpenInviteiId

> SendJoinRoomInvitationUsingOpenInviteiIdSuccess sendJoinRoomInvitationUsingOpenInviteiId(body)

Join a room using an openInviteId

From 1.83.0 release, a Rainbow user may have a public links that will help their coworkers to join rooms. So that he just has to create a room and create a public link so called **'public URL'**. Each user can create on demand a public URL to one of his rooms([users public link][0]). The public URL format is designed by the Rainbow application programmer and must contain at least an 'openInviteId'. This openInviteId is an UUID-V4 value.   * https://meet.openrainbow.com/d4bb04c2a2254cd3bebb28e449ce7de3  The goal of this api is to embed on the fly a user in the room bind with the given openInviteId (body parameter). Many error cases may occur:   * The openInviteId is not valid HTTP error 404 Not Found (detail: 40400) * If no room is currently binded or when the room to join is no more active (deleted or archived), an HTTP error 404 Not Found (detail: 404116) is returned. * If the room is locked (autoRegister = 'lock'), a user not yet registered inside this room is rejected. An HTTP error 403 (detail: 403621 - Forecast a maximum quota reached..) is returned * If the maximum of users for a room is reached, an HTTP error 403 (detail: 403621 - Forecast a maximum quota reached..) is returned     A message stanza is sent to added user. This allow clients to be notified and join the room:        ```html <message           from='inviter user's jid'           to='invited user's jid '>            <x xmlns='jabber:x:conference'                 jid: 'room jid'                 reason: 'reason given in body parameter' />    </message> ```    A message stanza is sent to moderators as a private room message. This allow clients to display notifications:        ```html <message           from='room jid'           to='room jid/user's nic'>            <x body  user's invited display name has been invited to join the bubble </body&gt            <x event xmlns='jabber:iq:configuration'                 name: 'invitation'                 jid: 'invited user's jid' />    </message> ```  [0]: #api-users_rooms_public_link

### Example

```javascript
var RainbowEnduserPortal = require('rainbow_enduser_portal');
var defaultClient = RainbowEnduserPortal.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new RainbowEnduserPortal.RoomsOpenInviteApi();
var body = new RainbowEnduserPortal.SendJoinRoomInvitationUsingOpenInviteiId(); // SendJoinRoomInvitationUsingOpenInviteiId | 
apiInstance.sendJoinRoomInvitationUsingOpenInviteiId(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SendJoinRoomInvitationUsingOpenInviteiId**](SendJoinRoomInvitationUsingOpenInviteiId.md)|  | 

### Return type

[**SendJoinRoomInvitationUsingOpenInviteiIdSuccess**](SendJoinRoomInvitationUsingOpenInviteiIdSuccess.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json