Command Reference

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

# 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 +15551234567
telnyx number order +15551234567 +15559876543 --messaging-profile-id <id>

[
  {
    "phone_number": "+12025551234",
    "region_information": [{"region_type": "state", "region_name": "DC"}],
    "cost_information": {"upfront_cost": "1.00", "monthly_cost": "1.00"},
    "features": ["sms", "mms", "voice", "fax"]
  },
  {
    "phone_number": "+12025555678",
    "region_information": [{"region_type": "state", "region_name": "DC"}],
    "cost_information": {"upfront_cost": "1.00", "monthly_cost": "1.00"},
    "features": ["sms", "mms", "voice"]
  }
]

# List your numbers
telnyx number list
telnyx number list --status active
telnyx number list --tag production

# Get number details
telnyx number get +15551234567

# Update number settings
telnyx number update +15551234567 --connection-id <id>
telnyx number update +15551234567 --messaging-profile-id <id>
telnyx number update +15551234567 --tags production,us-west

# Release a number
telnyx number delete +15551234567 --force
telnyx number delete +15551234567 --dry-run

# Send SMS
telnyx message send --from +15551234567 --to +15559876543 --text "Hello!"
telnyx message send -f +15551234567 -t +15559876543 --text "Hello!"

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

{
  "id": "4010101e-b673-4a0b-b677-3c82fc7bfee2",
  "record_type": "message",
  "direction": "outbound",
  "from": {"phone_number": "+15551234567"},
  "to": [{"phone_number": "+15559876543", "status": "queued"}],
  "text": "Hello!",
  "messaging_profile_id": "4001170e-b673-4a0b-aa77-3c82ea7bf442"
}

telnyx message list
telnyx message list --direction outbound --limit 50
telnyx message list --from +15551234567
telnyx message get <message-id>

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

# Dial outbound call
telnyx call dial --from +15551234567 --to +15559876543 --connection-id <id>
telnyx call dial -f +15551234567 -t +15559876543 --connection-id <id>

# With answering machine detection
telnyx call dial --from +15551234567 --to +15559876543 \
  --connection-id <id> \
  --answering-machine-detection detect

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> +15559876543
telnyx call playback <call-control-id> --audio-url https://...

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

telnyx connection list
telnyx connection list --type credential
telnyx connection get <id> --type credential
telnyx connection create --name "My Voice App" --type credential --webhook-url https://...
telnyx connection delete <id> --type credential --force

telnyx 10dlc wizard                  # Guided setup wizard

telnyx 10dlc brand list
telnyx 10dlc brand get <brand-id>
telnyx 10dlc brand create \
  --entity-type PRIVATE_PROFIT \
  --display-name "My Company" \
  --company-name "My Company Inc" \
  --ein 12-3456789 \
  --phone +15551234567 \
  --street "123 Main St" \
  --city "San Francisco" \
  --state CA \
  --postal-code 94102 \
  --country US \
  --vertical TECHNOLOGY \
  --website https://example.com

# Sole proprietor brand
telnyx 10dlc brand create --sole-prop \
  --display-name "My Business" \
  --phone +15551234567 \
  --email [email protected]

# Verify brand with OTP
telnyx 10dlc brand verify <brand-id> --pin <OTP>

telnyx 10dlc campaign list
telnyx 10dlc campaign get <campaign-id>
telnyx 10dlc campaign create \
  --brand-id <id> \
  --usecase MIXED \
  --description "Customer notifications" \
  --sample-message-1 "Your order has shipped" \
  --sample-message-2 "Your appointment is tomorrow"

# Assign number to campaign
telnyx 10dlc assign +15551234567 <campaign-id>

# Check assignment status
telnyx 10dlc assignment status +15551234567

telnyx 10dlc usecases                # List available use cases
telnyx 10dlc verticals               # List business verticals

telnyx verify profile list
telnyx verify profile get <id>
telnyx verify profile create --name "my-app" --default-verification-timeout-secs 300
telnyx verify profile delete <id> --force

telnyx verify template list
telnyx verify template create --text "Your {{app_name}} code is {{code}}. Do not share."
telnyx verify template get <id>

# Send verification code
telnyx verify send --phone +15551234567 --profile-id <id>
telnyx verify send --phone +15551234567 --profile-id <id> --type call

# Check submitted code
telnyx verify check --phone +15551234567 --code 123456 --profile-id <id>

telnyx fax send \
  --from +15551234567 \
  --to +15559876543 \
  --media-url https://example.com/document.pdf \
  --connection-id <id>

telnyx fax list
telnyx fax list --direction outbound
telnyx fax get <fax-id>
telnyx fax delete <fax-id> --force

telnyx lookup +15551234567
telnyx lookup +15551234567 --type carrier
telnyx lookup +15551234567 --type caller-name

telnyx billing balance               # Check account balance
telnyx billing group list            # List billing groups
telnyx billing group get <id>        # Get billing group details

# Chat with AI models
telnyx ai chat "What is the capital of France?"
telnyx ai chat "Summarize this: ..." --model llama3

# Generate embeddings
telnyx ai embed "Your text here"

telnyx storage bucket list
telnyx storage bucket create my-bucket
telnyx storage bucket delete my-bucket --force

# Upload
telnyx storage object put my-bucket/path/file.txt --file ./local-file.txt
telnyx storage object put my-bucket/image.jpg --file ./photo.jpg

# Download
telnyx storage object get my-bucket/path/file.txt --output ./downloaded.txt

# List
telnyx storage object list my-bucket
telnyx storage object list my-bucket --prefix "images/"

# Delete
telnyx storage object delete my-bucket/path/file.txt --force

telnyx video room list
telnyx video room create --name "Team Meeting" --max-participants 10
telnyx video room get <room-id>
telnyx video room delete <room-id> --force

telnyx video session list --room-id <id>
telnyx video recording list
telnyx video recording get <recording-id>
telnyx video recording delete <recording-id> --force

telnyx e911 address list
telnyx e911 address create \
  --street "123 Main St" \
  --city "San Francisco" \
  --state CA \
  --postal-code 94102 \
  --country US
telnyx e911 address delete <id> --force

telnyx porting order list
telnyx porting order get <order-id>
telnyx porting order create --numbers +15551234567,+15559876543

telnyx usage list
telnyx usage list --product messaging --start-date 2024-01-01 --end-date 2024-01-31
telnyx usage get <report-id>

telnyx --help                        # General help
telnyx <command> --help              # Command-specific help
telnyx number --help                 # Topic help
telnyx number search --help          # Subcommand help