Documentation

Get a call flowing in ten minutes

Gbox is the ingest leg, not a phone system: it captures a conversation and delivers the audio to your application. These are the things you configure.

1. Provision the device

The device stores its configuration on-device: host, port, TLS on/off, serial and token. The serial must match a device row in your account — that is how a unit announces itself as GBX-10001 instead of the placeholder.

# first boot: the device comes up as a setup access point;
# set Wi-Fi credentials and the API host, then it joins your network
host   = vb.example.com
port   = 443
tls    = 1
serial = GBX-10001
token  = vb_xxxxxxxxxxxxxxxx

2. Claim it

Open the console, sign in with your API key and claim the serial. The dashboard then shows its live state, telemetry and calls.

3. Choose how your app receives it

The audio leaves the device as frames. A destination is where they go — your own endpoint, a WebSocket, a SIP trunk or a file — and it is a type plus a URI. Recording is the only type that stores anything by default.

SIPsip:1000@pbx.example:5060 — UDP, TCP or TLS, with optional register=1 and srtp=1
RTP socketudp://host:9999?mode=rtp&codec=pcmu
WebSocketwss://host/audio — masked binary frames, the same [kind][payload] layout as the device link
HTTP streamhttps://host/audio?mode=chunked, optionally HMAC-signed
Recordingfile:///var/lib/gbox/call.wav

4. What is on the wire

Audio frames are a one-byte kind followed by the payload. The kind travels in every frame, so a codec change needs no negotiation.

kind 0x01  PCM16, 16 kHz          (640 B per 20 ms)
kind 0x03  PCM16,  8 kHz          (320 B per 20 ms — narrowband default)
kind 0x04  G.711 mu-law, 8 kHz    (160 B per 20 ms — half the bytes)

Control traffic is JSON on the same WebSocket: hello, telemetry, event and ping, each acknowledged by the server.

5. API

The console is a thin client over the deployed API. These are the routes that exist:

POST /v1/ui/login      { "email": "…", "password": "…" }  -> session + token
GET  /v1/ui/devices    the account's devices
GET  /v1/ui/calls      recent calls

Sign-up and password reset are not in the API yet — POST /v1/ui/signup and /v1/ui/forgot return 404 — so the site makes them requests to us rather than inventing accounts in your browser.