更新聊天室在线成员信息

请求参数

Path 参数

account_id

string

必需

需要更新信息的成员账号 ID。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

room_id

number

聊天室ID

必需

room_nick

string

成员在聊天室的昵称

必需

room_avatar

string

成员在聊天室的头像

必需

notification_enabled

boolean

必需

操作完成后是否发送通知消息，true：发送，false：不发送

notification_extension

string

必需

通知扩展字段，长度限制2048，请使用json格式

member_level

integer

必需

extension

string

必需

自定义扩展字段,长度限制4096

persistence

boolean

必需

是否持久化，true：持久化，false：不做持久化
该参数只对固定成员生效，对游客不生效
固定成员不在线，且无需持久化时，接口返回聊天室成员不在线错误信息
游客不在线时，接口返回聊天室成员不在线错误信息

antispam_configuration

object

必需

enabled

boolean

必需

business_id_map

array [object {2}]

必需

示例

{
  "room_id": 1602735437,
  "extension": "laborum",
  "room_avatar": "deserunt non irure id",
  "notification_extension": "sit laboris ullamco ut Ut",
  "notification_enabled": true,
  "room_nickname": "梁磊0001"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/room_members/' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "room_id": 1602735437,
    "extension": "laborum",
    "room_avatar": "deserunt non irure id",
    "notification_extension": "sit laboris ullamco ut Ut",
    "notification_enabled": true,
    "room_nickname": "梁磊0001"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

状态码，200 表示请求成功。

msg

string

提示信息

必需

提示信息。请求失败时返回错误信息，请求成功时返回 "success"。

data

object

返回的 JSON 数据对象

必需

返回的 JSON 数据对象，请求失败则返回空对象。

room_id

number

聊天室ID

必需

account_id

string

成员的帐号ID

必需

room_nick

string

成员昵称

必需

room_avatar

string

成员头像

必需

extension

string

开发者扩展字段

必需

member_role

integer

必需

角色类型：
查询固定成员的类型
0: 普通用户(非游客)
1: 创建者(非游客)
2: 管理员(非游客)
3：普通游客
4: 匿名游客

tags

string

必需

只有在线成员且登录时指定了标签才会有此字段

notify_target_tags

string

必需

只有在线成员且登录时指定了通知标签才会有此字段

member_level

integer

必需

成员级别（若未设置成员级别，则无此字段）

is_online

boolean

是否在线

必需

enter_time

number

进入聊天室的时间点

必需

blocked

boolean

是否在黑名单中

必需

chat_banned

boolean

是否被禁言

必需

temp_chat_banned

boolean

是否被临时禁言

必需

temp_chat_banned_time

number

必需

临时禁言的解除时长,单位秒

online_info_list

array [object {6}]

在线的成员信息

必需

online_count

string

在线端的数量

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "valid": true,
    "extension": "第三方扩展字段-更新聊天室信息",
    "creator": "yx60",
    "announcement": "announcement",
    "room_name": "yx60-1605291945",
    "chat_banned": false,
    "live_url": "视频直播拉流地址",
    "room_id": 1605291945,
    "queue_level": 0
  }
}

🟢200请求参数错误

🟢200服务器错误