### 3.4.1 黃歷 #### （1） 功能說明 經典黃歷大全，最多可支持到2025年12月31日。每日吉兇宜忌查詢，支持農歷、節日、日期、星期等各類時間實體識別。 #### （2） 接口說明 **請求方法** * POST **請求地址** * [http://api.ruyi.ai/v1/message](http://api.ruyi.ai/v1/message) **請求參數說明** | 參數名 | 參數類型 | 是否必須 | 參數說明 | | :--- | :--- | :---: | :--- | | q | String | 是 | 自然語言表達，例如“今天適合交易么”,"10月13號的黃歷"等 | | 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 開頭的內容;硬件端收到所有內容，依據需求解析使用 | **返回代碼說明** | 返回代碼 | 錯誤類型 | 說明 | | :--- | :--- | :--- | | 0／200 | 成功 | 請求成功 | | 400 | 無效請求 | 某些必需參數缺失或參數值錯誤，詳見msg字段 | | 401 | 未授權 | 授權失敗，app\_key缺失或錯誤 | | 403 | 請求被禁止 | 有效請求，但服務拒絕響應，請聯系contact@ruyi.ai | | 408 | 請求超時 | 請求響應超時，一般響應時間設置為2000ms以內 | | 429 | 短時間內大量訪問 | 短時間內請求數過多 | | 500 | 內部錯誤 | 服務處理異常 | | 503 | 服務不可用 | 服務異常或正在維護 | #### （4）請求示例 **請求范例** _我想查后天黃歷_ _請告訴我明天的宜忌_ _今天的黃歷_ _今天適合交易么_ _查一下黃歷_ _10月13號的黃歷_ **請求示例** * [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": "bdca40a9-c0fc-4604-8a2e-509bd733961a", "intents": [ { "parameters": { "date": "2016-10-23", "service": "huangli", "expiration": "today" }, "action": "sys.box.laohuangli", "name": "查黃歷——嚴格", "result": { "yinli": "丙申(猴)年九月廿三", "yi": "捕捉 畋獵 馀事勿取", "ji": "開市 交易 祭祀 入宅 安葬", "date": "2016-10-23", "text": "2016-10-23的黃歷為 \\n陰歷：丙申(猴)年九月廿三\\n 宜：捕捉 畋獵 馀事勿取\\n 忌：開市 交易 祭祀 入宅 安葬", "type": "dialog" }, "outputs": [ { "type": "wechat.text", "property": { "text": "2016-10-23的黃歷為 \\n陰歷：丙申(猴)年九月廿三\\n 宜：捕捉 畋獵 馀事勿取\\n 忌：開市 交易 祭祀 入宅 安葬" } }, { "type": "dialog", "property": { "text": "2016-10-23的黃歷為 \\n陰歷：丙申(猴)年九月廿三\\n 宜：捕捉 畋獵 馀事勿取\\n 忌：開市 交易 祭祀 入宅 安葬", "emotion": "happy" } } ], "score": "1.0", "scoreColor": "c4", "is_match": 1, "id": "5ef3bc10-cfb9-46e9-b717-f021026593aa" } ], "meta_process_milliseconds": 186 } } ``` **請求示例** * [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": "376d3439-11b7-4db5-a53c-6fd02e4c4cba", "intents": [{ "parameters": { "date": "2016-12-15", "shihe": "交易", "service": "huangli" }, "action": "sys.box.laohuangli", "name": "適合不適合", "result": { "yinli": "丙申(猴)年十一月十七", "yi": "安床 架馬 祭祀 塑繪 開光 出行 理發 伐木 作梁 開柱眼 開廁 畋獵 破土 入殮 除服 成服 移柩 啟鉆 修墳 立碑", "ji": "作灶 安門 造橋 開市 安葬", "date": "2016-12-15", "text": "黃歷上面沒說適宜呀，要不換個日子？", "type": "dialog" }, "outputs": [{ "type": "wechat.text", "property": { "text": "黃歷上面沒說適宜呀，要不換個日子？" } }, { "type": "dialog", "property": { "text": "黃歷上面沒說適宜呀，要不換個日子？", "emotion": "suspect" } }], "score": "0.9992374646062985", "scoreColor": "c4", "is_match": 1, "id": "1490ef70-e392-4c03-aa2a-ea93e9de9a95" }], "meta_process_milliseconds": 178 } } ``` **詳細參數說明** | 名稱 | 類型 | 說明 | | :--- | :--- | :--- | | service | String | 服務名稱 | | yinli | String | 要查詢的黃歷的陰歷 | | yi | String | 黃歷宜的內容 | | ji | String | 黃歷忌宜的內容 | | date | date | 要查詢的日期 | | text | String | 返回文本 |