Legacy CLI (@telnyx/api-cli)

This CLI is deprecated. The @telnyx/api-cli package is no longer actively maintained.For new projects, use the Telnyx CLI (Go) which offers better performance, simpler authentication, and full API coverage.

About the Legacy CLI

The @telnyx/api-cli is a Node.js-based command-line interface for interacting with the Telnyx API. It provides commands for managing phone numbers, sending messages, making calls, and more.

Features

Interactive Setup — Guided authentication with telnyx auth setup
Profile Management — Multiple API key profiles for different environments
10DLC Wizard — Step-by-step 10DLC brand and campaign registration
Shell Autocomplete — Tab completion for commands and options
Dry Run Mode — Preview destructive operations before executing

Legacy Documentation

Installation

npm installation instructions

Authentication

API keys, profiles, and config files

Command Reference

Full command reference

Migrating to the current CLI

The current Telnyx CLI (Go) uses plural resource names and long-form flags. Common command equivalents:

Legacy CLI (`@telnyx/api-cli`)	Current CLI (Go)
`telnyx auth setup`	`export TELNYX_API_KEY=KEY...` (no interactive setup)
`telnyx number search --country US`	`telnyx available-phone-numbers list --filter.country-code US`
`telnyx number order +15551234567`	`telnyx number-orders create --phone-number '{phone_number: +15551234567}'`
`telnyx number list`	`telnyx phone-numbers list`
`telnyx number get <id>`	`telnyx phone-numbers retrieve --id <id>`
`telnyx number update <id> ...`	`telnyx phone-numbers update --phone-number-id <id> ...`
`telnyx number delete <id>`	`telnyx phone-numbers delete --id <id>`
`telnyx message send -f <from> -t <to> --text "Hi"`	`telnyx messages send --from <from> --to <to> --text "Hi"`
`telnyx message get <id>`	`telnyx messages retrieve --id <id>`
`telnyx messaging-profile list`	`telnyx messaging-profiles list`
`telnyx call dial -f <from> -t <to> --connection-id <id>`	`telnyx calls dial --from <from> --to <to> --connection-id <id>`
`telnyx call hangup <call-control-id>`	`telnyx calls:actions hangup --call-control-id <id>`
`telnyx call speak <call-control-id> "Hi"`	`telnyx calls:actions speak --call-control-id <id> --payload "Hi" --voice AWS.Polly.Joanna`
`telnyx call transfer <call-control-id> <to>`	`telnyx calls:actions transfer --call-control-id <id> --to <to>`
`telnyx 10dlc brand list`	`telnyx messaging-10dlc:brand list`
`telnyx 10dlc campaign list <brand-id>`	`telnyx messaging-10dlc:campaign list --brand-id <id>`
`telnyx billing balance`	`telnyx balance retrieve`
`telnyx verify send -n <phone> --profile-id <id>`	`telnyx verifications trigger-sms --phone-number <phone> --verify-profile-id <id>`
`telnyx verify check -n <phone> -c <code> --profile-id <id>`	`telnyx verifications:actions verify --verification-id <id> --code <code>`

Listing sent messages (telnyx message list) has no direct equivalent in the current CLI — use MDR reports instead.

Resources

npm Package — Version history
GitHub Repository — Source code

​About the Legacy CLI

​Features

​Legacy Documentation

Installation

Authentication

Command Reference

​Migrating to the current CLI

​Resources

About the Legacy CLI

Features

Legacy Documentation

Migrating to the current CLI

Resources