Obtaining the Cloud Phone Access Information

Function

This API is used to obtain the cloud phone access information.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/cloud-phone/phones/batch-connection

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
phone_ids	Yes	Array of strings	Specifies the phone_id array. A maximum of 10 cloud phone IDs can be requested at a time.
client_type	Yes	String	Specifies the type of the client that needs to access the cloud phone. ANDROID: Android SDK WINDOWS: Microsoft Windows SDK H5_MOBILE: H5 SDK for mobile terminals H5_PC: H5 SDK for PCs iOS: iOS SDK

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the unique request ID.
connect_infos	Array of ConnectInfo objects	Specifies information about the cloud phones that have been accessed.
errors	Array of ConnectErrorInfo objects	Specifies the error message list.

**Table 5** ConnectInfo
Parameter	Type	Description
phone_id	String	Specifies the unique ID of the cloud phone.
access_info	access_info object	Specifies information about the cloud phone that has been accessed.

**Table 6** access_info
Parameter	Type	Description
access_ip	String	Specifies the EIP for accessing the cloud phone.
intranet_ip	String	Specifies the virtual IP address for accessing the cloud phone.
access_ipv6	String	Specifies the IPv6 address of the cloud phone server.
access_port	Integer	Specifies the port for accessing the cloud phone.
session_id	String	Specifies the ID of the session accessed this time.
timestamp	String	Specifies the timestamp.
ticket	String	Specifies the signature token.

**Table 7** ConnectErrorInfo
Parameter	Type	Description
phone_id	String	Specifies the cloud phone ID.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Obtaining the cloud phone access information

POST https://{CPHEndpoint}/v1/{project_id}/cloud-phone/phones/batch-connection

{
  "client_type" : "ANDROID",
  "phone_ids" : [ "1564567b8bab40f34711234cb80d8574", "1234567b8bab40ffb711234cb80d0234", "1234567b8bab40ffb711234cb8654321" ]
}

Example Responses

Status code: 200

{
  "request_id" : "70bb40bef50e4a14b116a5a527fd7432",
  "connect_infos" : [ {
    "phone_id" : "1564567b8bab40f34711234cb80d8574",
    "access_info" : {
      "access_ip" : "213.32.43.22",
      "intranet_ip" : "192.168.0.25",
      "access_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d",
      "access_port" : 14308,
      "session_id" : "9864567a7bab40f34711234cb8087474",
      "timestamp" : "122478329742",
      "ticket" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  } ],
  "errors" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "error_code" : "CPS.0018",
    "error_msg" : "Access info not found."
  }, {
    "phone_id" : "1234567b8bab40ffb711234cb8654321",
    "error_code" : "CPS.0005",
    "error_msg" : "Phone not found."
  } ]
}