Field and data conventions
Field and data conventions
Fields of forwarded endpoints follow the server data model. The conventions below apply to every list and detail response.
| Convention | Values | Details |
|---|---|---|
| Time | yyyy-MM-dd HH:mm:ss | Strings, not timestamps; the exception is createdAt of automation sessions, which is a millisecond number |
| Switches | ON · OFF | Fields such as actived, opened, and audioSwitch |
| Pagination input | page · size | Default 1 and 20; the server caps size at 1000; /sms/records caps it at 100, and /mail/pull always returns 10 per page |
| Keyword | keyword | Accounts match username/remark; proxies match host/username/activeIp/remark |
| Array query parameters | state=1&state=0 | Repeat the key to build an array; the state[]= form has no effect |
| Batch write collection | items | Backend commands read only items; batch creation needs items (or the accounts / proxyList aliases), and delete endpoints normalize every ID alias into items on the client |
| Team ownership | teamId | When accounts and proxies are saved, the server overrides it with the current team; passing it in the request has no effect |
| Proxy state | 0 · 1 · -1 · -2 | Pending check, available, unavailable, expired |
| Proxy enums | IPv4/IPv6 · SOCKS5/HTTP/HTTPS · CUSTOM/BUY | Map to ipVersion, protocol, and source |
| Window ID | windowId | The window's numeric primary key id, not its uuid |
| Window runtime state | local_running · occupied_by_other · closed | runtimeState of /browser/list; opened is only the server record and may be stale |
| Window binding fields | platformId · pluginId | JSON text of an ID array, such as "[5001,5002]", not an array |
| Amounts | USDT | Prices may be numbers or decimal strings; compute totals with fixed-point decimals, not floating-point multiplication |
| JSON text fields | product · resources · message · solution | In service records these fields are JSON strings and need to be parsed again |
Service IDs
The different service IDs cannot be substituted for one another:
| ID | Meaning | Where it is used |
|---|---|---|
productId from /ip/products | Standard proxy product ID | /ip/buy |
id from /proxy/list | Local proxy ID | items of /ip/renew |
id from /ip/orders | Local order ID | nexIpId of the short-term pull /ip/snap/pull |
tel from /sms/records | Full phone number string | /sms/pull, /sms/recover |
id from /mail/records | Local mailbox record ID | id of /mail/pull and /mail/detail |
data[].id from /mail/pull | Numeric email ID, not the Message-ID | mailId of /mail/detail |
id from /captcha/records | Local solving task ID, not taskId | /captcha/query |
What credentials leave the client
/account/list and /browser/list return platform account password and key2fa in plain text; /browser/accounts returns only masked usernames plus the hasPassword / has2fa flags. When you need to sign in, prefer account_fill, which keeps passwords and codes inside the client. resources in /ip/orders and the response of /ip/snap/pull contain proxy credentials in plain text.