讯飞api
首页
首页
  1. 快速开始
  • 基本介绍
  • 快速开始
    • 开发必读
    • 接口调用
    • 获取token令牌
      POST
  • 音频转写
    • 实时语音转写
    • 语音文件异步转写
      POST
    • 异步接收转写结果
      POST
  • 语音听写
    • 开启会话
      POST
    • 音频写入
      POST
    • 获取结果
      POST
    • 结束会话
      POST
  • 录音文件识别
    • 调用说明
    • 提交任务
      POST
    • 查询识别结果
      POST
  • ocr识别
    • 获取图像OCR结果
      POST
  • 附录
    • 附录1:错误码枚举
  1. 快速开始

接口调用

HTTP调用方式可以面向HTTP接口进行开发,开发者可以根据自己系统的情况,选择不同的实现语言来实现对接。

请求参数#

公共请求头#

除了TTP协议中规定的头信息以外,本开放接口额外做以下头信息要求:
参数名称参数名称说明
Content-TypeString请填写application/json;charset=UTF-8
tokenString大多数接口,需要通过验证身份以后才能访问,需要携带该头信息;获取token令牌
timestampLong当前时间戳的毫秒数。可以参考java的System.currentTimeMillis()方法生成;(如果未携带该头信息,或与服务端的时间差超过 15 分钟,则云端拒绝该请求)
signString签名,用于校验请求的合法性

公共返回报文#

在所有请求的返回值里,有一些公共的字段:
参数名称参数名称说明
codeString错误码,详见附录1:业务编码枚举
msgString业务异常信息
dataObject业务数据
traceIdString日志id
返回结果
请求成功时返回结果示例:
{
    "code": "200",
    "msg": "操作成功!",
    "data": {
		"name": "小明"
	},
    "traceId": "089f4c4ba09f1a16"
}

请求失败时返回结果示例:
{
    "code": "202",
    "msg": "请求头中签名不能为空",
    "traceId": "af1eb58ea9a06e97"
}

签名规则#

每个请求头都需要添加sign字段,来验证请求的合法性,填写方法如下:

1. 计算签名#

第一步,生成待签名字符串:
待签名字符串 = Content + "_" + timestamp + "_" + AppSecret
其中:
1.
Content:为请求的body,json格式
2.
timestamp:时间戳
3.
appSecret:为分配给接入方的密钥
第二步,生成开始签名
签名值 = MD5(待签名字符串)),并转小写

2. 签名示例#

假设请求报文:
{"id":"123"}
appSecret:
de121212ddddf
时间戳timestamp:
1737358768572
则生成待签名字符串:
{"id":"123"}_1737358768572_de121212ddddf
Md5签名值为:
0b64d867867294b362e659848f51c2f9

API鉴权调用常见问题#

1.
header中的timestamp和sign签名中的timestamp需要相同。
2.
确认MD5函数的结果是否正确,校验使用https://www.sojson.com/encrypt_md5.html
3.
body中请求参数和sign签名中的请求参数要一致,使用字符串,尽量不要有空格和回车。
修改于 2025-01-20 08:06:18
上一页
开发必读
下一页
获取token令牌
Built with