tencent cloud

文档反馈

获取用户属性

最后更新时间:2023-12-13 17:31:44

    功能说明

    获取用户属性(必须以管理员账号调用);每次最多只能获取100个用户的属性。使用前请先 设置应用属性名称

    接口调用说明

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

    请求 URL 示例

    https://xxxxxx/v4/all_member_push/im_get_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
    孟买:adminapiind.im.qcloud.com
    硅谷:adminapiusa.im.qcloud.com
    雅加达:adminapiidn.im.qcloud.com
    v4/all_member_push/im_get_attr
    请求接口
    usersig
    App 管理员账号生成的签名,参见 UserSig 后台 API
    identifier
    必须为 App 管理员账号
    sdkappid
    创建应用时即时通信控制台分配的 SdkAppid
    random
    32位无符号整数随机数
    contenttype
    固定值为:json

    最高调用频率

    100次/秒。

    请求包示例

    {
    "To_Account": [
    "张小红",
    "陈小明",
    "abc"
    ]
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    To_Account
    Array
    必填
    目标用户账号列表

    应答包体示例

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "UserAttrs": [
    {
    "To_Account": "张小红",
    "Attrs": {
    "sex": "女",
    "city": "纽约"
    }
    },
    {
    "To_Account": "abc",
    "Attrs": {}
    },
    {
    "To_Account": "陈小明",
    "Attrs": {
    "sex": "男",
    "city": "深圳"
    }
    }
    ]
    }

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    错误码
    ErrorInfo
    String
    错误信息
    UserAttrs
    Array
    用户标签内容列表
    To_Account
    String
    用户账号
    Attrs
    Object
    属性内容

    错误码说明

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

    接口调试工具

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

    参考

    联系我们

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

    技术支持

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

    7x24 电话支持