应用外 Web SDK 接口
以下均为基于JS SDK的JS接口
一、执行能力接口
功能
执行能力(openFeatureFunc)接口，用于执行Web消息协议中的能力
入参
入参为Web消息协议Json，协议字段如下表
| 字段 |
说明 |
类型 |
示例 |
| name |
能力名称，参照Web消息协议 |
String |
native_open_asr |
| params |
能力参数的Json字符串，参照Web消息协议 |
String |
数据示例
{
"name":"native_open_asr",
"params":"{\"token\": \"abcd\", \"appid\": \"1234\"}"
}
二、开始轮询获取数据接口
功能
开始轮询(getCmd)接口，用于开启轮询请求，随时获取回调的数据内容
入参
轮询功能String字符串，固定为“open_xiri”
三、停止轮询获取数据接口
功能
停止轮询(stopCmd)接口，用于停止轮询请求，停止获取回调的数据内容
入参
无
四、轮询数据回调
功能
创建Listener示例时，同时创建监听数据回调，用于接收开放的数据内容
回调参数
Json对象，数据主体协议字段如下表
| 字段 |
说明 |
类型 |
示例 |
| _command |
命令类型 |
String |
当_commands == _XIRI_PUSH 为推送消息（APK推送给EPG） |
| _action |
命令的数据类型 |
String |
当_command == _XIRI_PUSH时有效
开放平台：open_xiri |
| data |
命令的数据内容 |
String |
推送消息的json字符串 |
推送消息协议data字段如下表
| 字段 |
说明 |
类型 |
示例 |
| msgId |
消息ID，用于JS端反馈处理推送结果 |
String |
74748d82-24cc-4f8a-8649-acefb705e4ae |
| name |
能力名称，见Web消息协议 |
String |
h5_send_asr_result |
| params |
推送的数据的Json字符串，见Web消息协议 |
String |
回调结果示例
{
"msgId":"74748d82-24cc-4f8a-8649-acefb705e4ae",
"name":"h5_send_asr_result",
"params":"{\"token\":\"565f0bfb712c49b4bf051562d27cd36d@18\",\"linkId\":\"2b91a04b-659c-48af-bd9e-4f686c979c26\",\"text\":\"你好\"}"
}
五、释放开放能力接口
功能
取消开放能力使用(unregister)接口，用于页面不再使用开放能力时调用
入参
无
六、反馈处理推送消息结果接口
功能
反馈处理结果(pushMsg)接口，用于JS端处理完成反馈处理结果
入参
入参为Json实体，协议字段如下表
| 参数名称 |
参数类型 |
说明 |
默认值 |
| msgId |
String |
推送过来的消息ID |
|
| msg |
String |
推送的消息内容，如下表 |
推送消息内容协议字段如下表
| 参数名称 |
参数类型 |
说明 |
| code |
int |
返回码 |
| msg |
String |
"成功" |
| name |
String 处理的消息名称
asrHandleResult：第三方处理asr的结果
nlpHandleResult：第三方处理nlp的结果 |
| data |
Object |
返回内容 |
入参示例
{
"msgId":"74748d82-24cc-4f8a-8649-acefb705e4ae",
"msg":"{\"code\":200,\"msg\":\"成功\",\"name\":\"asrHandleResult\",\"data\":{\"token\":\"565f0bfb712c49b4bf051562d27cd36d@18\",\"handled\":false}}"
}
七、能力查询接口
功能
能力查询(featureSupport)接口，用于查询对端(APK)是否支持某能力
入参
| 参数名称 |
参数类型 |
说明 |
| type |
String |
能力类型：open_xiri 开放平台 |
| version |
String |
协议版本号 |
返回数据示例
| 参数名称 |
参数类型 |
说明 |
| result |
int |
是否支持
0：不支持
1：支持 |
| version |
String |
协议版本号 |