Obtaining the Cloud Phone Access Information
Function
This API is used to obtain the cloud phone access information.
URI
POST /v1/{project_id}/cloud-phone/phones/batch-connection
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Request 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. |
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.
|
Response Parameters
Status code: 200
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. |
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. |
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. |
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
OK
{ "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." } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot