tencent cloud

移动推送

产品动态
公告
产品功能动态
Android SDK 发布动态
iOS SDK 发布动态
macOS SDK 发布动态
产品简介
产品概述
产品优势
应用场景
全球化部署
购买指南
价格总览
购买指引
计费模式
免费试用
欠费说明
快速入门
创建产品和应用
Android 快速接入
iOS 快速接入
创建推送任务
查询推送记录
推送测试方法指引
产品限制说明
操作指南
推送管理
推送高级功能
实践教程
iOS 平台角标功能实践
API 文档
简介
API 概览
调用方式
推送相关接口
标签相关接口
账号相关接口
统计相关接口
用户属性相关接口
服务端错误码
服务端 SDK
API（Java）
SDK 文档
Android 接入指南
iOS 接入指南
客户端集成插件
macOS接入指南
用户及权限
快速入门配置
进阶自定义配置
资源标签
服务协议
服务等级协议
开发者协议
常见问题
iOS 常见问题
Android 常见问题
Flutter 常见问题
其他问题
移动推送政策
移动推送隐私协议
TPNS 数据处理和安全协议
Developer Agreement
联系我们
词汇表
文档移动推送API 文档用户属性相关接口

用户属性相关接口

PDF
聚焦模式
字号
最后更新时间： 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"
        }
    }
}

上一篇: 根据 Token 查询当天所有推送任务下一篇: 服务端错误码

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈