结果回调
接口描述
- 此接口由第三方提供，用于接收平台返回的结果数据。
- 一般来说，平台返回给第三方数据时每隔1秒通知一次，共计通知3次，直到响应
success则不再通知。
接口说明
- 请求地址： 第三方提供
- 请求头：无
- 请求方式：
POST
请求参数
- 使用form-data方式传参。
参数名 |
变量 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| 第三方单据流水号 | outId |
String | 是 | 第三方唯一标识 |
| 签名 | signature |
String | 是 | 对outId进行RSA签名后得到的字符串。这里使用的是平台私钥签名，第三方应该使用平台公钥（rsaPublicKey）验签 |
| 结果加密数据 | encryptData |
String | 是 | 需要使用AES进行解密。解密算法请参考“资源下载”。根据原文中returnType字段的值不同，则返回类型不同，详见下面请求示例 |
- encryptData对应原文中
returnType字段各个值的含义如下表：
类型 |
含义 |
|---|---|
returnType=100 |
最终结果 |
returnType=101 |
错误提示 |
请求示例
1、最终结果
原文示例
{
"outId": "2025111703",
"result": {
"kesheng": [
{
"code": "ak2",
"description": "【咳声音高】多属实证，多因热邪犯肺，灼伤肺津。 ",
"name": "咳声音高",
"simpleDescription": "【咳声音高】多属实证，多因热邪犯肺，灼伤肺津。 "
},
{
"code": "ak6",
"description": "【咳声嘶哑 】风寒束肺或肺阴亏损。",
"name": "咳声嘶哑 ",
"simpleDescription": "【咳声嘶哑 】风寒束肺或肺阴亏损。"
}
],
"yusheng": [
{
"code": "ar1",
"description": "【语声正常】气血充盛，发声器官和脏腑功能正常。",
"name": "语声正常",
"simpleDescription": "【语声正常】气血充盛，发声器官和脏腑功能正常。"
}
]
},
"returnType": 100
}
参数说明
基础参数
参数名 |
变量 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| 第三方单据流水号 | outId |
String | 是 | 第三方唯一标识 |
| 返回类型 | returnType |
Number | 是 | returnType=100表示是最终结果 |
| 结果 | result |
Object | 是 | 详见结果参数 |
结果参数
参数名 |
变量 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| 咳声特征列表 | kesheng |
Array | 否 | 详见特征描述 |
| 朗读声特征列表 | yusheng |
Array | 否 | 详见特征描述 |
特征描述
参数名 |
变量 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| 特征编码 | code |
String | 是 | - |
| 特征名称 | name |
String | 是 | - |
| 特征描述 | description |
String | 否 | - |
| 特征简述 | simpleDescription |
String | 否 | - |
2、错误提示
原文示例
{
"error": {
"code": 210,
"msg": "音频不符合检测要求"
},
"outId": "2025111702",
"returnType": 101
}
参数说明
参数名 |
变量 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| 第三方单据流水号 | outId |
String | 是 | 第三方唯一标识 |
| 返回类型 | returnType |
Number | 是 | returnType=101表示是错误提示 |
| 错误信息 | error |
Object | 是 | 详见 API接口回调错误码 |