Interface Hello

The payload sent by the server when you initiate a new gateway connection.

Example

{
  "op": "HELLO",
  "d": {
    "heartbeat_interval": 45000,
    "instance_info": {
      "instance_name": "EmreLand",
      "description": "More based than Oliver's instance (trust)",
      "version": "0.3.3",
      "message_limit": 2048,
      "oprish_url": "https://example.com",
      "pandemonium_url": "https://example.com",
      "effis_url": "https://example.com",
      "file_size": 20000000,
      "attachment_file_size": 100000000
    },
    "rate_limit": {
      "reset_after": 10,
      "limit": 5
    }
  }
}

Hierarchy

  • Hello

Properties

heartbeat_interval instance_info op rate_limit

Properties

heartbeat_interval

heartbeat_interval: number

The amount of milliseconds your ping interval is supposed to be.

instance_info

instance_info: InstanceInfo

The instance's info.

This is the same payload you get from the get_instance_info payload without ratelimits

op

op: "HELLO"

rate_limit

rate_limit: RateLimitConf

The pandemonium ratelimit info.

On This Page