设备信息

更新时间:
复制 MD 格式

设备信息查询

根据用户 ID 或设备 ID 获取设备信息,包含设备绑定信息、设备关联的厂商信息、安卓系统设备是否在线等。

入参

参数

类型

是否必选

示例

描述

appId

String

ONEX570DA89211721

应用 ID

workspaceId

String

default

工作空间 ID

tenantId

String

LZFPEFIM

租户 ID

targetType

Integer

2

目标类型:

  • 1 - 设备

  • 2 - 用户

target

String

push_test_user

  • 当 targetType=1 时,target 是设备 ID

  • 当 targetType=2 时,target 是用户 ID

出参

参数

类型

示例

描述

requestId

String

6FF637EA-D55D-1A4E-8443-DF28688E61B8

请求 ID

success

Boolean

true

结果

code

String

100

结果码

message

String

SUCCESS

结果信息

data

Object

-

结果内容

data

参数

类型

示例

描述

userId

String

push_test_user

用户 ID

deviceId

String

ae6f2a800196100080003030ac10010a396

设备 ID

deliveryToken

String

ae6f2a800196100080003030ac10010a396

自建 Token

thirdToken

String

IQAAAACy0f7tAABYiMwLEENtr0TKYJEsv7wyu4Ubt9XXwTJAlknnCb1LAzB3wJvoZIcT_nJdaMhEoXJaqQrObAGHLGoU1GOexlTcLWzja-0HfGHKBw

厂商 Token

platform

String

android

平台:

  • android

  • ios

  • harmonyos

manufacturer

String

hms

厂商:

  • unknown

  • android

  • ios

  • miui

  • hms

  • fcm

  • oppo

  • vivo

  • honor

  • harmonyos

statue

String

ONLINE

状态(iOS 和鸿蒙系统默认 UNKNOW)

  • ONLINE

  • OFFLINE

  • UNKNOW

使用示例

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.PushQueryDeviceStateRequest;
import com.aliyun.mpaas20201028.models.PushQueryDeviceStateResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
    // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里。
    // 建议先完成环境变量配置
    Config config = new Config();
    // 必填,您的 AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // 必填,您的 AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // mPaaS 的 REGION_ID 和 Endpoint,以杭州非金为例
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    PushQueryDeviceStateRequest request = new PushQueryDeviceStateRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setTargetType(2);
    request.setTarget("push_test");
    PushQueryDeviceStateResponse pushQueryDeviceStateResponse = client.pushQueryDeviceState(request);
    System.out.println("response==>"+ JSON.toJSONString(pushQueryDeviceStateResponse));
}

结果码

结果码

结果信息

描述

100

SUCCESS

成功

3028

INVALID_PARAM

请检查一下参数

8011

FLOW_CONTROL_ERROR

流量控制

8012

INVALID_INSTANCE_ID

请检查一下 appId 和 workspaceId

8013

INVALID_TENANT_ID

非法 tenantId

8014

ACCOUNT_NO_PERMISSION

no permission

9000

SYSTEM_ERROR

系统异常