Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Session Open Group Server

Schemessession://, sessions://, sogs://
Cargo featureservice-sogs
Servicehttps://getsession.org/
Body formatstext (first is the default)
Attachmentsno
Title lengthno title (merged into the body)
Body length2,000 characters
Body linesunlimited
Request throttlenone
Vendor URLs acceptedno

URL formats

{schema}://{user}:{password}@{host}/{targets}
{schema}://{user}:{password}@{host}:{port}/{targets}

{schema} is one of session://, sessions://, sogs://.

URL tokens

TokenMeaningTypeRequiredDefaultNotes
{host}Hostnamestringyes
{password}Seedstringyessecret
{port}Portint, 1 to 65535no
{targets}Roomslistnoseparated by /
{user}Public Keystringyes

Query parameters

ParameterMeaningTypeDefaultNotes
keyPublic Keystringsets {user}
public_keyPublic Keystringsets {user}
seedSeedstringsets {password}
toRoomslistsets {targets}

The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.

Examples

Rejected URLs:

sessions://host/test-room
sessions://bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb@host/test-room
sessions://ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa@host/test-room
sessions://bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa@host

Notes

Session Open Group Server (session://, sessions://, sogs://): messages to Session open group rooms.

Every request is authenticated with the X-SOGS-* headers: an Ed25519 signature (by the bot’s seed) over the server key, a random nonce, the timestamp, method, path and the BLAKE2b-512 hash of the body.