### 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 | 返回文本 |