tencent cloud

Boost Engagement with Tencent RTC Free TrialFree video and chat features await!

文档反馈

即时通信 IM

删除用户属性

最后更新时间:2025-01-14 14:31:39

功能说明

管理员给用户删除属性。注意每次最多只能给100个用户删除属性。使用前请先 设置应用属性名称

接口调用说明

“全员推送”为 IM 专业版、专业版Plus、企业版功能,需 购买专业版、专业版Plus、企业版 并在 控制台 > 功能配置 > 登录与消息 > 全员推送设置 打开开关后方可使用。

请求 URL 示例

https://xxxxxx/v4/all_member_push/im_remove_attr?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json

请求参数说明

参数
说明
https
请求协议为 HTTPS,请求方式为 POST
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/all_member_push/im_remove_attr
请求接口
usersig
App 管理员账号生成的签名,参见 UserSig 后台 API
identifier
必须为 App 管理员账号
sdkappid
创建应用时即时通信控制台分配的 SdkAppid
random
32位无符号整数随机数
contenttype
固定值为:json

最高调用频率

100次/秒。

请求包示例

{
"UserAttrs": [
{
"To_Account": "xiaojun013",
"Attrs": [
"sex",
"city"
]
},
{
"To_Account": "xiaojun012",
"Attrs": [
"sex",
"city"
]
}
]
}

请求包字段说明

字段
类型
属性
说明
To_Account
String
必填
目标用户账号
Attrs
Array
必填
属性集合,注意这里只需要给出属性名即可;Attrs 形式及含义参见 设置应用属性名称

应答包体示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
错误码
ErrorInfo
String
错误信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码
含义说明
90001
JSON 格式解析失败,请检查请求包是否符合 JSON 规范。
90009
请求需要 App 管理员权限。
90018
请求的账号数量超过限制。
90033
属性无效。
91000
服务内部错误,请重试。

接口调试工具

通过 REST API 在线调试 工具调试本接口。

参考

联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon