ctl
Command-Line for Fonoster
Use this tool to manage your Fonoster resources from the command line. With this tool, you can create, update, and delete resources like Applications, Numbers, SIP Agents, and more.
On the new platform: applications:* manage streams (your WebSocket server: URL, protocol, speech defaults as catalog ids, listeners, recording, fallback) and Autopilot agents (--agent); webhooks:* manage workspace webhooks and their delivery log; records:* search call records and download recordings and vCons; providers:* list the provider catalog and manage the workspace's vendor keys. See Try the new platform.
When connecting to your own instance of Fonoster, remember to use your endpoint when login in. If your install uses its generated certificate, trust it with
--ca-file <path to its config/tls/ca.pem>(orFONOSTER_CA_FILE). The CLI always uses TLS.
Usage
$ npm install -g @fonoster/ctl
$ fonoster COMMAND
running command...
$ fonoster (--version)
@fonoster/ctl/0.52.1 darwin-arm64 node-v22.23.3
$ fonoster --help [COMMAND]
USAGE
$ fonoster COMMAND
...
Commands
fonoster apikeys:createfonoster apikeys:delete REFfonoster apikeys:listfonoster apikeys:rotate REFfonoster applications:createfonoster applications:delete REFfonoster applications:evalfonoster applications:get REFfonoster applications:listfonoster applications:rotate-secret REFfonoster applications:update [REF]fonoster bugfonoster feedbackfonoster mcp:configurefonoster providers:catalogfonoster providers:keys:delete PROVIDERfonoster providers:keys:listfonoster providers:keys:set PROVIDERfonoster records:download REFfonoster records:get REFfonoster records:listfonoster secrets:createfonoster secrets:delete REFfonoster secrets:get REFfonoster secrets:listfonoster secrets:update REFfonoster sipnet:acls:createfonoster sipnet:acls:delete REFfonoster sipnet:acls:get REFfonoster sipnet:acls:listfonoster sipnet:acls:update REFfonoster sipnet:agents:createfonoster sipnet:agents:delete REFfonoster sipnet:agents:get REFfonoster sipnet:agents:listfonoster sipnet:agents:update REFfonoster sipnet:calls:createfonoster sipnet:calls:get REFfonoster sipnet:calls:listfonoster sipnet:credentials:createfonoster sipnet:credentials:delete REFfonoster sipnet:credentials:get REFfonoster sipnet:credentials:listfonoster sipnet:credentials:update REFfonoster sipnet:domains:createfonoster sipnet:domains:delete REFfonoster sipnet:domains:get REFfonoster sipnet:domains:listfonoster sipnet:domains:update REFfonoster sipnet:numbers:createfonoster sipnet:numbers:delete REFfonoster sipnet:numbers:get REFfonoster sipnet:numbers:linkTwilio PHONENUMBERfonoster sipnet:numbers:linkTwilioNumber PHONENUMBERfonoster sipnet:numbers:linkWhatsApp [PHONENUMBER]fonoster sipnet:numbers:listfonoster sipnet:numbers:update REFfonoster sipnet:trunks:createfonoster sipnet:trunks:delete REFfonoster sipnet:trunks:get REFfonoster sipnet:trunks:listfonoster sipnet:trunks:update REFfonoster webhooks:createfonoster webhooks:delete REFfonoster webhooks:deliveries [REF]fonoster webhooks:get REFfonoster webhooks:listfonoster webhooks:resend REFfonoster webhooks:rotate REFfonoster webhooks:update REFfonoster workspaces:activefonoster workspaces:listfonoster workspaces:loginfonoster workspaces:logout REFfonoster workspaces:use REF
fonoster apikeys:create
create an API key for the active Workspace
USAGE
$ fonoster apikeys:create [--ca-file <value>] [-e <value>] [-r <value>]
FLAGS
-e, --expiration=<value> API Key expiration time in days(e.g. 10d) or months(e.g. 10m)
-r, --role=<value> [default: WORKSPACE_ADMIN] API Key role
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
create an API key for the active Workspace
EXAMPLES
$ fonoster apikeys:create
See code: dist/commands/apikeys/create.js
fonoster apikeys:delete REF
delete an API key from the active Workspace
USAGE
$ fonoster apikeys:delete REF [--ca-file <value>]
ARGUMENTS
REF the ApiKey to delete from the Workspace
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete an API key from the active Workspace
EXAMPLES
$ fonoster apikeys:delete
See code: dist/commands/apikeys/delete.js
fonoster apikeys:list
display all API keys in the active Workspace
USAGE
$ fonoster apikeys:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all API keys in the active Workspace
EXAMPLES
$ fonoster apikeys:list
See code: dist/commands/apikeys/list.js
fonoster apikeys:rotate REF
generate a new access key secret for an API key
USAGE
$ fonoster apikeys:rotate REF [--ca-file <value>]
ARGUMENTS
REF the API key to rotate
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
generate a new access key secret for an API key
EXAMPLES
$ fonoster apikeys:rotate
See code: dist/commands/apikeys/rotate.js
fonoster applications:create
add a new Application to the active Workspace
USAGE
$ fonoster applications:create [--ca-file <value>] [-f <value>] [-n <value>] [-u <value>] [--protocol fonoster|twilio]
[-a <value>] [--voice <value>] [--language <value>] [--stt-model <value>] [--tts-model <value>] [--silence-timeout
<value>] [--patience low|normal|high] [--speed <value>] [--audio-codec pcm16|pcmu] [--audio-rate <value>]
[--fallback-app <value>] [--fallback-message <value>] [-l <value>...] [--clear-listeners] [--recording off|on]
[--amd] [--amd-window <value>] [--noise-cancelling <value>]
FLAGS
-a, --agent=<value> a YAML or JSON agent file; makes it an Autopilot agent (hosted by Fonoster)
-f, --from-file=<value> a YAML or JSON file with the Application (an `agent` key makes it an Autopilot agent)
-l, --listener=<value>... a listen-only socket: <wss-url>[,inbound|outbound|both] (repeatable, at most 4)
-n, --name=<value> the Application name
-u, --url=<value> the stream's WebSocket URL (ws:// or wss://)
--[no-]amd answering-machine detection: the app gets one amd.result per call (--no-amd turns it
off)
--amd-window=<value> milliseconds of caller audio AMD classifies (500 to 15000, default 4000); implies
--amd
--audio-codec=<option> audio frames for fonoster-protocol streams
<options: pcm16|pcmu>
--audio-rate=<value> audio sample rate for fonoster-protocol streams: 8000, 16000 or 24000 (pcmu is 8000
only)
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
--clear-listeners remove the current listeners (update; combine with --listener to replace)
--fallback-app=<value> the Application to hand the call to when this one fails
--fallback-message=<value> what the caller hears when the app fails and no fallback app answers
--language=<value> speech language (e.g. en-US)
--noise-cancelling=<value> noise cancelling on the caller's audio: none, or a noise-cancelling provider in your
catalog (such as aicoustics)
--patience=<option> how long to wait before taking the turn
<options: low|normal|high>
--protocol=<option> the protocol the stream speaks
<options: fonoster|twilio>
--recording=<option> the recording policy
<options: off|on>
--silence-timeout=<value> milliseconds of caller silence before a silence event
--speed=<value> speech speed, from 0.7 to 1.2; 1.0 is the voice's normal pace
--stt-model=<value> STT model as a catalog id (e.g. deepgram/nova-3)
--tts-model=<value> TTS model as a catalog id (e.g. deepgram/aura-2)
--voice=<value> TTS voice as a catalog id (e.g. deepgram/aura-2-thalia-en)
DESCRIPTION
add a new Application to the active Workspace
EXAMPLES
$ fonoster applications:create --name Bot --url wss://bot.example.com/session
$ fonoster applications:create --name Bot --url wss://bot.example.com/media --protocol twilio
$ fonoster applications:create --name Receptionist --agent agent.yaml --voice deepgram/aura-2-thalia-en
$ fonoster applications:create --from-file app.yaml
$ fonoster applications:create # asks for the basics
See code: dist/commands/applications/create.js
fonoster applications:delete REF
delete an Application from the active Workspace
USAGE
$ fonoster applications:delete REF [--ca-file <value>]
ARGUMENTS
REF the Application to delete
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete an Application from the active Workspace
EXAMPLES
$ fonoster applications:delete
See code: dist/commands/applications/delete.js
fonoster applications:eval
experimental command to test an Autopilot agent
USAGE
$ fonoster applications:eval -f <value> [--ca-file <value>] [-o pretty|json] [--output-file <value>] [--model
<value>] [--repeat <value>] [--max-first-token-p50 <value>] [--max-first-token-p95 <value>] [--min-tool-pass
<value>] [--min-step-pass <value>]
FLAGS
-f, --file=<value> (required) path to test cases file (json, yaml, or yml)
-o, --output=<option> [default: pretty] output format
<options: pretty|json>
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's
config/tls/ca.pem (default: FONOSTER_CA_FILE)
--max-first-token-p50=<value> fail if the median time to first token is above this, in ms
--max-first-token-p95=<value> fail if the p95 time to first token is above this, in ms
--min-step-pass=<value> fail if fewer than this percent of steps pass
--min-tool-pass=<value> fail if fewer than this percent of tool steps are right
--model=<value> catalog id of the language model to test, instead of the one in the file
--output-file=<value> write JSON summary to this file (with pretty: also show streamed output)
--repeat=<value> [default: 1] how many times to run the test cases; above 1, prints only the summary
DESCRIPTION
experimental command to test an Autopilot agent
EXAMPLES
$ fonoster applications:eval -f agent.json
$ fonoster applications:eval -f agent.yaml
$ fonoster applications:eval -f agent.yaml -o json
$ fonoster applications:eval -f agent.yaml -o json --output-file results.json
See code: dist/commands/applications/eval.js
fonoster applications:get REF
retrieve details of an Application by reference
USAGE
$ fonoster applications:get REF [--ca-file <value>]
ARGUMENTS
REF The Application to show details about
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of an Application by reference
EXAMPLES
$ fonoster applications:get <ref>
See code: dist/commands/applications/get.js
fonoster applications:list
display all Applications in the active Workspace
USAGE
$ fonoster applications:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all Applications in the active Workspace
EXAMPLES
$ fonoster applications:list
See code: dist/commands/applications/list.js
fonoster applications:rotate-secret REF
issue a new signing secret for an Application (the old one stops working)
USAGE
$ fonoster applications:rotate-secret REF [--ca-file <value>]
ARGUMENTS
REF the Application whose secret to rotate
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
issue a new signing secret for an Application (the old one stops working)
EXAMPLES
$ fonoster applications:rotate-secret <ref>
See code: dist/commands/applications/rotate-secret.js
fonoster applications:update [REF]
modify an Application (only the fields you pass change)
USAGE
$ fonoster applications:update [REF] [--ca-file <value>] [-f <value>] [-n <value>] [-u <value>] [--protocol
fonoster|twilio] [-a <value>] [--voice <value>] [--language <value>] [--stt-model <value>] [--tts-model <value>]
[--silence-timeout <value>] [--patience low|normal|high] [--speed <value>] [--audio-codec pcm16|pcmu] [--audio-rate
<value>] [--fallback-app <value>] [--fallback-message <value>] [-l <value>...] [--clear-listeners] [--recording
off|on] [--amd] [--amd-window <value>] [--noise-cancelling <value>]
ARGUMENTS
[REF] the Application to update (optional when `ref` is set in --from-file)
FLAGS
-a, --agent=<value> a YAML or JSON agent file; makes it an Autopilot agent (hosted by Fonoster)
-f, --from-file=<value> a YAML or JSON file with the Application (an `agent` key makes it an Autopilot agent)
-l, --listener=<value>... a listen-only socket: <wss-url>[,inbound|outbound|both] (repeatable, at most 4)
-n, --name=<value> the Application name
-u, --url=<value> the stream's WebSocket URL (ws:// or wss://)
--[no-]amd answering-machine detection: the app gets one amd.result per call (--no-amd turns it
off)
--amd-window=<value> milliseconds of caller audio AMD classifies (500 to 15000, default 4000); implies
--amd
--audio-codec=<option> audio frames for fonoster-protocol streams
<options: pcm16|pcmu>
--audio-rate=<value> audio sample rate for fonoster-protocol streams: 8000, 16000 or 24000 (pcmu is 8000
only)
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
--clear-listeners remove the current listeners (update; combine with --listener to replace)
--fallback-app=<value> the Application to hand the call to when this one fails
--fallback-message=<value> what the caller hears when the app fails and no fallback app answers
--language=<value> speech language (e.g. en-US)
--noise-cancelling=<value> noise cancelling on the caller's audio: none, or a noise-cancelling provider in your
catalog (such as aicoustics)
--patience=<option> how long to wait before taking the turn
<options: low|normal|high>
--protocol=<option> the protocol the stream speaks
<options: fonoster|twilio>
--recording=<option> the recording policy
<options: off|on>
--silence-timeout=<value> milliseconds of caller silence before a silence event
--speed=<value> speech speed, from 0.7 to 1.2; 1.0 is the voice's normal pace
--stt-model=<value> STT model as a catalog id (e.g. deepgram/nova-3)
--tts-model=<value> TTS model as a catalog id (e.g. deepgram/aura-2)
--voice=<value> TTS voice as a catalog id (e.g. deepgram/aura-2-thalia-en)
DESCRIPTION
modify an Application (only the fields you pass change)
EXAMPLES
$ fonoster applications:update <ref> --voice deepgram/aura-2-thalia-en --patience high
$ fonoster applications:update <ref> --agent agent.yaml
$ fonoster applications:update <ref> --clear-listeners --listener wss://rec.example.com/ws,inbound
$ fonoster applications:update <ref> --noise-cancelling aicoustics
$ fonoster applications:update --from-file app.yaml # with `ref` in the file
See code: dist/commands/applications/update.js
fonoster bug
report a bug to the development team 🐞
USAGE
$ fonoster bug
DESCRIPTION
report a bug to the development team 🐞
EXAMPLES
$ fonoster bug
See code: dist/commands/bug.js
fonoster feedback
provide feedback on your experience
USAGE
$ fonoster feedback
DESCRIPTION
provide feedback on your experience
...
Help us improve by providing some feedback
EXAMPLES
$ fonoster feedback
See code: dist/commands/feedback.js
fonoster mcp:configure
configure MCP client settings
USAGE
$ fonoster mcp:configure [-c claude] [-w <value>]
FLAGS
-c, --client=<option> [default: claude] MCP client to configure
<options: claude>
-w, --workspace=<value> workspace reference
DESCRIPTION
configure MCP client settings
EXAMPLES
$ fonoster mcp:configure --client claude
$ fonoster mcp:configure --client claude --workspace my-workspace
See code: dist/commands/mcp/configure.js
fonoster providers:catalog
list the provider catalog: the providers, models and voices apps can use (catalog ids)
USAGE
$ fonoster providers:catalog [--ca-file <value>] [-k provider|model|voice] [-t stt|tts|llm|nc]
FLAGS
-k, --kind=<option> only this kind of item
<options: provider|model|voice>
-t, --type=<option> only this capability
<options: stt|tts|llm|nc>
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
list the provider catalog: the providers, models and voices apps can use (catalog ids)
EXAMPLES
$ fonoster providers:catalog
$ fonoster providers:catalog --kind voice
$ fonoster providers:catalog --kind model --type stt
See code: dist/commands/providers/catalog.js
fonoster providers:keys:delete PROVIDER
remove the Workspace's key for a vendor (calls fall back to the platform's key, if any)
USAGE
$ fonoster providers:keys:delete PROVIDER [--ca-file <value>]
ARGUMENTS
PROVIDER the provider id
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
remove the Workspace's key for a vendor (calls fall back to the platform's key, if any)
EXAMPLES
$ fonoster providers:keys:delete deepgram
See code: dist/commands/providers/keys/delete.js
fonoster providers:keys:list
list the vendors the Workspace has its own key for (keys are never shown)
USAGE
$ fonoster providers:keys:list [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
list the vendors the Workspace has its own key for (keys are never shown)
EXAMPLES
$ fonoster providers:keys:list
See code: dist/commands/providers/keys/list.js
fonoster providers:keys:set PROVIDER
set the Workspace's own key for a speech or LLM vendor (replaces any previous key)
USAGE
$ fonoster providers:keys:set PROVIDER [--ca-file <value>] [--key <value>]
ARGUMENTS
PROVIDER the provider id (see providers:catalog --kind provider)
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
--key=<value> the vendor key (omit to type it without echo)
DESCRIPTION
set the Workspace's own key for a speech or LLM vendor (replaces any previous key)
EXAMPLES
$ fonoster providers:keys:set deepgram # asks for the key
$ fonoster providers:keys:set elevenlabs --key $ELEVENLABS_API_KEY
See code: dist/commands/providers/keys/set.js
fonoster records:download REF
save a call's recording (WAV), vCon (JSON) or signed vCon (JWS) to a file
USAGE
$ fonoster records:download REF [--ca-file <value>] [-p recording|vcon|signed] [-o <value>] [--version <value>]
[--original]
ARGUMENTS
REF the call (callRef)
FLAGS
-o, --output=<value> the file to write (default <call-ref>.<ext>)
-p, --part=<option> [default: recording] what to download
<options: recording|vcon|signed>
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
--original the unredacted record (owner or admin)
--version=<value> a record version (default latest)
DESCRIPTION
save a call's recording (WAV), vCon (JSON) or signed vCon (JWS) to a file
EXAMPLES
$ fonoster records:download <call-ref> # <call-ref>.wav
$ fonoster records:download <call-ref> --part vcon -o call.json
$ fonoster records:download <call-ref> --part signed # verifiable JWS
See code: dist/commands/records/download.js
fonoster records:get REF
show the summary of a call record (use records:download for the files)
USAGE
$ fonoster records:get REF [--ca-file <value>] [--version <value>] [--original]
ARGUMENTS
REF the call (callRef)
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
--original the unredacted record (owner or admin)
--version=<value> a record version (default latest)
DESCRIPTION
show the summary of a call record (use records:download for the files)
EXAMPLES
$ fonoster records:get <call-ref>
$ fonoster records:get <call-ref> --original --version 1
See code: dist/commands/records/get.js
fonoster records:list
search the call records (vCon) of the active Workspace, newest first
USAGE
$ fonoster records:list [--ca-file <value>] [--after <value>] [--before <value>] [--number <value>] [--app
<value>] [--status <value>] [-s <value>] [-t <value>]
FLAGS
-s, --page-size=<value> [default: 50] the number of items to show
-t, --page-token=<value> the token for the next page (printed after a full page)
--after=<value> started at or after (ISO date/time)
--app=<value> calls handled by this Application
--before=<value> started before (ISO date/time)
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
--number=<value> calls from or to this number
--status=<value> record status (e.g. sealed, failed)
DESCRIPTION
search the call records (vCon) of the active Workspace, newest first
EXAMPLES
$ fonoster records:list
$ fonoster records:list --after 2026-10-01 --number +17853178070
$ fonoster records:list --app <app-ref> --status failed
See code: dist/commands/records/list.js
fonoster secrets:create
add a new Secret to the active Workspace
USAGE
$ fonoster secrets:create [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
add a new Secret to the active Workspace
EXAMPLES
$ fonoster secrets:create
See code: dist/commands/secrets/create.js
fonoster secrets:delete REF
delete a Secret from the active Workspace
USAGE
$ fonoster secrets:delete REF [--ca-file <value>]
ARGUMENTS
REF the Secret reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete a Secret from the active Workspace
EXAMPLES
$ fonoster secrets:delete
See code: dist/commands/secrets/delete.js
fonoster secrets:get REF
retrieve details of a Secret by reference
USAGE
$ fonoster secrets:get REF [--ca-file <value>]
ARGUMENTS
REF The Secret to show details about
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of a Secret by reference
EXAMPLES
$ fonoster secrets:get
See code: dist/commands/secrets/get.js
fonoster secrets:list
display all Secrets in the active Workspace
USAGE
$ fonoster secrets:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all Secrets in the active Workspace
EXAMPLES
$ fonoster secrets:list
See code: dist/commands/secrets/list.js
fonoster secrets:update REF
modify the value or metadata of a Secret
USAGE
$ fonoster secrets:update REF [--ca-file <value>]
ARGUMENTS
REF the Secret to update
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
modify the value or metadata of a Secret
EXAMPLES
$ fonoster secrets:update
See code: dist/commands/secrets/update.js
fonoster sipnet:acls:create
create a new Access Control List (ACL)
USAGE
$ fonoster sipnet:acls:create [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
create a new Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:acls:create
See code: dist/commands/sipnet/acls/create.js
fonoster sipnet:acls:delete REF
remove an Access Control List (ACL) from the Workspace
USAGE
$ fonoster sipnet:acls:delete REF [--ca-file <value>]
ARGUMENTS
REF the ACL reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
remove an Access Control List (ACL) from the Workspace
EXAMPLES
$ fonoster sipnet:acls:delete
See code: dist/commands/sipnet/acls/delete.js
fonoster sipnet:acls:get REF
get a specific Access Control List (ACL)
USAGE
$ fonoster sipnet:acls:get REF [--ca-file <value>]
ARGUMENTS
REF The ACL reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
get a specific Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:acls:get
See code: dist/commands/sipnet/acls/get.js
fonoster sipnet:acls:list
list all Access Control Lists (ACLs)
USAGE
$ fonoster sipnet:acls:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
list all Access Control Lists (ACLs)
EXAMPLES
$ fonoster sipnet:acls:list
See code: dist/commands/sipnet/acls/list.js
fonoster sipnet:acls:update REF
update an existing Access Control List (ACL)
USAGE
$ fonoster sipnet:acls:update REF [--ca-file <value>]
ARGUMENTS
REF the ACL reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
update an existing Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:acls:update
See code: dist/commands/sipnet/acls/update.js
fonoster sipnet:agents:create
add a new SIP Agent to the network
USAGE
$ fonoster sipnet:agents:create [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
add a new SIP Agent to the network
EXAMPLES
$ fonoster sipnet:agents:create
See code: dist/commands/sipnet/agents/create.js
fonoster sipnet:agents:delete REF
delete a SIP Agent from the network
USAGE
$ fonoster sipnet:agents:delete REF [--ca-file <value>]
ARGUMENTS
REF the Agent reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete a SIP Agent from the network
EXAMPLES
$ fonoster sipnet:agents:delete
See code: dist/commands/sipnet/agents/delete.js
fonoster sipnet:agents:get REF
retrieve details of a SIP Agent
USAGE
$ fonoster sipnet:agents:get REF [--ca-file <value>]
ARGUMENTS
REF The Agent reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of a SIP Agent
EXAMPLES
$ fonoster sipnet:agents:get
See code: dist/commands/sipnet/agents/get.js
fonoster sipnet:agents:list
display all SIP Agents in the network
USAGE
$ fonoster sipnet:agents:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all SIP Agents in the network
EXAMPLES
$ fonoster sipnet:agents:list
See code: dist/commands/sipnet/agents/list.js
fonoster sipnet:agents:update REF
add a new SIP Agent to the network
USAGE
$ fonoster sipnet:agents:update REF [--ca-file <value>]
ARGUMENTS
REF the ACL reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
add a new SIP Agent to the network
EXAMPLES
$ fonoster sipnet:agents:update
See code: dist/commands/sipnet/agents/update.js
fonoster sipnet:calls:create
place an outbound call to a phone number or SIP URI and follow its status
USAGE
$ fonoster sipnet:calls:create -f <value> -t <value> -a <value> [--ca-file <value>] [-o <value>] [-m <value>] [-d]
FLAGS
-a, --app-ref=<value> (required) the Application that handles the call
-d, --detach print the call ref and return without following the status
-f, --from=<value> (required) the number to make the call from
-m, --metadata=<value> a JSON object the app receives with the session (e.g. '{"name": "John Doe"}')
-o, --timeout=<value> [default: 30] seconds to wait for an answer
-t, --to=<value> (required) the number or SIP URI to call
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
place an outbound call to a phone number or SIP URI and follow its status
EXAMPLES
$ fonoster sipnet:calls:create -f +17853178070 -t +18287854037 -a <app-ref>
$ fonoster sipnet:calls:create -f +17853178070 -t +18287854037 -a <app-ref> --detach
$ fonoster sipnet:calls:create -f +17853178070 -t +18287854037 -a <app-ref> -m '{"name":"Jane"}'
See code: dist/commands/sipnet/calls/create.js
fonoster sipnet:calls:get REF
get a specific Access Control List (ACL)
USAGE
$ fonoster sipnet:calls:get REF [--ca-file <value>]
ARGUMENTS
REF The ACL reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
get a specific Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:calls:get
See code: dist/commands/sipnet/calls/get.js
fonoster sipnet:calls:list
display all calls made in the active Workspace
USAGE
$ fonoster sipnet:calls:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all calls made in the active Workspace
EXAMPLES
$ fonoster sipnet:calls:list
See code: dist/commands/sipnet/calls/list.js
fonoster sipnet:credentials:create
add a new set of Credentials to the network
USAGE
$ fonoster sipnet:credentials:create [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
add a new set of Credentials to the network
EXAMPLES
$ fonoster sipnet:credentials:create
See code: dist/commands/sipnet/credentials/create.js
fonoster sipnet:credentials:delete REF
delete a set of Credentials from the active Workspace
USAGE
$ fonoster sipnet:credentials:delete REF [--ca-file <value>]
ARGUMENTS
REF the Credentials reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete a set of Credentials from the active Workspace
EXAMPLES
$ fonoster sipnet:credentials:delete
See code: dist/commands/sipnet/credentials/delete.js
fonoster sipnet:credentials:get REF
retrieve details of a set of Credentials by reference
USAGE
$ fonoster sipnet:credentials:get REF [--ca-file <value>]
ARGUMENTS
REF The Credentials reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of a set of Credentials by reference
EXAMPLES
$ fonoster sipnet:credentials:get
See code: dist/commands/sipnet/credentials/get.js
fonoster sipnet:credentials:list
display all Credentials in the active Workspace
USAGE
$ fonoster sipnet:credentials:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all Credentials in the active Workspace
EXAMPLES
$ fonoster sipnet:credentials:list
See code: dist/commands/sipnet/credentials/list.js
fonoster sipnet:credentials:update REF
modify the values or metadata of a set of Credentials
USAGE
$ fonoster sipnet:credentials:update REF [--ca-file <value>]
ARGUMENTS
REF the Credentials reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
modify the values or metadata of a set of Credentials
EXAMPLES
$ fonoster sipnet:credentials:update
See code: dist/commands/sipnet/credentials/update.js
fonoster sipnet:domains:create
add a new Domain to the SIP network
USAGE
$ fonoster sipnet:domains:create [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
add a new Domain to the SIP network
EXAMPLES
$ fonoster sipnet:domains:create
See code: dist/commands/sipnet/domains/create.js
fonoster sipnet:domains:delete REF
delete a Domain from the active Workspace
USAGE
$ fonoster sipnet:domains:delete REF [--ca-file <value>]
ARGUMENTS
REF the Domain reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete a Domain from the active Workspace
EXAMPLES
$ fonoster sipnet:domains:delete
See code: dist/commands/sipnet/domains/delete.js
fonoster sipnet:domains:get REF
retrieve details of a Domain by reference
USAGE
$ fonoster sipnet:domains:get REF [--ca-file <value>]
ARGUMENTS
REF The Domain reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of a Domain by reference
EXAMPLES
$ fonoster sipnet:domains:get
See code: dist/commands/sipnet/domains/get.js
fonoster sipnet:domains:list
display all Domains in the SIP network
USAGE
$ fonoster sipnet:domains:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all Domains in the SIP network
EXAMPLES
$ fonoster sipnet:domains:list
See code: dist/commands/sipnet/domains/list.js
fonoster sipnet:domains:update REF
modify the configuration of a Domain
USAGE
$ fonoster sipnet:domains:update REF [--ca-file <value>]
ARGUMENTS
REF the Domain reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
modify the configuration of a Domain
EXAMPLES
$ fonoster sipnet:domains:update
See code: dist/commands/sipnet/domains/update.js
fonoster sipnet:numbers:create
add a new Number to the SIP network
USAGE
$ fonoster sipnet:numbers:create [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
add a new Number to the SIP network
EXAMPLES
$ fonoster sipnet:numbers:create
See code: dist/commands/sipnet/numbers/create.js
fonoster sipnet:numbers:delete REF
delete a Number from the active Workspace
USAGE
$ fonoster sipnet:numbers:delete REF [--ca-file <value>]
ARGUMENTS
REF the Numbers's reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete a Number from the active Workspace
EXAMPLES
$ fonoster sipnet:numbers:delete
See code: dist/commands/sipnet/numbers/delete.js
fonoster sipnet:numbers:get REF
retrieve details of a Number by reference
USAGE
$ fonoster sipnet:numbers:get REF [--ca-file <value>]
ARGUMENTS
REF the Number to show details about
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of a Number by reference
EXAMPLES
$ fonoster sipnet:numbers:get
See code: dist/commands/sipnet/numbers/get.js
fonoster sipnet:numbers:linkTwilio PHONENUMBER
link a number from your Twilio account to the active workspace
USAGE
$ fonoster sipnet:numbers:linkTwilio PHONENUMBER [--ca-file <value>] [--name <value>] [--app <value> | --agent <value>]
[--account-sid <value>] [--api-key-sid <value> | --auth-token] [--yes]
ARGUMENTS
PHONENUMBER the number to link, in E.164 (it must be in your Twilio account)
FLAGS
--account-sid=<value> the Twilio Account SID (AC...)
--agent=<value> the SIP agent (AOR) that answers the number
--api-key-sid=<value> a Twilio Standard API key SID (SK...); the secret is read from TWILIO_API_KEY_SECRET or a
masked prompt
--app=<value> the Application that answers the number
--auth-token sign in with the Auth Token instead of an API key; it is read from TWILIO_AUTH_TOKEN or a
masked prompt
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
--name=<value> the Number's name (default: the phone number)
--yes link without asking, replacing the trunk and route of a number already in the workspace
DESCRIPTION
link a number from your Twilio account to the active workspace
ALIASES
$ fonoster sipnet:numbers:linkTwilioNumber
EXAMPLES
$ fonoster sipnet:numbers:linkTwilio +18095550123 --app <ref> # asks for what's missing
TWILIO_API_KEY_SECRET=... fonoster sipnet:numbers:linkTwilio +18095550123 --account-sid AC... --api-key-sid SK... --app <ref> --yes
See code: dist/commands/sipnet/numbers/linkTwilio.js
fonoster sipnet:numbers:linkTwilioNumber PHONENUMBER
link a number from your Twilio account to the active workspace
USAGE
$ fonoster sipnet:numbers:linkTwilioNumber PHONENUMBER [--ca-file <value>] [--name <value>] [--app <value> | --agent <value>]
[--account-sid <value>] [--api-key-sid <value> | --auth-token] [--yes]
ARGUMENTS
PHONENUMBER the number to link, in E.164 (it must be in your Twilio account)
FLAGS
--account-sid=<value> the Twilio Account SID (AC...)
--agent=<value> the SIP agent (AOR) that answers the number
--api-key-sid=<value> a Twilio Standard API key SID (SK...); the secret is read from TWILIO_API_KEY_SECRET or a
masked prompt
--app=<value> the Application that answers the number
--auth-token sign in with the Auth Token instead of an API key; it is read from TWILIO_AUTH_TOKEN or a
masked prompt
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
--name=<value> the Number's name (default: the phone number)
--yes link without asking, replacing the trunk and route of a number already in the workspace
DESCRIPTION
link a number from your Twilio account to the active workspace
ALIASES
$ fonoster sipnet:numbers:linkTwilioNumber
EXAMPLES
$ fonoster sipnet:numbers:linkTwilioNumber +18095550123 --app <ref> # asks for what's missing
TWILIO_API_KEY_SECRET=... fonoster sipnet:numbers:linkTwilioNumber +18095550123 --account-sid AC... --api-key-sid SK... --app <ref> --yes
fonoster sipnet:numbers:linkWhatsApp [PHONENUMBER]
link a WhatsApp Business number to the active workspace
USAGE
$ fonoster sipnet:numbers:linkWhatsApp [PHONENUMBER] [--ca-file <value>] [--phone-number-id <value>] [--name <value>] [--app
<value> | --agent <value>] [--yes]
ARGUMENTS
[PHONENUMBER] the WhatsApp Business number, in E.164; only when you set up Meta yourself (no --phone-number-id)
FLAGS
--agent=<value> the SIP agent (AOR) that answers the number
--app=<value> the Application that answers the number
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
--name=<value> the Number's name (default: Meta's verified name, or the phone number)
--phone-number-id=<value> Meta's id of the phone number (WhatsApp Manager > Phone numbers); Fonoster then sets up
Meta with a token read from META_ACCESS_TOKEN or a masked prompt
--yes skip the confirmation; required without a terminal
DESCRIPTION
link a WhatsApp Business number to the active workspace
EXAMPLES
$ fonoster sipnet:numbers:linkWhatsApp --phone-number-id 106612345678901 --app <ref> # asks for the token and what's missing
META_ACCESS_TOKEN=... fonoster sipnet:numbers:linkWhatsApp --phone-number-id 106612345678901 --app <ref> --yes
WHATSAPP_SIP_PASSWORD=... fonoster sipnet:numbers:linkWhatsApp +525512345678 --app <ref> --yes # you set up Meta yourself
See code: dist/commands/sipnet/numbers/linkWhatsApp.js
fonoster sipnet:numbers:list
display all Numbers in the active Workspace
USAGE
$ fonoster sipnet:numbers:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to return
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all Numbers in the active Workspace
EXAMPLES
$ fonoster sipnet:numbers:list
See code: dist/commands/sipnet/numbers/list.js
fonoster sipnet:numbers:update REF
modify the configuration of a Number
USAGE
$ fonoster sipnet:numbers:update REF [--ca-file <value>]
ARGUMENTS
REF the Number to update
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
modify the configuration of a Number
EXAMPLES
$ fonoster sipnet:numbers:update
See code: dist/commands/sipnet/numbers/update.js
fonoster sipnet:trunks:create
add a new Trunk to the SIP network
USAGE
$ fonoster sipnet:trunks:create [--ca-file <value>]
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
add a new Trunk to the SIP network
EXAMPLES
$ fonoster sipnet:trunks:create
See code: dist/commands/sipnet/trunks/create.js
fonoster sipnet:trunks:delete REF
remove a Trunk from the active Workspace
USAGE
$ fonoster sipnet:trunks:delete REF [--ca-file <value>]
ARGUMENTS
REF the Trunk's reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
remove a Trunk from the active Workspace
EXAMPLES
$ fonoster sipnet:trunks:delete
See code: dist/commands/sipnet/trunks/delete.js
fonoster sipnet:trunks:get REF
retrieve details of a Trunk by reference
USAGE
$ fonoster sipnet:trunks:get REF [--ca-file <value>]
ARGUMENTS
REF The Trunk's reference
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of a Trunk by reference
EXAMPLES
$ fonoster sipnet:trunks:get
See code: dist/commands/sipnet/trunks/get.js
fonoster sipnet:trunks:list
display all Trunks in the active Workspace
USAGE
$ fonoster sipnet:trunks:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all Trunks in the active Workspace
EXAMPLES
$ fonoster sipnet:trunks:list
See code: dist/commands/sipnet/trunks/list.js
fonoster sipnet:trunks:update REF
modify the configuration of a Trunk
USAGE
$ fonoster sipnet:trunks:update REF [--ca-file <value>]
ARGUMENTS
REF the Trunk to update
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
modify the configuration of a Trunk
EXAMPLES
$ fonoster sipnet:trunks:update
See code: dist/commands/sipnet/trunks/update.js
fonoster webhooks:create
subscribe an HTTPS endpoint to Workspace events
USAGE
$ fonoster webhooks:create -u <value> -e
call.started|call.ended|call.failed|call_record.sealed|provider.deprecated... [--ca-file <value>]
FLAGS
-e, --event=<option>... (required) an event to receive (repeatable)
<options: call.started|call.ended|call.failed|call_record.sealed|provider.deprecated>
-u, --url=<value> (required) the endpoint that receives the events (https://)
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
subscribe an HTTPS endpoint to Workspace events
EXAMPLES
$ fonoster webhooks:create --url https://example.com/hooks -e call.ended -e call_record.sealed
See code: dist/commands/webhooks/create.js
fonoster webhooks:delete REF
delete a Webhook from the active Workspace
USAGE
$ fonoster webhooks:delete REF [--ca-file <value>]
ARGUMENTS
REF the Webhook to delete
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
delete a Webhook from the active Workspace
EXAMPLES
$ fonoster webhooks:delete <ref>
See code: dist/commands/webhooks/delete.js
fonoster webhooks:deliveries [REF]
show the delivery log (all Webhooks, or one)
USAGE
$ fonoster webhooks:deliveries [REF] [--ca-file <value>] [-s <value>]
ARGUMENTS
[REF] only this Webhook's deliveries
FLAGS
-s, --page-size=<value> [default: 50] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
show the delivery log (all Webhooks, or one)
EXAMPLES
$ fonoster webhooks:deliveries
$ fonoster webhooks:deliveries <webhook-ref> -s 20
See code: dist/commands/webhooks/deliveries.js
fonoster webhooks:get REF
retrieve details of a Webhook by reference
USAGE
$ fonoster webhooks:get REF [--ca-file <value>]
ARGUMENTS
REF the Webhook to show details about
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
retrieve details of a Webhook by reference
EXAMPLES
$ fonoster webhooks:get <ref>
See code: dist/commands/webhooks/get.js
fonoster webhooks:list
display all Webhooks in the active Workspace
USAGE
$ fonoster webhooks:list [--ca-file <value>] [-s <value>]
FLAGS
-s, --page-size=<value> [default: 1000] the number of items to show
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
display all Webhooks in the active Workspace
EXAMPLES
$ fonoster webhooks:list
See code: dist/commands/webhooks/list.js
fonoster webhooks:resend REF
send a delivery again (same event id, so receivers can dedupe)
USAGE
$ fonoster webhooks:resend REF [--ca-file <value>]
ARGUMENTS
REF the delivery to resend (see webhooks:deliveries)
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
send a delivery again (same event id, so receivers can dedupe)
EXAMPLES
$ fonoster webhooks:resend <delivery-ref>
See code: dist/commands/webhooks/resend.js
fonoster webhooks:rotate REF
issue a new signing secret for a Webhook (the old one keeps working for a while)
USAGE
$ fonoster webhooks:rotate REF [--ca-file <value>]
ARGUMENTS
REF the Webhook whose secret to rotate
FLAGS
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem (default:
FONOSTER_CA_FILE)
DESCRIPTION
issue a new signing secret for a Webhook (the old one keeps working for a while)
EXAMPLES
$ fonoster webhooks:rotate <ref>
See code: dist/commands/webhooks/rotate.js
fonoster webhooks:update REF
change a Webhook's URL or events (--event replaces the list)
USAGE
$ fonoster webhooks:update REF [--ca-file <value>] [-u <value>] [-e
call.started|call.ended|call.failed|call_record.sealed|provider.deprecated...]
ARGUMENTS
REF the Webhook to update
FLAGS
-e, --event=<option>... an event to receive (repeatable)
<options: call.started|call.ended|call.failed|call_record.sealed|provider.deprecated>
-u, --url=<value> the new endpoint
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's config/tls/ca.pem
(default: FONOSTER_CA_FILE)
DESCRIPTION
change a Webhook's URL or events (--event replaces the list)
EXAMPLES
$ fonoster webhooks:update <ref> -e call.started -e call.ended
$ fonoster webhooks:update <ref> --url https://example.com/new
See code: dist/commands/webhooks/update.js
fonoster workspaces:active
display the name of the active Workspace
USAGE
$ fonoster workspaces:active
DESCRIPTION
display the name of the active Workspace
EXAMPLES
$ fonoster workspaces:active
See code: dist/commands/workspaces/active.js
fonoster workspaces:list
display all linked Workspaces
USAGE
$ fonoster workspaces:list
DESCRIPTION
display all linked Workspaces
EXAMPLES
$ fonoster workspaces:list
See code: dist/commands/workspaces/list.js
fonoster workspaces:login
link a Workspace to the local environment
USAGE
$ fonoster workspaces:login [--ca-file <value>] [-e <value>] [--access-key-id <value>] [--access-key-secret <value>]
FLAGS
-e, --endpoint=<value> the API endpoint (skips the questions with the key flags)
--access-key-id=<value> a Workspace API key id
--access-key-secret=<value> the API key secret
--ca-file=<value> a PEM file of certificate authorities to trust, such as an install's
config/tls/ca.pem (default: FONOSTER_CA_FILE)
DESCRIPTION
link a Workspace to the local environment
EXAMPLES
$ fonoster workspaces:login
$ fonoster wor