流式消息开启

POST

/robots/{robot_id}/{app_key}/stream/start

流式消息开启

请求参数

Path 参数

robot_id

string

必需

即user的username

app_key

string

应用key

必需

Body 参数application/json

header

object

消息头

可选

no_persist

integer

是否不持久化

可选

red_dot

integer

是否显示红点

可选

sync_once

integer

可选

此消息只被同步或被消费一次(1表示消息将走写模式) ，特别注意：sync_once=1表示写扩散 sync_once=0表示读扩散写扩散的messageSeq和读扩散messageSeq来源不一样

channel_id

string

频道ID

可选

channel_type

integer

频道类型

可选

client_msg_no

string

可选

payload

object

消息正文

可选

from_uid

string

发送者UID

可选

示例

{
    "header": {
        "no_persist": 0,
        "red_dot": 0,
        "sync_once": 0
    },
    "channel_id": "string",
    "channel_type": 0,
    "client_msg_no": "string",
    "payload": {},
    "from_uid": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.botgate.cn/v1/robots///stream/start' \
--header 'Content-Type: application/json' \
--data-raw '{
    "header": {
        "no_persist": 0,
        "red_dot": 0,
        "sync_once": 0
    },
    "channel_id": "string",
    "channel_type": 0,
    "client_msg_no": "string",
    "payload": {},
    "from_uid": "string"
}'

返回响应

🟢200返回

application/json

Body

stream_no

string

流编号

可选

示例

{
    "stream_no": "string"
}

🟠400错误

修改于 2024-09-15 13:57:40

输入中

流式消息结束