tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
即时通信 IM
    文档
    Download PDF

    删除所有好友

    最后更新时间：2024-07-16 11:25:50
    下载PDF

      功能说明

      清除指定用户的标配好友数据和自定义好友数据（该接口不触发回调请求）。

      接口调用说明

      请求 URL 示例

      https://xxxxxx/v4/sns/friend_delete_all?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/sns/friend_delete_all
      请求接口
      sdkappid
      创建应用时即时通信 IM 控制台分配的 SDKAppID
      identifier
      必须为 App 管理员账号，更多详情请参见 App 管理员
      usersig
      App 管理员账号生成的签名，具体操作请参见 生成 UserSig
      random
      请输入随机的32位无符号整数，取值范围0 - 4294967295
      contenttype
      请求格式固定值为json

      最高调用频率

      200次/秒。

      请求包示例

      删除单向好友。
      {
        "From_Account":"id"
      }
      删除双向好友。
      {
        "From_Account":"id",
        "DeleteType":"Delete_Type_Both"
      }

      请求包字段说明

      字段
      类型
      属性
      说明
      From_Account
      String
      必填
      指定要清除好友数据的用户的 UserID
      DeleteType
      String
      选填
      删除模式，默认删除单向好友，详情请参见 删除好友

      应答包体示例

      {
          "ActionStatus": "OK",
          "ErrorCode": 0,
          "ErrorInfo": "",
          "ErrorDisplay": ""
      }

      应答包字段说明

      字段
      类型
      说明
      ActionStatus
      String
      请求包的处理结果，OK 表示处理成功，FAIL 表示失败
      ErrorCode
      Integer
      错误码，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明
      ErrorInfo
      String
      详细错误信息
      ErrorDisplay
      String
      详细的客户端展示信息

      错误码说明

      除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
      公共错误码（60000到79999）请参见 错误码。
      本 API 私有错误码如下：
      错误码
      描述
      30001
      请求参数错误，请根据错误描述检查请求参数
      30003
      请求的用户账号不存在
      30004
      请求需要 App 管理员权限
      30006
      服务器内部错误，请重试
      30007
      网络超时，请稍后重试
      30008
      并发写导致写冲突，建议使用批量方式

      接口调试工具

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

      参考

      添加好友（v4/sns/friend_add）
      导入好友（v4/sns/friend_import）
      更新好友（v4/sns/friend_update）
      删除好友（v4/sns/friend_delete）
      校验好友（v4/sns/friend_check）
      拉取好友（v4/sns/friend_get）
      拉取指定好友（v4/sns/friend_get_list）
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款