Wire messages
<!-- Generated by docs-site/scripts/generate-reference-pages.mjs. Do not edit. -->
Generated page
Built from server/src/relay_wire_protocol.rs on every docs build, so it always matches the code.
Relay to phone
Server -> device. client_id names the asking agent; the app maps it to a display name.
Every message is a JSON object whose type field names the message.
locate
expires_ms: epoch ms when the relay stops waiting.
| Field | Type | Required | Notes |
|---|---|---|---|
client_id | string | yes | |
expires_ms | integer (uint64) | yes | |
id | string (uuid) | yes | |
requester | any | no | Null for the owner's own agent. |
cancel
Another device answered id: close the prompt.
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | yes |
Phone to relay
Device -> server.
Every message is a JSON object whose type field names the message.
hello
| Field | Type | Required | Notes |
|---|---|---|---|
app_version | string | no | |
device_id | string (uuid) | no | |
device_name | string | no | |
platform | string | no |
location
Fix sent by the phone in answer to a locate ping.
| Field | Type | Required | Notes |
|---|---|---|---|
accuracy_m | number (double) | no | |
captured_at_ms | integer (uint64) | yes | |
id | string (uuid) | yes | |
latitude | number (double) | yes | |
longitude | number (double) | yes |
denied
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | yes | |
reason | no_answer, user | no | Why the user did not share. Unknown reasons count as User. |
unavailable
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | yes | |
reason | permission, no_fix, error | yes | Why the phone could not look. Unknown reasons count as Error. |
log
App diagnostics (no location data); the relay only logs them.
| Field | Type | Required | Notes |
|---|---|---|---|
msg | string | yes |