Get Device Information

Restriction: This API endpoint is not supported in the public cloud.
Restriction: This API endpoint is not supported in the Free Trial cloud.

Retrieves the information for the device specified by <deviceId>

Users can only get information for devices that are accessible by their roles.

URL

Copy 
https://<your_cloud>.app.perfectomobile.com/api/v1/device-management/devices/<DEVICE_ID>

Method

GET

For information on a previous version of this endpoint, see Get Device Information | Legacy.

Header parameters

Name

Description

Perfecto-Authorization

The Perfecto security token. For more information, see Generate security tokens.

Request parameters

Name

Type

Default

Description

admin

boolean

false

true to provide administrative information in the response. This is permitted only for users with administrative credentials, for devices that the user is allowed to administrate.

Success response

Code: 200 OK

Copy 
{
    "handset": {
        "osBuild": "<<OS_BUILD_VALUE>>",
        "modelVersion": "<<MODEL_VERSION_VALUE>>",
        "link": {
            "type": "<<LINK_TYPE_VALUE>>"
        },
        "available": true|false,
        "description": "<<DESCRIPTION>>",
        "debugLogs": {
            "collecting": false|true
        },
        "language": "<<LANGUAGE>>",
        "imsi": <<IMSI_NUMBER>>,
        "deviceId": "<<DEVICE_ID>>",
        "resolution": "RESOLUTION_VALUE",
        "operator": {
            "country": "<<COUNTRY>>",
            "code": <<CODE>>,
            "name": "<<NAME>>",
            "content": "<<CONTENT>>"
        },
        "manufacturer": "<<MANUFACTURER_VALUE>>",
        "wifiMacAddress": "<<WIFI_MAC_ADDRESS>>",
        "mode": "<<MODE_VALUE>>",
        "productVersion": "<<PRODUCT_VERSION>>",
        "cradleId": "<<CRADLE_ID>>",
        "osVersion": "<<OS_VERSION>>",
        "inUse": false|true,
        "model": "<<MODEL_VALUE>>",
        "firmware": "<<FIRMWARE_VALUE>>",
        "os": "<<OS_VALUE>>",
        "cpuArch": "<<CPU_ARCH_VALUE>>",
        "originalDeviceId": "<<ORIGINAL_DEVICE_ID>>",
        "timeStamp": <<TIMESTAMP>>,
        "phoneNumber": "<<PHONE_NUMBER>>",
        "lastCradleId": "<<LAST_CRADLE_ID>>",
        "reserved": false|true,
        "location": "<<LOCATION_VALUE>>",
        "operabilityRating": {
            "score": <<SCORE>>
        },
        "time": "<<GMT TIME>>",
        "distributer": "<<DISTRIBUTER_VALUE>>",
        "position": {
            "method": "<<METHOD_VALUE>>",
            "rotation": <<ROTATION_VALUE>>,
            "id": "<<ID>>"
        },
        "nativeImei": <<NATIVE_IMEI_VALUE>>,
        "status": "<<STATUS_VALUE>>"
    }
}
Copy 
{
    "handset": {
        "connectionProperties": {
            "property": [
                {
                    "name": "chromeDriver-port",
                    "content": <<VALUE>>
                },
                {
                    "name": "device-host",
                    "content": "<<VALUE>>"
                },
                {
                    "name": "device-host-type",
                    "content": "<<VALUE>>"
                },
                {
                    "name": "device-id",
                    "content": "<<VALUE>>"
                },
                {
                    "name": "dns-name",
                    "content": "<<VALUE>>"
                },
                {
                    "name": "host-port",
                    "content": "<<VALUE>>"
                },
                {
                    "name": "location",
                    "content": "<<VALUE>>"
                },
                {
                    "name": "real-id",
                    "content": "<<VALUE>>"
                },
                {
                    "name": "webView-port",
                    "content": "<<VALUE>>"
                }
            ]
        },
        "osBuild": "<<OS_BUILD_VALUE>>",
        "modelVersion": "<<MODEL_VERSION_VALUE>>",
        "roles": {
            "role": [
                "<<ROLES>>"
            ]
        },
        "link": {
            "type": "<<LINK_TYPE_VALUE>>"
        },
        "available": true|false,
        "description": "<<DESCRIPTION>>",
        "debugLogs": {
            "collecting": false|true
        },
        "language": "<<LANGUAGE>>",
        "imsi": "<<IMSI_NUMBER>>",
        "assetTag": "<<ASSET_TAG_VALUE>>",
        "deviceId": "<<DEVICE_ID>>",
        "resolution": "<<RESOLUTION>>",
        "operator": {
            "country": "<<COUNTRY>>",
            "code": <<COUNTRY_CODE>>,
            "name": "<<NAME>>",
            "content": "<<CONTENT>>"
        },
        "powerSupply": {
            "offlineCharging": "<<OFFLINE_CHARGING_VALUE>>",
            "source": "<<SOURCE_VALUE>>"
        },
        "manufacturer": "<<MANUFACTURER>>",
        "wifiMacAddress": "<<WIFI_MAC_ADDRESS>>",
        "mode": "<<MODE_VALUE>>",
        "productVersion": "<<PRODUCT_VERSION_VALUE>>",
        "cradleId": "<<CRADLE_ID>>",
        "osVersion": "<<OS_VERSION_VALUE>>",
        "inUse": false|true,
        "lastUsedBy": "<<LAST_USED_BY_USER_ID>>",
        "model": "<<MODEL_VALUE>>",
        "firmware": "<<FIRMWARE_VALUE>>",
        "os": "<<OS_VALUE>>",
        "cradle": {
            "id": "<<CRADLE_ID>>",
            "status": {
                "mode": "<<MODE_VALUE>>",
                "code": "<<CODE_VALUE>>",
                "description": "<<DESCRIPTION>>"
            }
        },
        "cpuArch": "<<CPU_ARCH_VALUE>>",
        "originalDeviceId": "<<ORIGINAL_DEVICE_ID>>",
        "timeStamp": <<TIMESTAMP>>,
        "phoneNumber": "<<PHONE_NUMBER>>",
        "lastCradleId": "LAST_CRADLE_ID",
        "lastUsedAt": {
            "formatted": "<<GMT TIME>>",
            "millis": <<TIME_IN_MILLIS>>
        },
        "reserved": false|true,
        "location": "<<LOCATION>>",
        "operabilityRating": {
            "score": <<SCORE_VALUE>>
        },
        "time": "<<GMT_TIME>>",
        "distributer": "<<DISTRIBUTER_VALUE>>",
        "position": {
            "method": "<<METHOD_VALUE>>",
            "rotation": <<ROTATION_VALUE>>,
            "id": "<<ID>>"
        },
        "nativeImei": <<NATIVE_IMEI>>,
        "status": "<<STATUS>>",
        "deviceLocation": "<<DEVICE_LOCATION>>"
    }
}

where: 

  • handset status can take on one of the following values:

    • Never Connected

    • Not Connected

    • Ready

    • Connected

    • Loading

    • Error

    • Unknown

    • Invalid

    • Ready to connect

    • Unsupported

  • mode can take on one of the following values:

    • NEVER_CONNECTED

    • NOT_CONNECTED

    • CONNECTED

    • LOADING

    • ERROR

    • READY_TO_CONNECT

    • UNSUPPORTED

Error response

Copy
Error response format
[
    {
        "userMessage":"ERROR_MESSAGE",
        "developerMessage": "1-63dbebb1-4521fab52df9f41a578221c8"
    }
]

where:

  • userMessage is the error message to be shown.

  • developerMessage is a value that you can send to Perfecto Support to check errors if further investigation is required.

Sample error responses

Copy

A wrong securityToken is passed in the request (Unauthorized Request Code - 401)

[
    {
        "userMessage": "Unable to authenticate bearer token",
        "developerMessage": "Unable to authenticate bearer token"
    }
]