被共享方调用该接口分页查询共享的语料。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | PageQuerySharedSpeechOpen |
系统规定参数。取值:PageQuerySharedSpeechOpen。 |
IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 |
要查询的设备ID。 说明 如果传入该参数,则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符,和ProductKey与DeviceName组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName组合,则以IotId为准。
|
ShareTaskCode | String | 否 | ebed9280_ba25_48df_80c2_**** |
语料分享任务的分享码。 您可在千里传音语音播报服务的分享语料管理页面,获取分享码。 |
IotInstanceId | String | 否 | iot-2w**** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 注意
实例的更多信息,请参见实例概述。 |
PageSize | Integer | 否 | 10 |
指定返回结果中每页显示的记录数量,最大不超过100。 |
ProductKey | String | 否 | sd34**** |
设备所属产品的ProductKey。 |
PageId | Integer | 否 | 1 |
要查询的页码。 |
DeviceName | String | 否 | device1 |
设备名称。 |
Status | Integer | 否 | 1 |
要查询语料的状态。可取值:
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | String iot.system.SystemException |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct |
调用成功,返回的结果。 |
|
PageId | Integer | 1 |
当前页码。 |
PageSize | Integer | 10 |
每页显示数据条数。 |
ResultData | Array of Data |
返回的共享语料信息。 |
|
Data | |||
AudioFormat | String | wav |
音频格式,仅支持wav、mp3、amr格式。 |
BizCode | String | identifying |
语料标识。项目下唯一。 |
Code | String | ws**** |
模版唯一标识。 |
SpeechRate | Integer | 50 |
播报速度,取值范围:-500~500。 |
Status | Integer | 1 |
语料状态。返回值:
|
Text | String | test |
语料内容。 |
Voice | String | Siyue |
语料播报声音。 |
Volume | Integer | 50 |
音量大小,取值范围:0~100。 |
Total | Integer | 100 |
数据记录总数量。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=PageQuerySharedSpeechOpen
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公共请求参数>
正常返回示例
XML
格式
<PageQuerySharedSpeechOpenResponse>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<Data>
<PageId>1</PageId>
<PageSize>10</PageSize>
<Total>100</Total>
<ResultData>
<Data>
<Status>1</Status>
<Volume>50</Volume>
<Text>test</Text>
<AudioFormat>wav</AudioFormat>
<Voice>Siyue</Voice>
<Code>ws****</Code>
<SpeechRate>50</SpeechRate>
<BizCode>identifying</BizCode>
</Data>
</ResultData>
</Data>
<Success>true</Success>
</PageQuerySharedSpeechOpenResponse>
JSON
格式
{
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"Data": {
"PageId": 1,
"PageSize": 10,
"Total": 100,
"ResultData": {
"Data": {
"Status": 1,
"Volume": 50,
"Text": "test",
"AudioFormat": "wav",
"Voice": "Siyue",
"Code": "ws****",
"SpeechRate": 50,
"BizCode": "identifying"
}
}
},
"Success": true
}