该接口可以为指定用户添加用户标签。

功能描述

云信支持为用户添加用户标签，后续可通过设置的标签向标签中的用户发送推送消息，具体可参考 发送标签用户推送。

• 每次最多只能为 100 个用户添加标签，并且单个用户添加的标签数最多为 10 个。
• 单个用户的最大标签数为 100 个，若用户当前标签超过 100 个，则在添加新标签之前请先删除旧标签。
• 单个应用的最大标签数为 1000 个，即所有用户的标签去重复后加和的数量为最多 1000 个。
• 单个标签最大长度不超过 50。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求信息

请求 URL

PATCH https://{endpoint}/im/v2/user_tags

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

请求体参数

参数名称	类型	是否必选	说明
- user_tags	Array of objects	是	需要添加标签的用户及其标签。
account_id	String	是	用户的 IM 账号 ID。
tags	Array of strings	是	用户的标签列表，JSONArray 格式。

请求体示例

JSON{
    "user_tags": [
        {
            "account_id": "zhangsan",
            "tags": [
                "a",
                "b",
                "c"
            ]
        },
        {
            "account_id": "lisi",
            "tags": [
                "d",
                "e",
                "f"
            ]
        }
    ]
}

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
success_list	Array of strings	操作成功的云信账号列表。	否
- failed_list	Array of objects	操作失败的用户信息。	否
account_id	String	用户的 IM 账号 ID。	否
error_code	Integer	错误码。	否
error_msg	String	错误信息。	否

响应体示例

JSON{
    "code":200,
    "msg":"success",
    "data":{
        "success_list":[
            "zhangsan"
        ],
        "failed_list":[{
            "account_id": "lisi",
            "error_code": 102404,
            "error_msg":"error"
        }]
    }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
403	系统推送功能未开启	push is disabled
414	参数错误	parameter error
102404	用户不存在	account not exist
122434	应用下的用户标签数量超限	app user tag limit
122435	用户下的标签数量超限	user tag limit
500	服务器内部错误	internal server error