tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

用户属性相关接口

最后更新时间：2024-01-17 14:26:44

    接口说明

    请求方式：POST。
    服务地址/v3/device/set_custom_attribute
    接口服务地址与服务接入点一一对应，请选择与您的应用服务接入点对应的 服务地址。
    接口功能：用于 token 级别的个性化属性配置，包括增加、删除、更新、查询功能。

    参数说明

    请求参数

    参数名称
    是否必填
    类型
    描述
    cmd
    是
    Integer
    操作类型：
    1：新增属性
    2：更新属性
    3：删除属性
    4：删除所有属性
    5：查询属性
    token
    是
    String
    TPNS 为设备分配的唯一 ID
    获取 Token交互建议（Android）
    获取 Token 交互建议（iOS）
    
    attributeInfo
    
    当 cmd=1，2，3时必填
    Map
    属性详情，参考下方 attributeMap 描述
    attributeMap
    当 cmd=1，2，3时必填
    Map
    属性详情：
    key 为 属性名，长度限制为50字节 注意：需要已经在【控制台】>【配置管理】>【用户属性管理】中创建属性，否则会被过滤掉，并返回 invalidAttribute。
    value 为属性值，长度限制为50字节

    返回参数

    参数名称
    是否必定返回
    类型
    描述
    retCode
    是
    Integer
    错误码，详细参照 错误码对照表 。
    errMsg
    是
    String
    请求出错时的错误信息。
    attributeInfo
    cmd = 5
    Map
    属性详情。
    invalidAttribute
    属性无效时
    Array
    无效属性详情。

    示例说明

    新增属性

    请求示例

    为单个 token 增加3个属性。
    {
        "cmd": 1,
        "token": "04cac74a714f61bf089987a986363d88****",   
        "attributeInfo": {
             "attributeMap": {
                "age": "100",
                "name": "Ming",
                "high": "2.66"
            }
        }
    }
    
    

    应答示例

    {
        "retCode": 0,
        "errMsg": "success",
        "invalidAttribute": [
            "high"   // 控制台上没有对应的 key 值
        ]
    }

    更新属性

    请求示例

    更新属性“name”对应的值“workman”。
    {
        "cmd": 2,    
        "token": "04cac74a714f61bf089987a986363d88****",
        "attributeInfo": {
             "attributeMap": {
                "name": "workman"   
            }
        }
    }
    
    
    

    应答示例

    {
        "retCode": 0,
        "errMsg": "success"
    }

    删除属性

    请求示例

    删除属性“name”对应的值“workman”。
    {
        "cmd": 3,    
        "token": "04cac74a714f61bf089987a986363d88****",
        "attributeInfo": {
             "attributeMap": {
                "name": "workman"  
            }
        }
    }
    
    
    

    应答示例

    {
        "retCode": 0,
        "errMsg": "success"
    }

    删除所有属性

    请求示例

    删除该 token 下的所有属性。
    {
        "cmd": 4,    
        "token": "04cac74a714f61bf089987a986363d88****"  
    
    }

    应答示例

    {
        "retCode": 0,
        "errMsg": "success"
    }

    查询属性

    请求示例

    查询该 token 下的属性详情。
    {
        "cmd": 5,    
        "token": "04cac74a714f61bf089987a986363d88****"
    
    }

    应答示例

    {
        "retCode": 0,
        "errMsg": "success",
        "attributeInfo": {
            "attributeMap": {
                "nickname": "workman"
            }
        }
    }
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款