Endpoints

To use the Omikrons functions a Secure Websocket connection must be established. Where to connect is provided by the Omega Server. All entries are split into Iota & Client. As the Omikron connects the Iota and Client by passing messages from one to the other all Communication from Iota to Client has to contain a receiver_id The Omikron will add a sender_id to Messages from Client to the Iota.

The receiver_id and sender_id of the Omikron server are 22222222-2222-2222-2222-222222222222.

Identification

Any message to the Omikron will be ignored until Identification.

Iota

REQ:

{
  "type": "identification",
  "data": {
    "iota_id": "<iota-id>",
  }
}

REQ & RES:

{
  "type": "challenge",
  "data": {
    "public_key": "<omikrons public key>",
    "challenge": "<random encrypted b64 string>"
  }
}

REQ & RES:

{
  "type": "challenge_response",
  "data": {
    "challenge": "<decrypted b64 string>",
  }
}

RES:

{
  "type": "identification_response",
  "data": {
      "accepted": boolean,
  }
}

---

Client

This is a two step process.

Get a challenge:

REQ:

{
  "id": "<uuid>",
  "type": "identification",
  "data": {
    "user_id": "<user-id>"
  }
}

RES:

{
  "id": "<uuid>",
  "type": "challenge",
  "data": {
    "challenge": "<base64 string>",
    "public_key": "<base64 string>"
  }
}

Send back the solved challenge:

REQ:

{
  "id": "<uuid>",
  "type": "challenge_response",
  "data": {
    "challenge": "<decrypted challenge>"
  }
}

RES:

{
  "id": "<uuid>",
  "type": "identification_response",
  "data": {}
}

Ping & Pong

A ping request comes from the Client or Iota and the Omikron returns a pong answer. The ping request should contain the last Client or Iota ping and the pong answer will contain the last ping of the Omikron.****

Iota

REQ:

{
  "id": "<uuid>",
  "type": "ping",
  "data": {
    "last_ping": long
  }
}

RES:

{
  "id": "<uuid>",
  "type": "pong",
  "data": {
    "user_ping": {
      "<user-id>": long,
      "<user-id>": long
    }
  }
}

Client

REQ:

{
  "id": "<uuid>",
  "type": "ping",
  "data": {
    "last_ping": long
  }
}

RES:

{
  "id": "<uuid>",
  "type": "pong",
  "data": {
    "last_ping": long
  }
}

User Online Status

Set Client Status

The client can change their online status by sending a client_changed message.
Supported status values: user_online, user_offline, user_dnd, user_idle, user_wc, user_invisible.

When user_invisible is set, the user remains connected and can send/receive messages, but appears as user_offline to all other users.

REQ (Client → Omikron):

{
  "id": "<uuid>",
  "type": "client_changed",
  "data": {
    "user_state": "<status>"
  }
}

Online Status Notifications

When a connected user changes their status, interested clients receive a notification:

EVENT (Omikron → Client):

{
  "type": "client_changed",
  "data": {
    "user_id": "<user-id>",
    "user_state": "<status>"
  }
}

Online Status in User Data

When fetching another user’s profile via get_user_data, their online status is included in the response. Invisible users are reported as user_offline.

RES (Omikron → Client, field in get_user_data):

{
  "id": "<uuid>",
  "type": "get_user_data",
  "data": {
    "user_id": long,
    "username": "<string>",
    "display": "<string>",
    "public_key": "<base64>",
    "iota_id": long,
    "online_status": "<status>",
    "omikron_id": long,
    "omikron_connections": [long, ...],
    "sub_level": long,
    "sub_end": long,
    "about": "<string>?",
    "avatar": "<base64>?",
    "status": "<string>?"
  }
}