文件上传

开发环境

http://dev-cn.your-api-server.com

POST

https: //raasr.xfyun.cn/v2/api/upload

首先调用文件上传接口，上传待转写音频文件的基本信息（文件名、大小等）和相关的可配置参数。
调用成功，返回订单ID（orderId，用于查询结果或者联调排查问题时使用），是后续接口的必传参数。

#signa生成

① 获取baseString

baseString 由 appid 和当前时间戳 ts 拼接而成；
假如 appid = 595f23df，ts = 1512041814，则 baseString = 595f23df1512041814

② 对 baseString 进行 MD5

假如 baseString 为上一步生成的 595f23df1512041814，MD5 之后则为 0829d4012497c14a30e7e72aeebe565e

③ 以 secret key 为 key 对 MD5 之后的 baseString 进行 HmacSHA1 加密，然后再对加密后的字符串进行 base64 编码。

假如 secretkey = d9f4aa7ea6d94faca62cd88a28fd5234，
MD5 之后的 baseString 为上一步生成的 0829d4012497c14a30e7e72aeebe565e，
则 HmacSHA1 加密之后再进行 base64 编码得到的 signa 为： IrrzsJeOFk1NGfJHW6SkHUoN9CU=

备注：

secretkey：接口密钥，在应用中添加语音转写服务后，显示在服务管理页面，请调用方注意保管；

signa 的生成公式：HmacSHA1(MD5(appid + ts)，secretkey)，具体的生成方法详见【调用示例】；

#请求参数

注：如下参数请参数拼接在 url 中，如果是音频流模式，音频文件需要放在 body 体中，同时设置 http 的 header（Content-Type 为 application/octet-stream）。

#转写结束异步回调状态

当订单转写流程结束时会回调用户（如果录音文件转写接口 upload 传了callbackUrl），会把订单号和订单状态返回，具体的格式和参数说明如下：回调地址示例：

GET http://ip:prot/server/xxx?orderId=DKHJQ202004291620042916580FBC96690001F&status=1

参数名	类型	必传	描述
orderId	String	是	转写订单号，用于查询使用
status	String	是	订单状态： -1：失败 1：成功注： 1、成功需要调用 getResult 接口查询转写结果数据； 2、如果任务包含翻译环节且任务在转码、转写环节失败不会进行翻译的回调；
resultType	String	否	回调任务类型：为空或不包含该字段时为转写回调转写：transfer；翻译：translate；质检：predict；

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.comhttps: //raasr.xfyun.cn/v2/api/upload' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileName\t": "string",
    "fileSize": 0,
    "duration": 0,
    "language\t": "string",
    "callbackUrl": "string"
}'

响应示例

200 - 示例 1

{
  "code": "string",
  "descInfo": "string",
  "content": {
    "orderId": "string",
    "taskEstimateTime": 0
  }
}

请求参数

Body 参数application/json

fileName

string

必需

音频文件名称，最好携带音频真实的后缀名，避免影响转码

fileSize

integer

必需

音频文件大小（字节数），当前只针对本地文件流方式校验，使用url外链方式不校验，可随机传一个数字。传递真实的音频文件大小，音频流模式服务端会根据这个参数和实际获取到的进行比较，不一致可能是文件丢失直接导致创建订单失败

duration

integer

必需

音频真实时长.当前未验证，可随机传一个数字

language

string

可选

语种类型：默认 cn cn：中文，通用方言（包括普通话、天津、河北、东北、甘肃、山东、太原） en：英文 ja：日语 ko：韩语 ru：俄语 fr：法语 es：西班牙语 vi：越南语 ar：阿拉伯语 cn_xinanese：西南官话（包括四川、重庆、云南、贵州） cn_cantonese：粤语 cn_henanese；河南 cn_uyghur：维吾尔语 cn_tibetan：藏语 ar:阿拉伯语 de:德语 it:意大利语重要提示：非实时语音转写结合统一建模的星火多语种语音识别大模型，推出英语en、日语ja、韩语ko、俄语ru、法语fr、西班牙语es、阿拉伯语ar、德语de、葡萄牙语pt、越南语vi、泰语th、意大利语it、印地语hi转写语种识别。极大提升了语音转写准确度，真实还原语音内容，标点等同步预测，带来更流畅的体验。后续将持续扩增转写语种的支持。

callbackUrl

string

可选

回调地址订单完成时回调该地址通知完成支持get 请求，我们会在回调地址中拼接参数，长度限制512： http://{ip}/{port}?xxx&OrderId=xxxx&status=1 参数：orderId为订单号、status为订单状态: 1(转写识别成功) 、-1(转写识别失败)

示例

返回响应

🟢200成功

application/json

Body

code

string

必需

descInfo

string

必需

content

object

必需

orderId

string

必需

调用成功，orderId即为订单ID，是后续接口的必传参数

taskEstimateTime

integer

必需

🟠400请求有误

语音转写 API 文档

查询结果

文件上传

#signa生成#

#请求参数#

#转写结束异步回调状态#

请求参数

返回响应

#signa生成

#请求参数

#转写结束异步回调状态