tencent cloud

直播 SDK

动态与公告
TUILiveKit 产品动态
云直播推拉流 SDK 产品动态
新手指引
产品简介
产品概述
产品优势
性能数据
基本概念
购买指南
TRTC Live 价格总览
Live 视频直播计费说明
开通服务（TUILiveKit）
Demo 体验
Demo 体验指引
跑通 Demo（TUILiveKit）
接入指南
视频直播
准备工作
主播开播
观众观看
直播列表
语聊房
准备工作
主播开播
观众观看
直播列表
推流助手
推流助手（Electron 桌面应用）
推流助手（Web 桌面浏览器）
直播监播
监播页面（Web 桌面浏览器 React 版）
监播页面（Web 桌面浏览器 Vue 版）
UI 自定义
直播视频组件
视频源编辑组件
观众列表组件
聊天弹幕组件
媒体源配置面板
连麦管理面板
直播送礼组件
无 UI 集成
搭建视频直播
搭建语聊房
功能指南
关注主播（TUILiveKit）
至臻画质（TUILiveKit）
输入媒体流进房（TUILiveKit）
礼物系统（TUILiveKit）
客户端 API
Android
iOS
Web
服务端 API（TUILiveKit）
账号系统
REST API
第三方回调
错误码（TUILiveKit）
常见问题
平台编译
用户鉴权
云直播推拉流 SDK
产品简介
购买指南
Demo 体验
免费测试
SDK 下载
License 管理
高级功能
客户端 API
常见问题
无 UI 集成方案
API 文档
OSS information
OSS Attribution Notice
ドキュメント直播 SDK服务端 API（TUILiveKit）REST API用户管理用户资料拉取资料

拉取资料

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-03-11 09:57:51

功能说明

支持拉取 标配资料字段 和 自定义资料字段。
建议每次拉取的用户数不超过100，避免因回包数据量太大导致回包失败。
请确保请求中的所有账号都已导入即时通信 Chat，如果请求中含有未导入即时通信 Chat 的账号，即时通信 Chat 后台将会提示错误。
说明：
Live 和 即时通信 Chat 共用同一套账号体系，因此账号附带的资料也是共用的。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
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/profile/portrait_get
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

请求频率限制

默认接口请求频率限制：200次/秒。

请求包示例

读一个用户的一个资料字段
{
  "To_Account":["id1"],
  "TagList":
  [
      "Tag_Profile_IM_Nick"
  ]
}
读一个用户的多个资料字段
{
  "To_Account":["id1"],
  "TagList":
  [
      "Tag_Profile_IM_Nick",
      "Tag_Profile_IM_AllowType",
      "Tag_Profile_IM_SelfSignature",
      "Tag_Profile_Custom_Test"
  ]
}
读多个用户的一个资料字段
{
  "To_Account":["id1","id2","id3"],
  "TagList":
  [
      "Tag_Profile_IM_Nick"
  ]
}
读多个用户的多个资料字段
{
  "To_Account":["id1","id2","id3","id4"],
  "TagList":
  [
      "Tag_Profile_IM_Nick",
      "Tag_Profile_IM_AllowType",
      "Tag_Profile_IM_SelfSignature",
      "Tag_Profile_Custom_Test"
  ]
}

请求包字段说明

字段
类型
属性
说明
To_Account
Array
必填
需要拉取这些 UserID 的资料。注意：每次拉取的用户数不得超过100，避免因回包数据量太大以致回包失败。
TagList
Array
必填
指定要拉取的资料字段的 Tag，资料字段

应答包体示例

读一个用户的一个资料字段
{
  "UserProfileItem":
  [
      {
          "To_Account":"id1",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest1"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      }
  ],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
}
读一个用户的多个资料字段
{
  "UserProfileItem":
  [
      {
          "To_Account":"id1",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest1"
              },
              {
                  "Tag":"Tag_Profile_IM_AllowType",
                  "Value":"AllowType_Type_NeedConfirm"
              },
              {
                  "Tag":"Tag_Profile_IM_SelfSignature",
                  "Value":"I'm Test1"
              },
              {
                  "Tag":"Tag_Profile_Custom_Test",
                  "Value":"Custom Data1"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      }
  ],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
}
读多个用户的一个资料字段
{
  "UserProfileItem":
  [
      {
          "To_Account":"id1",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest1"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      },
      {
          "To_Account":"id2",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest2"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      },
      {
          "To_Account":"id3",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest3"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      }
  ],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
}
读多个用户的多个资料字段
{
  "UserProfileItem":
  [
      {
          "To_Account":"id1",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest1"
              },
              {
                  "Tag":"Tag_Profile_IM_AllowType",
                  "Value":"AllowType_Type_NeedConfirm"
              },
              {
                  "Tag":"Tag_Profile_IM_SelfSignature",
                  "Value":"I'm Test1"
              },
              {
                  "Tag":"Tag_Profile_Custom_Test",
                  "Value":"Custom Data1"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      },
      {
          "To_Account":"id2",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest2"
              },
              {
                  "Tag":"Tag_Profile_IM_AllowType",
                  "Value":"AllowType_Type_DenyAny"
              },
              {
                  "Tag":"Tag_Profile_IM_SelfSignature",
                  "Value":"I'm Test2"
              },
              {
                  "Tag":"Tag_Profile_Custom_Test",
                  "Value":"Custom Data2"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      },
      {
          "To_Account":"id3",
          "ProfileItem":
          [
              {
                  "Tag":"Tag_Profile_IM_Nick",
                  "Value":"NickNameTest3"
              },
              {
                  "Tag":"Tag_Profile_IM_AllowType",
                  "Value":"AllowType_Type_AllowAny"
              },
              {
                  "Tag":"Tag_Profile_IM_SelfSignature",
                  "Value":"I'm Test3"
              },
              {
                  "Tag":"Tag_Profile_Custom_Test",
                  "Value":"Custom Data3"
              }
          ],
          "ResultCode":0,
          "ResultInfo":""
      },
      {
          "To_Account":"id4",
          "ResultCode":40006,
          "ResultInfo":"Err_Profile_PortraitGet_Read_Custom_Data_Fail"
      }
  ],
  "Fail_Account":["id4"],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
}

应答包字段说明

字段
类型
说明
UserProfileItem
Array
返回的用户资料结构化信息
To_Account
String
返回的用户的 UserID
ProfileItem
Array
返回的用户的资料对象数组，数组中每一个对象都包含了 Tag 和 Value
Tag
String
返回的资料对象的名称，详细信息见资料字段
Value
uint64_t/string/bytes
拉取的资料对象的值
ResultCode
Integer
To_Account 的处理结果：
0：表示成功
非0：表示失败
ResultInfo
String
To_Account 的错误描述信息，成功时该字段为空
Fail_Account
Array
返回处理失败的用户列表，仅当存在失败用户时才返回该字段
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码：
0：表示成功
非0：表示失败
ErrorInfo
String
详细错误信息
ErrorDisplay
String
详细的客户端展示信息

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
40001
请求参数错误，请根据错误描述检查请求参数
40002
请求参数错误，没有指定 To_Account
40003
请求的用户账号不存在
40004
请求需要 App 管理员权限
40006
服务器内部错误，请稍后重试
40007
没有资料字段的读权限
40009
资料字段的 Tag 不存在

接口调试工具

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


前の記事へ: 设置资料次の記事へ: 创建房间

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック