Integration - CLI Tool 💻

ASG_ENDPOINT="https://api.sms-gate.app/3rdparty/v1"
ASG_USERNAME="your_username"
ASG_PASSWORD="your_password"

smsgate [global options] command [command options] [arguments...]

smsgate send [command options] 'Message content'

# Send a simple text message
smsgate send --phones '+12025550123' 'Hello, Dr. Turk!'

# Send to multiple numbers
smsgate send --phones '+12025550123' --phones '+12025550124' 'Hello, doctors!'

# Send with explicit device selection
smsgate send --phones '+12025550123' --device-id device123 'Message'

# Send with SIM number selection (1-based)
smsgate send --phones '+12025550123' --sim-number 2 'Message'

# Send with priority (>=100 bypasses limits)
smsgate send --phones '+12025550123' --priority 100 'Urgent message'

# Send with time-to-live (TTL)
smsgate send --phones '+12025550123' --ttl 1h30m 'Expiring message'

# Send with expiration date (RFC3339 format)
smsgate send --phones '+12025550123' --valid-until '2027-12-31T23:59:59Z' 'Message'

# Disable delivery report
smsgate send --phones '+12025550123' --delivery-report=false 'Message'

# Skip phone number validation
smsgate send --phones '+12025550123' --skip-phone-validation 'Message'

# Filter by device activity (devices active within last 12 hours)
smsgate send --phones '+12025550123' --device-active-within 12 'Message'

# Send data message (base64 encoded)
echo -n 'hello world' | base64
smsgate send --phones '+12025550123' --data --data-port 12345 'aGVsbG8gd29ybGQ='

smsgate status 'Message ID'

smsgate batch send [command options] filename.[csv|xlsx]

# Basic mapping with headers
smsgate batch send --map phone=Phone,text=Message contacts.csv

# Excel file with specific sheet
smsgate batch send --sheet Sheet1 --map phone=Phone,text=Message campaign.xlsx

# No headers, column positions
smsgate batch send --header=false --map phone=col_1,text=col_2 data.csv

# Full mapping with optional fields
smsgate batch send --map phone=Phone,text=Message,device_id=Device,sim_number=SIM,priority=Priority contacts.csv

smsgate batch send --map phone=Phone,text=Message --validate-only contacts.csv

smsgate batch send --map phone=Phone,text=Message --dry-run contacts.csv

smsgate batch send --map phone=Phone,text=Message --concurrency=5 contacts.csv

# Send with device and SIM selection
smsgate batch send --map phone=Phone,text=Message,device_id=Device,sim_number=SIM --concurrency=5 contacts.csv

# Send with priority
smsgate batch send --map phone=Phone,text=Message --priority 100 --concurrency=5 contacts.csv

# Send with TTL and delivery reports disabled
smsgate batch send --map phone=Phone,text=Message --ttl 1h --delivery-report=false contacts.csv

# Send with device filtering and validation skip
smsgate batch send --map phone=Phone,text=Message --device-active-within 12 --skip-phone-validation contacts.csv

# Basic batch send
smsgate batch send --map phone=Phone,text=Message contacts.csv

# Excel with custom sheet and no headers
smsgate batch send --sheet "Summer Campaign" --header=false --map phone=col_1,text=col_2 campaign.xlsx

# High concurrency with error continuation
smsgate batch send --map phone=Phone,text=Message --concurrency=10 --continue-on-error large_list.csv

# Send with device and SIM selection
smsgate batch send --map phone=Phone,text=Message,device_id=Device,sim_number=SIM device_specific.csv

# Priority-based sending
smsgate batch send --map phone=Phone,text=Message,priority=Priority priority_campaign.csv

smsgate webhooks register [options] URL

smsgate webhooks list

smsgate webhooks delete 'Webhook ID'

smsgate logs [options]

# Send a message
smsgate send --phones '+12025550123' 'Hello, Dr. Turk!'

# Send a message to multiple numbers
smsgate send --phones '+12025550123' --phones '+12025550124' 'Hello, doctors!'
# or
smsgate send --phones '+12025550123,+12025550124' 'Hello, doctors!'

# Send messages from a CSV file
smsgate batch send --map phone=Phone,text=Message contacts.csv

# Send messages from an Excel file with specific sheet
smsgate batch send --sheet Sheet1 --map phone=Phone,text=Message campaign.xlsx

# Validate input without sending (dry run)
smsgate batch send --map phone=Phone,text=Message --dry-run contacts.csv

# Send with custom concurrency and continue on errors
smsgate batch send --map phone=Phone,text=Message --concurrency=5 --continue-on-error contacts.csv

# Get the status of a sent message
smsgate status zXDYfTmTVf3iMd16zzdBj

# Get logs for the last 24 hours (default)
smsgate logs

# Get logs for a specific time range
smsgate logs --from '2024-01-15T00:00:00Z' --to '2024-01-15T23:59:59Z'

# Get logs with custom time range and output format
smsgate --format json logs --from '2024-01-15T10:00:00+07:00' --to '2024-01-15T18:00:00+07:00'

# Register a webhook for received messages
smsgate webhooks register --event 'sms:received' 'https://example.com/webhook'

# List all registered webhooks
smsgate webhooks list

# Delete a webhook
smsgate webhooks delete 'webhook-id'

docker run -it --rm --env-file .env ghcr.io/android-sms-gateway/cli \
  send --phone '+12025550123' 'Hello, Dr. Turk!'