Menu

Share Cloud Phone

Usage Instructions

Share Cloud Phone.

Request Instructions

POST /api/v1/cloudPhone/share

Request Parameters

Parameter Type Required Description
share array Yes Share Cloud Phone information

share

Parameter Type Required Description
image_ids array Yes Cloud phone IDs
config Object No Configuration information. If not provided, the default configuration will be used

config

Parameter Type Required Description
share_status integer No Share switch. 1 for On; 2 for Off. Default: Off
share_phone_type integer No Startup mode. 1 for Prioritize Subscription Startup; 2 for Subscription Startup 3 for Temporary Startup. Default: Prioritize Subscription Startup
share_code string No Share password. Must meet the format requirements: length 8-20 characters, combination of digits and uppercase/lowercase letters. Defaults: Random
share_auth array No Functional permissions. 1 for Reset Device; 2 for Factory reset; 3 for Edit Params; 4 for Cloud Drive. Defaults: Empty

Request Example

json Copy
{
    "share": [
        {
            "image_ids": [
                "xxx",
                "xxx"
            ],
            "config": {
                "share_status": 1,
                "share_phone_type": 3,
                "share_code": "xxxxxxxx",
                "share_auth": [
                    3,
                    4
                ]
            }
        },
        {
            "image_ids": [
                "xxx"
            ],
            "config": {
                "share_status": 2
            }
        },
        {
            "image_ids": [
                "xxx"
            ]
        }
    ]
}

Response Example

json Copy
{
    "code": 200,
    "data": {
        "xxxx": "https://xxxxxx?id=xxxx&name=xxx",  // Cloud phone ID: Sharing link
        "xxxx": ""     // If sharing is disabled, the link will be empty.
    },
    "message": "Success"
}
Previous
Write SMS to Cloud Phone
Next
Subscription Startup
Last modified: 2026-03-18Powered by