喜馬拉雅FM · ruyi.ai開發者文檔

### 3.5.1 喜馬拉雅FM #### （1）功能說明千萬級有聲資源、十大流行聲音類型，滿足兒童、成人、白領、老人各類人群聽的需求。涵蓋小說，電臺、兒童故事、兒歌、相聲、健康養生、國學、脫口秀等海量音頻實現智能點播，智能硬件的必選技能。返回播放列表。 #### （2）接口說明 **請求方法** * POST **請求地址** * [http://api.ruyi.ai/v1/message](http://api.ruyi.ai/v1/message) **請求參數說明** | 參數名 | 參數類型 | 是否必須 | 參數說明 | | :--- | :--- | :--- | :--- | | q | String | 是 | 自然語言表達，例如“我要聽羅輯思維最新一集" | | app\_key | String | 是 | 應用開發者秘鑰，注冊開發者后臺賬號，建立虛擬助理后獲得 | | user\_id | String | 是 | 用戶唯一標識，便于支持個性化語義解析。建議開發者使用 UUID 字符，且不同用戶必須用不同的 user\_id，防止意圖串。 | #### （3）返回說明 **返回參數說明** | 名稱 | 類型 | 說明 | | :--- | :--- | :--- | | code | Integer | 返回代碼 | | msg | String | 返回代碼描述 | | parameters | JSON Object | 解析到的實體以及服務說明 | | action | String | 服務的接口名稱 | | name | String | 匹配的意圖名稱 | | result | JSON Object | 接口返回內容 | | outputs | Array | 服務輸出結果，微信端使用 type 類型為 wechat. 開頭的內容;硬件端收到所有內容，依據需求解析使用 | | duration | Long | 音頻時長 | **返回代碼說明** | 返回代碼 | 錯誤類型 | 說明 | | :--- | :--- | :--- | | 0／200 | 成功 | 請求成功 | | 400 | 無效請求 | 某些必需參數缺失或參數值錯誤，詳見msg字段 | | 401 | 未授權 | 授權失敗，app\_key 缺失或錯誤 | | 403 | 請求被禁止 | 有效請求，但服務拒絕響應，請聯系contact@ruyi.ai | | 408 | 請求超時 | 請求響應超時，一般響應時間設置為2000ms以內 | | 429 | 短時間內大量訪問 | 短時間內請求數過多 | | 500 | 內部錯誤 | 服務處理異常 | | 503 | 服務不可用 | 服務異常或正在維護 | #### （4）請求示例 **請求范例** _給我放西游記_ _我想聽相聲_ _我想聽小馬過河的故事_ _我想聽西游記三打白骨精_ _我要聽羅胖_ _我要聽羅輯思維最新一集_ _我要聽采采脫口秀_ _我要聽采采的段子來了_ **請求示例** （匹配正確資源，返回播放列表） * [http://api.ruyi.ai/ruyi-api/v1/message?app\_key=APP\_KEY&user\_id=user0&q=我要聽羅輯思維最新一集](http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=我要聽羅輯思維最新一集) 返回結果 ```json { "code": 0, "msg": "ok", "result": { "_text": "我要聽羅輯思維最新一集", "msg_id": "c6938e11-b41c-4bba-b407-ff42a7678bfb", "intents": [{ "parameters": { "chapter1": "-1", "album": "羅輯思維", "service": "audio" }, "action": "sys.action.xmly/search", "name": "2-點播專輯+章節", "result": { "id": "xmly:sound:26637186", "html_link": "http://www.ximalaya.com/sound/26637186", "source": "喜馬拉雅", "source_link": "http://www.ximalaya.com/", "sound_id": "26637186", "title": "有效行動的邏輯[羅輯思維]No·199", "media_url": "http://audio.xmcdn.com/group22/M0B/A9/B7/wKgJLlhLVivCY70oAXUyHQjGCO8189.m4a", "cover_url": "http://fdfs.xmcdn.com/group22/M02/A9/78/wKgJM1hLVpKh3dpiAAHjHCQ8i2g515_web_meduim.jpg", "mp3_audio_url": "http://fdfs.xmcdn.com/group22/M0B/A9/75/wKgJM1hLVifDL0n3ALhmxsOlab4206.mp3", "album": "羅輯思維全集", "album_id": "239463", "type": "sound", "tracks": { "id": 26637186, "kind": "track", "category_id": 8, "track_title": "有效行動的邏輯[羅輯思維]No·199", "track_tags": "羅振宇,脫口秀,羅胖,羅輯思維,自媒體", "track_intro": "羅振宇的個人視頻脫口秀。羅胖讀書，講給您聽。我們在知識中尋找獨立的見識，您在把玩知識中尋找思維的樂趣。我們的口號是，死磕自己，愉悅大家。為了大家收聽方便，我們把所有節目合并到一起，以后的節目，每周六我們都會在這里持續更新，請繼續關注收聽羅輯思維。", "cover_url_small": "http://fdfs.xmcdn.com/group22/M02/A9/78/wKgJM1hLVpKh3dpiAAHjHCQ8i2g515_web_meduim.jpg", "cover_url_middle": "http://fdfs.xmcdn.com/group22/M02/A9/78/wKgJM1hLVpKh3dpiAAHjHCQ8i2g515_web_large.jpg", "cover_url_large": "http://fdfs.xmcdn.com/group22/M02/A9/78/wKgJM1hLVpKh3dpiAAHjHCQ8i2g515_mobile_large.jpg", "announcer": { "id": 1412917, "kind": "user", "nickname": "羅輯思維脫口秀", "avatar_url": "http://fdfs.xmcdn.com/group5/M07/4A/35/wKgDtlS4cmeAM8R4AAC2jG7vGBo443_web_large.jpg", "is_verified": true }, "duration": 3021, "play_count": 810716, "favorite_count": 2779, "comment_count": 735, "download_count": 0, "play_url_32": "http://fdfs.xmcdn.com/group22/M0B/A9/75/wKgJM1hLVifDL0n3ALhmxsOlab4206.mp3", "play_size_32": 12084934, "play_url_64": "http://fdfs.xmcdn.com/group21/M05/A9/08/wKgJLVhLVkfAGsZzAXDNTbmuuMs622.mp3", "play_size_64": 24169805, "play_url_64_m4a": "http://audio.xmcdn.com/group22/M0B/A9/B7/wKgJLlhLVivCY70oAXUyHQjGCO8189.m4a", "play_size_64_m4a": 24457757, "play_url_24_m4a": "http://audio.xmcdn.com/group22/M0B/A9/B7/wKgJLlhLVivDmYL6AI6wh4g9wcc394.m4a", "play_size_24_m4a": 9351303, "can_download": true, "download_url": "http://download.xmcdn.com/group22/M0B/A9/B7/wKgJLlhLVjKDwEQ-ALhsDjjf_WM197.aac", "download_size": 12086286, "subordinated_album": { "id": 239463, "album_title": "羅輯思維全集", "cover_url_small": "http://fdfs.xmcdn.com/group5/M09/4A/32/wKgDtlS4cZeCzmE2AAHjHCQ8i2g083_mobile_small.jpg", "cover_url_middle": "http://fdfs.xmcdn.com/group5/M09/4A/32/wKgDtlS4cZeCzmE2AAHjHCQ8i2g083_mobile_meduim.jpg", "cover_url_large": "http://fdfs.xmcdn.com/group5/M09/4A/32/wKgDtlS4cZeCzmE2AAHjHCQ8i2g083_mobile_large.jpg" }, "source": 1, "updated_at": 1481332403000, "created_at": 1481332372000, "order_num": 0 }, "current_order_num": 0, "match_rule": "match", "track_list": [{ "track_title": "有效行動的邏輯[羅輯思維]No·199", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group22/M02/A9/78/wKgJM1hLVpKh3dpiAAHjHCQ8i2g515_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group22/M0B/A9/B7/wKgJLlhLVivCY70oAXUyHQjGCO8189.m4a", "announcer": "羅輯思維脫口秀", "track_id": 26637186, "order_num": 0, "album_id": "239463", "break_in_seconds": 0 }, { "track_title": "你是巨嬰嗎?[羅輯思維]No·198", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group24/M09/8C/68/wKgJNVhCNUzRuQmFAAHjHCQ8i2g341_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group22/M01/8C/99/wKgJLlhCNIrjc02JAbSaoU4Dlvo394.m4a", "announcer": "羅輯思維脫口秀", "track_id": 26219966, "order_num": 1, "album_id": "239463" }, { "track_title": "嚴伯鈞：打開古典音樂的正確姿勢[羅輯思維]No·197", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group25/M01/6A/4F/wKgJMVg5YHbThiIeAAHjHCQ8i2g130_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group24/M01/6A/9A/wKgJNVg5YE6y2QudAaNPAPXZZng233.m4a", "announcer": "羅輯思維脫口秀", "track_id": 25838707, "order_num": 2, "album_id": "239463" }, { "track_title": "政治的殘酷邏輯[羅輯思維]No·196", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group21/M07/4B/39/wKgJLVgtogyjBfO6AAHjHCQ8i2g343_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group25/M01/4B/22/wKgJNlgtoWLxsv5gAbhmTbwLTUA887.m4a", "announcer": "羅輯思維脫口秀", "track_id": 25289999, "order_num": 3, "album_id": "239463" }, { "track_title": "大國難題[羅輯思維]No·195", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group22/M04/39/5A/wKgJM1gm6-_DwmXZAAHjHCQ8i2g029_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group24/M05/39/61/wKgJNVgm6vrgmbPDAWQ9bvfpuWM090.m4a", "announcer": "羅輯思維脫口秀", "track_id": 24968013, "order_num": 4, "album_id": "239463" }, { "track_title": "成敗蔣介石[羅輯思維]No·194", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group22/M04/1C/4A/wKgJM1gbGRrBokWyAAHjHCQ8i2g449_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group25/M02/1E/9C/wKgJMVgcFaKROdgYAal1BeiMZ3M254.m4a", "announcer": "羅輯思維脫口秀", "track_id": 24444330, "order_num": 5, "album_id": "239463" }, { "track_title": "共同體的意義[羅輯思維]No·193", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group23/M0B/04/E7/wKgJNFgR1dWiFt7rAAHjHCQ8i2g865_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group24/M03/04/EA/wKgJNVgR1TvwnuJ1AVuXWcPxXCE307.m4a", "announcer": "羅輯思維脫口秀", "track_id": 24030407, "order_num": 6, "album_id": "239463" }, { "track_title": "弱者的邏輯[羅輯思維]No·192", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group18/M04/93/95/wKgJJVgIp_eT4rEvAAHjHCQ8i2g535_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group19/M03/94/3E/wKgJK1gIp7jzcxLGAbZf-2wZg-8617.m4a", "announcer": "羅輯思維脫口秀", "track_id": 23592670, "order_num": 7, "album_id": "239463" }, { "track_title": "老辦法抓不住新機會[羅輯思維]No·191", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group19/M08/77/0B/wKgJJlf_ZuHhOftSAAHjHCQ8i2g522_web_meduim.jpg", "media_url": "http://audio.xmcdn.com/group20/M00/84/BF/wKgJJ1gENAWyDjwvAXjKTTNH5EI920.m4a", "announcer": "羅輯思維脫口秀", "track_id": 23168511, "order_num": 8, "album_id": "239463" }, { "track_title": "亂世中的奇怪失敗[羅輯思維]No·190", "album_title": "羅輯思維全集", "cover_url": "http://fdfs.xmcdn.com/group17/M08/5A/70/wKgJJFf2NBmAclfEAAHjHCQ8i2g213_web_meduim.jpg", "media_url": "http://audio2.xmcdn.com/group17/M05/77/21/wKgJJFf_ZSbB7iW8AXngXfCPKs8545.m4a", "announcer": "羅輯思維脫口秀", "track_id": 22738431, "order_num": 9, "album_id": "239463" }], "text": "OK。" }, "outputs": [{ "type": "wechat.music", "property": { "title": "有效行動的邏輯[羅輯思維]No·199", "description": "羅輯思維全集", "music_url": "http://audio.xmcdn.com/group22/M0B/A9/B7/wKgJLlhLVivCY70oAXUyHQjGCO8189.m4a" } }, { "type": "dialog", "property": { "text": "好的。", "emotion": "positive" } }], "score": "1.0", "scoreColor": "c4", "is_match": 1, "id": "fcfdbeec-f4a4-44d1-8d90-23504f1e0050" }], "meta_process_milliseconds": 302 } } ``` **請求示例** （失敗情況，沒有找到匹配資源，返回code:404） * [http://api.ruyi.ai/ruyi-api/v1/message?app\_key=APP\_KEY&user\_id=user0&q=我要聽小星星的故事](http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=我要聽小星星的故事) 返回結果 ```json { "code": 0, "msg": "ok", "result": { "_text": "我要聽小星星的故事", "msg_id": "9d4474c3-b28d-434e-8b09-efe1a154062d", "intents": [{ "parameters": { "album": "小星星", "category": "故事", "service": "audio" }, "action": "sys.action.xmly/search", "name": "0-點播專輯（+分類）", "result": { "type": "dialog", "code": 404, "text": "沒有找到你要的聲音，換一個吧！" }, "outputs": [{ "type": "dialog", "property": { "text": "沒有找到你要的聲音，換一個吧！", "emotion": "calm" } }], "score": "1.0", "scoreColor": "c4", "is_match": 1, "id": "cbc72dd8-ec80-4d87-9129-0619d2263285" }], "meta_process_milliseconds": 165 } } ``` **詳細參數說明** | 名稱 | 類型 | 說明 | | :--- | :--- | :--- | | service | String | 服務名稱 | | html\_link | String | 網頁鏈接 | | source | String | 來源 | | source\_link | String | 來源鏈接 | | sound\_id | String | 音頻ID | | title | String | 題目標題 | | media\_url | String | 音頻鏈接 | | cover\_url | String | 封面鏈接 | | mp3\_audio\_url | String | mp3鏈接 | | album | String | 專輯名稱 | | album\_id | String | 專輯ID | | tracks | Array | 聲音列表 | | category\_id | String | 類別ID | | track\_title | String | 聲音標題 | | track\_tags | String | 聲音標簽 | | track\_intro | String | 聲音簡介 | | track\_id | String | 聲音ID | | cover\_url\_small | String | 分類封面小圖 | | cover\_url\_middle | String | 分類封面中圖 | | cover\_url\_large | String | 分類封面大圖 | | announcer | String | 主播信息 | | play\_count | Integer | 專輯播放次數 | | favorite\_count | Integer | 專輯收藏次數 | | comment\_count | Integer | 專輯評論次數 | | download\_count | Integer | 專輯下載次數 | | can\_download | Boolean | 可否下載，true 則為可下載 | | download\_url | String | 下載鏈接 | | download\_size | Integer | 聲音下載大小 | | updated\_at | String | 專輯更新時間 | | created\_at | String | 專輯創建時間 | | order\_num | String | 排序值,值越小排序越在前 | | current\_order\_num | String | 當前排序值 | | track\_list | Array | 聲音列表 | ### （5）主要資源類別 **優質資源** | 序號 | 類別 | | :--- | :--- | | 1 | 兒歌 | | 2 | 兒童故事 | | 3 | 國學 | | 4 | 相聲 | | 5 | 戲曲 | | 6 | 詩歌 | | 7 | 笑話 | | 8 | 散文 | **普通資源** | 序號 | 類別 | | :--- | :--- | | 1 | 有聲小說/圖書 | | 2 | 娛樂電臺 | | 3 | 脫口秀 | | 4 | 情感類電臺 | | 5 | 人文類電臺 | | 6 | 英語類電臺 | | 7 | 其他語種電臺 | | 8 | 教育培訓 | | 9 | 歷史講壇 | | 10 | 廣播劇 | | 11 | 主播電臺 | | 12 | 商業財經 | | 13 | IT科技 | | 14 | 健康養生 | | 15 | 旅游節目 | | 16 | 汽車話題 | | 17 | 動漫游戲 | | 18 | 電影類 | | 19 | 名校公開課 | | 20 | 時尚生活類節目 | | 21 | 佛學宗教 | **注意事項：** * 由于資源版權問題，部分音頻會出現點播不到情況。