User Guide
Learn how to set up and use Pathway to send SMS through your Android device.
1 Install the Android Gateway
Download the APK
Go to the download page and get the latest app-debug.apk file.
Install on Android
Transfer the APK to your Android device and install it. You may need to enable "Install from unknown sources" in your settings.
Grant Permissions
Open the app and grant the required permissions: SMS, Phone, and Notifications. These are needed to send SMS and run USSD codes.
2 Configure the Gateway
Set your API Key
Enter a secure API key that will be used to authenticate requests. This should be kept secret.
Note the IP Address
The app will display your device's local IP address (e.g., 192.168.1.100). You'll need this to connect from the desktop.
Start the Server
Tap "Start Server" to begin accepting API requests. The server runs on port 8080 by default.
3 Connect the Desktop Dashboard
Install Desktop App
Download and install the desktop app for your operating system from the download page.
Add Your Device
In the desktop app, add a new device with the IP address and API key from your Android gateway.
Start Sending SMS
Once connected, you can send individual messages or bulk campaigns through the dashboard!
API Usage
Send SMS
POST /sms
curl -X POST http://192.168.1.100:8080/sms \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"number": "+1234567890", "message": "Hello!"}'
Run USSD Code
POST /ussd
curl -X POST http://192.168.1.100:8080/ussd \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"code": "*123#"}'
Health Check
GET / (no auth required)
curl http://192.168.1.100:8080/
# Response: {"status": "online"}
Tips for Best Performance
🔋 Battery Optimization
Disable battery optimization for the Pathway app to ensure it keeps running in the background.
🌐 Static IP
Consider assigning a static IP to your Android device in your router settings for consistent connectivity.
🔌 Keep Plugged In
For 24/7 operation, keep your device connected to power and enable "Keep screen on" in the app.
📱 Multiple Devices
Use multiple Android gateways for load balancing and to avoid carrier rate limits.