# Generated by ShowAPI OpenAPI generator
# source: market/1978
# generated-at: 2026-06-26T03:17:48.946Z
openapi: 3.0.3
info:
  title: 腾讯云-语音技术
  description: 为开发者提供语音转文字服务的最佳体验，开放实时语音识别、一句话识别和录音文件识别三种服务形式，满足不同类型开发者需求，具备识别准确率高、接入便捷、性能稳定等特点。
  termsOfService: https://www.showapi.com/helpcenter/view#/4019/2
  version: 1.0.0
servers:
  - url: https://route.showapi.com
paths:
  /1978-4:
    x-pointCode: 4
    x-mode: mapping
    x-read-timeout: 20
    x-connect-timeout: 20
    post:
      summary: 录音文件识别(结果查询)
      description: |-
        本接口用于对60秒之内的短音频文件进行识别，支持本地语音文件上传和语音URL上传两种请求方式。

        当音频文件通过请求中body内容上传时，请求大小不能超过600KB；当音频以url方式传输时，音频时长不可超过60s。

        所有请求参数放在POST请求的body中，编码类型采用x-www-form-urlencoded，参数进行urlencode编码后传输。

        现暂只支持中文普通话和带有一定方言口音的中文普通话识别，支持识别8k16bit和16k16bit的mp3或者wav格式的单声道音频。
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          Response:
                            type: object
                            properties:
                              RequestId:
                                type: string
                                description: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
                              Data:
                                type: object
                                properties:
                                  Status:
                                    type: string
                                  Result:
                                    type: string
                                  AudioDuration:
                                    type: string
                                  StatusStr:
                                    type: string
                                  ErrorMsg:
                                    type: string
                                  TaskId:
                                    type: string
                                description: 识别结果。
                          remark:
                            type: string
                          ret_code:
                            type: number
                        description: 业务返回体
      operationId: 1978_4_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                TaskId:
                  type: number
                  description: 从获取id接口获取的TaskId，用于获取任务状态与结果。
              required:
                - ds_id
                - TaskId
  /1978-3:
    x-pointCode: 3
    x-mode: mapping
    x-read-timeout: 20
    x-connect-timeout: 20
    post:
      summary: 录音文件识别(获取id)
      description: |-
        本接口用于对60秒之内的短音频文件进行识别，支持本地语音文件上传和语音URL上传两种请求方式。

        当音频文件通过请求中body内容上传时，请求大小不能超过600KB；当音频以url方式传输时，音频时长不可超过60s。

        所有请求参数放在POST请求的body中，编码类型采用x-www-form-urlencoded，参数进行urlencode编码后传输。

        现暂只支持中文普通话和带有一定方言口音的中文普通话识别，支持识别8k16bit和16k16bit的mp3或者wav格式的单声道音频。
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          Response:
                            type: object
                            properties:
                              RequestId:
                                type: string
                                description: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
                              Data:
                                type: object
                                properties:
                                  TaskId:
                                    type: string
                                    description: 识别任务id
                          remark:
                            type: string
                          ret_code:
                            type: number
                        description: 业务返回体
      operationId: 1978_3_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                EngineModelType:
                  type: string
                  description: |-
                    引擎模型类型。注意：非电话场景请务必使用16k的引擎。
                    电话场景：
                    • 8k_zh：中文电话通用；
                    • 8k_en：英文电话通用；

                    非电话场景：
                    • 16k_zh：中文通用；
                    • 16k_zh-PY：中英粤;
                    • 16k_zh_medical：中文医疗；
                    • 16k_en：英语；
                    • 16k_ca：粤语；
                    • 16k_ja：日语；
                    • 16k_ko：韩语；
                    • 16k_vi：越南语；
                    • 16k_ms：马来语；
                    • 16k_id：印度尼西亚语；
                    • 16k_fil：菲律宾语；
                    • 16k_th：泰语；
                    • 16k_pt：葡萄牙语；
                    • 16k_tr：土耳其语；
                    • 16k_zh_dialect：多方言，支持23种方言（上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话）；
                ChannelNum:
                  type: number
                  description: 识别声道数。1：单声道（非电话场景，直接选择单声道即可，忽略音频声道数）；2：双声道（仅支持8k_zh电话场景，双声道应分别对应通话双方）。注意：双声道的电话音频已物理分离说话人，无需再开启说话人分离功能。
                ResTextFormat:
                  type: number
                  description: "识别结果返回形式。0： 识别结果文本(含分段时间戳)； 1：词级别粒度的详细识别结果(不含标点，含语速值)；2：词级别粒度的详细识别结果（包含标点、语速值）；3: 标点符号分段，包含每段时间戳，特别适用于字幕场景（包含词级时间、标点、语速值）。"
                SourceType:
                  type: number
                  description: 语音数据来源。0：语音 URL；1：语音数据（post body）。
                SpeakerDiarization:
                  type: number
                  description: |-
                    是否开启说话人分离，0：不开启，1：开启(仅支持8k_zh，16k_zh，16k_zh_video，单声道音频)，默认值为 0。
                    注意：8k电话场景建议使用双声道来区分通话双方，设置ChannelNum=2即可，不用开启说话人分离。
                SpeakerNumber:
                  type: string
                  description: |-
                    说话人分离人数（需配合开启说话人分离使用），取值范围：0-10，0代表自动分离（目前仅支持≤6个人），1-10代表指定说话人数分离。默认值为 0。
                    注：此功能结果仅供参考，请根据您的需要谨慎使用。
                CallbackUrl:
                  type: string
                  description: |-
                    回调 URL，用户自行搭建的用于接收识别结果的服务URL。如果用户使用轮询方式获取识别结果，则无需提交该参数。回调格式&内容详见：录音识别回调说明

                    回调说明：https://cloud.tencent.com/document/product/1093/52632
                Url:
                  type: string
                  description: 语音的URL地址，需要公网环境浏览器可下载。当 SourceType 值为 0 时须填写该字段，为 1 时不需要填写。注意：请确保录音文件时长在5个小时之内，否则可能识别失败。请保证文件的下载速度，否则可能下载失败。
                Data:
                  type: string
                  description: 语音数据base64编码，当SourceType 值为1时必须填写，为0可不写。音频数据要小于5MB。
                DataLen:
                  type: number
                  description: 数据长度，非必填（此数据长度为数据未进行base64编码时的数据长度）。
                ConvertNumMode:
                  type: number
                  description: "是否进行阿拉伯数字智能转换（目前支持中文普通话引擎）。0：不转换，直接输出中文数字，1：根据场景智能转换为阿拉伯数字，3: 打开数学相关数字转换。默认值为 1。"
                FilterDirty:
                  type: number
                  description: 是否过滤脏词（目前支持中文普通话引擎）。0：不过滤脏词；1：过滤脏词；2：将脏词替换为 * 。默认值为 0。
                HotwordId:
                  type: string
                  description: 热词表id。如不设置该参数，自动生效默认热词表；如设置了该参数，那么将生效对应的热词表。
                CustomizationId:
                  type: string
                  description: 自学习模型 id。如设置了该参数，将生效对应的自学习模型。
                FilterPunc:
                  type: number
                  description: 是否过滤标点符号（目前支持中文普通话引擎）。 0：不过滤，1：过滤句末标点，2：过滤所有标点。默认值为 0。
                FilterModal:
                  type: number
                  description: 是否过滤语气词（目前支持中文普通话引擎）。0：不过滤语气词；1：部分过滤；2：严格过滤 。默认值为 0。
                EmotionalEnergy:
                  type: number
                  description: 情绪能量值，取值为音量分贝值/10。取值范围：[1,10]。值越高情绪越强烈。0:不开启，1:开启
                ReinforceHotword:
                  type: number
                  description: 热词增强功能。1:开启后（仅支持8k_zh,16k_zh），将开启同音替换功能，同音字、词在热词中配置。举例：热词配置“蜜制”并开启增强功能后，与“蜜制”同拼音（mizhi）的“秘制”的识别结果会被强制替换成“蜜制”。因此建议客户根据自己的实际情况开启该功能。
                SentenceMaxLength:
                  type: number
                  description: 单标点最多字数，取值范围：[6，40]。默认为0，不开启该功能。该参数可用于字幕生成场景，控制单行字幕最大字数（设置ResTextFormat为3，解析返回的ResultDetail列表，通过结构中FinalSentence获取单个标点断句结果）。
                EmotionRecognition:
                  type: number
                  description: |-
                    情绪识别能力(目前支持16k_zh) 默认为0，不开启。 1：开启情绪识别但是不会在文本展示“情绪标签”， 2：开启情绪识别并且在文本展示“情绪标签”。（该功能需要设置ResTextFormat 大于0）
                    注意：本功能为增值服务，购买对应套餐包后，将参数设置为1或2时方可按对应方式生效，并消耗套餐包对应资源。参数设置为0时无需购买套餐包，也不会消耗对应资源。
              required:
                - ds_id
                - EngineModelType
                - ChannelNum
                - ResTextFormat
                - SourceType
  /1978-2:
    x-pointCode: 2
    x-mode: mapping
    x-read-timeout: 60
    x-connect-timeout: 60
    post:
      summary: 语音合成
      description: 腾讯云语音合成技术（TTS）可以将任意文本转化为语音，实现让机器和应用张口说话。 腾讯TTS技术可以应用到很多场景，比如，移动APP语音播报新闻；智能设备语音提醒；依靠网上现有节目或少量录音，快速合成明星语音，降低邀约成本；支持车载导航语音合成的个性化语音播报。原接口订购地址：https://cloud.tencent.com/product/tts
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          Response:
                            type: object
                            properties:
                              Audio:
                                type: string
                                description: base64编码的wav音频数据
                              RequestId:
                                type: string
                                description: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
                              SessionId:
                                type: string
                                description: 一次请求对应一个SessionId
                              Subtitles:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    BeginIndex:
                                      type: number
                                      description: 该字在整句中的开始位置，从0开始。
                                    BeginTime:
                                      type: number
                                      description: ⽂本对应tts语⾳开始时间戳，单位ms。
                                    EndIndex:
                                      type: number
                                      description: 该字在整句中的结束位置，从0开始。
                                    EndTime:
                                      type: number
                                      description: ⽂本对应tts语⾳结束时间戳，单位ms。
                                    Phoneme:
                                      type: string
                                      description: |-
                                        该字的音素
                                        注意：此字段可能返回 null，表示取不到有效值。
                                    Text:
                                      type: string
                                      description: ⽂本信息。
                                description: 时间戳信息，若未开启时间戳，则返回空数组。
                          remark:
                            type: string
                          ret_code:
                            type: number
                        description: 业务返回体
      operationId: 1978_2_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                Text:
                  type: string
                  description: |-
                    合成语音的源文本，按UTF-8编码统一计算。
                    中文最大支持150个汉字（全角标点符号算一个汉字）；英文最大支持500个字母（半角标点符号算一个字母）。
                SessionId:
                  type: string
                  description: 一次请求对应一个SessionId，会原样返回，建议传入类似于uuid的字符串防止重复。
                Volume:
                  type: number
                  description: 音量大小，范围：[0，10]，分别对应11个等级的音量，默认为0，代表正常音量。没有静音选项。
                Speed:
                  type: number
                  description: |-
                    语速，范围：[-2，6]，分别对应不同语速：
                    -2代表0.6倍
                    -1代表0.8倍
                    0代表1.0倍（默认）
                    1代表1.2倍
                    2代表1.5倍
                    6代表2.5倍
                    如果需要更细化的语速，可以保留小数点后一位，例如0.5 1.1 1.8等。
                ProjectId:
                  type: number
                  description: 项目id，用户自定义，默认为0。
                ModelType:
                  type: number
                  description: 模型类型，1-默认模型。
                VoiceType:
                  type: number
                  description: |-
                    音色 ID，包括标准音色与精品音色，精品音色拟真度更高，价格不同于标准音色，请参见购买指南。完整的音色 ID 列表请参见音色列表。
                    购买指南：https://cloud.tencent.com/document/product/1073/34112
                    音色列表：https://cloud.tencent.com/document/product/1073/92668
                PrimaryLanguage:
                  type: number
                  description: |-
                    主语言类型：
                    1-中文（默认）
                    2-英文
                SampleRate:
                  type: number
                  description: |-
                    音频采样率：
                    16000：16k（默认）
                    8000：8k
                Codec:
                  type: string
                  description: 返回音频格式，可取值：wav（默认），mp3，pcm
                EnableSubtitle:
                  type: boolean
                  description: 是否开启时间戳功能，默认为false。
                SegmentRate:
                  type: number
                  description: 断句敏感阈值，默认值为：0，取值范围：[0,1,2]。该值越大越不容易断句，模型会更倾向于仅按照标点符号断句。此参数建议不要随意调整，可能会影响合成效果。
                EmotionCategory:
                  type: string
                  description: "控制合成音频的情感，仅支持多情感音色使用。取值: neutral(中性)、sad(悲伤)、happy(高兴)、angry(生气)、fear(恐惧)、news(新闻)、story(故事)、radio(广播)、poetry(诗歌)、call(客服)"
                EmotionIntensity:
                  type: number
                  description: 控制合成音频情感程度，取值范围为[50,200],默认为100；只有EmotionCategory不为空时生效；
              required:
                - ds_id
                - Text
                - SessionId
  /1978-1:
    x-pointCode: 1
    x-mode: mapping
    x-read-timeout: 20
    x-connect-timeout: 20
    post:
      summary: 语音识别
      description: |-
        本接口用于对60秒之内的短音频文件进行识别，支持本地语音文件上传和语音URL上传两种请求方式。

        当音频文件通过请求中body内容上传时，请求大小不能超过600KB；当音频以url方式传输时，音频时长不可超过60s。

        所有请求参数放在POST请求的body中，编码类型采用x-www-form-urlencoded，参数进行urlencode编码后传输。

        现暂只支持中文普通话和带有一定方言口音的中文普通话识别，支持识别8k16bit和16k16bit的mp3或者wav格式的单声道音频。原接口订购地址：https://cloud.tencent.com/product/asr
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          Response:
                            type: object
                            properties:
                              RequestId:
                                type: string
                                description: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
                              Result:
                                type: string
                                description: 识别结果。
                              WordSize:
                                type: string
                                description: |-
                                  词时间戳列表的长度
                                  注意：此字段可能返回 null，表示取不到有效值。
                              AudioDuration:
                                type: string
                                description: 请求的音频时长，单位为ms
                              WordList:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    Word:
                                      type: string
                                      description: 词结果
                                    StartTime:
                                      type: string
                                      description: 词在音频中的开始时间
                                    EndTime:
                                      type: string
                                      description: 词在音频中的结束时间
                                description: |-
                                  词时间戳列表
                                  注意：此字段可能返回 null，表示取不到有效值。
                          remark:
                            type: string
                          ret_code:
                            type: number
                        description: 业务返回体
      operationId: 1978_1_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                EngSerViceType:
                  type: string
                  description: |-
                    引擎模型类型。
                    电话场景：
                    • 8k_zh：中文电话通用；
                    • 8k_en：英文电话通用；

                    非电话场景：
                    • 16k_zh：中文通用；
                    • 16k_zh-PY：中英粤;
                    • 16k_zh_medical：中文医疗；
                    • 16k_en：英语；
                    • 16k_yue：粤语；
                    • 16k_ja：日语；
                    • 16k_ko：韩语；
                    • 16k_vi：越南语；
                    • 16k_ms：马来语；
                    • 16k_id：印度尼西亚语；
                    • 16k_fil：菲律宾语；
                    • 16k_th：泰语；
                    • 16k_pt：葡萄牙语；
                    • 16k_tr：土耳其语；
                    • 16k_zh_dialect：多方言，支持23种方言（上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话）；
                SourceType:
                  type: number
                  description: 语音数据来源。0：语音 URL；1：语音数据（post body）。
                VoiceFormat:
                  type: string
                  description: 识别音频的音频格式，支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac、amr。
                Url:
                  type: string
                  description: 语音的URL地址，需要公网环境浏览器可下载。当 SourceType 值为 0时须填写该字段，为 1 时不填。音频时长不能超过60s，音频文件大小不能超过3MB。
                Data:
                  type: string
                  description: 语音数据，当SourceType 值为1（本地语音数据上传）时必须填写，当SourceType 值为0（语音 URL上传）可不写。要使用base64编码(采用python语言时注意读取文件应该为string而不是byte，以byte格式读取后要decode()。编码后的数据不可带有回车换行符)。音频时长不能超过60s，音频文件大小不能超过3MB（Base64后）。
                DataLen:
                  type: number
                  description: 数据长度，单位为字节。当 SourceType 值为1（本地语音数据上传）时必须填写，当 SourceType 值为0（语音 URL上传）可不写（此数据长度为数据未进行base64编码时的数据长度）。
                WordInfo:
                  type: number
                  description: 是否显示词级别时间戳。0：不显示；1：显示，不包含标点时间戳，2：显示，包含标点时间戳。默认值为 0。
                FilterDirty:
                  type: number
                  description: 是否过滤脏词（目前支持中文普通话引擎）。0：不过滤脏词；1：过滤脏词；2：将脏词替换为 * 。默认值为 0。
                FilterModal:
                  type: number
                  description: 是否过语气词（目前支持中文普通话引擎）。0：不过滤语气词；1：部分过滤；2：严格过滤 。默认值为 0。
                FilterPunc:
                  type: number
                  description: 是否过滤标点符号（目前支持中文普通话引擎）。 0：不过滤，1：过滤句末标点，2：过滤所有标点。默认值为 0。
                ConvertNumMode:
                  type: number
                  description: 是否进行阿拉伯数字智能转换。0：不转换，直接输出中文数字，1：根据场景智能转换为阿拉伯数字。默认值为1。
                HotwordId:
                  type: string
                  description: 热词id。用于调用对应的热词表，如果在调用语音识别服务时，不进行单独的热词id设置，自动生效默认热词；如果进行了单独的热词id设置，那么将生效单独设置的热词id。
                CustomizationId:
                  type: string
                  description: 自学习模型 id。如设置了该参数，将生效对应的自学习模型。
                ReinforceHotword:
                  type: number
                  description: 热词增强功能。1:开启后（仅支持8k_zh,16k_zh），将开启同音替换功能，同音字、词在热词中配置。举例：热词配置“蜜制”并开启增强功能后，与“蜜制”同拼音（mizhi）的“秘制”、“蜜汁”的识别结果会被强制替换成“蜜制”。因此建议客户根据自己的实际情况开启该功能。
                HotwordList:
                  type: string
                  description: |-
                    临时热词：用于提升识别准确率，临时热词规则：“热词|权重”，热词不超过30个字符（最多10个汉字），权重1-10，最多传入128个热词。举例："腾讯云|10,语音识别|5,ASR|10"。
                    “临时热词”和“热词id”的区别：热词id需要先在控制台或通过接口创建热词表，得到热词表id后才可以使用热词功能，本字段可以在每次请求时直接传入热词使用，但每次请求后云端不会保留相关的热词数据，需要客户自行维护相关数据
              required:
                - ds_id
                - EngSerViceType
                - SourceType
                - VoiceFormat
components:
  securitySchemes:
    AppKeyAuth:
      type: apiKey
      in: query
      name: appKey
      description: 从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp
  schemas:
    ShowapiResEnvelope:
      type: object
      description: ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）
      properties:
        showapi_res_code:
          type: integer
          description: API 返回的状态码
        showapi_res_error:
          type: string
          description: API 返回的错误信息
        showapi_res_id:
          type: string
          description: API 请求的唯一标识
        showapi_fee_num:
          type: integer
          description: API 调用计费次数
security:
  - AppKeyAuth: []
externalDocs:
  url: https://www.showapi.com/apiGateway/view/1978?tab=book
x-apiCode: "1978"
x-is-own: false
x-is-op: true
