发送频道消息@全体成员/@在线成员

开发中

POST

https://chat.xiaoheihe.cn/chatroom/v2/channel_msg/send

请求参数

Authorization

在 header 添加参数

token

示例：

token: ********************

Query 参数

client_type

string

声明请求黑盒语音

必需

默认值:

heybox_chat

x_client_type

string

声明客户端类型

必需

默认值:

web

os_type

string

声明客户端类型

必需

默认值:

web

x_os_type

string

声明客户端是bot

必需

默认值:

bot

x_app

string

声明请求黑盒语音

必需

默认值:

heybox_chat

chat_os_type

string

声明客户端是bot

必需

默认值:

bot

chat_version

string

必需

客户端版本号,不同版本返回的结果可能有区别

默认值:

1.30.0

Header 参数

Content-Type

string

必需

示例值:

application/json;charset=UTF-8

Body 参数application/json

msg

string

必需

"@{here}" 等价于@在线成员,该消息会推送当前房间的所有在线成员，增加所有在线成员的未读消息数量。 "@{all}"等价于 @全体成员,该消息会推送当前房间的所有在线成员，增加所有成员的未读消息数量。

msg_type

integer

必需

heychat_ack_id

string

必需

reply_id

string

必需

room_id

string

必需

addition

string

必需

at_user_id

string

必需

at_role_id

string

必需

mention_channel_id

string

必需

channel_id

string

必需

channel_type

integer

必需

示例

{
  "msg": "@{hear}xxxxxxxx",
  "msg_type": 10,
  "heychat_ack_id": "0",
  "reply_id": "",
  "room_id": "3382569362853470208",
  "addition": "{\"img_files_info\":[]}",
  "channel_id": "3590006252185763840"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://chat.xiaoheihe.cn/chatroom/v2/channel_msg/send?client_type=&x_client_type=&os_type=&x_os_type=&x_app=&chat_os_type=&chat_version=' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "msg": "@{hear}xxxxxxxx",
    "msg_type": 10,
    "heychat_ack_id": "0",
    "reply_id": "",
    "room_id": "3382569362853470208",
    "addition": "{\"img_files_info\":[]}",
    "channel_id": "3590006252185763840"
    }'

返回响应

🟢200成功

application/json

Body

msg

string

必需

result

object

必需

chatmobile_ack_id

string

必需

heychat_ack_id

string

必需

status

string

必需

示例

{
  "msg": "string",
  "result": {
    "chatmobile_ack_id": "string",
    "heychat_ack_id": "string"
  },
  "status": "string"
}

修改于 2024-10-16 09:33:23

发送卡片消息

更新指定的频道消息