推流至语音频道

开发中

POST

https://chat.xiaoheihe.cn/chatroom/v3/channel/stream/push

当前仅支持线路1

请求参数

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

Body 参数application/json

room_id

string

房间ID

必需

channel_id

string

频道ID

必需

stream_url

string

源流URL

必需

volume

integer

可选

音量，取值范围[0, 100]，默认100，表示原音量。

operator

integer

操作用户的UID

必需

callback_url

string

回调链接详见文档

可选

seek_second

integer

可选

指定视频从某个秒时间戳播放

repeat_num

integer

可选

循环播放次数, 取值范围[-1, 1000], 默认1次。

max_duration

integer

可选

循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。

示例

{
    "room_id": "3886418517665415168",
    "channel_id": "3886418645352636424",
    "stream_url": "https://dlink.host/musics/aHR0cHM6Ly9vbmVkcnYtbXkuc2hhcmVwb2ludC5jb20vOnU6L2cvcGVyc29uYWwvc3Rvcl9vbmVkcnZfb25taWNyb3NvZnRfY29tL0VXODJiQUJPRHcxRGh0cW9Lb0RlUHdVQi1JNmE3bWVXdnpHZEZqbXUxVkdoQXc.mp3",
    "volume": 30,
    "operator": 8829829,
    "callback_url": "https://yourdomain.com/callback",
    "seek_second": 10,
    "repeat_num": 2,
    "max_duration": 233
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://chat.xiaoheihe.cn/chatroom/v3/channel/stream/push?client_type=&x_client_type=&os_type=&x_os_type=&x_app=&chat_os_type=&chat_version=' \
--header 'Content-Type: application/json' \
--header 'token;' \
--data-raw '{
    "room_id": "3886418517665415168",
    "channel_id": "3886418645352636424",
    "stream_url": "https://dlink.host/musics/aHR0cHM6Ly9vbmVkcnYtbXkuc2hhcmVwb2ludC5jb20vOnU6L2cvcGVyc29uYWwvc3Rvcl9vbmVkcnZfb25taWNyb3NvZnRfY29tL0VXODJiQUJPRHcxRGh0cW9Lb0RlUHdVQi1JNmE3bWVXdnpHZEZqbXUxVkdoQXc.mp3",
    "volume": 30,
    "operator": 8829829,
    "callback_url": "https://yourdomain.com/callback",
    "seek_second": 10,
    "repeat_num": 2,
    "max_duration": 233
}'

返回响应

🟢200成功

application/json

Body

msg

string

必需

result

object

必需

task_id

string

必需

任务ID 操作任务的唯一凭证

status

string

必需

示例

{
    "msg": "",
    "result": {
        "task_id": "VmKuXYqynxHc+BHhOWtI5srKrZl7mV9CbhVM7KgFflnIEuUuEKNsjpLzB6DWdZuaL0t030+nrUzarKGmqR6dgAz+K9lrsNsCYjKpnqkbnlyzeXGTRMmp+ecUhAMGvtvy"
    },
    "status": "ok"
}

修改于 2025-07-23 02:49:19

在线媒体流说明文档

停止推流至语音频道