聊天室聊天室偏好设定取消静音聊天室通知

取消静音聊天室通知

概述

此端点允许当前用户取消指定聊天室的静音设定,恢复接收该聊天室的推播通知。此设定为个人偏好,仅影响当前用户,不影响其他成员。


API 端点

取消静音聊天室通知

取消指定聊天室的静音设定,恢复接收推播通知。

DELETE /me/mute/:room

Headers

参数类型必填说明
IM-CLIENT-KEYstring用户端金钥
IM-Authorizationstring用户端权杖

Path Parameters

参数类型必填说明
:roomstring聊天室唯一识别码

此 API 无需请求内容(Request Body)。

范例请求

cURL 范例:

curl -X "DELETE" "https://your-app.imkit.io/me/mute/demo-room" \
     -H 'IM-CLIENT-KEY: {IM-CLIENT-KEY}' \
     -H 'IM-Authorization: {IM-Authorization}'

JavaScript 范例:

const response = await axios.delete(
  `https://your-app.imkit.io/me/mute/${roomID}`,
  {
    headers: {
      "IM-CLIENT-KEY": `${IM_CLIENT_KEY}`,
      "IM-Authorization": `${TOKEN}`,
    },
  }
);

Response

成功回应(200 OK)

参数类型说明
RCnumber回应代码(0 表示成功)
RMstring回应讯息
resultobject更新后的当前用户资讯
result._idstring用户唯一识别码
result.nicknamestring用户显示名称
result.emailstring用户电子邮件
result.mutearray[string]已静音的聊天室 ID 阵列(取消后移除)

范例回应

{
  "RC": 0,
  "RM": "OK",
  "result": {
    "_id": "1485248560558",
    "email": "test@test.com",
    "nickname": "Test AB",
    "appID": "SampleApp",
    "avatarUrl": "http://example.com/avatarUrl",
    "address": {
      "port": 56216,
      "family": "IPv6",
      "address": "::1"
    },
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36",
    "mute": [],
    "lastLoginTimeMS": 1487068306745
  }
}

错误回应

当请求失败时,您会收到包含错误详细资讯的错误回应。常见的错误情况包括:

  • 无效的用户端金钥或授权权杖
  • 指定的聊天室不存在
  • 伺服器内部错误

使用场景

  • 恢复聊天室通知:当用户希望重新接收某个聊天室的推播通知时,可取消静音
  • 静音聊天室:若要静音聊天室,请使用静音聊天室通知 API

注意事项

  • 个人偏好:取消静音设定仅影响当前用户,其他成员的通知不受影响
  • 静音状态:成功后,该聊天室 ID 会从回应中 mute 阵列移除,代表用户目前静音的所有聊天室
© 2026 FUNTEK Software Inc. All rights reserved.