查询聊天室信息 - 即时通信

请求参数

Path 参数

room_id

string

必需

需要更新信息的聊天室 ID，聊天室创建成功后，云信会返回聊天室 ID。

示例值:

1605537145

Query 参数

need_online_user_count

string

可选

是否需要返回聊天室的在线人数。false（默认）：不返回；true：返回。

示例值:

true

online_user_count_by_type

string

可选

是否需要根据类型显示每个端的在线用户数。false（默认）：不显示；true：显示。

示例值:

true

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open.yunxinapi.com/im/v2/chatrooms/1605537145?need_online_user_count=true&online_user_count_by_type=true' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

valid

boolean

必需

extension

string

必需

creator

string

必需

announcement

string

必需

room_name

string

必需

chat_banned

boolean

必需

live_url

string

必需

room_id

integer

必需

queue_level

integer

必需

in_out_notification

integer

必需

cdn_message_enable

boolean

必需

online_user_count

integer

必需

ios_online_user_count

integer

必需

android_online_user_count

integer

必需

pc_online_user_count

integer

必需

web_online_user_count

integer

必需

mac_online_user_count

integer

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "valid": true,
    "extension": "extension",
    "creator": "yx29",
    "announcement": "announcement",
    "room_name": "room_name",
    "chat_banned": false,
    "live_url": "broadcast_url",
    "room_id": 1605537145,
    "queue_level": 0,
    "in_out_notification": 1,
    "cdn_message_enable": false,
    "online_user_count": 0,
    "ios_online_user_count": 0,
    "android_online_user_count": 0,
    "pc_online_user_count": 0,
    "web_online_user_count": 0,
    "mac_online_user_count": 0
  }
}