Legacy Command Reference

Complete reference for legacy CLI commands (@telnyx/api-cli)

This CLI is deprecated. For the current CLI commands, see Command Reference.

Authentication & Profiles

telnyx auth setup                    # Interactive API key setup
telnyx auth setup --profile prod     # Setup named profile
telnyx auth status                   # Check current auth status

telnyx profile list                  # List all profiles
telnyx profile set-default <name>    # Set default profile
telnyx profile delete <name>         # Delete a profile

Phone Numbers

Search & Purchase

# Search available numbers
telnyx number search --country US
telnyx number search --country US --contains 555
telnyx number search --country US --type toll_free
telnyx number search --country CA --locality Toronto --limit 20

# Purchase numbers
telnyx number order [phone]
telnyx number order [phone] [phone] --messaging-profile-id <id>

Manage Numbers

telnyx number list
telnyx number list --status active
telnyx number list --tag production

telnyx number get [phone]
telnyx number update [phone] --connection-id <id>
telnyx number update [phone] --tags production,us-west
telnyx number delete [phone] --force
telnyx number delete [phone] --dry-run

Messaging

Send Messages

# Send SMS
telnyx message send --from [phone] --to [phone] --text "Hello!"
telnyx message send -f [phone] -t [phone] --text "Hello!"

# Send MMS
telnyx message send --from [phone] --to [phone] \
  --text "Check this out" \
  --media https://example.com/image.jpg

List & Retrieve

telnyx message list
telnyx message list --direction outbound --limit 50
telnyx message list --from [phone]
telnyx message get <message-id>

Messaging Profiles

telnyx messaging-profile list
telnyx messaging-profile get <id>
telnyx messaging-profile create --name "Production" --webhook-url https://...
telnyx messaging-profile update <id> --webhook-url https://...
telnyx messaging-profile delete <id> --force

Voice

Make Calls

telnyx call dial --from [phone] --to [phone] --connection-id <id>
telnyx call dial -f [phone] -t [phone] --connection-id <id>

# With answering machine detection
telnyx call dial --from [phone] --to [phone] \
  --connection-id <id> \
  --answering-machine-detection detect

Call Control

telnyx call list
telnyx call list --direction outgoing --status active
telnyx call hangup <call-control-id>
telnyx call speak <call-control-id> "Hello, how can I help you?"
telnyx call transfer <call-control-id> [phone]
telnyx call playback <call-control-id> --audio-url https://...

Voice Profiles & Connections

telnyx voice-profile list
telnyx voice-profile get <id>
telnyx voice-profile create --name "Production" --concurrent-call-limit 100

telnyx connection list
telnyx connection list --type credential
telnyx connection create --name "My Voice App" --type credential --webhook-url https://...

10DLC

Interactive Setup

telnyx 10dlc wizard                  # Guided setup wizard

Brand Management

telnyx 10dlc brand list
telnyx 10dlc brand get <brand-id>
telnyx 10dlc brand create --display-name "My Company" --entity-type PRIVATE_PROFIT

Campaign Management

telnyx 10dlc campaign list
telnyx 10dlc campaign get <campaign-id>
telnyx 10dlc campaign create --brand-id <id> --use-case MARKETING

Billing

telnyx billing balance               # Check account balance

Verification

telnyx verify start [phone] --channel sms
telnyx verify check <verification-id> --code 123456

Shell Autocomplete

telnyx autocomplete                  # Setup instructions
telnyx autocomplete bash             # Bash completion script
telnyx autocomplete zsh              # Zsh completion script

Global Options

Flag	Description
--api-key <key>	Override API key
--profile <name>	Use specific profile
--json	Output as JSON
--help	Show command help
--version	Show CLI version
--dry-run	Preview without executing (some commands)

Migration to New CLI

See the Legacy CLI Overview for a command mapping to the new Go-based CLI.