文档中心 > API类目 > 天猫精灵开放API

taobao.ailab.aicloud.top.memo.alarm.list (天猫精灵闹钟查询)

查询天猫精灵用户设置的所有闹钟

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
schema String 必须 淘宝 schema
user_id String 必须 1212 企业用户ID
utd_id String 可选 3434 手持设备ID
ext String 可选 {} 扩展信息json段,用于存放APP类型,APP版本等等信息。
memo_id Number 可选 1111 闹钟ID

响应参数

名称 类型 示例值 描述
result Result 服务的结果封装
  • └ message
  • String
  • schema and userId cannot be null
  • 附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题
  • └ status_code
  • Number
  • 200
  • 调用返回码
  • alarms
  • Alarm []
  • 服务的实际返回结果
  • alarm_music
  • AlarmMusic
  • 闹钟音乐,第一次响起来的音乐
  • └ source
  • String
  • xiami
  • 铃声来源,默认为虾米
  • └ url
  • String
  • http://abc
  • 铃声url
  • └ name
  • String
  • 可爱的萝莉音
  • 铃声名字
  • └ id
  • String
  • 1
  • 铃声id
  • └ category
  • String
  • 活动铃声
  • 铃声类型
  • └ status
  • String
  • ACTIVE
  • memo状态
  • └ gmt_create
  • Date
  • 2018-03-23 08:06:42
  • 创建时间
  • └ gmt_modified
  • Date
  • 2018-03-23 08:06:42
  • 修改时间
  • └ memo_id
  • Number
  • 345
  • memo_ID
  • └ uuid
  • String
  • 59A25632025733BA0FDE904CACC80B35
  • uuid
  • └ music_pre
  • String
  • musicPre
  • └ music_url
  • String
  • http://abc
  • 铃声Url
  • └ topic
  • String
  • 睡觉(TEST CREATE)
  • 闹铃主题
  • └ ring_type
  • String
  • 闹铃声音类型
  • └ alert_ways
  • String []
  • ["DEVICE", "APP"]
  • 提醒方式,如APP,音箱等,如果有多个,用逗号分隔
  • alarm_musics
  • AlarmMusic []
  • 闹钟音乐列表
  • └ category
  • String
  • 活动铃声
  • 铃声类型
  • └ id
  • String
  • 1
  • 铃声id
  • └ name
  • String
  • 可爱的萝莉音
  • 铃声名字
  • └ url
  • String
  • http://abc
  • 铃声url
  • └ source
  • String
  • xiami
  • 铃声来源,默认为虾米
  • schedule_info
  • ScheduleInfo
  • 调度信息
  • └ repeat
  • String
  • TIMING
  • 调度周期
  • └ frequency
  • String
  • DAILY
  • 调度频率
  • └ time
  • Date
  • 03:00:00
  • 调度时间点
  • └ start_date
  • Date
  • 03:00:00
  • 调度开始时间
  • └ end_date
  • Date
  • 03:00:00
  • 调度结束时间
  • └ interval
  • Number
  • 1
  • 调度间隔
  • └ day_of_xs
  • Number []
  • [0]
  • DayOfWeek/DayOfMonth

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AilabAicloudTopMemoAlarmListRequest req = new AilabAicloudTopMemoAlarmListRequest();
req.setSchema("淘宝");
req.setUserId("1212");
req.setUtdId("3434");
req.setExt("{}");
req.setMemoId(1111L);
AilabAicloudTopMemoAlarmListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<ailab_aicloud_top_memo_alarm_list_response>
    <result>
        <message>schema and userId cannot be null</message>
        <status_code>200</status_code>
        <alarms>
            <alarm>
                <alarm_music>
                    <source>xiami</source>
                    <url>http://abc</url>
                    <name>可爱的萝莉音</name>
                    <id>1</id>
                    <category>活动铃声</category>
                </alarm_music>
                <status>ACTIVE</status>
                <gmt_create>2018-03-23 08:06:42</gmt_create>
                <gmt_modified>2018-03-23 08:06:42</gmt_modified>
                <memo_id>345</memo_id>
                <uuid>59A25632025733BA0FDE904CACC80B35</uuid>
                <music_pre></music_pre>
                <music_url>http://abc</music_url>
                <topic>睡觉(TEST CREATE)</topic>
                <ring_type></ring_type>
                <alert_ways>
                    <string>[&quot;DEVICE&quot;</string>
                    <string>&quot;APP&quot;]</string>
                </alert_ways>
                <alarm_musics>
                    <alarm_music>
                        <category>活动铃声</category>
                        <id>1</id>
                        <name>可爱的萝莉音</name>
                        <url>http://abc</url>
                        <source>xiami</source>
                    </alarm_music>
                </alarm_musics>
                <schedule_info>
                    <repeat>TIMING</repeat>
                    <frequency>DAILY</frequency>
                    <time>03:00:00</time>
                    <start_date>03:00:00</start_date>
                    <end_date>03:00:00</end_date>
                    <interval>1</interval>
                    <day_of_xs>
                        <number>[0]</number>
                    </day_of_xs>
                </schedule_info>
            </alarm>
        </alarms>
    </result>
</ailab_aicloud_top_memo_alarm_list_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

返回
顶部