文档中心 > API类目 > 数娱搜索

youku.tvspeech.docconfig.get (获得语音配置文档,包括引导文档,帮助文档,场景提示文档)

获得语音配置文档,包括引导文档,帮助文档,场景提示文档

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
scene_info String 可选 {"appPackage":"com.yunos.tv.alitvasr","asrId":null,"city":"杭州","clientTime":"20161227","clientVersion":2100500000,"clientVersionName":"5.1.0","desktopMode":"123","deviceMode":0,"deviceType":0,"ip":null,"location":null,"timezone":null,"useApp":"com.yunos.tv.homeshell","videoId":null} 当前场景信息
system_info String 可选 {"device_sn":"7EE7125248BB4662","device_model":"MagicBox2","device_system_version":"3.0.3","device_firmware_version":"3.0.3-D-20150922.1534","device_media":"dts,dolby,drm,h265_720p","charge_type":"2,3,5","version_code":2100302010,"bcp":1,"from":"0,4,5,6","sw":"sw1080","uuid":"0D1B4827412AF9CFFD6955221E1120CC","area_code":"330200"} 系统信息
client_version Number 可选 21005000000 语音客户端版本号:version_code
locale_info String 可选 {} 区域语言

响应参数

名称 类型 示例值 描述
result Result {} 结果
  • model
  • AllDocConfigDo
  • {}
  • 结果对象
  • └ scene_tips
  • String
  • {}
  • 各个场景的提示信息
  • └ guide
  • String
  • {"normal":["http://galitv.alicdn.com/product/attachment/speech/guidedocdevice/20170718/492f0259946442a91e131068cf745aea.png","http://galitv.alicdn.com/product/attachment/speech/guidedocdevice/20170718/b60d37ba64d687a53f95e476684de981.png"]}
  • 引导文档图片链接地址
  • └ package_infos
  • String []
  • ["com.yunos.tv.homeshell","com.yunos.tv.yingshi.boutique","com.yunos.tv.appstore","com.ali.tv.gamecenter","com.xiami.tv","com.yunos.tvtaobao","com.yunos.tbsdk","com.moretv.android","com.iflytek.aichang.tv","com.multak.LoudSpeakerKaraoke","com.yunos.tv.videochat","com.skyworthdigital.stb.app","com.yinhe.hunan.dtv","com.audiocn.kalaok.tv.haier.amlogict866","com.um.dvb","com.panda.stb","cn.ljwl.bn.dvb","com.cibn.yktv","cn.ccdt.dvbplayer","com.yunos.tv.hongbao","com.yunos.tv.edu","com.yunos.tv.notification","com.yunos.tv.bluray","com.hrtvbic.usb.mm","com.haier.usb.picture","com.cibn.tv","com.tvjianshen.tvfit","com.haier.voicehelper","com.hezy.family","com.gw.cbn.stbdw","com.haier.uhome.uplustv"]
  • 客户端需要检测的应用包名列表
  • help_and_settings_dos
  • HelpAndSettingsDo []
  • []
  • 帮助与设置
  • help_and_settings_category_dos
  • HelpAndSettingsCategoryDo []
  • []
  • 帮助与设置类目
  • help_and_settings_action_dos
  • HelpAndSettingsActionDo []
  • []
  • 帮助与设置命令
  • └ action_tip
  • String
  • 我要看白夜追凶
  • 命令文本
  • └ hasc_id
  • Number
  • 1
  • 帮助与设置分类ID
  • └ id
  • Number
  • 1
  • 主键
  • └ name
  • String
  • 默认-影视
  • 分类名称
  • └ has_id
  • Number
  • 1
  • 帮助与设置ID
  • └ id
  • Number
  • 1
  • 主键
  • └ device_model
  • String
  • MagicBox2
  • 设备
  • └ device_id
  • Number
  • 1
  • 设备ID
  • └ action_abstract
  • String
  • 我要看白夜追凶
  • 命令摘要
  • └ provider_pic
  • String
  • http://galitv.alicdn.com/product/attachment/speech/helpandsettings/20171129/feae64cc0e63fdd292d705be7681e719.png
  • 服务提供商
  • └ icon
  • String
  • ""
  • 图片
  • └ pic
  • String
  • http://galitv.alicdn.com/product/attachment/speech/helpandsettings/20180130/e2adbbf19a3b62d12ade9c18b7130aeb.png
  • 图片
  • └ subtitle
  • String
  • 根据片名、演员等条件点播影视
  • 副标题
  • └ title
  • String
  • 影视点播
  • 标题
  • └ id
  • Number
  • 1
  • 主键
  • └ voiceprint_labels
  • String []
  • ["剧情","爱情","喜剧","科幻","动作","悬疑","恐怖","战争","动画","古装"]
  • 声纹标签
  • └ ptts_switch
  • Boolean
  • false
  • 个性话语音播报开关,true表示开启,false表示关闭
  • └ nls_domain
  • String
  • nls-gateway-inner.aliyuncs.com
  • NLS服务域名配置
  • └ xf_asr_setting
  • String
  • {}
  • 声纹开关
  • └ msg_code
  • String
  • SYSTEM_INFO_ILLEGAL
  • 错误码
  • └ msg_info
  • String
  • 设备信息非法
  • 错误信息
  • └ success
  • Boolean
  • false
  • 接口调用状态

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YoukuTvspeechDocconfigGetRequest req = new YoukuTvspeechDocconfigGetRequest();
req.setSceneInfo("{\"appPackage\":\"com.yunos.tv.alitvasr\",\"asrId\":null,\"city\":\"杭州\",\"clientTime\":\"20161227\",\"clientVersion\":2100500000,\"clientVersionName\":\"5.1.0\",\"desktopMode\":\"123\",\"deviceMode\":0,\"deviceType\":0,\"ip\":null,\"location\":null,\"timezone\":null,\"useApp\":\"com.yunos.tv.homeshell\",\"videoId\":null}");
req.setSystemInfo("{\"device_sn\":\"7EE7125248BB4662\",\"device_model\":\"MagicBox2\",\"device_system_version\":\"3.0.3\",\"device_firmware_version\":\"3.0.3-D-20150922.1534\",\"device_media\":\"dts,dolby,drm,h265_720p\",\"charge_type\":\"2,3,5\",\"version_code\":2100302010,\"bcp\":1,\"from\":\"0,4,5,6\",\"sw\":\"sw1080\",\"uuid\":\"0D1B4827412AF9CFFD6955221E1120CC\",\"area_code\":\"330200\"}");
req.setClientVersion(21005000000L);
req.setLocaleInfo("{}");
YoukuTvspeechDocconfigGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<youku_tvspeech_docconfig_get_response>
    <result>
        <model>
            <scene_tips>{}</scene_tips>
            <guide>{&quot;normal&quot;:[&quot;http://galitv.alicdn.com/product/attachment/speech/guidedocdevice/20170718/492f0259946442a91e131068cf745aea.png&quot;,&quot;http://galitv.alicdn.com/product/attachment/speech/guidedocdevice/20170718/b60d37ba64d687a53f95e476684de981.png&quot;]}</guide>
            <package_infos>
                <string>[&quot;com.yunos.tv.homeshell&quot;</string>
                <string>&quot;com.yunos.tv.yingshi.boutique&quot;</string>
                <string>&quot;com.yunos.tv.appstore&quot;</string>
                <string>&quot;com.ali.tv.gamecenter&quot;</string>
                <string>&quot;com.xiami.tv&quot;</string>
                <string>&quot;com.yunos.tvtaobao&quot;</string>
                <string>&quot;com.yunos.tbsdk&quot;</string>
                <string>&quot;com.moretv.android&quot;</string>
                <string>&quot;com.iflytek.aichang.tv&quot;</string>
                <string>&quot;com.multak.LoudSpeakerKaraoke&quot;</string>
                <string>&quot;com.yunos.tv.videochat&quot;</string>
                <string>&quot;com.skyworthdigital.stb.app&quot;</string>
                <string>&quot;com.yinhe.hunan.dtv&quot;</string>
                <string>&quot;com.audiocn.kalaok.tv.haier.amlogict866&quot;</string>
                <string>&quot;com.um.dvb&quot;</string>
                <string>&quot;com.panda.stb&quot;</string>
                <string>&quot;cn.ljwl.bn.dvb&quot;</string>
                <string>&quot;com.cibn.yktv&quot;</string>
                <string>&quot;cn.ccdt.dvbplayer&quot;</string>
                <string>&quot;com.yunos.tv.hongbao&quot;</string>
                <string>&quot;com.yunos.tv.edu&quot;</string>
                <string>&quot;com.yunos.tv.notification&quot;</string>
                <string>&quot;com.yunos.tv.bluray&quot;</string>
                <string>&quot;com.hrtvbic.usb.mm&quot;</string>
                <string>&quot;com.haier.usb.picture&quot;</string>
                <string>&quot;com.cibn.tv&quot;</string>
                <string>&quot;com.tvjianshen.tvfit&quot;</string>
                <string>&quot;com.haier.voicehelper&quot;</string>
                <string>&quot;com.hezy.family&quot;</string>
                <string>&quot;com.gw.cbn.stbdw&quot;</string>
                <string>&quot;com.haier.uhome.uplustv&quot;]</string>
            </package_infos>
            <help_and_settings_dos>
                <help_and_settings_do>
                    <help_and_settings_category_dos>
                        <help_and_settings_category_do>
                            <help_and_settings_action_dos>
                                <help_and_settings_action_do>
                                    <action_tip>我要看白夜追凶</action_tip>
                                    <hasc_id>1</hasc_id>
                                    <id>1</id>
                                </help_and_settings_action_do>
                            </help_and_settings_action_dos>
                            <name>默认-影视</name>
                            <has_id>1</has_id>
                            <id>1</id>
                        </help_and_settings_category_do>
                    </help_and_settings_category_dos>
                    <device_model>MagicBox2</device_model>
                    <device_id>1</device_id>
                    <action_abstract>我要看白夜追凶</action_abstract>
                    <provider_pic>http://galitv.alicdn.com/product/attachment/speech/helpandsettings/20171129/feae64cc0e63fdd292d705be7681e719.png</provider_pic>
                    <icon>&quot;&quot;</icon>
                    <pic>http://galitv.alicdn.com/product/attachment/speech/helpandsettings/20180130/e2adbbf19a3b62d12ade9c18b7130aeb.png</pic>
                    <subtitle>根据片名、演员等条件点播影视</subtitle>
                    <title>影视点播</title>
                    <id>1</id>
                </help_and_settings_do>
            </help_and_settings_dos>
            <voiceprint_labels>
                <string>[&quot;剧情&quot;</string>
                <string>&quot;爱情&quot;</string>
                <string>&quot;喜剧&quot;</string>
                <string>&quot;科幻&quot;</string>
                <string>&quot;动作&quot;</string>
                <string>&quot;悬疑&quot;</string>
                <string>&quot;恐怖&quot;</string>
                <string>&quot;战争&quot;</string>
                <string>&quot;动画&quot;</string>
                <string>&quot;古装&quot;]</string>
            </voiceprint_labels>
            <ptts_switch>false</ptts_switch>
            <nls_domain>nls-gateway-inner.aliyuncs.com</nls_domain>
            <xf_asr_setting>{}</xf_asr_setting>
        </model>
        <msg_code>SYSTEM_INFO_ILLEGAL</msg_code>
        <msg_info>设备信息非法</msg_info>
        <success>false</success>
    </result>
</youku_tvspeech_docconfig_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部