An API for every phone.
Manage a phone and its proxies from your tools. Its API address stays the same when switching relays.
Authentication & permissions
Issue a key from the phone API page. Read keys retrieve data; manage keys allow creation, changes and commands. Neither grants server, user or billing administration.
GET /api/connection/v1/{phone_id}
Authorization: Bearer YOUR_PHONE_API_KEY
Accept: application/jsonTreat the key as a secret. Set an expiry, rotate or revoke it when needed. Keep it out of URLs and public browser code.
Phone endpoints
Append the following paths to the phone API base address.
| Request | Purpose |
|---|---|
| GET / | Phone status and settings |
| GET /proxy-access | List phone proxies |
| POST /proxy-access | Create proxy |
| PATCH /proxy-access/{id} | Update proxy limits and credentials |
| DELETE /proxy-access/{id} | Delete proxy |
| PATCH /settings | Phone & network settings |
| POST /rotate | Rotate IP |
| GET /commands | Command results |
| POST /commands | Operations |
| GET /relays | Available servers |
| POST /switch | Move phone to an available server |
Create an independent connection
Choose a name and protocol. The port and credentials are generated automatically. Connection limits cannot exceed the phone subscription.
POST /api/connection/v1/{phone_id}/proxy-access
Content-Type: application/json
Authorization: Bearer YOUR_PHONE_API_KEY
{"name": "Browser", "protocol": "http"}Responses & errors
401: invalid or expired key. 403: insufficient permission. 404: phone or connection outside your access. 409: conflict or plan limit. 503: relay unavailable. Follow asynchronous command status before treating it as successful.
Contact support →