Skip to content
API Reference
/
/
/
Set cloud phone proxy

Set cloud phone proxy

Request

Bind a proxy to one or more Cloud Phones.

  • Preconditions: provide at least one of ids or uniqueIds. The phones must belong to your team; they do not need to be powered on. A supplied proxyId must exist, otherwise the call is rejected.
  • Effect: when proxyId is omitted or 0, an existing proxy with identical connection details is reused and a new proxy record is created in your team if none matches. The proxy check state is reset and the previous proxy is remembered.
  • Completion: synchronous. Phones that are powered on receive the new proxy immediately — no restart is needed; powered-off phones pick it up on next start.
  • Retry: rebinding an existing proxyId is idempotent, but repeating a call that carries raw connection details can create another proxy record each time deduplication misses.

Documented business errors: 33300, 33303, 33320, 14023. See Error Codes for what each code means. Any operation can additionally return the common codes.

Security
Authorization
Bodyapplication/jsonrequired
idsArray of strings

List of cloud phone environment IDs

Example:
[
  "1558968155668507"
]
uniqueIdsArray of integers

List of display sequence IDs of cloud phone environments (used as reference mapping if envIds are not provided)

Example:
[
  1001
]
proxyobject(CloudPhoneProxyDto)

Proxy settings

curl -i -X POST \
  https://api.morelogin.com/cloudphone/setProxy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "1558968155668507"
    ],
    "uniqueIds": [
      1001
    ],
    "proxy": {
      "proxyIp": "192.168.1.100",
      "proxyPort": 8080,
      "proxyProvider": 2
    }
  }'

Responses

Success. data is always null for this operation; the outcome is carried by code.

Bodyapplication/json
codeinteger

Response code: 0 = success, >0 = error

datanull
msgstring or null

Message; populated if code > 0

requestIdstring

Unique request identifier; include it when contacting support

Response
{
  "code": 0,
  "data": null,
  "msg": null,
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}