ExilProductions/VRChatBackendDocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
VRChatBackendDocs/Apis/InviteApi.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

335 lines
14 KiB
Markdown
Raw Permalink Blame History

# InviteApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getInviteMessage**](InviteApi.md#getInviteMessage) | **GET** /message/{userId}/{messageType}/{slot} | Get Invite Message |
| [**getInviteMessages**](InviteApi.md#getInviteMessages) | **GET** /message/{userId}/{messageType} | List Invite Messages |
| [**inviteMyselfTo**](InviteApi.md#inviteMyselfTo) | **POST** /invite/myself/to/{worldId}:{instanceId} | Invite Myself To Instance |
| [**inviteUser**](InviteApi.md#inviteUser) | **POST** /invite/{userId} | Invite User |
| [**inviteUserWithPhoto**](InviteApi.md#inviteUserWithPhoto) | **POST** /invite/{userId}/photo | Invite User with photo |
| [**requestInvite**](InviteApi.md#requestInvite) | **POST** /requestInvite/{userId} | Request Invite |
| [**requestInviteWithPhoto**](InviteApi.md#requestInviteWithPhoto) | **POST** /requestInvite/{userId}/photo | Request Invite with photo |
| [**resetInviteMessage**](InviteApi.md#resetInviteMessage) | **DELETE** /message/{userId}/{messageType}/{slot} | Reset Invite Message |
| [**respondInvite**](InviteApi.md#respondInvite) | **POST** /invite/{notificationId}/response | Respond Invite |
| [**respondInviteWithPhoto**](InviteApi.md#respondInviteWithPhoto) | **POST** /invite/{notificationId}/response/photo | Respond Invite with photo |
| [**updateInviteMessage**](InviteApi.md#updateInviteMessage) | **PUT** /message/{userId}/{messageType}/{slot} | Update Invite Message |
<a name="getInviteMessage"></a>
# **getInviteMessage**
> InviteMessage getInviteMessage(userId, messageType, slot)
Get Invite Message
Returns a single Invite Message. This returns the exact same information but less than &#x60;getInviteMessages&#x60;. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
| **slot** | **Integer**| The message slot to fetch of a given message type. | [default to null] |
### Return type
[**InviteMessage**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInviteMessages"></a>
# **getInviteMessages**
> List getInviteMessages(userId, messageType)
List Invite Messages
Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
### Return type
[**List**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="inviteMyselfTo"></a>
# **inviteMyselfTo**
> SentNotification inviteMyselfTo(worldId, instanceId)
Invite Myself To Instance
Sends self an invite to an instance
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
| **instanceId** | **String**| Must be a valid instance ID. | [default to null] |
### Return type
[**SentNotification**](../Models/SentNotification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="inviteUser"></a>
# **inviteUser**
> SentNotification inviteUser(userId, InviteRequest)
Invite User
Sends an invite to a user. Returns the Notification of type &#x60;invite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **InviteRequest** | [**InviteRequest**](../Models/InviteRequest.md)| Slot number of the Invite Message to use when inviting a user. | |
### Return type
[**SentNotification**](../Models/SentNotification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="inviteUserWithPhoto"></a>
# **inviteUserWithPhoto**
> SentNotification inviteUserWithPhoto(userId, data, image)
Invite User with photo
Sends an photo invite to a user. Returns the Notification of type &#x60;invite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **data** | [**InviteRequest**](../Models/InviteRequest.md)| | [default to null] |
| **image** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**SentNotification**](../Models/SentNotification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="requestInvite"></a>
# **requestInvite**
> Notification requestInvite(userId, RequestInviteRequest)
Request Invite
Requests an invite from a user. Returns the Notification of type &#x60;requestInvite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **RequestInviteRequest** | [**RequestInviteRequest**](../Models/RequestInviteRequest.md)| Slot number of the Request Message to use when request an invite. | [optional] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="requestInviteWithPhoto"></a>
# **requestInviteWithPhoto**
> Notification requestInviteWithPhoto(userId, data, image)
Request Invite with photo
Requests with photo an invite from a user. Returns the Notification of type &#x60;requestInvite&#x60; that was sent.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **data** | [**RequestInviteRequest**](../Models/RequestInviteRequest.md)| | [default to null] |
| **image** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="resetInviteMessage"></a>
# **resetInviteMessage**
> List resetInviteMessage(userId, messageType, slot)
Reset Invite Message
Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \&quot;Too Fast Error\&quot;. Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
| **slot** | **Integer**| The message slot to fetch of a given message type. | [default to null] |
### Return type
[**List**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="respondInvite"></a>
# **respondInvite**
> Notification respondInvite(notificationId, InviteResponse)
Respond Invite
Respond to an invite or invite request without accepting it. &#x60;:notificationId&#x60; is the ID of the requesting notification. In case the notification being replied to is an invite, the &#x60;responseSlot&#x60; refers to a response message from the the &#x60;message&#x60; collection. In case the notification is an invite request, it will refer to one from the &#x60;requestResponse&#x60; collection instead.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
| **InviteResponse** | [**InviteResponse**](../Models/InviteResponse.md)| Slot number of the Response Message to use when responding to a user. | |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="respondInviteWithPhoto"></a>
# **respondInviteWithPhoto**
> Notification respondInviteWithPhoto(notificationId, data, image)
Respond Invite with photo
Respond with photo to an invite or invite request without accepting it. &#x60;:notificationId&#x60; is the ID of the requesting notification. In case the notification being replied to is an invite, the &#x60;responseSlot&#x60; refers to a response message from the the &#x60;message&#x60; collection. In case the notification is an invite request, it will refer to one from the &#x60;requestResponse&#x60; collection instead.&#39;
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
| **data** | [**InviteResponse**](../Models/InviteResponse.md)| | [default to null] |
| **image** | **File**| The binary blob of the png file. | [default to null] |
### Return type
[**Notification**](../Models/Notification.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
<a name="updateInviteMessage"></a>
# **updateInviteMessage**
> List updateInviteMessage(userId, messageType, slot, UpdateInviteMessageRequest)
Update Invite Message
Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 \&quot;Too Fast Error\&quot;. Message type refers to a different collection of messages, used during different types of responses. * &#x60;message&#x60; &#x3D; Message during a normal invite * &#x60;response&#x60; &#x3D; Message when replying to a message * &#x60;request&#x60; &#x3D; Message when requesting an invite * &#x60;requestResponse&#x60; &#x3D; Message when replying to a request for invite
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **messageType** | **String**| The type of message to fetch, must be a valid InviteMessageType. | [default to message] [enum: message, request, requestResponse, response] |
| **slot** | **Integer**| The message slot to fetch of a given message type. | [default to null] |
| **UpdateInviteMessageRequest** | [**UpdateInviteMessageRequest**](../Models/UpdateInviteMessageRequest.md)| Message of what to set the invite message to. | [optional] |
### Return type
[**List**](../Models/InviteMessage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
Reference in New Issue View Git Blame Copy Permalink