当前位置：主页 > 查看内容

即时通信 IM 拉取资料 - 服务端 API

发布时间：2021-10-18 00:00| 有位朋友查看

简介：功能说明支持拉取好友和非好友的资料字段。支持拉取标配资料字段和自定义资料字段。建议每次拉取的用户数不超过100，避免因回包数据量太大导致回包失败。请确保请求中的所有帐号都已导入即时通信 IM，如果请求中含有未导入即时通信 IM 的帐号，即时通……

功能说明

支持拉取好友和非好友的资料字段。
支持拉取标配资料字段和自定义资料字段。
建议每次拉取的用户数不超过100，避免因回包数据量太大导致回包失败。
请确保请求中的所有帐号都已导入即时通信 IM，如果请求中含有未导入即时通信 IM 的帐号，即时通信 IM 后台将会提示错误。

接口调用说明

请求 URL 示例

https://console.tim.qq.com/v4/profile/portrait_get?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

参数	说明
v4/profile/portrait_get	请求接口
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier	必须为 App 管理员帐号，更多详情请参见 App 管理员
usersig	App 管理员帐号生成的签名，具体操作请参见生成 UserSig
random	请输入随机的32位无符号整数，取值范围0 - 4294967295

最高调用频率

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，支持的字段有： 1. 标配资料字段，详情可参见标配资料字段 2. 自定义资料字段，详情可参见自定义资料字段

应答包体示例

读一个用户的一个资料字段

{
  "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	返回的资料对象的名称： 1. 标配资料字段，详情可参见标配资料字段 2. 自定义资料字段，详情可参见自定义资料字段
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 在线调试工具调试本接口。

参考

设置资料（v4/profile/portrait_set）

本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！

上一篇：每个用户可以创建多少个主题？_消息通知服务 SMN_常见问题 下一篇：没有了

即时通信 IM 拉取资料 - 服务端 API

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考

推荐图文

GPU 云服务器安装 NVIDIA GRID 驱动 - 操作指南

Serverless 应用中心数据库 PostgreSQL 组件 - Ser

地图采集车的那些事 | 时间同步

DescribeIngress - Serverless应用引擎

主机安全态势_态势感知 SA_用户指南_综合大屏

免费下载！运维工程师的Ansible速查手册

随机推荐

哪个企业邮箱性价比高

亚马逊和谷歌闹掰了：注册系列域名要对标

服务器虚拟化面临的五大挑战

阿里云与Linux基金会发布“云原生人才计

顺序表练习——C++学生信息管理系统

私有网络删除网络ACL - API文档

如何在裸金属服务器操作系统内部修改登录

即时通信 IM 登录鉴权 - 产品简介

百度云召开战略发布会

批量创建ECS实例 - 云服务器 ECS

关于我们