聊天室模块

Chatroom.create(chatroom)

创建聊天室

聊天室使用步骤:

1、App Server 创建聊天室

2、客户端调用各端 SDK 加入聊天室

3、收发消息

chatrooms 参数的属性说明

参数 类型 必填 说明 最低版本
id string 聊天室 Id 3.0.0
name string 聊天室名称 3.0.0
请求成功
{
    "code": 200
}

Chatroom.destory(chatroom)

销毁聊天室,禁言、封禁关系不销毁

chatroom 参数的属性说明

参数 类型 必填 说明 最低版本
id string 聊天室 Id 3.0.0
请求成功
{
    "code": 200
}

Chatroom.get(chatroom)

获取聊天室信息,返回按时间排序后的最多 500 个成员信息

chatroom 参数的属性说明

参数 类型 必填 说明 最低版本
id string 聊天室 Id 列表 3.0.0
count number 聊天室成员信息数,最多返回 500 个成员 3.0.0
order number 查询聊天室成员顺序, 1: 加入时间正序 2: 加入时间倒序 3.0.0
请求成功
{
    "code": 200,
    "total": 100,
    "members": [{
        "id": "member1",
        "time": "2018-03-08 16:38:26"
    },
    {
        "id": "member2",
        "time": "2018-03-08 16:38:26"
    }]
}
参数 类型 说明
id string 用户 Id
total string 当前聊天室中用户数
time string 加入聊天室时间

Chatroom.isExist(chatroom)

检查用户是否在聊天室

参数 类型 说明 最低版本
id string 聊天室 Id 3.0.0
members array 每次最多 1000 个成员 3.0.0
请求成功
{
    "code": 200,
    "members": [{
        "id": "y41z2IXBW",
        "isInChrm": 0
    }, {
        "id": "niCtlxnas",
        "isInChrm": 1
    }]
}

members 说明:

参数 类型 说明
id string 成员 Id
isInChrm number 是否在聊天室中 1: 在 0: 不在

results matching ""

    No results matching ""