即时通信

修改聊天室在线成员标签

PATCH

/im/v2/room_members/{account_id}/actions/tags

请求参数

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

integer <long>

聊天室 ID

必需

聊天室 ID。

tags

string

标签

必需

需要设置的标签，可设置多个标签，JSON 字符串格式，例如 ["tag1", "tag2"]。

notify_target_tags

string

通知目标标签

可选

通知目标标签，修改后，目标标签下的用户会收到通知。是标签表达式，同时也会改变该连接掉线时的通知对象。

notify_extension

string

通知扩展字段

可选

通知扩展字段，长度上限为 2048 字符。

示例

{
  "room_id": 72,
  "notify_target_tags": "{\"tag\":\"tag1\"}",
  "notify_extension": "dolore",
  "tags": [
    "test01",
    "test02"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/room_members//actions/tags' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "room_id": 72,
    "notify_target_tags": "{\"tag\":\"tag1\"}",
    "notify_extension": "dolore",
    "tags": ["test01", "test02"]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {}
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-26 02:30:07

聊天室标签禁言

查询标签下的在线成员数