v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get Invite Message

Returns a single Invite Message. This returns the exact same information but less than getInviteMessages. 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.

  • message = Message during a normal invite
  • response = Message when replying to a message
  • request = Message when requesting an invite
  • requestResponse = Message when replying to a request for invite

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/message/{userId}/{messageType}/{slot}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

userIdstring

Must be a valid user ID.

messageTypeInviteMessageType

The type of message to fetch, must be a valid InviteMessageType.

Default"message"
Value in"message" | "response" | "request" | "requestResponse"
slotinteger

The message slot to fetch of a given message type.

Range0 <= value <= 11

Response Body

curl -X GET "https://api.vrchat.cloud/api/1/message/string/message/11"
fetch("https://api.vrchat.cloud/api/1/message/string/message/11")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.vrchat.cloud/api/1/message/string/message/11"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.vrchat.cloud/api/1/message/string/message/11"

response = requests.request("GET", url)

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://api.vrchat.cloud/api/1/message/string/message/11"))
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
var response = await client.GetAsync("https://api.vrchat.cloud/api/1/message/string/message/11");
var responseBody = await response.Content.ReadAsStringAsync();
{
  "canBeUpdated": true,
  "id": "invm_24a1c14d-5e24-48e5-90e3-c3f712420ffa",
  "message": "string",
  "messageType": "message",
  "remainingCooldownMinutes": 0,
  "slot": 11,
  "updatedAt": "2019-08-24T14:15:22Z"
}

{}

{
  "error": {
    "message": "You are not authorized to perform that action.",
    "status_code": 401
  }
}

{
  "error": {
    "status_code": 404
  }
}