Class PushManager

PushManager 负责 push token、免打扰与语言偏好管理

Constructors

constructor

Methods

uploadPushToken setGlobalSilentMode getGlobalSilentMode setConversationSilentMode getConversationSilentMode clearConversationRemindType getConversationSilentModes setPushLanguage getPushLanguage getConversationListByRemindType

Constructors

constructor

Methods

uploadPushToken

  • uploadPushToken(params: UploadPushTokenParams): Promise<void>

    上传或覆盖设备 Push Token。成功时仅表示请求完成，不返回业务数据。

    Parameters

    Returns Promise<void>

    成功时 resolve，无返回值。

    Example: 调用示例（上传设备 token）

    await client.pushManager.uploadPushToken({
      deviceId: 'web-device-001',
      deviceToken: 'token-from-push-provider',
      notifierName: 'FCM',
    });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 传入非空 deviceId、deviceToken 和 notifierName 否
    1500 Push token 上传失败 400 检查登录态、deviceToken 与 notifierName 后重试 是

setGlobalSilentMode

  • setGlobalSilentMode(
        params: SetGlobalSilentModeParams,
    ): Promise<GlobalSilentModeResponse>

    设置 App 级（全局）免打扰规则，支持提醒类型、持续时长、时间区间三种模式。

    Parameters

    Returns Promise<GlobalSilentModeResponse>

    返回全局规则快照。

    Example: 调用示例（设置全局提醒类型）

    const result = await client.pushManager.setGlobalSilentMode({
      rule: { mode: 'REMIND_TYPE', remindType: 'AT' },
    });
    console.log(result.rule.remindType);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 按 REMIND_TYPE、DURATION 或 INTERVAL 选择一种规则模式，并传入对应必填字段 否
    1501 免打扰设置失败 400 检查免打扰参数后重试 否

getGlobalSilentMode

  • getGlobalSilentMode(
        params?: GetGlobalSilentModeParams,
    ): Promise<GlobalSilentModeResponse>

    查询 App 级（全局）免打扰规则。

    Parameters

    Returns Promise<GlobalSilentModeResponse>

    返回全局规则快照。

    Example: 调用示例（查询全局规则）

    const result = await client.pushManager.getGlobalSilentMode();
    console.log(result.rule);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    1501 免打扰设置失败 - 根据错误原因修正后重试 否

setConversationSilentMode

  • setConversationSilentMode(
        params: SetConversationSilentModeParams,
    ): Promise<ConversationSilentModeResponse>

    设置单会话免打扰规则，仅支持单聊与群聊。

    Parameters

    Returns Promise<ConversationSilentModeResponse>

    返回目标会话与规则快照。

    Example: 调用示例（设置会话时长免打扰）

    const result = await client.pushManager.setConversationSilentMode({
      conversationId: 'group_123',
      conversationType: 'groupChat',
      rule: { mode: 'DURATION', duration: 60 },
    });
    console.log(result.rule.expireTimestamp);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 传入合法会话 ID、会话类型，并按 REMIND_TYPE、DURATION 或 INTERVAL 选择一种规则模式 否
    1501 免打扰设置失败 400 检查免打扰参数后重试 否

getConversationSilentMode

  • getConversationSilentMode(
        params: GetConversationSilentModeParams,
    ): Promise<ConversationSilentModeResponse>

    查询单会话免打扰规则。

    Parameters

    Returns Promise<ConversationSilentModeResponse>

    返回目标会话的规则快照。

    Example: 调用示例（查询会话规则）

    const result = await client.pushManager.getConversationSilentMode({
      conversationId: 'user_001',
      conversationType: 'singleChat',
    });
    console.log(result.rule.remindType);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 传入合法会话 ID，并使用 singleChat 或 groupChat 否
    1501 免打扰设置失败 - 根据错误原因修正后重试 否

clearConversationRemindType

  • clearConversationRemindType(
        params: ClearConversationRemindTypeParams,
    ): Promise<ConversationSilentModeResponse>

    清除会话提醒类型配置，恢复服务端默认提醒策略。

    Parameters

    Returns Promise<ConversationSilentModeResponse>

    返回清除后的会话规则快照。

    Example: 调用示例（清除会话提醒类型）

    const result = await client.pushManager.clearConversationRemindType({
      conversationId: 'group_123',
      conversationType: 'groupChat',
    });
    console.log(result.rule.remindType);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 传入合法会话 ID，并使用 singleChat 或 groupChat 否
    1501 免打扰设置失败 - 根据错误原因修正后重试 否

getConversationSilentModes

  • getConversationSilentModes(
        params: GetConversationSilentModesParams,
    ): Promise<BatchConversationSilentModeResponse>

    批量查询多个会话的免打扰规则，单次最多 20 条。

    Parameters

    Returns Promise<BatchConversationSilentModeResponse>

    返回与输入顺序对齐的会话规则列表。

    Example: 调用示例（批量查询）

    const result = await client.pushManager.getConversationSilentModes({
      conversationList: [
        { conversationId: 'user_001', conversationType: 'singleChat' },
        { conversationId: 'group_123', conversationType: 'groupChat' },
      ],
    });
    console.log(result.conversations);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 传入 1 到 20 个会话，并确保每项包含非空 id 与 singleChat/groupChat 类型 否
    1501 免打扰设置失败 - 根据错误原因修正后重试 否

setPushLanguage

  • setPushLanguage(params: SetPushLanguageParams): Promise<void>

    设置推送翻译语言。

    Parameters

    Returns Promise<void>

    成功时 resolve，无返回值。

    Example: 调用示例（设置推送语言）

    await client.pushManager.setPushLanguage({ language: 'zh-Hans' });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 传入非空语言标识，例如 zh-Hans 或 en 否
    1502 推送翻译语言设置失败 400 检查语言参数后重试 否

getPushLanguage

  • getPushLanguage(params?: GetPushLanguageParams): Promise<PushLanguageResponse>

    查询当前推送翻译语言。

    Parameters

    Returns Promise<PushLanguageResponse>

    返回当前语言值。

    Example: 调用示例（查询推送语言）

    const result = await client.pushManager.getPushLanguage();
    console.log(result.language);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    1502 推送翻译语言设置失败 - 根据错误原因修正后重试 否

getConversationListByRemindType

  • getConversationListByRemindType(
        params: GetConversationListByRemindTypeParams,
    ): Promise<MutedConversationPageResponse>

    分页查询已设置提醒类型的会话列表。

    Parameters

    Returns Promise<MutedConversationPageResponse>

    返回会话列表与下一页游标。

    Example: 调用示例（分页查询）

    const result = await client.pushManager.getConversationListByRemindType({
      pageSize: 20,
      cursor: '',
    });
    console.log(result.conversations, result.cursor);

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效 - 传入正整数 pageSize，并使用上一次返回的 cursor 否

Settings

Member Visibility

On This Page

Constructors
Methods