@perk-net/perk-pushplus-sdk 1.0.0

package/src/api/clawbot-api.ts

@@ -0,0 +1,42 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import { ClawBotInfo, ClawBotMessage, ClawBotQrCode } from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 微信 ClawBot（文档「八. 微信ClawBot接口」）。
+ */
+export class ClawBotApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 1. 获取二维码。 */
+  getBotQrcode(): Promise<ClawBotQrCode> {
+    return this.executeOpen<ClawBotQrCode>('GET', '/api/open/clawBot/getBotQrcode');
+  }
+
+  /** 2. 扫码结果查询。 */
+  async getQrcodeStatus(qrcode: string): Promise<void> {
+    await this.executeOpen<unknown>(
+      'GET',
+      this.appendQuery('/api/open/clawBot/getQrcodeStatus', { getQrcodeStatus: qrcode }),
+    );
+  }
+
+  /** 3. 绑定详情。 */
+  botInfo(): Promise<ClawBotInfo> {
+    return this.executeOpen<ClawBotInfo>('GET', '/api/open/clawBot/botInfo');
+  }
+
+  /** 4. 解绑。 */
+  async unbind(): Promise<void> {
+    await this.executeOpen<unknown>('GET', '/api/open/clawBot/unbind');
+  }
+
+  /** 5. 获取发送消息。 */
+  getMsg(): Promise<ClawBotMessage[]> {
+    return this.executeOpen<ClawBotMessage[]>('GET', '/api/open/clawBot/getMsg');
+  }
+}

package/src/api/friend-api.ts

@@ -0,0 +1,47 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import { FriendItem, FriendQrCode, PageQuery, PageResult } from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 好友功能（文档「十. 好友功能接口」）。
+ */
+export class FriendApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 1. 获取个人二维码。 */
+  getQrCode(options: {
+    appId?: string;
+    content?: string;
+    second?: number;
+    scanCount?: number;
+  }): Promise<FriendQrCode> {
+    const p: Record<string, unknown> = {};
+    if (options.appId != null) p.appId = options.appId;
+    if (options.content != null) p.content = options.content;
+    if (options.second != null) p.second = options.second;
+    if (options.scanCount != null) p.scanCount = options.scanCount;
+    return this.executeOpen<FriendQrCode>('GET', this.appendQuery('/api/open/friend/getQrCode', p));
+  }
+
+  /** 2. 获取好友列表。 */
+  list(query?: PageQuery): Promise<PageResult<FriendItem>> {
+    return this.executeOpen<PageResult<FriendItem>>('POST', '/api/open/friend/list', query ?? {});
+  }
+
+  /** 3. 删除好友。 */
+  async delete(friendId: number): Promise<void> {
+    await this.executeOpen<unknown>(
+      'GET',
+      this.appendQuery('/api/open/friend/deleteFriend', { friendId }),
+    );
+  }
+
+  /** 4. 修改好友备注。 */
+  async editRemark(id: number, remark: string): Promise<void> {
+    await this.executeOpen<unknown>('POST', '/api/open/friend/editRemark', { id, remark });
+  }
+}

package/src/api/message-api.ts

@@ -0,0 +1,109 @@
+import { ResolvedPushPlusConfig } from '../config';
+import { PushPlusError } from '../exception';
+import { HttpRequester } from '../http';
+import { BatchSendRequest, BatchSendResult, SendRequest } from '../models';
+import { RateLimitGuard } from '../rate-limit';
+import { AbstractApi } from './base';
+
+/**
+ * 发送消息接口。
+ *
+ * 对应 PushPlus 文档「二. 发送消息接口」与「三. 多渠道发送消息接口」。
+ *
+ * 内置本地限流守卫：当上游返回 ErrorCode.RATE_LIMITED（code=900）时，
+ * 后续对同一 token 的发送调用会在 SDK 内被直接短路抛 PushPlusError，
+ * 不再发起 HTTP，直到守卫到期自动解除。
+ */
+export class MessageApi extends AbstractApi {
+  private readonly rateLimitGuard: RateLimitGuard;
+
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, rateLimitGuard: RateLimitGuard) {
+    super(config, http);
+    this.rateLimitGuard = rateLimitGuard;
+  }
+
+  /** 暴露限流守卫，便于运维场景手动 clear 或观察解禁时间。 */
+  getRateLimitGuard(): RateLimitGuard {
+    return this.rateLimitGuard;
+  }
+
+  /**
+   * 发送单条消息。
+   *
+   * @returns 消息流水号
+   */
+  async send(request: SendRequest): Promise<string> {
+    const req = this.withDefaultToken(request);
+    validateSend(req);
+    this.rateLimitGuard.check(req.token);
+    return this.executeWithGuard(req.token, () =>
+      this.executeForData<string>('POST', '/send', null, req),
+    );
+  }
+
+  /**
+   * 多渠道发送消息。
+   */
+  async batchSend(request: BatchSendRequest): Promise<BatchSendResult[]> {
+    const req = this.withDefaultBatchToken(request);
+    validateBatch(req);
+    this.rateLimitGuard.check(req.token);
+    return this.executeWithGuard(req.token, () =>
+      this.executeForData<BatchSendResult[]>('POST', '/batchSend', null, req),
+    );
+  }
+
+  /** 便捷方法：以默认渠道、默认模板发送一条简单消息。 */
+  sendSimple(title: string | undefined, content: string): Promise<string> {
+    return this.send({ title, content });
+  }
+
+  /* ============================== 内部辅助 ============================== */
+
+  private async executeWithGuard<T>(token: string | undefined, call: () => Promise<T>): Promise<T> {
+    try {
+      return await call();
+    } catch (e) {
+      if (e instanceof PushPlusError && e.isRateLimited()) {
+        this.rateLimitGuard.markBlocked(token);
+      }
+      throw e;
+    }
+  }
+
+  private withDefaultToken(req: SendRequest): SendRequest {
+    if (req == null) throw new PushPlusError('SendRequest 不能为空');
+    if (!req.token || req.token.trim().length === 0) {
+      return { ...req, token: this.requireToken() };
+    }
+    return req;
+  }
+
+  private withDefaultBatchToken(req: BatchSendRequest): BatchSendRequest {
+    if (req == null) throw new PushPlusError('BatchSendRequest 不能为空');
+    if (!req.token || req.token.trim().length === 0) {
+      return { ...req, token: this.requireToken() };
+    }
+    return req;
+  }
+
+  private requireToken(): string {
+    const t = this.config.token;
+    if (!t || t.trim().length === 0) {
+      throw new PushPlusError('发送消息需要 token，但 PushPlusConfig.token 为空');
+    }
+    return t;
+  }
+}
+
+function validateSend(req: SendRequest): void {
+  if (!req.content || req.content.trim().length === 0) {
+    throw new PushPlusError('发送消息 content 不能为空');
+  }
+}
+
+function validateBatch(req: BatchSendRequest): void {
+  if (!req.content || req.content.trim().length === 0) {
+    throw new PushPlusError('批量发送消息 content 不能为空');
+  }
+}

package/src/api/message-token-api.ts

@@ -0,0 +1,52 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import {
+  MessageTokenAddRequest,
+  MessageTokenEditRequest,
+  MessageTokenItem,
+  MessageTokenOption,
+  PageQuery,
+  PageResult,
+} from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 消息 token（文档「四. 消息token接口」）。
+ */
+export class MessageTokenApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 获取消息 token 列表。 */
+  list(query?: PageQuery): Promise<PageResult<MessageTokenItem>> {
+    return this.executeOpen<PageResult<MessageTokenItem>>('POST', '/api/open/token/list', query ?? {});
+  }
+
+  /** 新增消息 token，返回新建的 token 字符串。 */
+  add(req: MessageTokenAddRequest): Promise<string> {
+    return this.executeOpen<string>('POST', '/api/open/token/add', req);
+  }
+
+  /** 修改消息 token。 */
+  edit(req: MessageTokenEditRequest): Promise<string> {
+    return this.executeOpen<string>('POST', '/api/open/token/edit', req);
+  }
+
+  /** 删除消息 token。 */
+  delete(id: number): Promise<string> {
+    const path = this.appendQuery('/api/open/token/deleteToken', { id });
+    return this.executeOpen<string>('DELETE', path);
+  }
+
+  /**
+   * 消息 token 下拉选择列表。
+   *
+   * @param type 0-返回所有；1-返回未配置默认推送渠道的消息 token
+   */
+  selectList(type?: number): Promise<MessageTokenOption[]> {
+    const path = this.appendQuery('/api/open/token/selectTokenList', { type: type ?? 0 });
+    return this.executeOpen<MessageTokenOption[]>('GET', path);
+  }
+}

package/src/api/open-base.ts

@@ -0,0 +1,54 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { PushPlusError } from '../exception';
+import { HttpRequester } from '../http';
+import { AbstractApi, isApiSuccess } from './base';
+
+/**
+ * 开放接口基类。会自动在 header 中带上 access-key，
+ * 并在收到 401 类业务错误时尝试重试一次（刷新 AccessKey 后重试）。
+ */
+export abstract class OpenAbstractApi extends AbstractApi {
+  static readonly HEADER_ACCESS_KEY = 'access-key';
+  /** PushPlus AccessKey 失效相关的业务码（用于触发自动重试）。 */
+  private static readonly CODE_ACCESS_KEY_INVALID = 401;
+
+  protected readonly accessKeyManager: AccessKeyManager;
+
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, accessKeyManager: AccessKeyManager) {
+    super(config, http);
+    this.accessKeyManager = accessKeyManager;
+  }
+
+  private async headersWithAccessKey(): Promise<Record<string, string>> {
+    const key = await this.accessKeyManager.getAccessKey();
+    return { [OpenAbstractApi.HEADER_ACCESS_KEY]: key };
+  }
+
+  /**
+   * 执行带 access-key 的请求；当返回 code=401 时自动刷新 key 并重试一次。
+   */
+  protected async executeOpen<T>(method: string, path: string, body?: unknown): Promise<T> {
+    const headers = await this.headersWithAccessKey();
+    const resp = await this.execute<T>(method, path, headers, body);
+    if (isApiSuccess(resp)) {
+      return resp.data as T;
+    }
+    if (resp.code === OpenAbstractApi.CODE_ACCESS_KEY_INVALID) {
+      this.accessKeyManager.invalidate();
+      const retryHeaders = await this.headersWithAccessKey();
+      const retry = await this.execute<T>(method, path, retryHeaders, body);
+      if (isApiSuccess(retry)) {
+        return retry.data as T;
+      }
+      throw new PushPlusError(
+        `PushPlus 开放接口业务失败(重试后): code=${retry.code}, msg=${retry.msg}`,
+        retry.code ?? -1,
+      );
+    }
+    throw new PushPlusError(
+      `PushPlus 开放接口业务失败: code=${resp.code}, msg=${resp.msg}`,
+      resp.code ?? -1,
+    );
+  }
+}

package/src/api/open-message-api.ts

@@ -0,0 +1,50 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { PushPlusError } from '../exception';
+import { HttpRequester } from '../http';
+import { MessageItem, PageQuery, PageResult, SendMessageResult } from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 消息接口（文档「二. 消息接口」）。
+ */
+export class OpenMessageApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 1. 消息列表。 */
+  list(query?: PageQuery): Promise<PageResult<MessageItem>> {
+    return this.executeOpen<PageResult<MessageItem>>('POST', '/api/open/message/list', query ?? {});
+  }
+
+  /** 2. 查询消息发送结果。 */
+  queryResult(shortCode: string): Promise<SendMessageResult> {
+    if (!shortCode || shortCode.trim().length === 0) {
+      throw new PushPlusError('shortCode 不能为空');
+    }
+    const path = this.appendQuery('/api/open/message/sendMessageResult', { shortCode });
+    return this.executeOpen<SendMessageResult>('GET', path);
+  }
+
+  /** 3. 删除消息。 */
+  delete(shortCode: string): Promise<string> {
+    if (!shortCode || shortCode.trim().length === 0) {
+      throw new PushPlusError('shortCode 不能为空');
+    }
+    const path = this.appendQuery('/api/open/message/deleteMessage', { shortCode });
+    return this.executeOpen<string>('DELETE', path);
+  }
+
+  /**
+   * 4. 消息详情（HTML 页面 URL）。
+   *
+   * 该接口直接返回 HTML 内容，SDK 仅返回访问 URL，调用方自行决定是否拉取页面内容。
+   */
+  detailUrl(shortCode: string): string {
+    if (!shortCode || shortCode.trim().length === 0) {
+      throw new PushPlusError('shortCode 不能为空');
+    }
+    return this.resolveUrl('/shortMessage/' + shortCode);
+  }
+}

package/src/api/pre-api.ts

@@ -0,0 +1,42 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import { PageQuery, PageResult, PreDetail, PreItem, PreSaveRequest, PreTestRequest } from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 预处理信息（文档「十一. 预处理信息接口」）。注：需开通会员。
+ */
+export class PreApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  list(q?: PageQuery): Promise<PageResult<PreItem>> {
+    return this.executeOpen<PageResult<PreItem>>('POST', '/api/open/pre/list', q ?? {});
+  }
+
+  detail(preId: number): Promise<PreDetail> {
+    return this.executeOpen<PreDetail>('GET', this.appendQuery('/api/open/pre/detail', { preId }));
+  }
+
+  add(req: PreSaveRequest): Promise<number> {
+    return this.executeOpen<number>('POST', '/api/open/pre/add', req);
+  }
+
+  edit(req: PreSaveRequest): Promise<string> {
+    return this.executeOpen<string>('POST', '/api/open/pre/edit', req);
+  }
+
+  delete(preId: number): Promise<string> {
+    return this.executeOpen<string>(
+      'DELETE',
+      this.appendQuery('/api/open/pre/delete', { preId }),
+    );
+  }
+
+  /** 测试预处理代码，返回处理后的消息。 */
+  test(req: PreTestRequest): Promise<string> {
+    return this.executeOpen<string>('POST', '/api/open/pre/test', req);
+  }
+}

package/src/api/setting-api.ts

@@ -0,0 +1,99 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import {
+  PageQuery,
+  PageResult,
+  UserDefaultDetail,
+  UserDefaultItem,
+  UserDefaultSaveRequest,
+} from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 功能设置（文档「九. 功能设置接口」）。
+ */
+export class SettingApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 1. 获取默认配置列表。 */
+  listUserDefault(q?: PageQuery): Promise<PageResult<UserDefaultItem>> {
+    return this.executeOpen<PageResult<UserDefaultItem>>('POST', '/api/open/setting/listUserDefault', q ?? {});
+  }
+
+  /** 2. 默认配置详情。 */
+  detailUserDefault(id: number): Promise<UserDefaultDetail> {
+    return this.executeOpen<UserDefaultDetail>(
+      'GET',
+      this.appendQuery('/api/open/setting/detailUserDefault', { id }),
+    );
+  }
+
+  /** 3. 新增默认配置。 */
+  async addUserDefault(req: UserDefaultSaveRequest): Promise<void> {
+    await this.executeOpen<unknown>('POST', '/api/open/setting/addUserDefault', req);
+  }
+
+  /** 4. 修改默认配置。 */
+  async editUserDefault(req: UserDefaultSaveRequest): Promise<void> {
+    await this.executeOpen<unknown>('POST', '/api/open/setting/editUserDefault', req);
+  }
+
+  /** 5. 删除默认配置。 */
+  async deleteUserDefault(id: number): Promise<void> {
+    await this.executeOpen<unknown>(
+      'DELETE',
+      this.appendQuery('/api/open/setting/deleteUserDefault', { id }),
+    );
+  }
+
+  /**
+   * 6. 修改接收消息限制。
+   *
+   * @param recevieLimit 0-接收全部，1-不接收消息
+   */
+  async changeReceiveLimit(recevieLimit: number): Promise<void> {
+    await this.executeOpen<unknown>(
+      'GET',
+      this.appendQuery('/api/open/setting/changeRecevieLimit', { recevieLimit }),
+    );
+  }
+
+  /**
+   * 7. 开启/关闭发送消息功能。
+   *
+   * @param isSend 0-禁用，1-启用
+   */
+  async changeIsSend(isSend: number): Promise<void> {
+    await this.executeOpen<unknown>(
+      'GET',
+      this.appendQuery('/api/open/setting/changeIsSend', { isSend }),
+    );
+  }
+
+  /**
+   * 8. 修改打开消息方式。
+   *
+   * @param openMessageType 0:H5，1:小程序
+   */
+  async changeOpenMessageType(openMessageType: number): Promise<void> {
+    await this.executeOpen<unknown>(
+      'GET',
+      this.appendQuery('/api/open/setting/changeOpenMessageType', { openMessageType }),
+    );
+  }
+
+  /**
+   * 9. 修改插件渠道转发。
+   *
+   * @param forward 0:否，1:是
+   */
+  async changeExtensionForward(forward: number): Promise<void> {
+    await this.executeOpen<unknown>(
+      'GET',
+      this.appendQuery('/api/open/setting/extension', { forward }),
+    );
+  }
+}

package/src/api/topic-api.ts

@@ -0,0 +1,80 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import {
+  PageResult,
+  TopicAddRequest,
+  TopicDetail,
+  TopicEditRequest,
+  TopicItem,
+  TopicListQuery,
+  TopicQrCode,
+} from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 群组接口（文档「五. 群组接口」）。
+ */
+export class TopicApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 1. 群组列表。 */
+  list(query?: TopicListQuery): Promise<PageResult<TopicItem>> {
+    return this.executeOpen<PageResult<TopicItem>>('POST', '/api/open/topic/list', query ?? {});
+  }
+
+  /** 2. 获取我创建的群组详情。 */
+  detail(topicId: number): Promise<TopicDetail> {
+    return this.executeOpen<TopicDetail>('GET', this.appendQuery('/api/open/topic/detail', { topicId }));
+  }
+
+  /** 3. 获取我加入的群详情。 */
+  joinDetail(topicId: number): Promise<TopicDetail> {
+    return this.executeOpen<TopicDetail>(
+      'GET',
+      this.appendQuery('/api/open/topic/joinTopicDetail', { topicId }),
+    );
+  }
+
+  /** 4. 新增群组，返回新建群组编号。 */
+  add(req: TopicAddRequest): Promise<number> {
+    return this.executeOpen<number>('POST', '/api/open/topic/add', req);
+  }
+
+  /** 5. 修改群组。 */
+  edit(req: TopicEditRequest): Promise<string> {
+    return this.executeOpen<string>('POST', '/api/open/topic/editTopic', req);
+  }
+
+  /** 6. 获取群组二维码。 */
+  qrCode(topicId: number, second?: number, scanCount?: number): Promise<TopicQrCode> {
+    const params: Record<string, unknown> = { topicId };
+    if (second != null) params.second = second;
+    if (scanCount != null) params.scanCount = scanCount;
+    return this.executeOpen<TopicQrCode>('GET', this.appendQuery('/api/open/topic/qrCode', params));
+  }
+
+  /** 7. 退出群组。 */
+  exit(topicId: number): Promise<string> {
+    return this.executeOpen<string>(
+      'GET',
+      this.appendQuery('/api/open/topic/exitTopic', { topicId }),
+    );
+  }
+
+  /** 8. 删除群组。 */
+  delete(topicId: number): Promise<string> {
+    return this.executeOpen<string>('GET', this.appendQuery('/api/open/topic/delete', { topicId }));
+  }
+
+  /**
+   * 9. 上下架积分群组。
+   *
+   * @param isOpen 1-上架，0-下架
+   */
+  setOpen(topicId: number, isOpen: number): Promise<string> {
+    return this.executeOpen<string>('POST', '/api/open/topic/isOpen', { topic: topicId, isOpen });
+  }
+}

package/src/api/topic-user-api.ts

@@ -0,0 +1,30 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import { PageResult, TopicUserItem, TopicUserListQuery } from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 群组用户（文档「六. 群组用户接口」）。
+ */
+export class TopicUserApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 1. 获取群组内用户。 */
+  subscriberList(query: TopicUserListQuery): Promise<PageResult<TopicUserItem>> {
+    return this.executeOpen<PageResult<TopicUserItem>>('POST', '/api/open/topicUser/subscriberList', query);
+  }
+
+  /** 2. 删除群组内用户。 */
+  deleteUser(topicRelationId: number): Promise<string> {
+    const path = this.appendQuery('/api/open/topicUser/deleteTopicUser', { topicRelationId });
+    return this.executeOpen<string>('POST', path);
+  }
+
+  /** 3. 修改订阅人备注。 */
+  async editRemark(id: number, remark: string): Promise<void> {
+    await this.executeOpen<unknown>('POST', '/api/open/topicUser/editRemark', { id, remark });
+  }
+}

package/src/api/user-api.ts

@@ -0,0 +1,34 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import { SendCount, UserInfo, UserLimitTime } from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - 用户接口（文档「三. 用户接口」）。
+ */
+export class UserApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 获取用户 token。 */
+  getToken(): Promise<string> {
+    return this.executeOpen<string>('GET', '/api/open/user/token');
+  }
+
+  /** 个人资料详情。 */
+  myInfo(): Promise<UserInfo> {
+    return this.executeOpen<UserInfo>('GET', '/api/open/user/myInfo');
+  }
+
+  /** 获取解封剩余时间。 */
+  getLimitTime(): Promise<UserLimitTime> {
+    return this.executeOpen<UserLimitTime>('GET', '/api/open/user/userLimitTime');
+  }
+
+  /** 查询当日消息接口请求次数。 */
+  getSendCount(): Promise<SendCount> {
+    return this.executeOpen<SendCount>('GET', '/api/open/user/sendCount');
+  }
+}

package/src/api/webhook-api.ts

@@ -0,0 +1,34 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import { PageQuery, PageResult, WebhookItem, WebhookSaveRequest } from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/**
+ * 开放接口 - webhook 渠道配置（文档「七. 渠道配置接口」 1-4）。
+ */
+export class WebhookApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  list(q?: PageQuery): Promise<PageResult<WebhookItem>> {
+    return this.executeOpen<PageResult<WebhookItem>>('POST', '/api/open/webhook/list', q ?? {});
+  }
+
+  detail(webhookId: number): Promise<WebhookItem> {
+    return this.executeOpen<WebhookItem>(
+      'GET',
+      this.appendQuery('/api/open/webhook/detail', { webhookId }),
+    );
+  }
+
+  /** 新增 webhook，返回新 id。 */
+  add(req: WebhookSaveRequest): Promise<number> {
+    return this.executeOpen<number>('POST', '/api/open/webhook/add', req);
+  }
+
+  edit(req: WebhookSaveRequest): Promise<string> {
+    return this.executeOpen<string>('POST', '/api/open/webhook/edit', req);
+  }
+}