API docs

zpe-receptionist

mount /receptionist · base https://zpe.vc/receptionist · v4.0.1 · 2 operations · 0 write · 0 need no account · beta

the document this app serves now. Contract: https://zpe.vc/receptionist/_/api/v1/openapi.json · sha256 965e8021337a

GET /_/api/v1/inbox This account's conversations, newest first. getInbox

This account's conversations, newest first.

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200This account's conversations, newest first, each with its message count.object
401The key is missing, malformed, unknown, revoked, expired, or names another account.object
403That key is not granted this app, or the door named no account to scope the request to.object
429This key has spent its request ceiling for the current minute; retry after the break.object
500This app failed while answeringobject
503The key could not be checked, or this deployment could not read its store, so nothing was answered.object

Example

This account's conversations, newest first., with a token from the door.

GET /_/api/v1/inbox
curl -X GET 'https://zpe.vc/receptionist/_/api/v1/inbox' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

GET /_/api/v1/inbox/{id} One conversation and its messages. getInboxById

One conversation and its messages.

Parameters

nameinrequiredtypenotes
idpathyesstringThe conversation's id, as `/api/inbox` answered it.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200One conversation and its messages, oldest first, up to the handler's cap.object
401The key is missing, malformed, unknown, revoked, expired, or names another account.object
403That key is not granted this app, or the door named no account to scope the request to.object
404That conversation is not in this account.object
429This key has spent its request ceiling for the current minute; retry after the break.object
500This app failed while answeringobject
503The key could not be checked, or this deployment could not read its store, so nothing was answered.object

Example

One conversation and its messages., with a token from the door.

GET /_/api/v1/inbox/{id}
curl -X GET 'https://zpe.vc/receptionist/_/api/v1/inbox/string' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.