tencent cloud

功能说明

添加好友，支持批量添加好友。

接口调用说明

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

• 基础形式

  {
    "From_Account":"id",
    "AddFriendItem":
    [
        {
            "To_Account":"id1",
            "AddSource":"AddSource_Type_XXXXXXXX"
        }
    ]
  }
  

• 完整形式

  {
    "From_Account":"id",
    "AddFriendItem":
    [
        {
            "To_Account":"id1",
            "Remark":"remark1",
            "GroupName":"同学", // 添加好友时只允许设置一个分组，因此使用 String 类型即可
            "AddSource":"AddSource_Type_XXXXXXXX",
            "AddWording":"I'm Test1"
        }
    ],
    "AddType":"Add_Type_Both",
    "ForceAddFlags":1
  }
  

• 批量形式

  {
    "From_Account":"id",
    "AddFriendItem":
    [
        {
            "To_Account":"id1",
            "AddSource":"AddSource_Type_XXXXXXXX"
        },
        {
            "To_Account":"id2",
            "Remark":"remark2",
            "GroupName":"同学", // 添加好友时只允许设置一个分组，因此使用 String 类型即可
            "AddSource":"AddSource_Type_XXXXXXXX",
            "AddWording":"I'm Test2"
        },
        {
            "To_Account":"id3",
            "Remark":"remark3",
            "GroupName":"同事", // 添加好友时只允许设置一个分组，因此使用 String 类型即可
            "AddSource":"AddSource_Type_XXXXXXXX",
            "AddWording":"I'm Test3"
        }
    ],
    "AddType":"Add_Type_Both",
    "ForceAddFlags":1
  }
  

请求包字段说明

应答包体示例

• 基础形式、完备形式

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

• 批量形式

  {
    "ResultItem":
    [
        {
            "To_Account":"id1",
            "ResultCode":0,
            "ResultInfo":""
        },
        {
            "To_Account":"id2",
            "ResultCode":30006,
            "ResultInfo":"Err_SNS_FriendAdd_Unpack_Profile_Data_Fail"
        },
        {
            "To_Account":"id3",
            "ResultCode":30002,
            "ResultInfo":"Err_SNS_FriendAdd_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_import）

• 更新好友（v4/sns/friend_update）

• 删除好友（v4/sns/friend_delete）

• 删除所有好友（v4/sns/friend_delete_all）

• 校验好友（v4/sns/friend_check）

• 拉取好友（v4/sns/friend_get）

• 拉取指定好友（v4/sns/friend_get_list）