即时通信 IM 拉取分组 - 服务端 API

功能说明

拉取分组，支持指定分组以及拉取分组下的好友列表。

接口调用说明

请求 URL示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

• 基础形式

  {
    "From_Account":"id"
  }

• 完整形式

  {
     "From_Account":"id", 
     "NeedFriend":"Need_Friend_Type_Yes", 
     "LastSequence":1, 
     "GroupName":["group1"]
  }
  

请求包字段说明

应答包体示例

• 基础形式

  {
    "ResultItem": [
        {
            "GroupName": "group1",
            "FriendNumber": 1
        },
        {
            "GroupName": "group2",
            "FriendNumber": 2
        },
        {
            "GroupName": "group3",
            "FriendNumber": 3
        }
    ]
    "CurrentSequence": 2,
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
  }
  

• 完整形式

  {
    "ResultItem": [
        {
            "GroupName": "group1",
            "FriendNumber": 1,
            "To_Account": ["friend1"]
        }  
    ],
    "CurrentSequence": 2,
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
  }

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
公共错误码（60000到79999）请参见 错误码。
本 API 私有错误码如下：

接口调试工具

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

参考

• 添加分组（v4/sns/group_add）
• 删除分组（v4/sns/group_delete）