SOP-002: Get Modem Information
Fresh| Field | Value |
|---|---|
| Document ID | SOP-002 |
| Version | 1.0 |
| Status | Active |
| Plan Required | Essential+ |
Overview
Retrieve detailed information about all connected modems including IP addresses, signal strength, and connection status.
Prerequisites
- Valid API token (SOP-001)
- Proxidize Essential, Plus, or Business plan
Procedure
API Endpoint
GET /api/getinfoRequest Example
cURL:
bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
http://YOUR_SERVER_IP/api/getinfoJavaScript:
javascript
const response = await fetch('http://YOUR_SERVER_IP/api/getinfo', {
headers: { 'Authorization': 'Token YOUR_API_TOKEN' }
});
const modems = await response.json();
console.log(modems);Response Format
The API returns a JSON object containing information for each modem:
json
{
"modems": [
{
"index": 1,
"ip": "192.168.1.101",
"public_ip": "203.0.113.45",
"signal": "excellent",
"carrier": "Verizon",
"status": "connected",
"phone_number": "+15551234567"
},
{
"index": 2,
"ip": "192.168.1.102",
"public_ip": "203.0.113.46",
"signal": "good",
"carrier": "AT&T",
"status": "connected",
"phone_number": "+15559876543"
}
]
}Response Fields
| Field | Description |
|---|---|
index | Modem index number (used in other API calls) |
ip | Private IP address |
public_ip | Public IP address |
signal | Signal strength (excellent/good/fair/poor) |
carrier | Mobile carrier name |
status | Connection status |
phone_number | SIM card phone number |
Verification Checklist
- [ ] Request returns HTTP 200
- [ ] Response is valid JSON
- [ ] Modem count matches physical devices
- [ ] All modems show correct status
Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| Empty response | No modems connected | Check USB connections |
| Missing modem | Modem not detected | Reboot modem or check drivers |
| Stale IP data | Cached response | Wait and retry request |