### 3.4.7 日程创建 #### (1) 功能说明 高精度时间、地点识别的日程提醒功能。 #### (2) 接口说明 **请求方法** * POST **请求地址** * [http://api.ruyi.ai/v1/message](http://api.ruyi.ai/v1/message) **请求参数说明** | 参数名 | 参数类型 | 是否必须 | 参数说明 | | :--- | :--- | :---: | :--- | | q | String | 是 | 自然语言表达,例如“设置提醒我六点钟起床”,"明天8点去公司开会"等 | | 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) 请求示例 **请求范例** _明天中午十点到十二点和园园一块喝咖啡提前一小时提醒我_ _后天下午4点到5点在北京见老张,提前一个半小时提醒我_ _创建日程_ _今天晚上去华夏中路孙环路吃饭_ _9月15日下午两点到三点半和小王在陆家嘴拜访客户 提醒我_ _过十分钟提醒我去虹桥_ **请求示例** * [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": "10ffd724-5fe6-40e8-8121-6b9b54f3e42a", "intents": [ { "parameters": { "time_start": "1477186200000", "details": "开站会,", "timedelta_alert": "-1800000", "service": "calendar", "type": "ruyi-reminder" }, "action": "sys.action.item/insert", "name": "日程创建——不需暗号", "result": { "msg": "[2016-10-22T16:29:39][scheduler/add] http://apix.ruyi.ai/ruyi-wechat/message?openid=test_123&text=开站会,&ts=1477124979723 scheduled after 990 minutes. 0 job id 6f4bf0cd-4fde-4be8-a5b7-7b49fd356741\n", "text": "新建日程\\n事件:开站会,\\n时间:【2016年10月23日9点30分】 \\n提醒:【提前30分钟】 ", "type": "dialog" }, "outputs": [ { "type": "wechat.text", "property": { "text": "新建日程\\n事件:开站会,\\n时间:【2016年10月23日9点30分】 \\n提醒:【提前30分钟】 " } }, { "type": "dialog", "property": { "text": "新建日程\\n事件:开站会,\\n时间:【2016年10月23日9点30分】 \\n提醒:【提前30分钟】 ", "emotion": "calm" } } ], "score": "1.0", "scoreColor": "c4", "is_match": 1, "id": "f54335cb-0245-439e-91e0-30c667fe1c83" } ], "meta_process_milliseconds": 232 } } ``` **详细参数说明** | 名称 | 类型 | 说明 | | :--- | :--- | :--- | | service | String | 服务名称 | | details | String | 日程内容 | | time\_start | String | 日程开始时间 | | time\_end | String | 日程结束时间 | | timedelta\_alert | String | 日程提醒的时间差 | | location | String | 地点 | | participant | String | 参与者 |