Early Access: Die Schnittstellen sind als Entwurf dokumentiert. Befehle, Pakete und Endpunkte vor der Nutzung mit uns abstimmen.

CLI

Installation, Anmeldung und alle Befehle der Kommandozeile.

Installation

npm install -g @trunkbeam/cli

Alternativ ohne Installation mit npx @trunkbeam/cli. Voraussetzung ist Node.js 20 oder neuer.

Anmelden

trunkbeam login

login öffnet den Browser zur Bestätigung. Auf Servern ohne Browser setzt du stattdessen die Umgebungsvariable:

export TRUNKBEAM_API_KEY=tb_live_…

Mehrere Konten trennst du mit Profilen, zum Beispiel trunkbeam login --profile kunde-a und danach --profile kunde-a bei jedem Befehl.

Globale Optionen

OptionWirkung
--jsonAusgabe als JSON, für Skripte
--yesRückfragen überspringen, etwa beim Kauf
--profile <name>Anderes Konto verwenden
--helpHilfe zu jedem Befehl

Befehle

BefehlWas er macht
signupKonto anlegen
login, logoutCLI anmelden oder abmelden
statusPrüfstatus deines Kontos
verify --docs <datei>Unterlagen einreichen
addresses list, addresses addAdressen für weitere Ortsnetze
numbers search --area <vorwahl>Freie Nummern suchen
numbers buy <nummer> --sip <uri>Nummer kaufen und verbinden
numbers listDeine Nummern mit Status
numbers update <nummer> --sip <uri>Ziel ändern
numbers release <nummer>Nummer zum Monatsende kündigen
transfer allow <nummer> --to <ziele>Erlaubte Ziele für SIP REFER
trunks create --name <name>Zugangsdaten für ausgehende Anrufe
calls listLetzte Anrufe mit Dauer und Kosten
pricesAktuelle Preisliste
usage --month <JJJJ-MM>Verbrauch und Kosten eines Monats
keys create, keys list, keys revokeAPI-Schlüssel verwalten

In Skripten

Mit --json und --yes läuft alles ohne Rückfrage. Beispiel: für jeden neuen Kunden eine Nummer im passenden Ortsnetz holen.

nummer=$(trunkbeam numbers search --area 089 --json | jq -r '.[0].number')
trunkbeam numbers buy "$nummer" --sip "sip:kunde-42@voice.example" --yes --json

Rückgabewerte

CodeBedeutung
0Erfolgreich
1Allgemeiner Fehler
2Falsche Eingabe
3Nicht angemeldet oder Schlüssel ungültig
4Konto noch nicht freigegeben
5Ausgabelimit erreicht
Deinen Stack mit TrunkBeam verbinden