Qwen-TTS server events

服务端通过 WebSocket 连接发送以下事件。

error

客户端或服务端发生错误时发送。

Example

{
  "event_id": "event_QzAVZRVa9hKqM5VOaHunh",
  "type": "error",
  "error": {
    "code": "invalid_value",
    "message": "Session update error: session already started or finished or failed."
  }
}

string

body

事件 ID。

string

body

固定值 error。

object

body

错误详情。

显示properties

string

body

错误码。

string

body

错误信息。

session.created

客户端连接后立即发送，包含默认的会话配置。

Example

{
  "event_id": "event_xxx",
  "type": "session.created",
  "session": {
    "object": "realtime.session",
    "mode": "server_commit",
    "model": "qwen-tts-realtime",
    "voice": "Cherry",
    "response_format": "pcm",
    "sample_rate": 24000,
    "id": "sess_xxx"
  }
}

string

body

事件 ID。

string

body

固定值 session.created。

object

body

会话配置。

显示properties

string

body

会话 ID。

string

body

固定值 realtime.session。

string

body

交互模式：server_commit 或 commit。

string

body

模型名称。

string

body

音色名称。

string

body

音频格式。

integer

body

采样率，单位 Hz。

session.updated

服务端处理 session.update 请求后发送。如果处理失败，服务端会发送 error 事件。

Example

{
  "event_id": "event_xxx",
  "type": "session.updated",
  "session": {
    "id": "sess_xxx",
    "object": "realtime.session",
    "model": "qwen-tts-realtime",
    "voice": "Cherry",
    "language_type": "Chinese",
    "mode": "commit",
    "response_format": "pcm",
    "sample_rate": 24000
  }
}

string

body

事件 ID。

string

body

固定值 session.updated。

object

body

会话配置。

显示properties

string

body

会话 ID。

string

body

固定值 realtime.session。

string

body

交互模式：server_commit 或 commit。

string

body

模型名称。

string

body

音色名称。

string

body

音频格式。

integer

body

采样率，单位 Hz。

string

body

音频语言。

input_text_buffer.committed

服务端收到 input_text_buffer.commit 事件后发送。

Example

{
  "event_id": "event_FC6MA88wS2oEeXkPvWsxX",
  "type": "input_text_buffer.committed",
  "item_id": ""
}

string

body

事件 ID。

string

body

固定值 input_text_buffer.committed。

string

body

待创建的用户消息项 ID。

input_text_buffer.cleared

服务端收到 input_text_buffer.clear 事件后发送。

Example

{
  "event_id": "event_1122",
  "type": "input_text_buffer.cleared"
}

string

body

事件 ID。

string

body

固定值 input_text_buffer.cleared。

response.created

服务端收到 input_text_buffer.commit 事件后发送。

Example

{
  "event_id": "event_IMnLqDvG6Ahhk7sWV2uOs",
  "type": "response.created",
  "response": {
    "id": "resp_USvBwHktHcz76r6GaIJUV",
    "object": "realtime.response",
    "conversation_id": "",
    "status": "in_progress",
    "voice": "Cherry",
    "output": []
  }
}

string

body

事件 ID。

string

body

固定值 response.created。

object

body

响应详情。

显示properties

string

body

响应 ID。

string

body

固定值 realtime.response。

string

body

会话 ID。

string

body

响应状态：completed、failed、in_progress 或 incomplete。

string

body

音色名称。

array

body

该事件中为空数组。

response.output_item.added

新的输出项就绪时发送。

Example

{
  "event_id": "event_INDGnGNulaXCrStd9ZM5X",
  "type": "response.output_item.added",
  "response_id": "resp_USvBwHktHcz76r6GaIJUV",
  "output_index": 0,
  "item": {
    "id": "item_FIrYGaNVK3rbIZqeY4QjM",
    "object": "realtime.item",
    "type": "message",
    "status": "in_progress",
    "role": "assistant",
    "content": []
  }
}

string

body

事件 ID。

string

body

固定值 response.output_item.added。

string

body

响应 ID。

integer

body

响应输出项索引，固定值 0。

object

body

输出项详情。

显示properties

string

body

输出项 ID。

string

body

固定值 realtime.item。

string

body

消息类型，固定值 message。

string

body

输出项状态。

string

body

消息角色，固定值 assistant。

array

body

消息内容。

response.content_part.added

新的内容分片就绪时发送。

Example

{
  "event_id": "event_DigZ95MWN36YYyyjcENoq",
  "type": "response.content_part.added",
  "response_id": "resp_USvBwHktHcz76r6GaIJUV",
  "item_id": "item_FIrYGaNVK3rbIZqeY4QjM",
  "output_index": 0,
  "content_index": 0,
  "part": {
    "type": "audio",
    "text": ""
  }
}

string

body

事件 ID。

string

body

固定值 response.content_part.added。

string

body

响应 ID。

string

body

消息项 ID。

integer

body

响应输出项索引，固定值 0。

integer

body

内容分片索引，固定值 0。

object

body

内容分片详情。

显示properties

string

body

内容分片类型。

string

body

内容分片文本。

response.audio.delta

模型生成音频块时发送。

Example

{
  "event_id": "event_B1osWMZBtrEQbiIwW0qHQ",
  "type": "response.audio.delta",
  "response_id": "resp_B1osWTzBb8hO0WsELHgVP",
  "item_id": "item_B1osWH81fXDoyim1T5fsF",
  "output_index": 0,
  "content_index": 0,
  "delta": "base64 audio"
}

string

body

事件 ID。

string

body

固定值 response.audio.delta。

string

body

响应 ID。

string

body

消息项 ID。

integer

body

响应输出项索引，固定值 0。

integer

body

内容分片索引，固定值 0。

string

body

Base64 编码的音频数据块。

response.content_part.done

内容分片完成时发送。

Example

{
  "event_id": "event_Vo2YUjlYQJ4colH8nVzkU",
  "type": "response.content_part.done",
  "response_id": "resp_USvBwHktHcz76r6GaIJUV",
  "item_id": "item_FIrYGaNVK3rbIZqeY4QjM",
  "output_index": 0,
  "content_index": 0,
  "part": {
    "type": "audio",
    "text": ""
  }
}

string

body

事件 ID。

string

body

固定值 response.content_part.done。

string

body

响应 ID。

string

body

消息项 ID。

integer

body

响应输出项索引，固定值 0。

integer

body

内容分片索引，固定值 0。

object

body

已完成的内容分片。

显示properties

string

body

内容分片类型。

string

body

内容分片文本。

response.output_item.done

输出项完成时发送。

Example

{
  "event_id": "event_LO6SJRKIQ9NBayyYB8a1A",
  "type": "response.output_item.done",
  "response_id": "resp_USvBwHktHcz76r6GaIJUV",
  "output_index": 0,
  "item": {
    "id": "item_FIrYGaNVK3rbIZqeY4QjM",
    "object": "realtime.item",
    "type": "message",
    "status": "completed",
    "role": "assistant",
    "content": [
      {
        "type": "audio",
        "text": ""
      }
    ]
  }
}

string

body

事件 ID。

string

body

固定值 response.output_item.done。

string

body

响应 ID。

integer

body

响应输出项索引，固定值 0。

object

body

输出项详情。

显示properties

string

body

输出项 ID。

string

body

固定值 realtime.item。

string

body

消息类型，固定值 message。

string

body

输出项状态。

string

body

消息角色，固定值 assistant。

array

body

消息内容。

response.audio.done

音频生成完成时发送。

Example

{
  "event_id": "event_LZaOHPzXYMUXGBcVkBmKX",
  "type": "response.audio.done",
  "response_id": "resp_USvBwHktHcz76r6GaIJUV",
  "item_id": "item_FIrYGaNVK3rbIZqeY4QjM",
  "output_index": 0,
  "content_index": 0
}

string

body

事件 ID。

string

body

固定值 response.audio.done。

string

body

响应 ID。

string

body

消息项 ID。

integer

body

响应输出项索引，固定值 0。

integer

body

内容分片索引，固定值 0。

response.done

响应生成完成时发送。response 对象包含所有输出项，但不包含已发送的原始音频数据。

Qwen3-TTS Realtime
Qwen-TTS Realtime

Example

{
  "event_id": "event_Aemy83XqHFFDDSeJIDn6N",
  "type": "response.done",
  "response": {
    "id": "resp_LFeR42yXZ9SxUAeXjmyTz",
    "object": "realtime.response",
    "conversation_id": "",
    "status": "completed",
    "modalities": [
      "text",
      "audio"
    ],
    "voice": "Cherry",
    "output": [
      {
        "id": "item_Ae1lv2XmRljRSG96L8Zm1",
        "object": "realtime.item",
        "type": "message",
        "status": "completed",
        "role": "assistant",
        "content": [
          {
            "type": "audio",
            "transcript": ""
          }
        ]
      }
    ],
    "usage": {
      "characters": 25
    }
  }
}

Example

{
  "event_id": "event_xxx",
  "type": "response.done",
  "response": {
    "id": "resp_xxx",
    "object": "realtime.response",
    "conversation_id": "",
    "status": "completed",
    "modalities": [
      "text",
      "audio"
    ],
    "voice": "Cherry",
    "output": [
      {
        "id": "item_FIrYGaNVK3rbIZqeY4QjM",
        "object": "realtime.item",
        "type": "message",
        "status": "completed",
        "role": "assistant",
        "content": [
          {
            "type": "audio",
            "transcript": ""
          }
        ]
      }
    ],
    "usage": {
      "total_tokens": 67,
      "input_tokens": 3,
      "output_tokens": 64,
      "input_tokens_details": {
        "text_tokens": 3
      },
      "output_tokens_details": {
        "text_tokens": 0,
        "audio_tokens": 64
      }
    }
  }
}

string

body

事件 ID。

string

body

固定值 response.done。

object

body

响应详情。

显示properties

string

body

响应 ID。

string

body

固定值 realtime.response。

string

body

会话 ID。

string

body

响应状态，completed 表示生成完成。

array

body

响应包含的模态列表，如 ["text", "audio"]。

string

body

音色名称。

array

body

响应输出。

object

body

计费详情。

显示properties

integer

body

计费字符数（Qwen3-TTS Realtime）。

integer

body

输入和输出 token 总数（Qwen-TTS Realtime）。

integer

body

输入 token 数（Qwen-TTS Realtime）。

integer

body

输出 token 数（Qwen-TTS Realtime）。

object

body

输入 token 明细（Qwen-TTS Realtime）。

显示properties

integer

body

输入文本 token 数。

object

body

输出 token 明细（Qwen-TTS Realtime）。

显示properties

integer

body

输出文本 token 数。

integer

body

输出音频 token 数。1 秒 = 50 个 token，不足 1 秒按 50 个 token 计算。

session.finished

所有响应生成完成时发送。

Example

{
  "event_id": "event_2239",
  "type": "session.finished"
}

string

body

事件 ID。

string

body

固定值 session.finished。

​error

​session.created

​session.updated

​input_text_buffer.committed

​input_text_buffer.cleared

​response.created

​response.output_item.added

​response.content_part.added

​response.audio.delta

​response.content_part.done

​response.output_item.done

​response.audio.done

​response.done

​session.finished

error

session.created

session.updated

input_text_buffer.committed

input_text_buffer.cleared

response.created

response.output_item.added

response.content_part.added

response.audio.delta

response.content_part.done

response.output_item.done

response.audio.done

response.done

session.finished