即时通信 IM 更新好友 - 服务端 API

功能说明

• 支持批量更新同一用户的多个好友的关系链数据。
• 更新一个用户多个好友时，建议采用批量方式，避免并发写导致的写冲突。

接口调用说明

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

• 基础形式

  {
   "From_Account":"id",
   "UpdateItem":
   [
       {
           "To_Account":"id1",
           "SnsItem":
           [
               {
                   "Tag":"Tag_SNS_IM_Remark",
                   "Value":"remark1"
               }
           ]
       }
   ]
  }

• 完整形式

  {
   "From_Account":"id",
   "UpdateItem":
   [
       {
           "To_Account":"id1",
           "SnsItem":
           [
               {
                   "Tag":"Tag_SNS_IM_Remark",
                   "Value":"remark1"
               },
               {
                   "Tag":"Tag_SNS_IM_Group",
                   "Value":
                   [
                       "group1",
                       "group2"
                   ]
               },
               {
                   "Tag":"Tag_SNS_Custom_Test",
                   "Value":"test"
               }
           ]
       }
   ]
  }

• 批量形式

  {
   "From_Account":"id",
   "UpdateItem":
   [
       {
           "To_Account":"id1",
           "SnsItem":
           [
               {
                   "Tag":"Tag_SNS_IM_Remark",
                   "Value":"remark1"
               }
           ]
       },
       {
           "To_Account":"id2",
           "SnsItem":
           [
               {
                   "Tag":"Tag_SNS_IM_Remark",
                   "Value":"remark2"
               },
               {
                   "Tag":"Tag_SNS_IM_Group",
                   "Value":
                   [
                       "group1",
                       "group2"
                   ]
               }
           ]
       },
       {
           "To_Account":"id3",
           "SnsItem":
           [
               {
                   "Tag":"Tag_SNS_IM_Remark",
                   "Value":"remark3"
               },
               {
                   "Tag":"Tag_SNS_IM_Group",
                   "Value":
                   [
                       "group3"
                   ]
               },
               {
                   "Tag":"Tag_SNS_Custom_Test",
                   "Value":"test"
               }
           ]
       }
   ]
  }

请求包字段说明

应答包体示例

• 基础形式、完备形式

  {
  "ResultItem":
  [
    {
        "To_Account":"id1",
        "ResultCode":0,
        "ResultInfo":""
    }
  ],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
  }

• 批量形式

  {
  "ResultItem":
  [
    {
        "To_Account":"id1",
        "ResultCode":0,
        "ResultInfo":""
    },
    {
        "To_Account":"id2",
        "ResultCode":30011,
        "ResultInfo":"Err_SNS_FriendUpdate_Group_Num_Exceed_Threshold"
    },
    {
        "To_Account":"id3",
        "ResultCode":30002,
        "ResultInfo":"Err_SNS_FriendImport_SdkAppId_Illegal"
    }
  ],
  "Fail_Account":["id2","id3"],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
  }

应答包字段说明

错误码说明

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

接口调试工具

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

参考

• 添加好友（v4/sns/friend_add）
• 导入好友（v4/sns/friend_import）
• 删除好友（v4/sns/friend_delete）
• 删除所有好友（v4/sns/friend_delete_all）
• 校验好友（v4/sns/friend_check）
• 拉取好友（v4/sns/friend_get）
• 拉取指定好友（v4/sns/friend_get_list）