Help Center/ CloudDevice/ API Reference/ APIs/ Instance Management/ Canceling Instance Assignment
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Canceling Instance Assignment

Function

Before calling this API, ensure that the tenant has purchased an instance. This API is used to cancel the assignment of a cloud phone to a user specified by a tenant. After the API is called, the cloud phone usage data of the user is cleared.

URI

POST /v1/instances/unassign

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-request-id

Yes

String

Unique ID of a request.

X-Auth-Token

Yes

String

Tenant-level token.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

user_instances

Yes

Array of UserInstanceInfo objects

User instance information.
Table 3 UserInstanceInfo

Parameter

Mandatory

Type

Description

user_id

Yes

String

User ID. The value can contain a maximum of 32 characters.

instance_id

Yes

String

Instance ID. The value can contain a maximum of 32 characters.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

0: successful.

KOOPHONE.API.0000: The tenant does not exist.

KOOPHONE.API.1000: The request parameter is incorrect.

KOOPHONE.API.1001: Insufficient instance permissions.

KOOPHONE.API.2210: The binding relationship between the user and the instance does not exist.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

0: successful.

KOOPHONE.API.0000: The tenant does not exist.

KOOPHONE.API.1000: The request parameter is incorrect.

KOOPHONE.API.1001: Insufficient instance permissions.

KOOPHONE.API.2210: The binding relationship between the user and the instance does not exist.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

0: successful.

KOOPHONE.API.0000: The tenant does not exist.

KOOPHONE.API.1000: The request parameter is incorrect.

KOOPHONE.API.1001: Insufficient instance permissions.

KOOPHONE.API.2210: The binding relationship between the user and the instance does not exist.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Example Requests

/instances/unassign

{
  "user_instances" : [ {
    "instance_id" : "a44uhlf7",
    "user_id" : 1123422
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Normal response.

400

Request error.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Instance Management