关闭信令房间

更新时间: 2025/08/19 15:37:22

该接口支持关闭信令频道房间。

如果信令频道房间内的用户都没有主动关闭信令频道,那么服务器默认在会 2 小时后销毁该信令频道(2 小时内没有新用户加入房间,如有,从加入后再开始计算)。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求信息

请求 URL

httpsPOST https://api.yunxinapi.com/nimserver/signal/closeRoom.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求头参数

请求 Header 的参数说明请参考 请求 Header

请求体参数

参数名称 类型 是否必选 描述
channelId String 信令频道 ID。
from String 操作者账号 ID。
isSave Integer 通知是否存离线消息,0(默认):不存离线;1:存离线。
attachExt String 通知扩展字段,最大长度为 4096 字符。
isRoute Integer 是否抄送,0(默认):不抄送;1:抄送。

请求示例

curlcurl -X POST -H "AppKey: go9dnk49***w0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb**cc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=ch_87654321&from=user_abc123' 'https://api.yunxinapi.com/nimserver/signal/closeRoom.action'

响应示例

响应头参数

响应 Header 的参数说明请参考 响应 Header

响应体参数

参数名称 类型 说明
code Integer 状态码,200 表示请求成功。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

JSON{
  "code": 200,
  "data": {}
}

错误码

完整错误码请参考 错误码

此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求信息
  • 请求 URL
  • 请求头参数
  • 请求体参数
  • 请求示例
  • 响应示例
  • 响应头参数
  • 响应体参数
  • 响应体示例
  • 错误码