wechaty-puppet-matrix 0.0.4

package/src/matrix/service/request.ts

@@ -0,0 +1,1944 @@
+import axios from 'axios'
+import { log } from '@juzi/wechaty-puppet'
+import { EventEmitter } from 'events'
+// @ts-ignore
+import WebSocket from 'ws'
+import * as PUPPET from '@juzi/wechaty-puppet'
+import { format, getUnixTime } from 'date-fns'
+import { xmlToJson } from '../utils/xml-to-json.js'
+import { isRoomId } from '../utils/is-type.js'
+
+const PRE = '[PuppetMatrix]'
+
+/**
+ * 创建实例传过来的参数
+ */
+export type PuppetMatrixOptions = {
+  httpServer?: string;
+  endpoint?: string;
+  token?: string;
+};
+
+export enum NotifyTypeEnum {
+  Ready = 1001,
+  LoginQRCodeChange = 1002, // set
+  UserLogin = 1003, // set
+  UserLogout = 1004, // set
+  InitFinish = 1005,
+  HeartBeatError = 1006,
+  SessionTimeout = 1007,
+  LoginFailed = 1008,
+  ContactSyncFinish = 1009,
+  NewMsg = 1010, // set
+  ContactInfoChange = 1039,
+  FriendAdd = 1040, // set
+  FriendDel = 1041,
+  RoomAdd = 1042,
+  RoomQuit = 1043,
+  RoomDelMe = 1044,
+  RoomDisband = 1045,
+  RoomMemberAdd = 1046, // set
+  RoomMemberUpdate = 1047,
+  RoomMemberDel = 1048, // set
+}
+
+/**
+ * 性别
+ */
+enum ContactGender {
+  Unknown = 0, // 位置
+  Male = 1, // 男
+  Female = 2, // 女
+}
+
+/**
+ * 群成员
+ */
+export interface ChatRoomMember {
+  wxid: string; // wxid
+  groupNick: string; // 群昵称
+  avatarMinUrl?: string;
+  avatarMaxUrl?: string;
+  avatar?: string; // 头像
+  inviterUserName?: string; // 邀请人
+  displayName?: string; // 群备注
+  sex?: number;
+  wxNum?: string; // 微信号
+  alias?: string; // 备注名
+}
+
+/**
+ * 好友 或 群 实例构造参数  务必按照此格式返回数据，否则可能报错，非必填值可以不传
+ */
+export interface ContactPayload {
+  /**
+   * 头像，需在会话列表中
+   */
+  avatar: string;
+  /**
+   * 城市，需在会话列表中
+   */
+  city: string;
+  /**
+   * 国家，需在会话列表中
+   */
+  country: string;
+  /**
+   * 群成员数量，仅当对象是群聊时有效
+   */
+  memberNum?: number;
+  /**
+   * 朋友圈背景图，需在会话列表中 暂时无用
+   */
+  momentsBackgroudImgUrl?: string;
+  /**
+   * 昵称
+   */
+  name: string;
+  /**
+   * 备注
+   */
+  alias: string;
+  /**
+   * 省份，需在会话列表中
+   */
+  province: string;
+  /**
+   * 备注
+   */
+  remark?: string;
+  /**
+   * 性别，1=男，2=女
+   */
+  sex: ContactGender;
+  /**
+   * 签名，需在会话列表中
+   */
+  sign?: string;
+
+  /**
+   *  添加好友需要的ticket 票据 不同的客户端可能不同，自己构造好就行，会原样返回的 针对daen 是 v3 + '-' + v4
+   */
+  ticket?: string;
+  /**
+   * 微信ID
+   */
+  wxid: string;
+  /**
+   * 微信号
+   */
+  wxNum: string;
+  /**
+   * 群成员 id
+   */
+  chatroommemberList?: string[];
+  /**
+   * 群主
+   */
+  ownerId?: string;
+  /**
+   * 群管id
+   */
+  adminIdList?: string[];
+  /**
+   * 是否好友
+   */
+  isFriend?: number;
+  /**
+   * 加好友场景 来源，1=qq 3=微信号 6=单向添加 10和13=通讯录 14=群聊 15=手机号 17=名片 30=扫一扫
+   */
+  scene?: string;
+  device?: string;
+  qq?: string;
+  phone?: string;
+  email?: string;
+  description?: string;
+  labelIdlist?: string;
+  /**
+   * 朋友圈背景图
+   */
+  snsBgImg?: string;
+  /**
+   * 好友类型
+   * 1
+   */
+  contactType?: number;
+  /**
+   * 群公告
+   */
+  announcement?: string;
+}
+
+/**
+ * 微信登录状态
+ */
+enum Status {
+  normal = 'normal',
+  offline = 'offline',
+  pending = 'pending',
+  fail = 'fail',
+}
+
+/**
+ * 登录状态
+ */
+export interface StatsResult {
+  status: Status;
+}
+
+export type ClientEvent =
+  | 'kickout'
+  | 'contact'
+  | 'message'
+  | 'scan'
+  | 'verify-code';
+/**
+ * 消息类型：1|文本 3|图片 34|语音 42|名片 43|视频 47|动态表情 48|地理位置 49|分享链接或附件 2001|红包 2002|小程序 2003|群邀请 10000|系统消息
+ */
+export enum WechatMessageType {
+  Text = 1,
+  Image = 3,
+  Voice = 34,
+  VerifyMsg = 37,
+  PossibleFriendMsg = 40,
+  ShareCard = 42,
+  Video = 43,
+  Emoticon = 47,
+  Location = 48,
+  App = 49,
+  VoipMsg = 50,
+  StatusNotify = 51,
+  VoipNotify = 52,
+  VoipInvite = 53,
+  MicroVideo = 62,
+  VerifyMsgEnterprise = 65,
+  Transfer = 2000, // 转账
+  RedEnvelope = 2001, // 红包
+  MiniProgram = 2002, // 小程序
+  GroupInvite = 2003, // 群邀请
+  File = 2004, // 文件消息
+  SysNotice = 9999,
+  Sys = 10000,
+  SysTemplate = 10002, // NOTIFY 服务通知
+}
+
+/**
+ * 收到的消息格式
+ */
+export interface MessagePayload {
+  id: string; // 消息id
+  timeStamp: number; // 10位时间戳
+  talkerId: string; // 发消息 人 或者 群
+  text: string; // 消息内容
+  msgType?: WechatMessageType;
+  fromWxid: string; // 群id
+  atWxidList?: string[]; // 消息中艾特人wxid列表
+  msg: string; // 消息内容
+  listenerId: string; //
+}
+
+export interface BaseEvent {
+  errorCode: number;
+  errorMessage: string;
+  wxid?: string;
+  name?: string;
+  robotInfo?: ContactPayload;
+}
+
+export interface ImageMessagePayload {
+  aes_key: string;
+  file_id: string;
+  file_size: string | number;
+  file_name?: string;
+}
+
+export interface AudioMessagePayload {
+  aesKey: string;
+  length: string;
+  voicelength: string;
+  voiceurl: string;
+  voicemd5: string;
+  clientmsgid: string;
+  fromusername: string;
+}
+
+export interface VoiceMessagePayload {
+  length: string;
+}
+export interface VideoMessagePayload {
+  aes_key: string;
+  file_id: string;
+  file_size: string;
+  play_length: string;
+  thumb_aes_key: string;
+  thumb_url: string;
+  thumb_size: string;
+  thumb_width: string;
+  thumb_height: string;
+  file_name: '';
+}
+
+export enum FriendshipType {
+  Unknown = 0,
+  Confirm,
+  Receive,
+  Verify,
+  Delete,
+  Removed,
+}
+
+export interface ContactEvent {
+  type: FriendshipType;
+  contactInfo: ContactPayload;
+}
+
+export interface QrStatus {
+  qrcode: string;
+  status: number;
+}
+
+export interface VerifyInfo {
+  uuid: string;
+  ticket: string;
+}
+
+export interface LogoutInfo {
+  contactId: string;
+  reason: string;
+}
+export interface QrInfo {
+  status: number;
+  url?: string;
+}
+export interface RoomJoinPayload {
+  roomId: string;
+  inviterId: string;
+  joinIds: string[];
+}
+export interface RoomLeavPayload {
+  roomId: string;
+  leaveIds: string[];
+}
+
+async function getAtWxidList (source: string): Promise<string[]> {
+  if (source) {
+    const json = await xmlToJson(source)
+    return (
+      json?.msgsource?.atuserlist?.split(',').filter((item: string) => item)
+      || []
+    )
+  }
+  return []
+}
+class Client extends EventEmitter {
+
+  private readonly options: PuppetMatrixOptions
+  socket: any
+  server: any
+  tokenInfo: any
+  hasEmitLogout: boolean
+
+  // @ts-ignore
+  override emit(event: 'hook', detail: BaseEvent): boolean;
+  override emit(event: 'login', detail: BaseEvent): boolean;
+  override emit(event: 'logout', message: string): boolean;
+  override emit(event: 'message', messageList: MessagePayload): boolean;
+  override emit(event: 'contact', detail: ContactEvent): boolean;
+  override emit(event: 'error', detail: ContactEvent): boolean;
+  override emit(event: 'scan', qrInfo: QrInfo): boolean;
+  override emit(event: 'verify-code', verifyInfo: VerifyInfo): boolean;
+  override emit(event: 'update-contacts', contacts: ContactPayload[]): boolean;
+  override emit(event: 'room-join', info: any): boolean;
+
+  override emit (event: ClientEvent, ...args: any[]): boolean {
+    return super.emit(event, ...args)
+  }
+
+  public static async create (options: PuppetMatrixOptions) {
+    const client = new Client(options)
+    await client.initServer()
+    return client
+  }
+
+  private constructor (options: PuppetMatrixOptions = {}) {
+    super()
+    this.options = options
+    this.tokenInfo = null
+    this.socket = null
+    this.hasEmitLogout = false
+  }
+
+  async getTokenInfo () {
+    try {
+      const res = await axios.get(`https://api-bot.aibotk.com/openapi/v1/token/info?secret=5be06b6f8d42a7&token=${this.options.token}`)
+      if (res.data.code === 0) {
+        this.tokenInfo = res.data.data
+        return true
+      } else {
+        log.error('Token auth failed, reason: %s', res.data.message)
+        return false
+      }
+    } catch (e) {
+      log.error('error info: %s', e)
+      return false
+    }
+  }
+
+  async initServer () {
+    await this.getTokenInfo()
+    if (!this.socket) {
+      const ws = new WebSocket(
+        `${this.tokenInfo.endpoint}?guid=${this.tokenInfo.guid}`,
+        { perMessageDeflate: true, maxPayload: 100 * 1024 * 1024 },
+      )
+
+      /**
+       * 1. Message
+       *  1.1. Deal with payload
+       */
+      ws.on('message', (data: string) => {
+        log.silly(PRE, 'initWebSocket() ws.on(message): %s', data)
+        try {
+          const payload: any = JSON.parse(data)
+          log.info(JSON.stringify(payload))
+          void this.eventParse(payload)
+        } catch (e: any) {
+          log.warn(PRE, 'initWebSocket() ws.on(message) exception: %s', e)
+          this.emit('error', e.message)
+        }
+      })
+
+      /**
+       * 1. Message
+       *  1.2. use websocket message as heartbeat source
+       */
+      ws.on('message', () => {
+        // if (!this.throttleQueue || !this.debounceQueue) {
+        //   log.warn(PRE, 'initWebSocket() ws.on(message) throttleQueue or debounceQueue not exist')
+        //   return
+        // }
+        // if (this.connectionStatus.status === CONNECTED) {
+        //   this.debounceQueue.next('ws.on(message)')
+        //   this.throttleQueue.next('ws.on(message)')
+        // }
+      })
+
+      /**
+       * 2. Error
+       */
+      ws.on('error', (e: any) => {
+        if (e.message.indexOf('ECONNREFUSED') !== -1) {
+          // Can not connect to remote server, if this is triggered when puppet-padchat is connected,
+          // an close event must be emitted, so ignore this error
+          // If this is triggered when puppet-padchat is trying to reconnect, also ignore this error
+        } else {
+          log.verbose(PRE, 'initWebSocket() ws.on(error) %s', e)
+          this.emit('error', e)
+        }
+      })
+
+      /**
+       * 3. Close
+       */
+      ws.on('close', (code: any, reason: any) => {
+        log.warn(
+          PRE,
+          'initWebSocket() ws.on(close) code: %s, reason: %s',
+          code,
+          reason,
+        )
+
+        // if (!this.reconnectThrottleQueue) {
+        //   log.warn(PRE, 'initWebSocket() ws.on(close) reconnectThrottleQueue not exist')
+        //   return
+        // }
+        // if (this.connectionStatus.status === CONNECTED) {
+        //   this.reconnectThrottleQueue.next('ws.on(close, ' + code + ')')
+        // }
+      })
+
+      /**
+       * 5. Wait the WebSocket to be connected
+       */
+      await new Promise((resolve, reject) => {
+        ws.once('open', () => {
+          log.silly(PRE, 'initWebSocket() Promise() ws.on(open)')
+          return resolve({})
+        })
+
+        ws.once('error', (e: any) => {
+          log.silly(PRE, 'initWebSocket() Promise() ws.on(error) %s', e)
+          return reject(e)
+        })
+        ws.once('close', (e: any) => {
+          log.silly(PRE, 'initWebSocket() Promise() ws.on(close)')
+          return reject(e)
+        })
+      })
+
+      this.socket = ws
+      return
+    }
+    if (this.socket) {
+      throw new Error('socket had already been opened!')
+    }
+  }
+
+  async eventParse (eventData: any) {
+    const notifyType = eventData.notify_type
+    const data = eventData.data
+    let robotInfo, msg: MessagePayload, contactInfo: ContactPayload, atWxidList
+    switch (notifyType) {
+      case NotifyTypeEnum.LoginQRCodeChange:
+        if (data.authUrl) {
+          // @ts-ignore
+          this.emit('verify-code', {
+            ticket: this.getQrcodeTicket(data.authUrl),
+            status: PUPPET.types.ScanStatus.Scanned,
+          })
+        } else {
+          void this.onQrCodeEvent(
+            data.status,
+            `http://weixin.qq.com/x/${data.uuid}`,
+          )
+        }
+        break
+      case NotifyTypeEnum.UserLogin:
+        robotInfo = {
+          wxNum: data?.alias,
+          wxid: data?.username || '',
+          name: data?.nickname || '',
+          sex: data?.sex,
+          alias: '',
+          province: data?.province || '',
+          city: data?.city || '',
+          country: data?.country || '',
+          avatar: data?.big_headimg_url || data?.small_headimg_url || '',
+          description: '',
+          labelIdlist: '',
+        }
+
+        this.emit('login', {
+          errorCode: 0,
+          errorMessage: 'success',
+          wxid: robotInfo.wxid,
+          robotInfo,
+        })
+        break
+      case NotifyTypeEnum.NewMsg:
+        if (data.is_chatroom_msg) {
+          atWxidList = await getAtWxidList(data.source)
+        }
+        msg = {
+          msg: data.content,
+          text: data.content,
+          id: data.msg_id,
+          atWxidList,
+          fromWxid: data.from_username,
+          msgType: data.msg_type,
+          timeStamp: data.create_time,
+          talkerId: !data.is_chatroom_msg
+            ? data.from_username
+            : data.chatroom_sender,
+          listenerId: data.to_username,
+        }
+        this.emit('message', msg)
+        break
+      case NotifyTypeEnum.FriendAdd:
+        contactInfo = {
+          wxNum: data?.alias,
+          wxid: data?.username || '',
+          name: data?.nickname || '',
+          sex: data?.sex,
+          alias: '',
+          province: data?.province || '',
+          city: data?.city || '',
+          country: data?.country || '',
+          avatar: data?.big_headimg_url || data?.small_headimg_url || '',
+          description: '',
+          labelIdlist: data?.labelid_list,
+        }
+        this.emit('contact', { type: FriendshipType.Confirm, contactInfo })
+        break
+      case NotifyTypeEnum.ContactInfoChange:
+        contactInfo = {
+          wxNum: data?.alias,
+          wxid: data?.username || '',
+          name: data?.nickname || '',
+          sex: data?.sex,
+          alias: '',
+          province: data?.province || '',
+          city: data?.city || '',
+          country: data?.country || '',
+          avatar: data?.big_headimg_url || data?.small_headimg_url || '',
+          description: '',
+          labelIdlist: data?.labelid_list,
+        }
+        this.emit('update-contacts', [ contactInfo ])
+        break
+      case NotifyTypeEnum.UserLogout:
+        this.emit('logout', data.errmsg)
+        break
+      case NotifyTypeEnum.RoomMemberAdd:
+        this.emit('room-join', {
+          roomId: data.room_username,
+          inviterId: data.member_list[0]?.invite_username,
+          joinIds: data.member_list.map((item: any) => item.username),
+          joinUsers: data.member_list.map((data: any) => ({
+            wxNum: data?.alias,
+            wxid: data?.username || '',
+            name: data?.nickname || '',
+            sex: data?.sex,
+            alias: '',
+            province: data?.province || '',
+            city: data?.city || '',
+            country: data?.country || '',
+            avatar: data?.big_headimg_url || data?.small_headimg_url || '',
+            description: '',
+            labelIdlist: data?.labelid_list,
+          })),
+        })
+        break
+      case NotifyTypeEnum.RoomMemberDel:
+        // @ts-ignore
+        this.emit('room-leave', {
+          roomId: data.room_username,
+          leaveIds: data.member_list.map((item: any) => item.username),
+        })
+        break
+      default:
+        log.info('other data', JSON.stringify(data))
+    }
+  }
+
+  getQrcodeTicket (authurl: string): string {
+    if (!authurl || !authurl.startsWith('http')) return ''
+    const url = new URL(authurl)
+    const searchParams = new URLSearchParams(url.search.slice(1))
+    return searchParams.get('ticket') || ''
+  }
+
+  async onQrCodeEvent (status: number, url?: string) {
+    const ScanStatusName = {
+      [PUPPET.types.ScanStatus.Unknown]: 'Unknown',
+      [PUPPET.types.ScanStatus.Cancel]: 'Cancel',
+      [PUPPET.types.ScanStatus.Waiting]: 'Waiting',
+      [PUPPET.types.ScanStatus.Scanned]: 'Scanned',
+      [PUPPET.types.ScanStatus.Confirmed]: 'Confirmed',
+      [PUPPET.types.ScanStatus.Timeout]: 'Timeout',
+    }
+    let scanStatus: PUPPET.types.ScanStatus = PUPPET.types.ScanStatus.Unknown
+    let qrUrl: string | undefined = ''
+    switch (status) {
+      case 0:
+        scanStatus = PUPPET.types.ScanStatus.Waiting
+        qrUrl = url
+        break
+      case 1:
+        scanStatus = PUPPET.types.ScanStatus.Scanned
+        break
+      case 2:
+        scanStatus = PUPPET.types.ScanStatus.Confirmed
+        break
+      case 3:
+        scanStatus = PUPPET.types.ScanStatus.Cancel
+        break
+      case 4:
+        scanStatus = PUPPET.types.ScanStatus.Timeout
+        break
+    }
+    log.silly(
+      PRE,
+      `scan event, status: ${ScanStatusName[scanStatus]}${
+        url ? ', with qrcode: ' + url : ''
+      }`,
+    )
+
+    // @ts-ignore
+    this.emit('scan', {
+      qrcode: qrUrl,
+      status: scanStatus,
+    })
+  }
+
+  setEmitLogout (val: boolean) {
+    this.hasEmitLogout = val
+    if (val) {
+      let time: any = setTimeout(() => {
+        this.hasEmitLogout = false
+        clearTimeout(time)
+        time = null
+      }, 10000)
+    }
+  }
+
+  async postData (data: any) {
+    const config: any = {
+      data: {
+        guid: this.tokenInfo.guid,
+        ...data.data,
+      },
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      method: 'POST',
+      url: this.tokenInfo.httpServer + data.path,
+      timeout: 600000,
+    }
+
+    const res = await axios(config)
+
+    if (res.data?.errcode === -102) {
+      log.warn('request error: %s', res.data?.errmsg)
+      if (!this.hasEmitLogout) {
+        this.setEmitLogout(true)
+        this.emit('logout', res.data?.errmsg)
+      }
+
+      return {}
+    }
+
+    return res.data
+  }
+
+  /**
+   * 获取微信运行状态
+   */
+  public async getStats (): Promise<StatsResult> {
+    const res = await this.postData({
+      path: '/client/get_client_status',
+      data: {},
+    })
+    // 0: stop, 1: running, 2: online
+    const { errcode, data } = res
+    if (!errcode) {
+      return {
+        status:
+          data.status === 1
+            ? Status.pending
+            : data.status === 2
+              ? Status.normal
+              : Status.offline,
+      }
+    } else {
+      return { status: Status.fail }
+    }
+  }
+
+  /**
+   * 获取登录二维码
+   */
+  public async getQrcode (): Promise<{
+    base64: string;
+    qrcodeUrl: string;
+    expiredTime: number;
+    uuid: string;
+  } | null> {
+    try {
+      const res = await this.postData({
+        path: '/login/get_login_qrcode',
+        data: {},
+      })
+
+      if (res?.qrcode) {
+        return {
+          base64: `data:image/jpeg;base64,${res?.qrcode?.buffer}`,
+          qrcodeUrl: `http://weixin.qq.com/x/${res?.uuid}`,
+          uuid: res?.uuid,
+          expiredTime: res?.expiredTime,
+        }
+      }
+      log.info(PRE, 'getQrcode error:', res?.errmsg)
+      return null
+    } catch (e) {
+      log.error(PRE, 'getQrcode(): %s', e)
+      return null
+    }
+  }
+
+  /**
+   * 获取登录二维码状态
+   *   NEW: 0,
+   *   SCANNED: 1,
+   *   CONFIRMED: 2,
+   *   CANCELLED: 3,
+   *   EXPIRED: 4,
+   *   UNKNOWN_ERROR: 5
+   */
+  public async getQrcodeStatus (): Promise<{
+    uuid?: string;
+    status: number;
+    pushLoginUrlexpiredTime?: number;
+    expiredTime?: number;
+  } | null> {
+    try {
+      const res = await this.postData({
+        path: '/login/check_login_qrcode',
+        data: {},
+      })
+      if (res?.uuid) {
+        return res
+      }
+      log.info(PRE, 'getQrcodeStatus error:', res?.errmsg)
+      return {
+        status: 4,
+      }
+    } catch (e) {
+      log.error(PRE, 'getQrcodeStatus(): %s', e)
+      return {
+        status: 4,
+      }
+    }
+  }
+
+  public async verifyLoginUrl (ticket: string, pin: string): Promise<void> {
+    try {
+      const res = await this.postData({
+        path: '/login/verify_login_url',
+        data: {
+          ticket,
+          pin,
+        },
+      })
+
+      log.info(PRE, 'verifyLoginUrl', res)
+    } catch (e) {
+      log.error(PRE, 'verifyLoginUrl(): %s', e)
+    }
+  }
+
+  /**
+   * 推送手机登录通知
+   */
+  public async pushLoginNotify (): Promise<any> {
+    await this.postData({
+      path: '/login/push_login_url',
+      data: {},
+    })
+  }
+
+  /**
+   * 获取当前bot信息
+   */
+  public async getSelfInfo (): Promise<ContactPayload | boolean> {
+    try {
+      const res = await this.postData({ path: '/user/get_profile', data: {} })
+      if (res.errcode === -102) {
+        log.info(PRE, 'offline login:', res?.errmsg)
+        return false
+      } else if (res.userInfo) {
+        const contact = res?.userInfo
+        const contactMore = res?.userInfoExt
+        return {
+          wxNum: contact.alias,
+          wxid: contact?.userName?.string || '',
+          name: contact?.nickName?.string || '',
+          sex: contact?.sex,
+          alias: contact?.remark?.string || '',
+          province: contact?.province || '',
+          city: contact?.city || '',
+          country: contact?.country || '',
+          avatar:
+            contactMore?.bigHeadImgUrl || contactMore?.smallHeadImgUrl || '',
+          description: contact?.description,
+          labelIdlist: contact?.labelIdlist,
+        }
+      }
+      log.info(PRE, 'get self info error:(%s)', res?.errmsg)
+      return false
+    } catch (e) {
+      log.error(PRE, 'getSelfInfo(): %s', e)
+      return false
+    }
+  }
+
+  /**
+   * 获取机器人二维码
+   */
+  public async getUserQrcode (): Promise<string> {
+    try {
+      const res = await this.postData({
+        path: '/user/get_qrcode',
+        data: {},
+      })
+      return res.qrcodeUrl
+    } catch (e) {
+      log.error(PRE, 'getUserQrcode(): %s', e)
+      return ''
+    }
+  }
+
+  /**
+   * 退出登录
+   */
+  public async logout (): Promise<void> {
+    try {
+      await this.postData({
+        path: '/user/logout',
+        data: {},
+      })
+    } catch (e) {
+      log.error(PRE, 'logout(): %s', e)
+    }
+  }
+
+  /**
+   * 查询对象简单信息
+   * @param contactId
+   */
+  public async searchContact (
+    contactIds: string[],
+  ): Promise<ContactPayload | ContactPayload[] | undefined> {
+    if (!contactIds.length) return
+
+    try {
+      const res = await this.postData({
+        path: '/contact/batch_get_contact_brief_info',
+        data: {
+          username_list: contactIds,
+        },
+      })
+      if (res.contactList?.length === 1) {
+        const contactInfo = res.contactList?.length
+          ? res.contactList[0]
+          : undefined
+        if (contactInfo) {
+          const contact = contactInfo.contact
+          return {
+            wxNum: contact.alias,
+            wxid: contact?.userName?.string || '',
+            name: contact?.nickName?.string || '',
+            sex: contact?.sex,
+            alias: contact?.remark?.string || '',
+            province: contact?.province || '',
+            city: contact?.city || '',
+            country: contact?.country || '',
+            avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
+            description: contact?.description,
+            labelIdlist: contact?.labelIdlist,
+          }
+        }
+        return undefined
+      } else {
+        const contacts: ContactPayload[]
+          = res.contactList?.map((contactInfo: any) => {
+            const contact = contactInfo.contact
+            return {
+              wxNum: contact.alias,
+              wxid: contact?.userName?.string || '',
+              name: contact?.nickName?.string || '',
+              sex: contact?.sex,
+              alias: contact?.remark?.string || '',
+              province: contact?.province || '',
+              city: contact?.city || '',
+              country: contact?.country || '',
+              avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
+              description: contact?.description,
+              labelIdlist: contact?.labelIdlist,
+            }
+          }) || []
+        return contacts
+      }
+    } catch (e) {
+      log.error(PRE, 'searchContact(%s): %s', contactIds, e)
+      return undefined
+    }
+  }
+
+  /**
+   * 查询对象详细信息
+   * @param contactId
+   */
+  public async searchContactDetail (
+    contactIds: string[],
+    roomId?: string,
+  ): Promise<ContactPayload | ContactPayload[] | undefined> {
+    if (!contactIds.length && !roomId) return undefined
+
+    try {
+      const data: any = {}
+      if (contactIds.length) {
+        data['username_list'] = contactIds
+      }
+      if (roomId) {
+        data['room_username'] = roomId
+      }
+      const res = await this.postData({
+        path: '/contact/get_contact',
+        data,
+      })
+      if (res.contactList?.length === 1) {
+        const contactInfo = res.contactList.length
+          ? res.contactList[0]
+          : undefined
+        if (contactInfo) {
+          const contact = contactInfo.contact || {}
+          return {
+            wxNum: contact?.alias,
+            wxid: contact?.userName?.string,
+            name: contact?.nickName?.string || '',
+            sex: contact?.sex || 0,
+            alias: contact?.remark?.string || '',
+            province: contact?.province || '',
+            city: contact?.city || '',
+            country: contact?.country || '',
+            avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
+            description: contact?.description,
+            labelIdlist: contact?.labelIdlist,
+            scene: contact?.addContactScene,
+            sign: contact?.signature,
+            snsBgImg: contact?.snsUserInfo?.snsBgimgId,
+          }
+        }
+        return undefined
+      } else {
+        return res.contactList?.map((contactInfo: any) => {
+          const contact = contactInfo.contact || {}
+          return {
+            wxNum: contact?.alias,
+            wxid: contact?.userName?.string,
+            name: contact?.nickName?.string || '',
+            sex: contact?.sex || 0,
+            alias: contact?.remark?.string || '',
+            province: contact?.province || '',
+            city: contact?.city || '',
+            country: contact?.country || '',
+            avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
+            description: contact?.description,
+            labelIdlist: contact?.labelIdlist,
+            scene: contact?.addContactScene,
+            sign: contact?.signature,
+            snsBgImg: contact?.snsUserInfo?.snsBgimgId,
+          }
+        })
+      }
+    } catch (e) {
+      log.error(PRE, 'searchContactDetail(%s， %s): %s', contactIds, roomId, e)
+      return undefined
+    }
+  }
+
+  /**
+   * 同步联系人
+   */
+  public async syncContact (): Promise<void> {
+    try {
+      const res = await this.postData({
+        path: '/contact/init_contact',
+        data: {
+          contact_seq: 0,
+          room_seq: 0,
+        },
+      })
+      const contactUsernameList = res.contactUsernameList || []
+      const contactsInfo: ContactPayload[] = (await this.searchContact(
+        contactUsernameList,
+      )) as ContactPayload[]
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      this.emit('update-contacts', contactsInfo || [])
+    } catch (e) {
+      log.error(PRE, 'syncContact(): %s', e)
+    }
+  }
+
+  /**
+   * 获取好友列表 (本地存储)
+   */
+  public async getContactList (
+    page: number = 1,
+    pageSize: number = 100,
+  ): Promise<void> {
+    try {
+      const res = await this.postData({
+        path: '/contact/get_friends',
+        data: {
+          page_num: page,
+          page_size: pageSize,
+        },
+      })
+
+      const totalPage = res.total_page || 1
+      const contactList: ContactPayload[] = res.contact_list
+        .filter((item: any) => item.username)
+        .map((contact: any) => {
+          return {
+            isFriend: true,
+            wxNum: contact?.alias,
+            wxid: contact?.username,
+            name: contact?.nickname || '',
+            sex: contact?.sex,
+            alias: contact?.remark || '',
+            province: contact?.province || '',
+            city: contact?.city || '',
+            country: contact?.country || '',
+            avatar:
+              contact?.big_headimg_url || contact?.small_headimg_url || '',
+            labelIdlist: contact?.labelIdlist,
+          }
+        })
+      this.emit('update-contacts', contactList)
+      if (page < totalPage) {
+        await this.getContactList(page + 1, pageSize)
+      }
+    } catch (e) {
+      log.error(PRE, 'getContactList(): %s', e)
+    }
+  }
+
+  /**
+   * 获取群聊列表
+   */
+  public async getGroupList (
+    page: number = 1,
+    pageSize: number = 100,
+  ): Promise<void> {
+    try {
+      const res = await this.postData({
+        path: '/room/get_chatrooms',
+        data: {
+          page_num: page,
+          page_size: pageSize,
+        },
+      })
+      const totalPage = res.total_page || 1
+      const groupList: ContactPayload[] = res.room_list
+        .filter((item: any) => item.username)
+        .map((item: any) => {
+          return {
+            wxid: item.username,
+            announcement: item?.announcement,
+            ownerId: item?.creator,
+            name: item?.nickname,
+            avatar: item?.headimg_url,
+            memberNum: item?.total_member,
+            chatroommemberList: [],
+          }
+        })
+
+      if (groupList.length > 0) {
+        this.emit('update-contacts', groupList)
+      }
+
+      if (parseInt(page.toString()) < parseInt(totalPage.toString())) {
+        await this.getGroupList(parseInt(page.toString()) + 1, pageSize)
+      }
+    } catch (e) {
+      log.error(PRE, 'getGroupList(): %s', e)
+    }
+  }
+
+  public async getGroupMembersDetail (roomId: string) {
+    try {
+      const res = await this.postData({
+        path: '/room/get_chatroom_member_detail',
+        data: {
+          room_username: roomId,
+          version: 0,
+        },
+      })
+      const memeberIdList: string[]
+        = res?.allMemberUserNameList.map((item: any) => item.string) || []
+      const allMemberCount = res.allMemberCount
+      const ownerId = res.chatRoomOwner
+      const adminIdList: string[]
+        = res?.adminUserNameList.map((item: any) => item.string) || []
+      const memberList: ContactPayload[] = res?.newChatroomData?.chatRoomMember
+        .filter((item: any) => item.username)
+        .map((item: any) => ({
+          wxid: item.username, // wxid
+          groupNick: item?.nickname, // 群昵称
+          avatarMinUrl: item?.smallHeadImgUrl,
+          avatarMaxUrl: item?.bigHeadImgUrl,
+          avatar: item?.bigHeadImgUrl || item?.smallHeadImgUrl, // 头像
+          inviterUserName: item?.inviterUserName, // 邀请人
+        }))
+      return {
+        memeberIdList,
+        allMemberCount,
+        ownerId,
+        adminIdList,
+        memberList,
+      }
+    } catch (e) {
+      log.error(PRE, 'getGroupMembers(%s): %s', roomId, e)
+      return []
+    }
+  }
+
+  /**
+   * 获取群成员列表
+   * @param roomId 群id
+   * @param page
+   * @param pageSize
+   */
+  public async getGroupMembers (
+    roomId: string,
+    page: number = 1,
+    pageSize: number = 100,
+  ): Promise<ContactPayload[]> {
+    try {
+      const res = await this.postData({
+        path: '/room/get_chatroom_members',
+        data: {
+          room_username: roomId,
+          page_num: page,
+          page_size: pageSize,
+        },
+      })
+
+      const totalPage = res.total_page || 1
+      const memberList = res.room_list
+        .filter((item: any) => item.username)
+        .map((item: any) => ({
+          wxid: item.username, // wxid
+          groupNick: item?.nickname, // 群昵称
+          avatarMinUrl: item?.small_headimg_url,
+          avatarMaxUrl: item?.big_headimg_url,
+          avatar: item?.big_headimg_url || item?.small_headimg_url, // 头像
+          inviterUserName: item?.invite_username, // 邀请人
+          country: item?.country,
+          province: item?.province,
+          city: item?.city,
+          displayName: item?.display_name, // 群备注
+          sex: item?.sex,
+          wxNum: item?.alias,
+          alias: item?.remark,
+        }))
+
+      if (page < totalPage) {
+        const nextPageContacts = await this.getGroupMembers(roomId, page + 1, pageSize)
+        return memberList.concat(nextPageContacts)
+      } else {
+        return memberList
+      }
+    } catch (e) {
+      log.error(PRE, 'getGroupMembers(%s): %s', roomId, e)
+      return []
+    }
+  }
+
+  /**
+   * 获公众号聊列表
+   */
+  public async getOfficeList (
+    page: number = 1,
+    pageSize: number = 100,
+  ): Promise<void> {
+    try {
+      const res = await this.postData({
+        path: '/contact/get_publics',
+        data: {
+          page_num: page,
+          page_size: pageSize,
+        },
+      })
+      const totalPage = res.total_page || 1
+      const officeList = res.contact_list
+        .filter((item: any) => item.username)
+        .map((contact: any) => {
+          return {
+            wxNum: contact?.alias,
+            wxid: contact?.username,
+            name: contact?.nickname || '',
+            sex: contact?.sex,
+            alias: contact?.remark || '',
+            province: contact?.province || '',
+            city: contact?.city || '',
+            country: contact?.country || '',
+            avatar:
+              contact?.big_headimg_url || contact?.small_headimg_url || '',
+            labelIdlist: contact?.labelIdlist,
+          }
+        })
+      this.emit('update-contacts', officeList)
+      if (page < totalPage) {
+        await this.getOfficeList(page + 1, pageSize)
+      }
+    } catch (e) {
+      log.error(PRE, 'getOfficeList(): %s', e)
+    }
+  }
+
+  /**
+   * 发送文本消息
+   * @param contactId
+   * @param msg
+   */
+  public async sendText (
+    contactId: string,
+    msg: string,
+    selfId?: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const res = await this.postData({
+        path: '/msg/send_text',
+        data: {
+          to_username: contactId,
+          content: msg,
+        },
+      })
+
+      return {
+        id: res?.list?.[0].newMsgId || '',
+        timeStamp: res?.list?.[0].createTime || '',
+        msgType: res?.list?.[0].type || '',
+        talkerId: selfId || '',
+        text: msg,
+        msg,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (e) {
+      log.error(PRE, 'sendText(%s, %s, %s): %s', contactId, msg, e)
+    }
+  }
+
+  /**
+   * 发送文本消息带@
+   * @param contactId
+   * @param msg
+   * @param atList
+   * @param selfId
+   */
+
+  public async sendAtText (
+    contactId: string,
+    msg: string,
+    atList: string[],
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+
+    try {
+      const res = await this.postData({
+        path: '/msg/send_room_at',
+        data: {
+          to_username: contactId,
+          content: msg,
+          at_list: atList,
+        },
+      })
+
+      return {
+        id: res?.list?.[0].newMsgId || '',
+        timeStamp: res?.list?.[0].createTime || '',
+        msgType: res?.list?.[0].type || '',
+        talkerId: selfId || '',
+        text: msg,
+        msg,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (e) {
+      log.error(PRE, 'sendText(%s, %s, %s): %s', contactId, msg, atList, e)
+    }
+  }
+
+  /**
+   * 上传文件到cdn
+   * @param url
+   */
+
+  public async uploadFile (url: string, type: number): Promise<any> {
+    return await this.postData({
+      path: '/cloud/cdn_upload',
+      data: {
+        file_type: type,
+        url,
+      },
+    })
+  }
+
+  public async downloadImage (imageInfo: ImageMessagePayload): Promise<any> {
+    const params = {
+      file_type: 2,
+      file_id: imageInfo.file_id,
+      aes_key: imageInfo.aes_key,
+      file_size: imageInfo.file_size,
+      file_name: `/微信图片_${format(new Date(), 'yyyyMMddHHmmss')}.png`,
+    }
+    const res = await this.postData({
+      path: '/cloud/cdn_download',
+      data: params,
+    })
+    return encodeURI(res.url) || ''
+  }
+
+  /**
+   * 下载文件
+   * @param imageInfo
+   */
+  public async downloadFile (imageInfo: ImageMessagePayload): Promise<any> {
+    const params = {
+      file_type: 5,
+      file_id: imageInfo.file_id.replace('@cdn_', ''),
+      aes_key: imageInfo.aes_key,
+      file_size: imageInfo.file_size,
+      file_name: '/' + imageInfo.file_name,
+    }
+    const res = await this.postData({
+      path: '/cloud/cdn_download',
+      data: params,
+    })
+
+    return encodeURI(res.url) || ''
+  }
+
+  /**
+   * 下载语音
+   * @param imageInfo
+   */
+  public async downloadAudio (
+    msgId: string,
+    voiceInfo: VoiceMessagePayload,
+    roomId?: string,
+  ): Promise<any> {
+    const params = {
+      msg_id: msgId,
+      length: voiceInfo.length,
+      room_username: roomId,
+      file_name: '/voice.mp3',
+      to_mp3: true,
+    }
+    const res = await this.postData({
+      path: '/cloud/download_voice',
+      data: params,
+    })
+
+    return encodeURI(res.url) || ''
+  }
+
+  /**
+   * 下载视频
+   * @param imageInfo
+   */
+  public async downloadVideo (videoInfo: VideoMessagePayload): Promise<any> {
+    const params = {
+      file_type: 4,
+      file_id: videoInfo.file_id,
+      aes_key: videoInfo.aes_key,
+      file_size: videoInfo.file_size,
+      file_name: `/微信视频_${format(new Date(), 'yyyyMMddHHmmss')}.mp4`,
+    }
+
+    const res = await this.postData({
+      path: '/cloud/cdn_download',
+      data: params,
+    })
+
+    return encodeURI(res.url) || ''
+  }
+
+  /**
+   * 发送图片
+   * @param contactId 要给谁，支持好友、群聊、公众号等
+   * @param url 远程图片路径
+   */
+  public async sendUrlImg (
+    contactId: string,
+    url: string,
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const fileInfo = await this.uploadFile(url, 2)
+      const res = await this.postData({
+        path: '/msg/send_image',
+        data: {
+          to_username: contactId,
+          file_id: fileInfo.file_id,
+          aes_key: fileInfo.aes_key,
+          file_size: fileInfo.file_size,
+          big_file_size: 0,
+          thumb_file_size: fileInfo.thumb_file_size,
+          file_md5: fileInfo.md5,
+          thumb_width: fileInfo.thumb_width,
+          thumb_height: fileInfo.thumb_height,
+          file_crc: fileInfo.file_crc,
+        },
+      })
+      return {
+        id: res?.newMsgId || '',
+        timeStamp: res?.createTime || '',
+        msgType: WechatMessageType.Image,
+        talkerId: selfId || '',
+        text: url,
+        msg: url,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (e) {
+      log.error(PRE, 'sendUrlImg(%s, %s): %s', contactId, url, e)
+    }
+  }
+
+  /**
+   * 发送视频
+   * @param contactId 要给谁，支持好友、群聊、公众号等
+   * @param url 远程路径
+   */
+  public async sendVideo (
+    contactId: string,
+    url: string,
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const fileInfo = await this.uploadFile(url, 4)
+      const res = await this.postData({
+        path: '/msg/send_video',
+        data: {
+          to_username: contactId,
+          file_id: fileInfo.file_id,
+          aes_key: fileInfo.aes_key,
+          file_size: fileInfo.file_size,
+          thumb_file_size: fileInfo.thumb_file_size,
+          file_md5: fileInfo.md5,
+          thumb_file_md5: fileInfo.thumb_file_md5,
+          video_duration: fileInfo.video_duration,
+          file_crc: fileInfo.file_crc,
+          mp4_identify: fileInfo.mp4_identify,
+        },
+      })
+
+      return {
+        id: res?.newMsgId || '',
+        timeStamp: res?.createTime || getUnixTime(new Date()),
+        msgType: WechatMessageType.Image,
+        talkerId: selfId || '',
+        text: url,
+        msg: url,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (error) {
+      log.error(PRE, 'sendVideo(%s, %s): %s', contactId, url, error)
+    }
+  }
+
+  /**
+   * 发送文件
+   * @param contactId 要给谁，支持好友、群聊、公众号等
+   * @param url 远程路径
+   */
+  public async sendCloudFile (
+    contactId: string,
+    url: string,
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const fileInfo = await this.uploadFile(url, 5)
+      const res = await this.postData({
+        path: '/msg/send_file',
+        data: {
+          to_username: contactId,
+          file_id: fileInfo.file_id,
+          aes_key: fileInfo.aes_key,
+          file_size: fileInfo.file_size,
+          file_md5: fileInfo.md5,
+          file_name: fileInfo.name,
+          file_key: fileInfo.file_key,
+        },
+      })
+      return {
+        id: res?.newMsgId || '',
+        timeStamp: res?.createTime || '',
+        msgType: WechatMessageType.App,
+        talkerId: selfId || '',
+        text: url,
+        msg: url,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (error) {
+      log.error(PRE, 'sendCloudFile(%s, %s): %s', contactId, url, error)
+    }
+  }
+
+  /**
+   * 发送分享链接
+   * @param contactId
+   * @param title
+   * @param content
+   * @param jumpUrl 点击跳转地址
+   * @param imageUrl 缩略图地址
+   */
+  public async sendShareCard (
+    {
+      contactId,
+      title,
+      content,
+      jumpUrl,
+      imageUrl,
+    }: {
+      contactId: string;
+      title: string;
+      content: string | undefined;
+      jumpUrl: string;
+      imageUrl: string | undefined;
+    },
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const res = await this.postData({
+        path: '/msg/send_link_card',
+        data: {
+          to_username: contactId,
+          title,
+          desc: content,
+          url: jumpUrl,
+          image_url: imageUrl,
+        },
+      })
+      return {
+        id: res?.newMsgId || '',
+        timeStamp: res?.createTime || '',
+        msgType: WechatMessageType.Text,
+        talkerId: selfId || '',
+        text: jumpUrl,
+        msg: jumpUrl,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (e) {
+      log.error('error info', e)
+    }
+  }
+
+  /**
+   * 发送小程序
+   * @param contactId
+   * @param title
+   * @param content
+   * @param jumpUrl 点击跳转地址 点击跳转地址，例如饿了么首页为：pages/index/index.html
+   * @param gh 例如饿了么为：gh_6506303a12bb
+   * @param path 本地图片路径
+   */
+  public async sendMiniProgram (
+    {
+      appid,
+      contactId,
+      title,
+      content,
+      pagePath,
+      username,
+      thumbUrl,
+      iconUrl,
+    }: any,
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const fileInfo = await this.uploadFile(thumbUrl, 2)
+      const res = await this.postData({
+        path: '/msg/send_mini_app',
+        data: {
+          to_username: contactId,
+          appid,
+          username:
+            username && username.endsWith('@app')
+              ? username
+              : username + '@app',
+          title: content,
+          appname: title,
+          page_path: pagePath,
+          appicon: iconUrl,
+          file_id: fileInfo.file_id,
+          aes_key: fileInfo.aes_key,
+          file_size: fileInfo.file_size,
+          file_md5: fileInfo.md5,
+        },
+      })
+
+      return {
+        id: res?.newMsgId || '',
+        timeStamp: res?.createTime || '',
+        msgType: WechatMessageType.MiniProgram,
+        talkerId: selfId || '',
+        text: appid + '_' + username,
+        msg: appid + '_' + username,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (error) {
+      log.error(PRE, 'sendMiniProgram(%s, %s): %s', contactId, username, error)
+    }
+  }
+
+  /**
+   * 发送xml消息
+   * XML里<fromusername>wxid_3sq4tklb6c3121</fromusername>必须为自己的wxid，切记
+   * @param contactId
+   * @param xml
+   * 1.消息内支持文本代码，详情见文本代码章节
+   * 2.微信最多支持4096个字符，相当于2048个汉字，请勿超出否则崩溃
+   */
+  public async sendXml (
+    contactId: string,
+    xml: string,
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const res = await this.postData({
+        path: '/msg/send_app_msg',
+        data: {
+          to_username: contactId,
+          app_type: 0,
+          appid: '',
+          xml,
+        },
+      })
+
+      return {
+        id: res?.newMsgId || '',
+        timeStamp: res?.createTime || '',
+        msgType: WechatMessageType.App,
+        talkerId: selfId || '',
+        text: xml,
+        msg: xml,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (error) {
+      log.error(PRE, 'sendXml(%s, %s): %s', contactId, xml, error)
+    }
+  }
+
+  /**
+   * 同意好友请求
+   * @param contactId
+   * @param scene 来源
+   * @param ticket
+   */
+  public async confirmFriendship (
+    contactId: string,
+    scene: string | number | undefined,
+    ticket: string,
+  ): Promise<void> {
+    const res = await this.postData({
+      path: '/contact/verify_friend',
+      data: {
+        username: contactId,
+        scene: (scene && scene.toString()) || 6,
+        ticket,
+        opcode: 3, // 检查好友状态=>1, 单向加好友=>2, 同意好友申请=>3
+      },
+    })
+    return res
+  }
+
+  /**
+   * 添加好友_通过wxid
+   * @param scene 来源 1=qq 3=微信号 6=单向添加 10和13=通讯录 14=群聊 15=手机号 17=名片 30=扫一扫
+   * @param content 打招呼内容
+   * @param wxid wxid
+   */
+  public async addFriendByWxid ({
+    scene,
+    wxid,
+    content,
+    ticket,
+  }: {
+    scene: string | undefined;
+    content: string | undefined;
+    wxid: string | undefined;
+    ticket: string | undefined;
+  }): Promise<void> {
+    await this.postData({
+      path: '/contact/add_friend',
+      data: {
+        scene,
+        username: wxid,
+        verify_content: content,
+        ticket,
+      },
+    })
+  }
+
+  /**
+   * 查询陌生人信息
+   * @param content 手机号或者QQ
+   */
+  public async searchStranger (content: string): Promise<ContactPayload> {
+    const contact = await this.postData({
+      path: '/contact/search_contact',
+      data: {
+        username: content,
+        from_scene: 0,
+        search_scene: 0,
+      },
+    })
+
+    return {
+      wxNum: contact?.alias || '',
+      wxid: contact?.userName?.string,
+      isFriend:
+        contact?.userName?.string.includes('@stranger')
+        && contact?.userName?.string.includes('v3_')
+          ? 0
+          : 1,
+      name: contact?.nickName?.string || '',
+      sex: contact?.sex,
+      alias: contact?.remark?.string || '',
+      province: contact?.province || '',
+      city: contact?.city || '',
+      country: contact?.country || '',
+      avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
+      description: contact?.description,
+      labelIdlist: contact?.labelIdlist,
+      scene: contact?.addContactScene,
+      sign: contact?.signature,
+      snsBgImg: contact?.snsUserInfo?.snsBgimgId,
+      ticket: contact?.antispamTicket,
+    }
+  }
+
+  /**
+   * 邀请进群
+   * @param groupId 群id
+   * @param contactId 好友wxid
+   * @param type 类型 1直接拉  2 发送邀请链接
+   */
+  public async inviteToGroup (
+    groupId: string,
+    contactId: string,
+    type: number = 1,
+  ): Promise<void> {
+    if (type === 1) {
+      await this.postData({
+        path: '/room/add_chatroom_member',
+        data: {
+          room_username: groupId,
+          username_list: [ contactId ],
+        },
+      })
+    } else {
+      await this.postData({
+        path: '/room/invite_chatroom_member',
+        data: {
+          room_username: groupId,
+          username_list: [ contactId ],
+        },
+      })
+    }
+  }
+
+  /**
+   * 删除好友
+   * @param contactId 好友wxid
+   */
+  public async removeContact (contactId: string): Promise<void> {
+    await this.postData({
+      path: '/contact/del_friend',
+      data: {
+        username: contactId,
+      },
+    })
+  }
+
+  /**
+   * 设置好友备注
+   * @param contactId 好友wxid
+   * @param remark 支持emoji、微信表情
+   */
+  public async setContactAlias (
+    contactId: string,
+    remark: string,
+  ): Promise<void> {
+    await this.postData({
+      path: '/contact/modify_remark',
+      data: {
+        username: contactId,
+        remark,
+      },
+    })
+  }
+
+  /**
+   * 修改群名
+   * @param groupId 群id
+   * @param name 群名
+   */
+  public async setGroupName (
+    groupId: string,
+    name: string | undefined,
+  ): Promise<void> {
+    await this.postData({
+      path: '/room/modify_chatroom_name',
+      data: {
+        room_username: groupId,
+        name,
+      },
+    })
+  }
+
+  /**
+   * 删除好友
+   * @param contactId 好友wxid
+   */
+  public async roomQuit (roomId: string): Promise<void> {
+    await this.postData({
+      path: '/room/quit_chatroom',
+      data: {
+        room_username: roomId,
+      },
+    })
+  }
+
+  /**
+   * 发送名片
+   * @param contactId 接收人id
+   * @param xml 名片xml
+   */
+  public async sendContactCard (
+    contactId: string,
+    xml: string | any,
+    selfId: string | undefined,
+  ): Promise<MessagePayload | void> {
+    try {
+      const res = await this.postData({
+        path: '/msg/send_share_card_raw',
+        data: {
+          to_username: contactId,
+          xml,
+        },
+      })
+      return {
+        id: res?.newMsgId || '',
+        timeStamp: res?.createTime || '',
+        msgType: WechatMessageType.App,
+        talkerId: selfId || '',
+        text: xml,
+        msg: xml,
+        fromWxid: isRoomId(contactId) ? contactId : '',
+        listenerId: contactId,
+      }
+    } catch (error) {
+      log.error(PRE, 'sendContactCard(%s, %s): %s', contactId, xml, error)
+    }
+  }
+
+  /**
+   * 发送群公告
+   * @param roomId 群id
+   * @param content 公告内容
+   */
+  public async sendAnnouncement (
+    roomId: string,
+    content: string,
+  ): Promise<void> {
+    try {
+      const res = await this.postData({
+        path: '/room/set_chatroom_announcement',
+        data: {
+          room_username: roomId,
+          announcement: content,
+        },
+      })
+      if (res.baseResponse.ret) {
+        log.error('sendAnnouncement error: %s', JSON.stringify(res.baseResponse))
+      }
+    } catch (error) {
+      log.error(PRE, 'sendAnnouncement(%s, %s): %s', roomId, content, error)
+    }
+  }
+
+}
+
+export default Client