流式更新消息

请求方法

POST

请求地址

/messages/card/streaming

请求参数

参数	参数类型	数据类型	是否必需	描述
sessionId	Body	Long	是	会话ID
msgId	Body	Long	是	消息ID
key	Body	String	是	变量名称
content	Body	Object	是	变量内容
isFinalize	Body	boolean	是	是否最后一帧，如果设置为 true，AI卡片将从「输入中」状态切换为「完成」状态
isError	Body	boolean	是	是否出错，如果设置为 true，会填充默认显示内容

HTTP状态码

返回值	描述
200	操作成功，详见响应参数
400	客户端传参异常
401	鉴权失败
500	服务端异常

响应参数

无

请求消息示例

POST /open/api/v2/messages/card/streaming HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
Referer: https://api.yealink.com

{
  "organizationId": "org-123456", // String, 必填 - 组织ID
  "sessionId": 987654321,        // Long, 可选 - 会话ID (与 msgId 二选一)
  "msgId": "msg-abcdefg",        // String, 可选 - 消息ID (与 sessionId 二选一)
  "key": "content_key_1",        // String, 必填 - 卡片更新的键标识
  "content": {                   // Object, 必填 - 更新的内容
    "tag": "div",
    "text": {
      "tag": "plain_text",
      "content": "Updated content at 2023-10-27 10:00"
    }
  },
  "finalize": false,             // Boolean, 可选 - 是否为最后一次更新, 默认 false
  "error": false                 // Boolean, 可选 - 更新是否出错, 默认 false
}

响应消息示例

无