friend

未特别说明情况下请求域名均为 https://chat-go.jwzhd.com
没写请求/响应项目表示不需要相关参数.

添加用户/群聊/机器人

POST /v1/friend/apply

请求头

名称	必须	备注
token	是	无

请求体

{
  "chatId": "123", // 目标对象 ID
  "chatType": 2, // 目标对象类别: 1-用户，2-群聊，3-机器人
  "remark": "测试申请简介" // 申请简介
}

响应体

正常添加

{
  "code": 1,
  "msg": "success"
}

无效对象 ID

{
  "code": -1,
  "msg": "<群聊/用户/机器人>不存在"
}

已在添加过对象 ID

{
  "code": -9,
  "msg": "您已添加过对方"
}

删除用户/群聊/机器人

POST /v1/friend/delete-friend

请求头

名称	必须	备注
token	是	无

请求体

{
  "chatId": "123", // 目标对象 ID
  "chatType": 2, // 目标对象类别: 1-用户，2-群聊，3-机器人
}

响应体

{
  "code": 1,
  "msg": "success"
}

处理用户/群聊/机器人添加申请

POST /v1/friend/agree-apply

请求头

名称	必须	备注
token	是	无

请求体

{
  "id": 123, // 申请 ID
  "agree": 1 // 1-通过请求，2-拒绝请求，3-显示请求过期，4-显示已解散
}

响应体

{
  "code": 1,
  "msg": "success"
}

忽略申请

POST /v1/friend/ignore-apply

请求头

名称	必须	备注
token	是	无

请求体

{
  "id": 123, // 申请 ID
  "ignore": 1
}

响应体

{
  "code": 1,
  "msg": "success"
}

获取通讯录

POST /v1/friend/address-book-list

请求头

名称	必须	备注
token	是	无

请求体

message AddressBookListRequest {
  string md5 = 2; // 上一次通讯录的 MD5,如果和服务端一致则返回空列表
}

响应体

message AddressBookListResponse {
  Status status = 1;
  repeated Data data = 2;
  string md5 = 3;

  // 列表数据
  message Data {
    string list_name = 1; // 聊天对象列表名称，为"用户"，"我加入的群聊"，"机器人"
    repeated DataList data = 2;
    ChatType chat_type = 3;

    // 聊天对象数据
    message DataList {
      string chat_id = 1; // 聊天对象 ID
      string remark = 2; // 聊天对象备注名称
      string avatar_url = 3; // 聊天对象头像 url
      int32 permisson_level = 4; // 群权限等级(普通用户无此项(数值为 0 或无此项),群主 100,管理员 2),只有群列表才有此项
      bool no_disturb = 5; // 免打扰
      //int32 field6 = 6; // 未知
      string name = 8; // 聊天对象真实名称
    }
  }
}

获取申请/邀请列表

POST /v1/friend/request-list

请求头

名称	必须	备注
token	是	无

响应体

message RequestListResponse {
  Status status = 1;
  message Request {
    string receiver_name = 1; // 接收者名称
    string receiver_avatar = 2; // 接收者头像
    string name = 3; // 请求方名称
    string avatar = 4; // 请求方头像
    string group_name = 5; // 群组名称
    string group_avatar = 6; // 群组头像
    string inviter_id = 7; // 邀请者 ID (字段8同此含义)
    int32 source_type = 9; // 来源类型
    int32 target_type = 10; // 目标类型
    string target_id = 11; // 目标 ID
    string receiver_id = 12; // 接收者 ID
    int32 result = 13; // 处理结果
    int64 processed_at = 14; // 处理时间戳
    int64 invite_at = 16; // 邀请时间戳
    string invite_at_str = 17; // 邀请时间字符串
    int32 request_id = 18; // 请求 ID
    string bot_name = 19; // 机器人名称
    string bot_avatar = 20; // 机器人头像
    string processor_name = 22; // 处理者名称
    string note = 23; // 备注信息
  }
  repeated Request requests = 2; // 请求列表
  int32 total = 3; // 总请求数
  int32 pending = 4; // 待处理请求数
}

设置会话免打扰

POST /v1/friend/no-notify

请求头

名称	必须	备注
token	是	无

请求体

{
  "chatId": "118738312", // 会话 ID
  "noNotify": 0 // 0-取消免打扰，1-设置免打扰
}

响应体

{
  "code": 1,
  "msg": "success"
}

删除好友/邀请请求

POST /v1/friend/delete-request

请求头

名称	必须	备注
token	是	无

请求体

{
  "id": 123 // 请求ID
}

响应体

{
  "code": 1,
  "msg": "success"
}