Skip to main content
POST
Take a batch of a shared session's entries

Autorizações

Authorization
string
header
obrigatório

Enforced on every transport, with no exempt operation. A person's request — over the default local unix socket exactly as over a TCP listener — must carry a JWT issued by the configured identity provider, which the host verifies itself against that issuer's key set: signature, issuer, expiry, and the person and organisation it names. Requests without a valid one receive 401 NRY-0011. The socket's file permissions are transport and are not an authorisation.

Parâmetros de caminho

shareId
string
obrigatório

The share's id, as SessionShare.shareId reports it: 26 characters of RFC 4648 base32 drawn from a cryptographic source, carrying no encoding of anything. It is NOT a uuid and is deliberately unrelated to the session id it was published from — a share id travels, so an id derived from a session would make every leaked link a statement about the machine it came from.

Required string length: 26
Pattern: ^[A-Z2-7]{26}$

Corpo

application/json

One batch of a shared session crossing to the organisation's home. It carries the share's own facts alongside the entries because the first delivery is what announces the share at the receiving end — there is no earlier registration and no second operation for one. What it does NOT carry is who owns the share or which organisation it belongs to: the owner is the verified actor whose token carried the request, and the organisation is the home that took it.

sessionId
string<uuid>
obrigatório

The session these entries came from, at the home they came from. Provenance only — no session with this id exists at the receiving end, and none is created.

mode
enum<string>
obrigatório

Where the publish stops, so the receiving home's record is honest about whether more is coming.

Opções disponíveis:
once,
sync
entries
object[]
obrigatório

The entries of this batch, in the order the conversation happened in. One batch carries everything a drain found owed rather than one entry per request: a chatty session must not become a request per token.

expiresAt
string<date-time>

When this share stops, carried so the receiving home stops it by its OWN clock. The sweep that deletes these entries runs there, so a copy that arrived without this would be a conversation whose expiry depended on the publishing machine being switched on. Absent means a share with no expiry, which nothing this product publishes produces.

recipients
string[]

Who this share is for, as the publishing home holds it: the subjects of the colleagues it names, or ABSENT for the whole organisation — one spelling of "everybody here", matching the publishing home's own record. IT HAS TO TRAVEL, because the READ road is at this end. A copy that arrived without the list would be readable by every member of the organisation however narrowly the person who shared it chose, which is the one direction a targeted share must not be wrong in. It is read on the FIRST delivery, which is what announces the share here; a later batch does not re-open who a share this home already holds is for.

Resposta

Every entry in the batch is now held for this share — including any this home already had, which is what makes a retry safe.