1. 简介

讯飞开放平台通过 REST API 的方式给开发者提供语音转写的 HTTP 接口，基于该接口，开发者可以获取开发平台的语音转写能力，方便开发者使用自己熟悉的编程语言快速集成。

2. 接口说明

转写 API 包括以下接口： 预处理、 文件分片上传、 合并文件、 查询处理进度、 获取结果。

• 预处理 /prepare:
• 文件分片上传 /upload:
• 合并文件 /merge:
• 查询处理进度 /getProgress:
• 获取结果 /getResult:
  通用返回说明：

2.1. 接口调用流程

2.1.1. 预处理接口

说明：第一步调用预处理接口，上传待转写音频文件的基本信息（文件名、大小）和分片信息（若无需分片，slice_num=1）和相关的可配置参数。调用成功，返回任务ID（task_id，转写任务的唯一标识），是后续接口的必传参数。

URL

POST  http[s]://raasr.xfyun.cn/api/prepare

请求头

Content-Type: application/x-www-form-urlencoded; charset=UTF-8

参数说明

注： 标准版和电话版本的已经合并，现在购买的都是标准版的订单，lfasr_type传0即可，发音人分离可通过"has_seperate=true"和"speaker_number=个数"来配置。

返回值

成功

{
    "ok":0,
    "err_no":0,
    "failed":null,
    "data":"383e72a47557490aa05a344074117a9d"
}

失败

{
    "ok":-1,
    "err_no":26601,
    "failed":"非法应用信息",
    "data":null
}

结果说明

调用成功，data即为taskId（任务ID），是后续接口的必传参数。

2.1.2. 文件分片上传接口

说明：预处理成功，调用文件上传接口，按预处理设置的分片信息（slice_num）依次上传音频切片（文件以二进制方式读取上传），直到全部切片上传成功（如预处理时 slice_num=2，则需将音频切分成两部分，slice_id=aaaaaaaaaa和aaaaaaaaab，并按顺序调用该接口）。上一切片成功上传，才可进行下一切片的上传操作。调用过程中若出现异常，可重试若干次。

url

POST  http[s]://raasr.xfyun.cn/api/upload

请求头

Content-Type: multipart/form-data;

参数说明

返回值

成功

{
    "ok":0,
    "err_no":0,
    "failed":null,
    "data":null
}

失败

{
    "ok":-1,
    "err_no":26602,
    "failed":"任务ID不存在",
    "data":null
}

slice_id生成代码(python)示例：

class SliceIdGenerator:
    """slice id生成器"""
    def __init__(self):
        self.__ch = 'aaaaaaaaa`'
    def getNextSliceId(self):
        ch = self.__ch
        j = len(ch) - 1
        while j >= 0:
            cj = ch[j]
            if cj != 'z':
                ch = ch[:j] + chr(ord(cj) + 1) + ch[j+1:]
                break
            else:
                ch = ch[:j] + 'a' + ch[j+1:]
                j = j -1
        self.__ch = ch
        return self.__ch

注：每个转写任务上传开始前创建一个SliceIdGenerator，根据分片的顺序依次调用getNextSliceId生成对应的slice_id

2.1.3. 合并文件接口

说明：全部文件切片上传成功后，调用该接口，通知服务端进行文件合并与转写操作。该接口不会返回转写结果，而是通知服务端将任务列入转写计划。转写的结果通过 getResult 接口获取。

url

POST  http[s]://raasr.xfyun.cn/api/merge

请求头

Content-Type: application/x-www-form-urlencoded; charset=UTF-8

参数说明

返回值

成功

{
    "ok":0,
    "err_no":0,
    "failed":null,
    "data":null
}

失败

{
    "ok":-1,
    "err_no":26602,
    "failed":"任务ID不存在",
    "data":null
}

2.1.4. 查询处理进度接口

说明：在调用方发出合并文件请求后，服务端已将任务列入计划。在获取结果前，调用方需轮询该接口查询任务当前状态。当且仅当任务状态=9（转写结果上传完成），才可调用获取结果接口获取转写结果。轮询策略由调用方决定，建议每隔10分钟轮询一次。状态码说明见附录。

url

POST  http[s]://raasr.xfyun.cn/api/getProgress

请求头

Content-Type: application/x-www-form-urlencoded; charset=UTF-8

参数说明

返回值

成功

{
    "ok":0,
    "err_no":0,
    "failed":null,
    "data":"{\"desc\":\"任务创建成功\",\"status\":0}"
}

失败

{
    "ok":-1,
    "err_no":26640,
    "failed":"文件上传失败",
    "data":null
}

处理流程

2.1.5. 获取结果接口

说明：当任务处理进度状态=9（见查询处理进度接口），调用该接口获取转写结果。这是转写流程的最后一步。转写结果各字段的详细说明见转写结果说明文档。服务端也支持主动回调，转写完成之后主动发送转写结果到用户配置的回调地址，配置回调地址请联系技术支持。

url

POST  http[s]://raasr.xfyun.cn/api/getResult

请求头

Content-Type: application/x-www-form-urlencoded; charset=UTF-8

参数说明

返回值

成功

{
    "ok":0,
    "err_no":0,
    "failed":null,
    "data":"[{\"bg\":\"0\",\"ed\":\"4950\",\"onebest\":\"科大讯飞是中国最大的智能语音技术提供商。\",\"speaker\":\"0\"}]"
}

失败

{
    "ok":-1,
    "err_no":26601,
    "failed":"非法应用信息",
    "data":null
}

3. 附录

3.1. 转写结果字段说明

3.2. 错误码

3.3. 任务状态码

3.4. 调用示例

语音转写demo python3语言

语音转写demo java语言

Copyright © iflytek.com 2018 all right reserved，powered by Gitbook该文件修订时间：2019-05-07 07:12:51