文档首页/ 云客服/ API参考/ 机器人管理/ 离线转写回调接口
更新时间:2023-09-27 GMT+08:00

离线转写回调接口

场景描述

智能助手平台提供接口给第三方接入方调用,实现asr离线转写结果回传给ODFS。

该接口是系统级的第三方接口,鉴权方式请参考C3 智能助手平台接口鉴权方式中的说明下的第三点。

接口方法

POST

接口URI

https://IP:PORT/oifde/rest/sysapi/asrcallback

消息头

表1 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

userName

String

True

参见C3 智能助手平台接口鉴权方式中的说明下的第三点的appKey。

3

token

String

True

生成方式参见C3 智能助手平台接口鉴权方式

请求说明

表2 请求体参数

序号

参数名

参数类型

是否必选

说明

1

body

Object

True

回写结果。

该对象的参数说明请参见表3

表3 body参数说明

序号

参数名

参数类型

是否必选

说明

1.1

state

Object

True

转写状态。

该对象的参数说明请参见表4

1.2

body

Object

True

回写结果body体。

该对象的参数说明请参见表5

表4 state参数说明

序号

参数名

参数类型

是否必选

说明

1.1.1

code

String

True

转写的结果编码。

1.1.2

success

boolean

True

转写是否成功,true标识成功,false标识失败。

表5 body参数说明

序号

参数名

参数类型

是否必选

说明

1.2.1

aid

String

True

音频文件唯一标识符,由客户端传入。

1.2.2

lattices

List

True

转写结果。

该对象的参数说明请参见表6

表6 lattices参数说明

序号

参数名

参数类型

是否必选

说明

1.2.2.1

lid

int

True

片段序列号。

1.2.2.2

begin

int

True

分片开始时间。

1.2.2.3

end

int

True

分片结束时间。

1.2.2.4

onebest

String

True

转写后的文本。

1.2.2.5

spk

int

True

说话人的角色。

响应说明

  • 响应状态码: 200
    表7 响应体参数

    序号

    参数名

    参数类型

    说明

    1

    retCode

    String

    0,成功,其他为失败。

    2

    retMsg

    String

    失败原因的描述。

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

请求消息头

Content-Type:application/json; charset=UTF-8
userName:ODFS_SYS_OPENAPI
token:********************
请求体消息
{
	"body": {
		"state": {
			"code": 0,
			"success": true
        },
		"body": {
			"aid": "FJKkMeepk8l",
			"lattices": [{
				"begin": 4360,
				"end": 5970,
				"lid": 0,
				"onebest": "喂接通了吗?",
				"spk": 0
            }]
        }
    }
}
响应体消息
{
  "retCode": "0",
  "retMsg": "success"
}