diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/aligenie/ip_1.0/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/aligenie/ip_1.0/api-docs.php')
| -rw-r--r-- | data/en_us/aligenie/ip_1.0/api-docs.php | 18335 |
1 files changed, 5570 insertions, 12765 deletions
diff --git a/data/en_us/aligenie/ip_1.0/api-docs.php b/data/en_us/aligenie/ip_1.0/api-docs.php index 2729b8d..f36fd9a 100644 --- a/data/en_us/aligenie/ip_1.0/api-docs.php +++ b/data/en_us/aligenie/ip_1.0/api-docs.php @@ -1,1290 +1,558 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'AliGenie', - 'product' => 'AliGenie', - 'version' => 'ip_1.0', - ], + 'info' => ['style' => 'ROA', 'product' => 'AliGenie', 'version' => 'ip_1.0'], 'directories' => [ - [ - 'id' => 172223, - 'title' => null, - 'type' => 'directory', - 'children' => [ - [ - 'id' => 176686, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'GetRelationProductList', - 'CreateHotel', - 'UpdateHotel', - 'RemoveHotel', - 'ListHotelInfo', - 'ListHotels', - 'AuditHotel', - ], - ], - [ - 'id' => 176687, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ListHotelRooms', - 'BatchAddHotelRoom', - 'BatchDeleteHotelRoom', - 'CheckoutWithAK', - 'QueryHotelRoomDetail', - ], - ], - [ - 'id' => 176688, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ListSceneCategory', - 'ListDialogueTemplate', - 'InsertHotelSceneBookItem', - 'DeleteHotelSceneBookItem', - 'UpdateHotelSceneBookItem', - 'ListHotelSceneBookItems', - 'ListHotelSceneItems', - 'UpdateHotelSceneItem', - 'GetHotelSceneItemDetail', - 'InvokeRobotPush', - ], - ], - [ - 'id' => 177617, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ImportHotelConfig', - 'ImportRoomControlDevices', - 'ImportRoomGenieScenes', - 'PageGetHotelRoomDevices', - 'QueryRoomControlDevices', - 'GetHotelRoomDevice', - 'ControlRoomDevice', - 'PushVoiceBoxCommands', - 'SyncDeviceStatusWithAk', - 'CreateRcuScene', - 'DeleteRcuScene', - 'UpdateRcuScene', - 'ExecuteScene', - 'QuerySceneList', - 'QueryRoomStatus', - 'QueryRoomControlDevicesAndStatus', - [ - 'id' => 183878, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ListAllProvinces', - 'ListCitiesByProvince', - 'ListSTBServiceProviders', - 'ListInfraredDeviceBrands', - 'ListInfraredRemoteControllers', - ], - ], - ], - ], - [ - 'id' => 180467, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ListCustomQA', - 'AddCustomQA', - 'AddCustomQAV2', - 'UpdateCustomQA', - 'DeleteCustomQA', - 'GetBasicInfoQA', - 'UpdateBasicInfoQA', - 'ListServiceQA', - 'UpdateServiceQA', - ], - ], - [ - 'id' => 177620, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'AddCartoon', - 'GetCartoon', - 'DeleteCartoon', - 'GetHotelScreenSaverStyle', - 'AddOrUpdateHotelSetting', - 'GetHotelSetting', - 'DeleteHotelSetting', - ], - ], - [ - 'id' => 176771, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'AddOrUpdateWelcomeText', - 'GetWelcomeTextAndMusic', - 'ResetWelcomeTextAndMusic', - 'PushWelcomeTextAndMusic', - 'PushWelcome', - ], - ], - [ - 'id' => 176689, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'AddMessageTemplate', - 'ListHotelMessageTemplate', - 'DeleteMessageTemplate', - 'UpdateMessageTemplate', - 'PushHotelMessage', - ], - ], - [ - 'id' => 180476, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ListTickets', - 'UpdateTicket', - ], - ], - [ - 'id' => 176690, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'DeleteHotelAlarm', - 'ListHotelAlarm', - 'CreateHotelAlarm', - 'UpdateHotelAlarm', - ], - ], - 'ChildAccountAuth', - 'RemoveChildAccountAuth', - [ - 'id' => 190022, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'PmsEventReport', - ], - ], - ], - ], - [ - 'id' => 172229, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'QueryDeviceStatus', - 'ListHotelControlDevice', - 'DeviceControl', - 'ListHotelSceneItem', - 'ListHotelServiceCategory', - 'GetHotelOrderDetail', - 'ListHotelOrder', - 'SubmitHotelOrder', - 'GetHotelNotice', - 'GetHotelNoticeV2', - 'GetHotelHomeBackImageAndModes', - 'GetHotelSampleUtterances', - 'GetHotelScreenSaver', - 'RoomCheckOut', - 'GetHotelContacts', - 'GetHotelContactByNumber', - 'GetHotelContactByGenieDevice', - ], - ], - [ - 'id' => 179237, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'AddOrUpdateScreenSaver', - 'AddOrUpdateDisPlayModes', - 'GetUnionId', - 'HotelQrBind', - ], - ], + 'AddCartoon', 'AddCustomQA', 'AddCustomQAV2', 'AddMessageTemplate', 'AddOrUpdateDisPlayModes', 'AddOrUpdateHotelSetting', 'AddOrUpdateScreenSaver', 'AddOrUpdateWelcomeText', 'AuditHotel', 'BatchAddHotelRoom', 'BatchDeleteHotelRoom', 'CheckoutWithAK', 'ChildAccountAuth', 'ControlRoomDevice', 'CreateHotel', 'CreateHotelAlarm', 'CreateRcuScene', 'DeleteCartoon', 'DeleteCustomQA', 'DeleteHotelAlarm', + 'DeleteHotelSceneBookItem', 'DeleteHotelSetting', 'DeleteMessageTemplate', 'DeleteRcuScene', 'DeviceControl', 'ExecuteScene', 'GetBasicInfoQA', 'GetCartoon', 'GetHotelContactByGenieDevice', 'GetHotelContactByNumber', 'GetHotelContacts', 'GetHotelHomeBackImageAndModes', 'GetHotelNotice', 'GetHotelNoticeV2', 'GetHotelOrderDetail', 'GetHotelRoomDevice', 'GetHotelSampleUtterances', 'GetHotelSceneItemDetail', 'GetHotelScreenSaver', 'GetHotelScreenSaverStyle', + 'GetHotelSetting', 'GetRelationProductList', 'GetUnionId', 'GetWelcomeTextAndMusic', 'HotelQrBind', 'ImportHotelConfig', 'ImportRoomControlDevices', 'ImportRoomGenieScenes', 'InsertHotelSceneBookItem', 'InvokeRobotPush', 'ListAllProvinces', 'ListCitiesByProvince', 'ListCustomQA', 'ListDialogueTemplate', 'ListHotelAlarm', 'ListHotelControlDevice', 'ListHotelInfo', 'ListHotelMessageTemplate', 'ListHotelOrder', 'ListHotelRooms', + 'ListHotelSceneBookItems', 'ListHotelSceneItem', 'ListHotelSceneItems', 'ListHotelServiceCategory', 'ListHotels', 'ListInfraredDeviceBrands', 'ListInfraredRemoteControllers', 'ListSTBServiceProviders', 'ListSceneCategory', 'ListServiceQA', 'ListTickets', 'PageGetHotelRoomDevices', 'PmsEventReport', 'PushHotelMessage', 'PushVoiceBoxCommands', 'PushWelcome', 'PushWelcomeTextAndMusic', 'QueryDeviceStatus', 'QueryHotelRoomDetail', 'QueryRoomControlDevices', + 'QueryRoomControlDevicesAndStatus', 'QueryRoomStatus', 'QuerySceneList', 'RemoveChildAccountAuth', 'RemoveHotel', 'ResetWelcomeTextAndMusic', 'RoomCheckOut', 'SubmitHotelOrder', 'SyncDeviceStatusWithAk', 'UpdateBasicInfoQA', 'UpdateCustomQA', 'UpdateHotel', 'UpdateHotelAlarm', 'UpdateHotelSceneBookItem', 'UpdateHotelSceneItem', 'UpdateMessageTemplate', 'UpdateRcuScene', 'UpdateServiceQA', 'UpdateTicket', ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'GetRelationProductList' => [ - 'summary' => '关联产品列表查看', - 'path' => '/v1.0/ip/getRelationProductList', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddCartoon' => [ + 'summary' => 'Add or edit animation ', + 'path' => '/v1.0/ip/addCartoon', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], - 'parameters' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => '520a0***eb'], + ], + [ + 'name' => 'StartVideoUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Boot animation URL ', 'type' => 'string', 'required' => true, 'example' => 'https://***.mp4'], + ], + [ + 'name' => 'StartVideoMd5', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Boot animation MD5 ', 'type' => 'string', 'required' => true, 'example' => '40c804***697'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<ProductInfo>>', - 'description' => 'Result<List<ProductInfo>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '产品名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Pk' => [ - 'title' => '产品pk', - 'description' => '', - 'type' => 'string', - 'example' => 'jTOSl***l1odxImRw', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => 'any', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Trace request ID ', 'type' => 'string', 'example' => '0EC7*726E'."\n", 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"橙蜂中控面板\\",\\n \\"Pk\\": \\"jTOSl***l1odxImRw\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"any\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Add or edit animation ', + 'description' => 'Upload an MP4 format video file. Codec: AAC, H.264; resolution: 1280 × 800; video duration must not exceed 10 s; file size must not exceed 10 MB. After uploading the boot animation file, it will take effect after two restarts on the next boot. ', + 'changeSet' => [], ], - 'CreateHotel' => [ - 'summary' => '创建酒店项目', - 'path' => '/v1.0/ip/createHotel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddCustomQA' => [ + 'summary' => 'The Add Custom Q&A feature in the Custom Q&A module.', + 'path' => '/v1.0/ip/addCustomQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TbOpenId', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '淘宝开放id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AAEV***E3d3Z2ETwh', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013', 'title' => ''], ], [ - 'name' => 'AppKey', + 'name' => 'MajorQuestion', 'in' => 'formData', - 'schema' => [ - 'title' => '开放平台appKey', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '333566791', - ], + 'schema' => ['description' => 'Main question', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], ], [ - 'name' => 'HotelName', + 'name' => 'SupplementaryQuestions', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '酒店名称', - 'description' => '', - 'type' => 'string', - 'required' => true, + 'description' => 'List of supplementary questions', + 'type' => 'array', + 'items' => ['description' => 'Supplementary question', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + 'required' => false, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'Remark', + 'name' => 'KeyWords', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', + 'description' => 'List of keywords', + 'type' => 'array', + 'items' => ['description' => 'Keyword', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'HotelAddress', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店地址', - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'HotelEmail', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店联系邮箱', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test@hotel.com', - ], - ], - [ - 'name' => 'PhoneNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店联系电话', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '13xxxxxxxx', - ], - ], - [ - 'name' => 'RelatedPk', - 'in' => 'formData', - 'schema' => [ - 'title' => '关联产品', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'jTO****Rw', - ], - ], - [ - 'name' => 'RelatedPks', + 'name' => 'Answers', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '酒店关联产品列表', - 'description' => '酒店关联产品列表', + 'description' => 'List of answers', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], + 'items' => ['description' => 'Answer', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], 'required' => false, - ], - ], - [ - 'name' => 'RoomNum', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'EstOpenTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '预计开业时间：yyyy-MM-dd HH:mm:ss 格式字符串', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2022-10-1 00:00:00', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Result<Boolean>', 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'example' => '5abfd9***2c38661', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7***726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": \\"5abfd9***2c38661\\",\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'title' => 'Add Custom Q&A', + 'changeSet' => [], ], - 'UpdateHotel' => [ - 'summary' => '修改酒店项目', - 'path' => '/v1.0/ip/updateHotel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddCustomQAV2' => [ + 'summary' => 'Add Custom Q&A V2 Version ', + 'path' => '/v1.0/ip/addQAV2', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TbOpenId', - 'in' => 'formData', - 'schema' => [ - 'title' => '淘宝开放id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AAEVK***UE3d3Z2ETwh', - ], - ], - [ - 'name' => 'AppKey', - 'in' => 'formData', - 'schema' => [ - 'title' => '开放平台appKey', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '31342884', - ], - ], - [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb', 'title' => ''], ], [ - 'name' => 'HotelName', + 'name' => 'MajorQuestion', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Major Question', 'type' => 'string', 'required' => false, 'example' => '今天的天气怎么样', 'title' => ''], ], [ - 'name' => 'Remark', + 'name' => 'SupplementaryQuestions', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', + 'description' => 'Supplementary Question List', + 'type' => 'array', + 'items' => ['description' => 'Supplementary Question List', 'type' => 'string', 'required' => false, 'example' => '室外温度多少', 'title' => ''], 'required' => false, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'HotelAddress', + 'name' => 'KeyWords', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '酒店地址', - 'description' => '', - 'type' => 'string', + 'description' => 'List of keywords.', + 'type' => 'array', + 'items' => ['description' => 'List of keywords', 'type' => 'string', 'required' => false, 'example' => '天气', 'title' => ''], 'required' => false, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'HotelEmail', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店联系邮箱', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a*****@hotel.com', - ], - ], - [ - 'name' => 'PhoneNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店联系电话', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '130***', - ], - ], - [ - 'name' => 'RoomNum', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - ], - [ - 'name' => 'EstOpenTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '预计发布时间：yyyy-MM-dd HH:mm:ss格式字符串', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-02-22 00:00:00', - ], - ], - [ - 'name' => 'RelatedPks', + 'name' => 'Answers', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '关联产品列表', + 'description' => 'Answer List', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['description' => 'Answer List', 'type' => 'string', 'required' => false, 'example' => '你好,您可以再说一遍吗 不好意思我刚才没有听清', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<QAInfoResponse>', + 'description' => 'Result<QAInfoResponse>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code. Except for the convention-defined SUCCESS_CODE, all other codes are Custom-defined by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', 'title' => ''], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', + 'title' => '', + 'description' => 'Actual Return Result of the service. ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', + 'properties' => [ + 'QaId' => ['title' => 'qaID', 'description' => 'qaID', 'type' => 'string', 'example' => '1'], + 'MajorQuestion' => ['title' => '', 'description' => 'Major Question ', 'type' => 'string', 'example' => '今天天气怎么样'], + 'SupplementaryQuestion' => ['title' => '', 'description' => 'Supplementary Question', 'type' => 'string', 'example' => '室外温度多少'], + 'Answers' => ['title' => '', 'description' => 'Answers, separated by semicolons (;) if multiple answers exist. ', 'type' => 'string', 'example' => '你好,您可以再说一遍吗 不好意思我刚才没有听清'], + 'KeyWords' => ['title' => '', 'description' => 'keyword', 'type' => 'string', 'example' => '天气'], + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'a7***83'], + 'UpdateTime' => ['title' => '', 'description' => 'Update Time', 'type' => 'string', 'example' => '2023-01-10 10:01:59'], + 'CreateTime' => ['title' => '', 'description' => 'Creation Time', 'type' => 'string', 'example' => '2023-01-10 10:01:59'], + 'Status' => ['title' => '', 'description' => 'Status: 0 indicates in use; 1 indicates deleted. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'LastOperator' => ['title' => '', 'description' => 'Last Operator ', 'type' => 'string', 'example' => '8xxx9'], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request. ', - 'type' => 'string', - 'example' => '46C53AEB-B19C-5C42-B32E-A726979C126F', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"46C53AEB-B19C-5C42-B32E-A726979C126F\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Result\\": {\\n \\"QaId\\": \\"1\\",\\n \\"MajorQuestion\\": \\"今天天气怎么样\\",\\n \\"SupplementaryQuestion\\": \\"室外温度多少\\",\\n \\"Answers\\": \\"你好,您可以再说一遍吗 不好意思我刚才没有听清\\",\\n \\"KeyWords\\": \\"天气\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0,\\n \\"LastOperator\\": \\"8xxx9\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Add Custom Q&A Pair V2', + 'description' => 'The return value includes QAId. '."\n" + .'The Q&A Content and Answer are Required fields. ', + 'changeSet' => [], ], - 'RemoveHotel' => [ - 'summary' => '删除酒店项目', - 'path' => '/v1.0/ip/removeHotel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddMessageTemplate' => [ + 'summary' => 'Add hotel message template ', + 'path' => '/v1.0/ip/addMessageTemplate', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TbOpenId', - 'in' => 'formData', - 'schema' => [ - 'title' => '淘宝开放id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AAEVK***UE3d3Z2ETwh', - ], - ], - [ - 'name' => 'AppKey', + 'name' => 'TemplateName', 'in' => 'formData', - 'schema' => [ - 'description' => 'appkey', - 'type' => 'string', - 'required' => true, - 'example' => '30193305', - ], + 'schema' => ['title' => '', 'description' => 'Template Name ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试模板'], ], [ - 'name' => 'HotelId', + 'name' => 'TemplateDetail', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', - ], + 'schema' => ['title' => '', 'description' => 'Template Content ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '这是${hotel}的一个测试模板'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<Long>', + 'description' => 'Result<Long>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => '{}', - ], - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Message template ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": 11,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Add hotel message template ', + 'changeSet' => [], ], - 'ListHotelInfo' => [ - 'summary' => '获取酒店列表', - 'path' => '/v1.0/ip/listHotelInfo', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddOrUpdateDisPlayModes' => [ + 'summary' => 'Applies only to screen-equipped Maojing devices and is used to set the list of display patterns on screen-equipped devices.', + 'path' => '/v1.0/ip/addOrUpdateDisPlayModes', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], - 'parameters' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83'], + ], + [ + 'name' => 'HotelDeviceModeList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'List of pattern codes displayed on screen-equipped devices.', + 'type' => 'array', + 'items' => ['description' => 'Pattern encoding', 'type' => 'string', 'required' => false, 'example' => 'dndMode', 'title' => ''], + 'required' => true, + 'example' => '', + ], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelInfoResponse>>', - 'description' => 'Result<List<HotelInfoResponse>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', - ], - 'HotelName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotelAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AuthAccount' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UserName' => [ - 'title' => '授权子账号的账号名称', - 'description' => '', - 'type' => 'string', - 'example' => 'leetest', - ], - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"HotelName\\": \\"酒店\\",\\n \\"HotelAddress\\": \\"浙江身杭州市\\",\\n \\"AuthAccount\\": [\\n {\\n \\"UserName\\": \\"leetest\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Set the list of display patterns for screen-equipped devices.', + 'changeSet' => [], ], - 'ListHotels' => [ - 'summary' => '酒店列表(待审批/已拒绝/已通过)', - 'path' => '/v1.0/ip/listHotels', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddOrUpdateHotelSetting' => [ + 'summary' => 'Add or update hotel customization ', + 'path' => '/v1.0/ip/addOrUpdateHotelSetting', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => false, 'example' => 'a7a3***013'], + ], + [ + 'name' => 'SettingType', 'in' => 'formData', 'schema' => [ - 'title' => '审批状态（0：待审批、1：通过、2：拒绝）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + 'title' => '', + 'description' => 'The type of setting: Display Pattern with Screen (SCENE), Screensaver Configuration with Screen (SCREENSAVER), Home Page Background Image with Screen (HOMEPAGE_PIC), Hotel Notifications with Screen (NOTICE), Night Mode (NIGHT_MODE) ', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['NOTICE' => '', 'NIGHT_MODE' => '', 'SCREENSAVER' => '', 'SCENE' => '', 'HOMEPAGE_PIC' => ''], + 'example' => 'SCREENSAVER', ], ], [ - 'name' => 'Page', - 'in' => 'query', + 'name' => 'Value', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Home page background image / Hotel Notifications ', 'type' => 'string', 'required' => false, 'example' => '首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店～～'], + ], + [ + 'name' => 'HotelScreenSaver', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '分页参数', - 'description' => '', + 'title' => '', + 'description' => 'Screensaver ', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'ScreenSaverStyle' => ['title' => '', 'description' => 'Screensaver style code ', 'type' => 'string', 'required' => false, 'example' => 'common-weather'], + 'ScreenSaverPicUrl' => ['title' => '', 'description' => 'Screensaver image ', 'type' => 'string', 'required' => false, 'example' => 'https://a****jpg'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'HotelRequest', - 'in' => 'query', + 'name' => 'HotelDeviceModeList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Pattern ', + 'type' => 'array', + 'items' => ['description' => 'Parameter value ', 'type' => 'string', 'required' => false, 'example' => 'sleep', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'NightMode', + 'in' => 'formData', 'style' => 'json', 'schema' => [ + 'title' => '', + 'description' => 'Night Mode ', 'type' => 'object', 'properties' => [ - 'HotelId' => [ - 'type' => 'string', - 'required' => false, - ], + 'Enable' => ['title' => '', 'description' => 'Enable or disable ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'Start' => ['title' => '', 'description' => 'Start Time ', 'type' => 'string', 'required' => false, 'example' => '7:00'], + 'End' => ['title' => '', 'description' => 'End time ', 'type' => 'string', 'required' => false, 'example' => '22:00'], + 'DefaultVolume' => ['title' => '夜间模式下的默认音量', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'DefaultBright' => ['title' => '夜间模式下的默认亮度', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'StandbyAction' => ['title' => '', 'description' => 'Action to execute during hibernation: screen off (screenoff) or screensaver (screensaver) ', 'type' => 'string', 'required' => false, 'example' => 'screenoff'], ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<HotelListResp>', - 'description' => 'Result<HotelListResp>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Page' => [ - 'title' => '分页结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'title' => '共多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'TotalPage' => [ - 'title' => '共多少页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'HasNext' => [ - 'title' => '是否有下一页', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - 'HotelInfoList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'example' => '73ab1b03018d4da69b5bef17095f569b', - ], - 'HotelName' => [ - 'title' => '酒店名称', - 'description' => '', - 'type' => 'string', - 'example' => '酒店名称', - ], - 'CreateTime' => [ - 'title' => '创建时间（long类型）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1654568802000', - ], - 'HotelAddress' => [ - 'title' => '酒店地址', - 'description' => '', - 'type' => 'string', - 'example' => '酒店地址', - ], - 'PhoneNumber' => [ - 'title' => '联系方式', - 'description' => '', - 'type' => 'string', - 'example' => '13312340987', - ], - 'IndustryType' => [ - 'title' => '行业类型', - 'description' => '', - 'type' => 'string', - 'example' => '酒店', - ], - 'RoomNum' => [ - 'title' => '房间数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'RelatedProductName' => [ - 'title' => '关联产品名称', - 'description' => '', - 'type' => 'string', - 'example' => '测试产品', - ], - 'AccountNames' => [ - 'title' => '淘宝账号', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'testAccount', - ], - ], - 'Status' => [ - 'title' => '状态（0：待审批、1：通过、2：拒绝）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId', - 'type' => 'string', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the convention-based SUCCESS_CODE, all other codes are defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"HotelInfoList\\": [\\n {\\n \\"HotelId\\": \\"73ab1b03018d4da69b5bef17095f569b\\",\\n \\"HotelName\\": \\"酒店名称\\",\\n \\"CreateTime\\": 1654568802000,\\n \\"HotelAddress\\": \\"酒店地址\\",\\n \\"PhoneNumber\\": \\"13312340987\\",\\n \\"IndustryType\\": \\"酒店\\",\\n \\"RoomNum\\": 12,\\n \\"RelatedProductName\\": \\"测试产品\\",\\n \\"AccountNames\\": [\\n \\"testAccount\\"\\n ],\\n \\"Status\\": 1\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"85789C64-3644-56C0-9C0F-D2E0ECC227EF\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Add or update hotel customization ', + 'description' => '> Based on the input parameter settingType, you can add or modify different hotel customization configurations. '."\n" + .'> - Home page background – settingType="HOMEPAGE_PIC" '."\n" + .'> - Screensaver background – settingType="SCREENSAVER" '."\n" + .'> - Display mode with screen – settingType="SCENE" '."\n" + .'> - Hotel notifications with screen – settingType="NOTICE" '."\n" + .'> - Night mode – settingType="NIGHT_MODE" ', + 'changeSet' => [], ], - 'AuditHotel' => [ - 'summary' => '审批酒店', - 'path' => '/v1.0/ip/auditHotel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddOrUpdateScreenSaver' => [ + 'summary' => 'Applies only to MeowJing devices with screens. Configure the screen saver settings for screen-equipped devices.', + 'path' => '/v1.0/ip/addOrUpdateScreenSaver', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AuditHotelReq', - 'in' => 'query', + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'], + ], + [ + 'name' => 'HotelScreenSaver', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '审批request', - 'description' => '', + 'title' => '', + 'description' => 'Screen saver', 'type' => 'object', 'properties' => [ - 'AuditOpinion' => [ - 'title' => '审批意见', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '同意', - ], - 'Status' => [ - 'title' => '审批状态（1：审核通过 2：审核不通过）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - 'HotelId' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], + 'ScreenSaverStyle' => ['title' => '', 'description' => 'Screen saver style code', 'type' => 'string', 'required' => false, 'example' => 'common-weather'], + 'ScreenSaverPicUrl' => ['title' => '', 'description' => 'Screen saver image', 'type' => 'string', 'required' => false, 'example' => 'xxx.png'], ], 'required' => true, - 'docRequired' => true, + 'example' => '', ], ], ], @@ -1295,179 +563,182 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId', - 'type' => 'string', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service.', 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '4EED***9661', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4EED***9661\\"\\n}","type":"json"}]', + 'title' => 'Set Screen Saver', + 'description' => '- It is recommended to use a dark background image for the screen saver to ensure optimal visibility of information such as time and weather.', + 'changeSet' => [], ], - 'ListHotelRooms' => [ - 'summary' => '获取酒店的所有房间', - 'path' => '/v1.0/ip/listHotelRooms', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'AddOrUpdateWelcomeText' => [ + 'summary' => 'Set welcome message configuration ', + 'path' => '/v1.0/ip/addOrUpdateWelcomeText', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536'], + ], + [ + 'name' => 'WelcomeText', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Welcome text, up to 150 characters ', 'type' => 'string', 'required' => true, 'example' => '尊贵的客人，您好，欢迎入住，我是您的房间智能助理，我可以播放音乐，控制空调、灯光等，也能提供酒店的各种服务，回答酒店相关问题。只需要唤醒后，就能和我开始互动，我的更多能力，可以参考我旁边的立牌使用哦，祝您在本酒店度过一段愉快的入住时光。'], + ], + [ + 'name' => 'MusicUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Background audio link '."\n" + ."\n" + .'Upload requirements: '."\n" + .'1. Only .wav files with a sample rate of 16 kHz and single sound channel are supported. (If your background audio is not in .wav format, you can use ffmpeg to convert it: `ffmpeg -i input_audio -acodec pcm_s16le -ac 1 -ar 16000 output.wav`) '."\n" + .'2. File size must not exceed 2 MB. '."\n" + .'3. If the synthesized audio duration exceeds the background audio duration, the background audio will loop during playback.', 'type' => 'string', 'required' => true, 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service, indicating whether the add or update operation succeeded ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe failed invocations to help the caller troubleshoot issues ', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'Extension fields ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'Extended information ', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Set welcome message configuration ', + 'description' => 'Welcome message configuration includes the TTS text for playback and background audio: '."\n" + .'- Playback text: Can be configured as "Welcome to ${hotel}", using placeholders. During push, provide a parameter mapping table to replace the corresponding placeholders. '."\n" + .'- Background audio link: '."\n" + .' - 1. Only .wav files with a sample rate of 16 kHz and single sound channel are supported. (If your background audio is not in .wav format, you can use ffmpeg to convert it: `ffmpeg -i input_audio -acodec pcm_s16le -ac 1 -ar 16000 output.wav`) '."\n" + .' - 2. File size must not exceed 2 MB. '."\n" + .' - 3. If the synthesized audio duration exceeds the background audio duration, the background audio will loop during playback. ', + 'changeSet' => [], + ], + 'AuditHotel' => [ + 'summary' => 'Hotel approval.', + 'path' => '/v1.0/ip/auditHotel', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'security' => [ [ - 'name' => 'HotelAdminRoom', - 'in' => 'formData', + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AuditHotelReq', + 'in' => 'query', 'style' => 'json', 'schema' => [ + 'title' => '', + 'description' => 'Approval request', 'type' => 'object', 'properties' => [ - 'RoomNo' => [ - 'type' => 'string', - ], + 'AuditOpinion' => ['title' => '', 'description' => 'Approval opinion', 'type' => 'string', 'required' => false, 'example' => '同意'], + 'Status' => ['title' => '', 'description' => 'Approval status (1: Pass, 2: Failed)', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + 'HotelId' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelRoomResp>>', - 'description' => 'Result<List<HotelRoomResp>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', - ], - 'RoomNo' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'example' => '102', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => ''], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => ''], + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"e6dd44fd16084db8a60d69fd625d9f0f\\",\\n \\"RoomNo\\": \\"102\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D75D971E-33E8-1C48-A4B7-5FA6CC386146\\"\\n}","errorExample":""},{"type":"xml","example":"<ListHotelRoomsResponse>\\n <Code>200</Code>\\n <Result>\\n <HotelId>e6dd44fd16084db8a60d69fd625d9f0f</HotelId>\\n <RoomNo>102</RoomNo>\\n </Result>\\n <Message>success</Message>\\n <RequestId>D75D971E-33E8-1C48-A4B7-5FA6CC386146</RequestId>\\n</ListHotelRoomsResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": false,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Hotel approval', + 'changeSet' => [], ], 'BatchAddHotelRoom' => [ - 'summary' => '批量创建房间', + 'summary' => 'Batch create hotel channels ', 'path' => '/v1.0/ip/batchAddHotelRoom', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -1475,34 +746,21 @@ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'], ], [ 'name' => 'RoomNoList', 'in' => 'formData', 'style' => 'simple', 'schema' => [ - 'title' => '房间号List', - 'description' => '', + 'title' => '', + 'description' => 'List of channel numbers (a maximum of 10 can be passed in a single invoke; otherwise, the request will be blocked) ', 'type' => 'array', - 'items' => [ - 'title' => '房间号List', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["101","102"]', - ], + 'items' => ['title' => '', 'description' => 'List of channel numbers (a maximum of 10 can be passed in a single invoke; otherwise, the request will be blocked) ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["101","102"]'], 'required' => true, 'docRequired' => true, 'minItems' => 1, + 'example' => '', ], ], ], @@ -1513,62 +771,36 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['type' => 'string', 'description' => 'Request ID ', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]', + 'title' => 'Batch create hotel channels ', + 'changeSet' => [], ], 'BatchDeleteHotelRoom' => [ - 'summary' => '批量删除房间', + 'summary' => 'Batch delete hotel channels ', 'path' => '/v1.0/ip/batchDeleteHotelRoom', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -1576,34 +808,21 @@ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'], ], [ 'name' => 'RoomNoList', 'in' => 'formData', 'style' => 'simple', 'schema' => [ - 'title' => '房间号List', - 'description' => '', + 'title' => '', + 'description' => 'List of channel numbers ', 'type' => 'array', - 'items' => [ - 'title' => '房间号List', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["1211","1212"]', - ], + 'items' => ['title' => '', 'description' => 'List of channel numbers ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1211","1212"]'], 'required' => true, 'docRequired' => true, 'minItems' => 1, + 'example' => '', ], ], ], @@ -1614,86 +833,48 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => ''], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": false,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Batch delete hotel channels ', + 'changeSet' => [], ], 'CheckoutWithAK' => [ - 'summary' => '酒店退房，清楚例如闹钟等定时信息', + 'summary' => 'Check out and clear scheduled services such as alarms and reminders, as well as order information, from the CatGenie device.', 'path' => '/v1.0/ip/checkoutWithAK', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83'], ], [ 'name' => 'RoomNo', 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', - ], + 'schema' => ['title' => '', 'description' => 'Channel number', 'type' => 'string', 'required' => true, 'example' => '1211'], ], ], 'responses' => [ @@ -1703,941 +884,548 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C6***E6FA', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '73C6***E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'title' => 'Check Out', + 'changeSet' => [], ], - 'QueryHotelRoomDetail' => [ - 'summary' => '查询房间详细信息', - 'path' => '/v1.0/ip/queryHotelRoomDetail', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ChildAccountAuth' => [ + 'summary' => 'Authorize a RAM user for a hotel.', + 'path' => '/v1.0/ip/childAccountAuth', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Mac', + 'name' => 'Account', 'in' => 'formData', - 'schema' => [ - 'title' => '设备mac地址'."\n" - .'注：在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '38:c8:**:**:f5:22', - ], + 'schema' => ['title' => '', 'description' => 'Taobao account name', 'type' => 'string', 'required' => true, 'example' => 'lee'], ], [ - 'name' => 'Uuid', + 'name' => 'TbOpenId', 'in' => 'formData', - 'schema' => [ - 'title' => '设备uuid，可在App中查看'."\n" - .'注：在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '588***96j5WU', - ], + 'schema' => ['title' => '', 'description' => 'Taobao Open ID', 'type' => 'string', 'required' => true, 'example' => 'AAEV***E3d3Z2ETwh'], ], [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id'."\n" - .'注：传入设备mac/sn/uuid 可不传酒店id 若都未传 则 酒店id必传', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '520a0c0***5eb', - ], - ], - [ - 'name' => 'RoomNo', + 'name' => 'AppKey', 'in' => 'formData', - 'schema' => [ - 'title' => '房间号'."\n" - .'注：传入设备mac/sn/uuid 可不传房间号 若都未传 则 房间号必传', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1211', - ], + 'schema' => ['title' => '', 'description' => 'Open Platform appKey', 'type' => 'string', 'required' => true, 'example' => '30471753'], ], [ - 'name' => 'Sn', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '设备sn信息'."\n" - .'在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', - 'description' => '设备sn信息'."\n" - .'注：若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n" - .'传入mac uuid sn其中一个 则酒店id和房间号可不传', - 'type' => 'string', - 'required' => false, - 'example' => '280**28', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HotelRoomDetail>', - 'description' => 'Result<HotelRoomDetail>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result of the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is to provide a brief description of a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'Extension fields', 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'HotelName' => [ - 'title' => '酒店名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatorAccountName' => [ - 'title' => '酒店创建者账号名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ConnectType' => [ - 'title' => '酒店链接类型，rcu/mesh', - 'description' => '', - 'type' => 'string', - 'example' => 'rcu', - ], - 'RoomNo' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'example' => '2001', - ], - 'RoomControlInfo' => [ - 'title' => '客控信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '房型id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1170', - ], - 'TemplateName' => [ - 'title' => '房型名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AppId' => [ - 'title' => '云云对接应用id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '78', - ], - 'AppName' => [ - 'title' => '云云对接应用名称', - 'description' => '', - 'type' => 'string', - 'example' => 'app', - ], - 'RcuUrl' => [ - 'title' => 'rcu云云调用链接', - 'description' => '', - 'type' => 'string', - 'example' => 'http://www.xxx.com', - ], - 'DeviceInfos' => [ - 'title' => '客控设备信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '客控设备信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DeviceName' => [ - 'title' => '设备别名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CategoryId' => [ - 'title' => '品类id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'CategoryEnName' => [ - 'title' => '品类英文名', - 'description' => '', - 'type' => 'string', - 'example' => 'light', - ], - 'CategoryName' => [ - 'title' => '品类中文名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'LocationId' => [ - 'title' => '位置id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'LocationEnName' => [ - 'title' => '位置英文名', - 'description' => '', - 'type' => 'string', - 'example' => 'room', - ], - 'LocationName' => [ - 'title' => '位置中文名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DeviceId' => [ - 'title' => '设备唯一编号', - 'description' => '', - 'type' => 'string', - 'example' => 'readLight', - ], - 'DeviceConnectType' => [ - 'title' => '设备链接类型，rcu/mesh/红外', - 'description' => '', - 'type' => 'string', - 'example' => 'rcu', - ], - 'ProductKey' => [ - 'title' => 'mesh产品pk', - 'description' => '', - 'type' => 'string', - 'example' => 'a1ueWGP6W2L', - ], - 'DeviceCount' => [ - 'title' => '设备数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - ], - ], - ], - ], - ], - 'AuthAccounts' => [ - 'title' => '授权账号列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AccountName' => [ - 'title' => '账号名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AuthTime' => [ - 'title' => '授权时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-01 12:00:00', - ], - ], - ], - ], - 'DeviceInfos' => [ - 'title' => '猫精设备列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Uuid' => [ - 'title' => '猫精设备唯一标识uuid', - 'description' => '', - 'type' => 'string', - 'example' => '41c95c18a0a643bcb58edf438877def5', - ], - 'DeviceName' => [ - 'title' => '设备名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'OnlineStatus' => [ - 'title' => '设备在线状态，1：在线，0：离线', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Mac' => [ - 'title' => '设备mac地址', - 'description' => '', - 'type' => 'string', - 'example' => 'fa:03:23:58:c3:00', - ], - 'Sn' => [ - 'title' => '设备sn号', - 'description' => '', - 'type' => 'string', - 'example' => 'sag42dlz4qf', - ], - 'FirmwareVersion' => [ - 'title' => '设备固件版本', - 'description' => '', - 'type' => 'string', - 'example' => '6.1.8-RS-20230425.1806', - ], - 'ActiveTime' => [ - 'title' => '设备激活时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-01 12:00:00', - ], - ], - ], - ], - 'RoomServiceInfo' => [ - 'title' => '客需服务信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RoomServiceCnt' => [ - 'title' => '已配置服务数量，如洗衣服务', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'RepairServiceCnt' => [ - 'title' => '已配置维修数量，如电视坏了', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'GoodsServiceCnt' => [ - 'title' => '已配置物品数量，如我要包纸巾', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'BookServiceCnt' => [ - 'title' => '已配置预定数量，如预定个spa', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'OtherService' => [ - 'title' => '其他信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OpenCall' => [ - 'title' => '是否开通通话', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UnhandleTickets' => [ - 'title' => '剩余未处理工单数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'additionalProperties' => ['type' => 'any', 'description' => 'Extension fields', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '3DB51A10-327C-58D3-91DF-3A5A471C51E7', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"HotelName\\": \\"xx酒店\\",\\n \\"CreatorAccountName\\": \\"xx淘宝昵称\\",\\n \\"ConnectType\\": \\"rcu\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"RoomControlInfo\\": {\\n \\"TemplateId\\": 1170,\\n \\"TemplateName\\": \\"大床房\\",\\n \\"AppId\\": 78,\\n \\"AppName\\": \\"app\\",\\n \\"RcuUrl\\": \\"http://www.xxx.com\\",\\n \\"DeviceInfos\\": [\\n {\\n \\"DeviceName\\": \\"阅读灯\\",\\n \\"CategoryId\\": 3,\\n \\"CategoryEnName\\": \\"light\\",\\n \\"CategoryName\\": \\"灯\\",\\n \\"LocationId\\": 1,\\n \\"LocationEnName\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"DeviceId\\": \\"readLight\\",\\n \\"DeviceConnectType\\": \\"rcu\\",\\n \\"ProductKey\\": \\"a1ueWGP6W2L\\",\\n \\"DeviceCount\\": 4\\n }\\n ]\\n },\\n \\"AuthAccounts\\": [\\n {\\n \\"AccountName\\": \\"xx淘宝昵称\\",\\n \\"AuthTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"DeviceInfos\\": [\\n {\\n \\"Uuid\\": \\"41c95c18a0a643bcb58edf438877def5\\",\\n \\"DeviceName\\": \\"IN糖酒店版\\",\\n \\"OnlineStatus\\": 1,\\n \\"Mac\\": \\"fa:03:23:58:c3:00\\",\\n \\"Sn\\": \\"sag42dlz4qf\\",\\n \\"FirmwareVersion\\": \\"6.1.8-RS-20230425.1806\\",\\n \\"ActiveTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"RoomServiceInfo\\": {\\n \\"RoomServiceCnt\\": 12,\\n \\"RepairServiceCnt\\": 10,\\n \\"GoodsServiceCnt\\": 10,\\n \\"BookServiceCnt\\": 0\\n },\\n \\"OtherService\\": {\\n \\"OpenCall\\": false,\\n \\"UnhandleTickets\\": 0\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"3DB51A10-327C-58D3-91DF-3A5A471C51E7\\"\\n}","type":"json"}]', + 'title' => 'RAM User Authorization', + 'description' => 'Authorize a RAM user for a hotel.', + 'changeSet' => [], ], - 'ListSceneCategory' => [ - 'summary' => '酒店场景分类', - 'path' => '/v1.0/ip/listSceneCategory', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ControlRoomDevice' => [ + 'summary' => 'Control infrared or Mesh devices in hotel rooms. ', + 'path' => '/v1.0/ip/controlRoomDevice', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => 'hotelId', - 'description' => 'hotelId', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'a7***83', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => ['description' => 'Channel number ', 'type' => 'string', 'required' => true, 'example' => '1211', 'title' => ''], + ], + [ + 'name' => 'Cmd', 'in' => 'formData', + 'schema' => ['description' => 'Instruction Type ', 'type' => 'string', 'required' => true, 'example' => 'thing.attribute.set'."\n" + .'thing.attribute.adjust', 'title' => ''], + ], + [ + 'name' => 'DeviceNumber', + 'in' => 'formData', + 'schema' => ['description' => 'Device serial number, which is the serial number of the device under the room type and guest room control category settings in the Tmall Genie Industry Management Platform ', 'type' => 'string', 'required' => true, 'example' => 'INFRARED49122575595', 'title' => ''], + ], + [ + 'name' => 'DeviceIndex', + 'in' => 'formData', + 'schema' => ['description' => 'Ordinal number of a multi-button Toggle device ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Properties', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '场景分类类型（物品GOODS/服务SERVICE/维修REPAIR）', - 'description' => '', - 'type' => 'string', + 'description' => 'Property information ', + 'type' => 'object', 'required' => true, - 'docRequired' => true, - 'example' => 'REPAIR', + 'additionalProperties' => ['type' => 'string', 'description' => 'powerstate ', 'example' => '1', 'required' => true, 'title' => ''], + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<String>>', - 'description' => 'Result<List<String>>', + 'title' => 'Result<ControlResponse>', + 'description' => 'Result<ControlResponse>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'Invocation return code; except for the conventionally defined SUCCESS_CODE, all others are Custom by the service provider ', 'title' => 'Invocation return code; except for the conventionally defined SUCCESS_CODE, all others are Custom by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "电器类", "家具类", "卫生间类" ]', + 'title' => '', + 'description' => 'Actual return Result of the service ', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Control result code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200表示成功，其它为失败', 'title' => ''], + 'Message' => ['description' => 'Control result message ', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller locate the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7***726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n \\"[ \\\\\\"电器类\\\\\\", \\\\\\"家具类\\\\\\", \\\\\\"卫生间类\\\\\\" ]\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": 0,\\n \\"Message\\": \\"success\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'title' => 'Control guest room devices', + 'requestParamsDescription' => '<notice>Most infrared devices use the same key code for power toggle, which may result in the device actually turning off when powerstate is set to 1. Infrared devices currently support control of only a single property.</notice> '."\n" + ."\n" + .'### Fan '."\n" + .'#### thing.attribute.set '."\n" + .'- powerstate: Toggle '."\n" + .' - 0: shutdown '."\n" + .' - 1: open '."\n" + ."\n" + .'### Air Conditioner '."\n" + .'#### thing.attribute.set '."\n" + .'- powerstate: Toggle '."\n" + .' - 0: shutdown '."\n" + .' - 1: open '."\n" + .'- windspeed: Wind speed '."\n" + .' - 0~3: Wind speed levels 0 to 3 '."\n" + .'- targetTemperature: Target temperature '."\n" + .' - 16~30: Target temperature in degrees Celsius '."\n" + .'- mode: pattern '."\n" + .' - 2: Automatic pattern '."\n" + .' - 9: refrigeration pattern '."\n" + .' - 10: Heating pattern '."\n" + .' - 12: Airflow pattern '."\n" + .' - 13: dehumidify pattern '."\n" + .' - 14: sleep pattern '."\n" + .' - 38: Turbo pattern '."\n" + .' - 230: Energy-saving pattern '."\n" + .' - 231: prefetch pattern '."\n" + ."\n" + .'### TV Devices (TV, set-top box, projector, set-top box) '."\n" + .'#### thing.attribute.set '."\n" + .'- powerstate: Toggle '."\n" + .' - 0: shutdown '."\n" + .' - 1: open '."\n" + .'- channelNumber: channel number '."\n" + .' - 0~999: channel number '."\n" + .'- muteMode: Mute mode '."\n" + .' - 0: Disable mute mode '."\n" + .' - 1: Enable mute mode '."\n" + ."\n" + .'#### thing.attribute.adjust '."\n" + .'- volume: Volume '."\n" + .' - 1: Increase volume by one '."\n" + .' - -1: Decrease volume by one '."\n", + 'changeSet' => [], ], - 'ListDialogueTemplate' => [ - 'summary' => '酒店场景对话模板', - 'path' => '/v1.0/ip/listDialogueTemplate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'CreateHotel' => [ + 'summary' => 'Create Hotel API.', + 'path' => '/v1.0/ip/createHotel', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Obtained after Taobao authorization logon; the current logged-in Taobao Open user ID ', 'type' => 'string', 'required' => true, 'example' => 'AAEV***E3d3Z2ETwh'], + ], + [ + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'appKey obtained from the Taobao Open Platform for user authorization to logon to Taobao', 'type' => 'string', 'required' => true, 'example' => '333566791'], + ], + [ + 'name' => 'HotelName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel name ', 'type' => 'string', 'required' => true, 'example' => '天奥酒店'], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Remarks ', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'HotelAddress', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel address', 'type' => 'string', 'required' => true, 'example' => '浙江省杭州市xxxxxxxx'], + ], + [ + 'name' => 'HotelEmail', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel contact mailbox', 'type' => 'string', 'required' => true, 'example' => 'test@hotel.com'], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel contact phone number', 'type' => 'string', 'required' => true, 'example' => '13xxxxxxxx'], + ], + [ + 'name' => 'RelatedPk', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Associated product PK ID ', 'type' => 'string', 'required' => true, 'example' => 'jTO****Rw'], + ], + [ + 'name' => 'RelatedPks', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'hotelId', - 'description' => 'hotelId', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', + 'title' => '酒店关联产品列表', + 'description' => '酒店关联产品列表', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'RoomNum', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Number of rooms ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], + ], + [ + 'name' => 'EstOpenTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Estimated opening time: string in yyyy-MM-dd HH:mm:ss format', 'type' => 'string', 'required' => true, 'example' => '2022-10-1 00:00:00'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<DialogueTemplate>>', - 'description' => 'Result<List<DialogueTemplate>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => '', - 'type' => 'string', - 'example' => '物品多轮模板', - ], - 'TemplateDetail' => [ - 'title' => '模板详情（维修只有一轮对话）', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FirstDialogueTemplate' => [ - 'title' => '第一轮对话', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ZeroPriceYesAnswer' => [ - 'title' => '价格=0 && 肯定回答', - 'description' => '', - 'type' => 'string', - 'example' => '好的，服务员会尽快送来。', - ], - 'ZeroPriceNoAnswer' => [ - 'title' => '价格=0 && 否定回答', - 'description' => '', - 'type' => 'string', - 'example' => '对不起，暂时不提供此物品。', - ], - 'NonzeroPriceYesAnswer' => [ - 'title' => '价格！=0 &&肯定回答', - 'description' => '', - 'type' => 'string', - 'example' => '${goodsName}${price}元，请问需要服务员送来吗？', - ], - ], - ], - 'SecondDialogueTemplate' => [ - 'title' => '第二轮对话', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NonzeroPriceYesAnswer' => [ - 'title' => '价格！=0 && 肯定回答', - 'description' => '', - 'type' => 'string', - 'example' => '好的，服务员会尽快送来${goodsName}', - ], - 'NonzeroPriceNoAnswer' => [ - 'title' => '价格！=0 && 否定回答', - 'description' => '', - 'type' => 'string', - 'example' => '好的，已取消。', - ], - ], - ], - ], - ], - 'Type' => [ - 'title' => '模板类型', - 'description' => '', - 'type' => 'string', - 'example' => 'GOODS', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId', - 'type' => 'string', - 'example' => '0EC7*726E', + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service, which is the hotel ID.', 'type' => 'string', 'example' => '5abfd9***2c38661'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension fields', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'extension fields', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 4,\\n \\"TemplateName\\": \\"物品多轮模板\\",\\n \\"TemplateDetail\\": {\\n \\"FirstDialogueTemplate\\": {\\n \\"ZeroPriceYesAnswer\\": \\"好的，服务员会尽快送来。\\",\\n \\"ZeroPriceNoAnswer\\": \\"对不起，暂时不提供此物品。\\",\\n \\"NonzeroPriceYesAnswer\\": \\"${goodsName}${price}元，请问需要服务员送来吗？\\"\\n },\\n \\"SecondDialogueTemplate\\": {\\n \\"NonzeroPriceYesAnswer\\": \\"好的，服务员会尽快送来${goodsName}\\",\\n \\"NonzeroPriceNoAnswer\\": \\"好的，已取消。\\"\\n }\\n },\\n \\"Type\\": \\"GOODS\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": \\"5abfd9***2c38661\\",\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'title' => 'Create Hotel', + 'description' => 'Create Hotel API.', + 'changeSet' => [], ], - 'InsertHotelSceneBookItem' => [ - 'summary' => '酒店场景预订新增', - 'path' => '/v1.0/ip/insertHotelSceneBookItem', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'CreateHotelAlarm' => [ + 'summary' => 'Batch Creation of Alarms ', + 'path' => '/v1.0/ip/createHotelAlarm', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', 'title' => ''], + ], + [ + 'name' => 'Rooms', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'hotelID', - 'description' => 'hotelID', - 'type' => 'string', + 'title' => '', + 'description' => 'Batch alarm settings support up to 10 channels. Ensure that the number of channels specified here does not exceed 10.', + 'type' => 'array', + 'items' => ['description' => 'Channel ID', 'type' => 'string', 'required' => false, 'example' => '101', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', + 'example' => '', ], ], [ - 'name' => 'AddHotelSceneItemReq', - 'in' => 'query', + 'name' => 'ScheduleInfo', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => 'addHotelSceneItemReq', - 'description' => 'addHotelSceneItemReq', + 'description' => 'Time schedule information', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '酒店场景预订类型（FOOD：餐饮、LEISURE：SPA休闲、CAR_SERVICE：打车）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FOOD', - ], - 'Name' => [ - 'title' => '酒店场景预订item名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '青椒肉丝', - ], - 'Price' => [ - 'title' => '价格（单位：分）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1250', + 'Type' => ['title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', 'description' => 'ONCE, WEEKLY', 'type' => 'string', 'required' => true, 'example' => '调度类型'], + 'Once' => [ + 'description' => 'One-time alarm', + 'type' => 'object', + 'properties' => [ + 'Year' => ['description' => 'Year', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022', 'title' => ''], + 'Month' => ['description' => 'Month', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9', 'title' => ''], + 'Day' => ['description' => 'Day', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'Hour' => ['description' => 'Hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '19', 'title' => ''], + 'Minute' => ['description' => 'Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Icon' => [ - 'title' => 'icon', - 'description' => 'icon', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png', + 'Weekly' => [ + 'description' => 'Weekly loop', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'description' => 'Days of the week to trigger', + 'type' => 'array', + 'items' => ['description' => 'Day of the week', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Hour' => ['description' => 'Hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Minute' => ['description' => 'Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'MusicType', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Currently supports (DOU_YIN, JING_DIAN)', + 'type' => 'string', + 'required' => false, + 'example' => 'DOU_YIN', + 'enum' => ['DOU_YIN', 'JING_DIAN'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<HotelAlarmResponse>>', + 'description' => 'Result<List<HotelAlarmResponse>>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result ', + 'type' => 'object', + 'properties' => [ + 'RoomNo' => ['description' => 'Channel number ', 'type' => 'string', 'example' => '101', 'title' => ''], + 'AlarmId' => ['description' => 'Alarm ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '94', 'title' => ''], + 'DeviceOpenId' => ['description' => 'Open device ID ', 'type' => 'string', 'example' => 'Pvk***TA==', 'title' => ''], + 'UserOpenId' => ['description' => 'Open user ID', 'type' => 'string', 'example' => 'mg***Qd', 'title' => ''], + 'FailMsg' => ['description' => 'error message', 'type' => 'string', 'example' => '设备离线，闹钟创建失败', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId', - 'type' => 'string', - 'example' => '36FB***80C2', + 'Message' => ['title' => '', 'description' => 'Additional information, typically used in scenarios where a failed invocation is briefly described to help the caller locate the issue ', 'type' => 'string', 'example' => 'xx为空'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => 'Content of the extension ', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '43***86881', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"36FB***80C2\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"101\\",\\n \\"AlarmId\\": 94,\\n \\"DeviceOpenId\\": \\"Pvk***TA==\\",\\n \\"UserOpenId\\": \\"mg***Qd\\",\\n \\"FailMsg\\": \\"设备离线，闹钟创建失败\\"\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***86881\\"\\n}","type":"json"}]', + 'title' => 'Creation of hotel alarm', + 'description' => 'Batch creation of alarms. ', + 'changeSet' => [], ], - 'DeleteHotelSceneBookItem' => [ - 'summary' => '酒店场景预订删除', - 'path' => '/v1.0/ip/deleteHotelSceneBookItem', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'CreateRcuScene' => [ + 'summary' => 'Create an RCU custom scenario ', + 'path' => '/v1.0/ip/createRcuScene', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => 'hotelID', - 'description' => 'hotelID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'], ], [ - 'name' => 'Id', + 'name' => 'SceneId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店场景预订itemID'."\n" - .' 删除条件 id与名称必传一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '11823', - ], + 'schema' => ['title' => '', 'description' => 'Scenario encoding ', 'type' => 'string', 'required' => true, 'example' => 'yoga'], ], [ - 'name' => 'Name', + 'name' => 'SceneRelationExtDTO', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '名称 删除条件 id与名称必传一个', - 'type' => 'string', + 'title' => '', + 'description' => 'Hotel RCU custom scenario ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'Scenario name', 'type' => 'string', 'required' => true, 'example' => '瑜伽模式'], + 'Icon' => ['title' => '', 'description' => 'Scenario icon', 'type' => 'string', 'required' => true, 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png'], + 'Description' => ['title' => '', 'description' => 'Scenario description', 'type' => 'string', 'required' => true, 'example' => '做瑜伽的酒店场景'], + 'CorpusList' => [ + 'title' => '', + 'description' => 'Trigger phrases (multiple phrases are supported; pass a list as needed, for example: "yoga mode", "start yoga") ', + 'type' => 'array', + 'items' => ['description' => 'Trigger phrase ', 'type' => 'string', 'required' => false, 'example' => '瑜伽模式', 'title' => ''], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', ], ], ], @@ -2648,729 +1436,239 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the predefined SUCCESS_CODE, all other codes are defined by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '844BA5CE-E30A-53CB-8A11-DE1F344C846D'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"844BA5CE-E30A-53CB-8A11-DE1F344C846D\\"\\n}","type":"json"}]', + 'title' => 'Create an RCU custom scenario ', + 'description' => 'Create an RCU custom scenario by providing the request parameters as required. ', + 'changeSet' => [], ], - 'UpdateHotelSceneBookItem' => [ - 'summary' => '酒店场景预订编辑', - 'path' => '/v1.0/ip/updateHotelSceneBookItem', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'DeleteCartoon' => [ + 'summary' => 'Delete the configured animation', + 'path' => '/v1.0/ip/deleteCartoon', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => 'hotelID', - 'description' => 'hotelID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], - ], - [ - 'name' => 'UpdateHotelSceneBookReq', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'updateHotelSceneBookReq', - 'description' => 'updateHotelSceneBookReq', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '酒店场景预订itemID'."\n" - .'id与名称必须传其中一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], - 'Name' => [ - 'title' => '名称 查询条件 id与名称必须传一个', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '青椒肉丝', - ], - 'Icon' => [ - 'title' => 'icon', - 'description' => 'icon', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png', - ], - 'Price' => [ - 'title' => '价格（单位：分）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1250', - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => false, 'example' => 'a7***83'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '', - 'description' => '', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code; apart from the convention-based SUCCESS_CODE, all other codes are custom-defined by the service provider', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Trace request ID', 'type' => 'string', 'example' => '0EC7*726E'."\n", 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Delete the configured animation', + 'description' => 'Delete the configured animation', + 'changeSet' => [], ], - 'ListHotelSceneBookItems' => [ - 'summary' => '酒店场景预订列表（餐饮/SPA休闲/打车）', - 'path' => '/v1.0/ip/listHotelSceneBookItems', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'DeleteCustomQA' => [ + 'summary' => 'The delete custom Q&A pair feature in the Custom Q&A module.', + 'path' => '/v1.0/ip/deleteCustomQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', + 'name' => 'CustomQAIds', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'hotelID', - 'description' => 'hotelID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', + 'description' => 'List of custom Q&A pair IDs', + 'type' => 'array', + 'items' => ['description' => 'Custom Q&A pair ID', 'type' => 'string', 'required' => false, 'example' => '11', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Type', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店场景预订类型（FOOD：餐饮、LEISURE：SPA休闲、CAR_SERVICE：打车）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FOOD', - ], - ], - [ - 'name' => 'Page', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '分页参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<HotelSceneListResp>', - 'description' => 'Result<HotelSceneListResp>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Page' => [ - 'title' => '分页结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'title' => '共多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'TotalPage' => [ - 'title' => '共多少页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'HasNext' => [ - 'title' => '是否有下一页', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - 'SceneItemList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '酒店场景预订类型（FOOD：餐饮、LEISURE：SPA休闲、CAR_SERVICE：打车）', - 'description' => '', - 'type' => 'string', - 'example' => 'FOOD', - ], - 'Id' => [ - 'title' => '酒店场景预订itemID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11824', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => '青椒肉丝', - ], - 'Status' => [ - 'title' => '状态（已添加）', - 'description' => '', - 'type' => 'string', - 'example' => '已添加', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1666161803', - ], - 'Icon' => [ - 'title' => '物品、服务、维修的图标', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png', - ], - 'Price' => [ - 'title' => '价格（单位：分）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1850', - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the convention-based SUCCESS_CODE, all other codes are defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result from the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '73C6***E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"FOOD\\",\\n \\"Id\\": 11824,\\n \\"Name\\": \\"青椒肉丝\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666161803,\\n \\"Icon\\": \\"https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png\\",\\n \\"Price\\": 1850\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'title' => 'Delete Custom Q&A Pair', + 'changeSet' => [], ], - 'ListHotelSceneItems' => [ - 'summary' => '酒店场景列表（物品/服务/维修）', - 'path' => '/v1.0/ip/listHotelSceneItems', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'DeleteHotelAlarm' => [ + 'summary' => 'Delete hotel alarms, supporting both single and batch deletion.', + 'path' => '/v1.0/ip/deleteHotelAlarm', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => 'hotelID', - 'description' => 'hotelID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83', 'title' => ''], ], [ - 'name' => 'ListHotelSceneReq', - 'in' => 'query', + 'name' => 'Alarms', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => 'ListHotelSceneReq', - 'description' => 'ListHotelSceneReq', - 'type' => 'object', - 'properties' => [ - 'Page' => [ - 'title' => '分页参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - 'Type' => [ - 'title' => '酒店场景类型（物品GOODS/服务SERVICE/维修REPAIR）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GOODS', - ], - 'Category' => [ - 'title' => '酒店场景类型二级分类', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '客用品类', - ], - 'Status' => [ - 'title' => '是否添加', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '已添加', - ], - 'Keywords' => [ - 'title' => '酒店场景名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '棉签', + 'description' => 'Alarm information', + 'type' => 'array', + 'items' => [ + 'description' => 'object', + 'type' => 'object', + 'properties' => [ + 'RoomNo' => ['description' => 'Channel number', 'type' => 'string', 'required' => false, 'example' => '101', 'title' => ''], + 'AlarmId' => ['description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5029', 'title' => ''], + 'UserOpenId' => ['description' => 'Open user ID', 'type' => 'string', 'required' => true, 'example' => 'mgw/k***HQd', 'title' => ''], + 'DeviceOpenId' => ['description' => 'Open device ID', 'type' => 'string', 'required' => true, 'example' => 'PvkB***TA==', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HotelSceneListResp>', - 'description' => 'Result<HotelSceneListResp>', + 'title' => 'Result<Integer>', + 'description' => 'Result<Integer>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result from the service', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Message' => ['title' => '', 'description' => 'Additional information. A typical scenario is providing a brief description of a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => 'xxx为空'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension field', 'type' => 'object', - 'properties' => [ - 'Page' => [ - 'title' => '分页结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'title' => '共多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'TotalPage' => [ - 'title' => '共多少页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'HasNext' => [ - 'title' => '是否有下一页', - 'description' => '', - 'type' => 'boolean', - 'example' => 'False', - ], - ], - ], - 'SceneItemList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '酒店场景类型', - 'description' => '', - 'type' => 'string', - 'example' => 'GOODS', - ], - 'Category' => [ - 'title' => '酒店场景类型二级分类', - 'description' => '', - 'type' => 'string', - 'example' => '客用品类', - ], - 'Id' => [ - 'title' => 'id', - 'description' => 'id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10336', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => '棉签', - ], - 'Status' => [ - 'title' => '状态（已添加、未添加）', - 'description' => '', - 'type' => 'string', - 'example' => '已添加', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1666163226', - ], - 'Icon' => [ - 'title' => '物品、服务、维修的图标', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png', - ], - 'Price' => [ - 'title' => '价格（单位：分，eg：160表示1.6元）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '160', - ], - 'DeliveryMethod' => [ - 'title' => '物品配送方式 waiter 服务员 robot 机器人', - 'type' => 'string', - ], - 'RobotName' => [ - 'title' => '机器人名称', - 'type' => 'string', - ], - 'PaymentMethod' => [ - 'title' => '结算方式:room 房费结算 robot 机器人结算', - 'type' => 'string', - ], - 'LimitSwitch' => [ - 'title' => '是否限制数量:0或不传:不限制,1:限制', - 'type' => 'integer', - 'format' => 'int32', - ], - 'LimitNumber' => [ - 'title' => '限制数量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'BeyondLimitReply' => [ - 'title' => '超限回复', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => 'extension content', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '43***881', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666163226,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 160,\\n \\"DeliveryMethod\\": \\"robot\\",\\n \\"RobotName\\": \\"测试机器人\\",\\n \\"PaymentMethod\\": \\"robot\\",\\n \\"LimitSwitch\\": 1,\\n \\"LimitNumber\\": 2,\\n \\"BeyondLimitReply\\": \\"顾客您好，该物品已超出酒店今日供应限制，请联系前台。\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"xxx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + 'title' => 'Delete hotel alarm', + 'description' => 'Delete hotel alarms, supporting both single and batch deletion.', + 'changeSet' => [], ], - 'UpdateHotelSceneItem' => [ - 'summary' => '酒店场景修改（开启/关闭/编辑）', - 'path' => '/v1.0/ip/updateHotelSceneItem', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'DeleteHotelSceneBookItem' => [ + 'summary' => 'Delete hotel scenario booking', + 'path' => '/v1.0/ip/deleteHotelSceneBookItem', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -3378,190 +1676,17 @@ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => 'hotelID', - 'description' => 'hotelID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], + 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], [ - 'name' => 'UpdateHotelSceneOperateReq', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'updateHotelSceneReq', - 'description' => 'updateHotelSceneReq', - 'type' => 'object', - 'properties' => [ - 'OperateType' => [ - 'title' => '操作类型（OPEN开启,CLOSE关闭,EDIT编辑）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN', - ], - 'IsUseTemplateAnswer' => [ - 'title' => '是否使用模板回答（true/false）', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Item ID of the hotel scenario booking', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '11823'], ], [ - 'name' => 'UpdateHotelSceneReq', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => 'UpdateHotelSceneReq', - 'description' => 'UpdateHotelSceneReq', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'itemID', - 'description' => 'itemID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10337', - ], - 'Name' => [ - 'title' => '物品名称 id与name必传一个', - 'type' => 'string', - ], - 'Status' => [ - 'title' => '状态（已添加/未添加）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '已添加', - ], - 'Icon' => [ - 'title' => 'icon', - 'description' => 'icon', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png', - ], - 'Price' => [ - 'title' => '价格（单位：分）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '165', - ], - 'DialogueList' => [ - 'title' => '对话List', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'title' => 'itemId', - 'description' => 'itemId', - 'type' => 'string', - 'required' => false, - 'example' => '10337', - ], - 'Process' => [ - 'title' => '第几轮对话', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Question' => [ - 'title' => '问题', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], - 'YesAnswer' => [ - 'title' => '肯定回答', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '纸巾1.5元，请问需要么？', - ], - 'NoAnswer' => [ - 'title' => '否定回答', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '对不起，暂时不提供此物品', - ], - 'YesAnswerTemplate' => [ - 'title' => '肯定回答模板ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'NoAnswerTemplate' => [ - 'title' => '否定回答模板ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'DialogueId' => [ - 'title' => '对话ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '335', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'DeliveryMethod' => [ - 'title' => '物品配送方式:waiter 服务员（默认） robot 机器人', - 'type' => 'string', - ], - 'RobotName' => [ - 'title' => '机器人名称，物品配送方式为robot时必填', - 'type' => 'string', - ], - 'PaymentMethod' => [ - 'title' => '结算方式:room 房费结算（默认） robot 机器人结算', - 'type' => 'string', - ], - 'LimitSwitch' => [ - 'title' => '是否限制数量:1:限制 其它不限制', - 'type' => 'integer', - 'format' => 'int32', - ], - 'LimitNumber' => [ - 'title' => '限制数量', - 'type' => 'integer', - 'format' => 'int64', - ], - 'BeyondLimitReply' => [ - 'title' => '超限回复', - 'type' => 'string', - ], - ], - 'required' => true, - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'Name. One of ID or Name must be provided as the deletion condition', 'title' => 'Name. One of ID or Name must be provided as the deletion condition', 'type' => 'string', 'required' => false, 'example' => '棉签'], ], ], 'responses' => [ @@ -3571,353 +1696,117 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => '', - 'type' => 'string', - 'example' => '0D0C***67DB', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Delete hotel booking service item', + 'changeSet' => [], ], - 'GetHotelSceneItemDetail' => [ - 'summary' => '酒店场景详情', - 'path' => '/v1.0/ip/getHotelSceneItemDetail', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'DeleteHotelSetting' => [ + 'summary' => 'Delete hotel customization, including home page background, screensaver background, and more', + 'path' => '/v1.0/ip/deleteHotelSetting', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => 'hotelID', - 'description' => 'hotelID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => false, 'example' => 'af7***536'], ], [ - 'name' => 'ItemId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店场景itemID'."\n" - .'id与物品名称必传其中一个', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10336', - ], - ], - [ - 'name' => 'Name', + 'name' => 'SettingType', 'in' => 'formData', 'schema' => [ - 'title' => '物品名称'."\n" - .'id与物品名称必传其中一个', + 'title' => '', + 'description' => 'Type of setting: display mode with screen (SCENE), '."\n" + .'screensaver configuration with screen (SCREENSAVER), '."\n" + .'home page background image with screen (HOMEPAGE_PIC), '."\n" + .'hotel notification with screen (NOTICE), '."\n" + .'night mode (NIGHT_MODE)', 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['NOTICE' => '', 'NIGHT_MODE' => '', 'SCREENSAVER' => '', 'SCENE' => '', 'HOMEPAGE_PIC' => ''], + 'example' => 'SCREENSAVER', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HotelSceneDetailResp>', - 'description' => 'Result<HotelSceneDetailResp>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DialogueList' => [ - 'title' => '酒店场景item对话List', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ServiceId' => [ - 'title' => '酒店场景itemID', - 'description' => '', - 'type' => 'string', - 'example' => '10336', - ], - 'Process' => [ - 'title' => '第几轮对话', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Question' => [ - 'title' => '问题', - 'description' => '', - 'type' => 'string', - ], - 'YesAnswer' => [ - 'title' => '肯定回答', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'NoAnswer' => [ - 'title' => '否定回答', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'YesAnswerTemplate' => [ - 'title' => '肯定回答模板ID', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'NoAnswerTemplate' => [ - 'title' => '否定回答模板ID', - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'DialogueId' => [ - 'title' => '对话ID', - 'description' => '', - 'type' => 'string', - 'example' => '336', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1666164774', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1666164774', - ], - ], - ], - ], - 'Type' => [ - 'title' => '酒店场景类型', - 'description' => '', - 'type' => 'string', - 'example' => 'GOODS', - ], - 'Category' => [ - 'title' => '酒店场景类型二级分类', - 'description' => '', - 'type' => 'string', - 'example' => '客用品类', - ], - 'Id' => [ - 'title' => '酒店场景itemID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10336', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'example' => '擦鞋布', - ], - 'Status' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => '已添加', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1666168828', - ], - 'Icon' => [ - 'title' => '物品、服务、维修的图标', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png', - ], - 'Price' => [ - 'title' => '价格（单位：分）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '170', - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result from the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request trace ID', 'type' => 'string', 'example' => '73C67****BB3E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DialogueList\\": [\\n {\\n \\"ServiceId\\": \\"10336\\",\\n \\"Process\\": 0,\\n \\"Question\\": \\"无\\",\\n \\"YesAnswer\\": \\"纸巾1.5元，请问需要么？\\",\\n \\"NoAnswer\\": \\"对不起，暂时不提供此物品\\",\\n \\"YesAnswerTemplate\\": \\"4\\",\\n \\"NoAnswerTemplate\\": \\"4\\",\\n \\"DialogueId\\": \\"336\\",\\n \\"UpdateTime\\": 1666164774,\\n \\"CreateTime\\": 1666164774\\n }\\n ],\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"擦鞋布\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666168828,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png\\",\\n \\"Price\\": 170\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67****BB3E6FA\\"\\n}","type":"json"}]', + 'title' => 'Delete hotel customization (screensaver background, home page background, etc.)', + 'description' => '> You can delete different hotel customization configurations based on the input parameter settingType. '."\n" + .'> - To delete the home page background: settingType="HOMEPAGE_PIC" '."\n" + .'> - To delete the screensaver background: settingType="SCREENSAVER" '."\n" + .'> - To delete the display mode with screen: settingType="SCENE" '."\n" + .'> - To delete hotel notifications with screen: settingType="NOTICE" '."\n" + .'> - To delete night mode: settingType="NIGHT_MODE"', + 'changeSet' => [], ], - 'InvokeRobotPush' => [ - 'summary' => '机器人服务，消息推送', - 'path' => '/v1.0/ip/invokeRobotPush', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteMessageTemplate' => [ + 'summary' => 'Delete a notification message template ', + 'path' => '/v1.0/ip/deleteMessageTemplate', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1211', - ], - ], - [ - 'name' => 'RoomName', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], - ], - [ - 'name' => 'PushType', + 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'title' => '推送类型，PUT：放东西、GET：拿东西', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'GET', - ], + 'schema' => ['title' => '', 'description' => 'Message template ID ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '234'], ], ], 'responses' => [ @@ -3927,124 +1816,51 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C6***E6FA', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the agreed-upon SUCCESS_CODE, all other codes are defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'F7E2****B7C94', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'title' => 'Delete a notification message template ', + 'changeSet' => [], ], - 'ImportHotelConfig' => [ - 'summary' => '批量导入酒店配置', - 'path' => '/v1.0/ip/importHotelConfig', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'DeleteRcuScene' => [ + 'summary' => 'Delete a custom hotel RCU scenario ', + 'path' => '/v1.0/ip/deleteRcuScene', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'], ], [ - 'name' => 'ImportHotelConfig', + 'name' => 'SceneId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RcuCustomScenes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SceneId' => [ - 'type' => 'string', - 'required' => true, - ], - 'Name' => [ - 'type' => 'string', - 'required' => true, - ], - 'Icon' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'CorpusList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => true, - ], - 'required' => true, - ], - ], - ], - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Scenario encoding ', 'type' => 'string', 'required' => true, 'example' => 'yoga'], ], ], 'responses' => [ @@ -4054,581 +1870,157 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '4F61A7B7-409C-525D-AFDB-238A4E88925A', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4F61A7B7-409C-525D-AFDB-238A4E88925A\\"\\n}","type":"json"}]', + 'title' => 'Delete a custom hotel RCU scenario ', + 'description' => 'To delete a custom hotel RCU scenario, execute the request according to the request parameters. ', + 'changeSet' => [], ], - 'ImportRoomControlDevices' => [ - 'summary' => '批量导入设备（同时补充房型）', - 'path' => '/v1.0/ip/importRoomControlDevices', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeviceControl' => [ + 'summary' => 'Control hotel guest room devices, such as lights, air conditioners, curtains, and other in-room controllable devices. ', + 'path' => '/v1.0/ip/deviceControl', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vdgrefds', - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', - ], - ], - [ - 'name' => 'LocationDevices', - 'in' => 'formData', + 'name' => 'Payload', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '导入的位置、设备列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Location' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'room', - ], - 'LocationName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'light', - 'title' => '品类英文', - ], - 'Number' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'night_light', - 'title' => '序列号'."\n" - .'rcu试该参数必传', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - 'title' => '设备名称', - ], - 'ConnectType' => [ - 'title' => '设备连接类型：rcu、infrared、mesh'."\n" - .'不填默认rcu', - 'type' => 'string', - ], - 'Brand' => [ - 'title' => '品牌', - 'type' => 'string', - ], - 'Province' => [ - 'title' => '省份', - 'type' => 'string', - ], - 'City' => [ - 'title' => '城市', - 'type' => 'string', - ], - 'ServiceProvider' => [ - 'title' => '服务提供商', - 'type' => 'string', - ], - 'InfraredIndex' => [ - 'title' => '红外码库Index', - 'type' => 'string', - ], - 'InfraredId' => [ - 'title' => '红外码库id', - 'type' => 'string', - ], - 'InfraredVersion' => [ - 'title' => '红外码库版本号', - 'type' => 'string', - ], - 'MultiKeySwitchExt' => [ - 'type' => 'object', - 'properties' => [ - 'SwitchList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceIndex' => [ - 'title' => '设备序号', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Category' => [ - 'title' => '关联的设备品类英文名', - 'type' => 'string', - ], - 'Location' => [ - 'title' => '关联的设备位置英文', - 'type' => 'string', - ], - 'DeviceName' => [ - 'title' => '关联的设备别名', - 'type' => 'string', - ], - 'AliasList' => [ - 'title' => '设备多别名列表', - 'type' => 'array', - 'items' => [ - 'title' => '设备自定义别名', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'Dn' => [ - 'title' => '设备dn码', - 'type' => 'string', - ], - 'Pk' => [ - 'title' => '设备pk', - 'type' => 'string', - ], - 'AliasList' => [ - 'title' => '设备多别名列表', - 'type' => 'array', - 'items' => [ - 'title' => '设备自定义别名', - 'type' => 'string', - ], - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'description' => 'Business parameters ', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''], + 'Location' => ['description' => 'Location, such as room (channel), livingroom (living room), etc.', 'type' => 'string', 'required' => true, 'example' => 'room', 'title' => ''], + 'Category' => ['description' => 'Guest control device category, such as aircondition (air conditioner), light (light), etc. ', 'type' => 'string', 'required' => true, 'example' => 'aircondition', 'title' => ''], + 'Cmd' => ['description' => 'Instruction name, such as open or close. For a complete list of supported instructions, refer to the hotel industry integration document. ', 'type' => 'string', 'required' => true, 'example' => 'open', 'title' => ''], + 'Properties' => [ + 'description' => 'Optional configuration. Parameters that must be attached when executing an instruction in the execution section. For example, when setting the air conditioner temperature, the target temperature value must be included. For detailed parameters, see the hotel industry integration document.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => 'value', 'description' => 'Optional configuration. Parameters that must be attached when executing an instruction in the execution section. For example, when setting the air conditioner temperature, the target temperature value must be included. For detailed parameters, see the hotel industry integration document.', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, + 'ExtendInfo' => ['description' => 'Extension information, reserved field.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + 'DeviceNumber' => ['description' => 'Device serial number, which is the serial number assigned to the device under the room type and guest control category settings in the Tmall Genie Industry Management Platform. ', 'type' => 'string', 'required' => true, 'example' => 'air_condition', 'title' => ''], ], - 'required' => true, - ], - ], - [ - 'name' => 'EnableInfraredDeviceImport', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否支持红外 true 支持红外设备 false 不支持红外设备', - 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EnableMeshDeviceImport', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '是否支持mesh true/null 支持 走清理逻辑false 不支持 但是会保留Mesh设备 请求参数里面有 Mesh 数据报错', - 'type' => 'string', + 'description' => 'User Identifier information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding Type. Set this field to **HOTEL**.', 'type' => 'string', 'required' => true, 'example' => 'HOTEL', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type. Enter the application ID of the hotel here. You can view it in the Tmall Genie Industry Management Platform.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The Type of User ID '."\n" + .'- OPEN_ID: The default User ID identity '."\n" + .'- UNION_ID: The User ID identity at the organization dimension, which is available only after you have requested an organization in the Tmall Genie Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User Identifier. Set this field to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Integer>', - 'description' => 'Result<Integer>', + 'title' => 'PageResult<ListItemResponse>', + 'description' => 'Return Result object ', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'xxxx', - 'description' => '', + 'properties' => [ + 'Status' => ['description' => 'Status of the business execution result; 200 indicates successful execution. ', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fdsfregtre', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 10,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"xxxx\\"\\n },\\n \\"RequestId\\": \\"fdsfregtre\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": \\"200\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Hotel Guest Room Control – Device Control ', + 'changeSet' => [], ], - 'ImportRoomGenieScenes' => [ - 'summary' => '导入房间内精灵场景', - 'path' => '/v1.0/ip/importRoomGenieScenes', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ExecuteScene' => [ + 'summary' => 'Control channel scenario ', + 'path' => '/v1.0/ip/executeScene', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7a3***013', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], [ 'name' => 'RoomNo', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', - ], + 'schema' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'required' => true, 'example' => '1211'], ], [ - 'name' => 'SceneList', + 'name' => 'SceneName', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '场景列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SceneName' => [ - 'title' => '场景名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Description' => [ - 'title' => '场景描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Icon' => [ - 'title' => '场景图标', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.com/yyy.png', - ], - 'Display' => [ - 'title' => '是否在带屏侧显示', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'TriggerLogical' => [ - 'title' => '场景触发逻辑(0:条件与,1:条件或)', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'Triggers' => [ - 'title' => '触发条件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '触发类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'CorpusList' => [ - 'title' => '触发语料', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - ], - 'Device' => [ - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'type' => 'string', - 'required' => true, - ], - 'DeviceNumber' => [ - 'type' => 'string', - 'required' => true, - ], - 'DeviceIndex' => [ - 'type' => 'string', - ], - ], - ], - 'AttributeValues' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AttributeName' => [ - 'type' => 'string', - 'required' => true, - ], - 'AttributeValue' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'Actions' => [ - 'title' => '执行动作', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '动作类型', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Reply' => [ - 'title' => '音箱回复内容', - 'type' => 'string', - ], - 'Device' => [ - 'title' => '执行设备', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'title' => '设备品类', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'light', - ], - 'DeviceNumber' => [ - 'title' => '设备编号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3c5d2ab8f9ec', - ], - 'DeviceIndex' => [ - 'title' => '多键开关类设备，传入按键序号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Type' => [ - 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'AttributeValues' => [ - 'title' => '设备目标属性', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeName' => [ - 'title' => '属性名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'powerstate', - ], - 'AttributeValue' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Scenario name ', 'type' => 'string', 'required' => true, 'example' => '睡眠模式'], ], ], 'responses' => [ @@ -4638,1545 +2030,854 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C6***E6FA', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the convention-defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Return code used for POP responses ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]', + 'title' => 'Channel scenario control ', + 'changeSet' => [], ], - 'PageGetHotelRoomDevices' => [ - 'summary' => '分页查询酒店房间主控设备', - 'path' => '/v1.0/ip/pageGetHotelRoomDevices', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetBasicInfoQA' => [ + 'summary' => 'The feature for retrieving basic information Q&A pairs under the general Q&A module.', + 'path' => '/v1.0/ip/getBasicInfoQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'a7***83'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'PageResult<List<HotelDeviceInfo>>', - 'description' => 'PageResult<List<HotelDeviceInfo>>', + 'title' => 'Result<IntentionQATemplateResponse>', + 'description' => 'Result<IntentionQATemplateResponse>', 'type' => 'object', 'properties' => [ - 'Page' => [ - 'title' => '翻页参数', - 'description' => '', + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the predefined SUCCESS_CODE, all other codes are defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => [ + 'title' => '', + 'description' => 'The actual return result of the service.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'title' => '总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'TotalPage' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Start' => [ - 'title' => '起始序号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'End' => [ - 'title' => '末尾序号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'HasNext' => [ - 'title' => '是否还有下一页', - 'description' => '', - 'type' => 'boolean', - 'example' => 'False', - ], - ], - ], - 'StatusCode' => [ - 'title' => '调用返回码，除约定的200标识成功外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Mac' => [ - 'title' => '设备mac', - 'description' => '', - 'type' => 'string', - 'example' => 'b4:xx:xx:xx:65:2b', - ], - 'Sn' => [ - 'title' => '设备sn', - 'description' => '', - 'type' => 'string', - 'example' => '1200xxx048', - ], - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'RoomNo' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'example' => '2001', - ], - 'OnlineStatus' => [ - 'title' => '设备在线状态，1：在线；0：离线', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'FirmwareVersion' => [ - 'title' => '设备固件版本号', - 'description' => '', - 'type' => 'string', - 'example' => 'V21.10.00.313', - ], + 'HotelAddress' => ['title' => '', 'description' => 'Hotel Address ', 'type' => 'string', 'example' => '杭州市***'], + 'PhoneNumber' => ['title' => '', 'description' => 'Front Desk Phone Number ', 'type' => 'string', 'example' => '123***'], + 'CheckInTime' => ['title' => '', 'description' => 'Check-in Time (format: xx:xx, hour and minute) ', 'type' => 'string', 'example' => '11:11'], + 'CheckOutTime' => ['title' => '', 'description' => 'Check-out time (format: xx:xx, hour and minute)', 'type' => 'string', 'example' => '11:11'], + 'WifiName' => ['title' => '', 'description' => 'Wi-Fi Name ', 'type' => 'string', 'example' => '名称***'], + 'WifiPassword' => ['title' => '', 'description' => 'Wi-Fi password', 'type' => 'string', 'example' => '密码***'], + 'HotelMember' => ['title' => '', 'description' => 'Introduction to hotel membership', 'type' => 'string', 'example' => '会员***'."\n"], + 'HotelService' => ['title' => '', 'description' => 'Introduction to the hotel\'s featured services', 'type' => 'string', 'example' => '服务***'], + 'HotelIntroduction' => ['title' => '', 'description' => 'Hotel Introduction ', 'type' => 'string', 'example' => '酒店***'], + 'ParkingPosition' => ['title' => '', 'description' => 'Parking location', 'type' => 'string', 'example' => '杭州市***'], + 'ParkingExpenses' => [ + 'title' => '', + 'description' => 'Parking Fee (Free Parking / Paid Parking) ', + 'type' => 'string', + 'enumValueTitles' => ['收费停车' => '', '免费停车' => ''], + 'example' => '免费停车', + 'enum' => [], ], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - 'RequestId' => [ - 'title' => '请求参数', - 'description' => '', - 'type' => 'string', - 'example' => '4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7***726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 5,\\n \\"TotalPage\\": 1,\\n \\"Start\\": 0,\\n \\"End\\": 4,\\n \\"HasNext\\": true\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"V21.10.00.313\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelAddress\\": \\"杭州市***\\",\\n \\"PhoneNumber\\": \\"123***\\",\\n \\"CheckInTime\\": \\"11:11\\",\\n \\"CheckOutTime\\": \\"11:11\\",\\n \\"WifiName\\": \\"名称***\\",\\n \\"WifiPassword\\": \\"密码***\\",\\n \\"HotelMember\\": \\"会员***\\\\n\\",\\n \\"HotelService\\": \\"服务***\\",\\n \\"HotelIntroduction\\": \\"酒店***\\",\\n \\"ParkingPosition\\": \\"杭州市***\\",\\n \\"ParkingExpenses\\": \\"免费停车\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'title' => 'Retrieve Basic Information Q&A Pairs ', + 'changeSet' => [], ], - 'QueryRoomControlDevices' => [ - 'summary' => '查询酒店房间客控设备', - 'path' => '/v1.0/ip/queryRoomControlDevices', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCartoon' => [ + 'summary' => 'Query the configured animation', + 'path' => '/v1.0/ip/getCartoon', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<ListHotelMessageTemplate>>', - 'description' => '', + 'title' => 'Result<HotelCartoonResponse>', + 'description' => 'Result<HotelCartoonResponse>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Location' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'room', - ], - 'LocationName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'light', - ], - 'Number' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'night_light', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ConnectType' => [ - 'title' => '设备连接类型:rcu/infrared', - 'type' => 'string', - ], - 'PK' => [ - 'type' => 'string', - ], - 'DN' => [ - 'type' => 'string', - ], - 'DeviceStatus' => [ - 'type' => 'string', - ], - 'AliasList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'MultiKeySwitchExt' => [ - 'type' => 'object', - 'properties' => [ - 'SwitchList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceIndex' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ElementCode' => [ - 'type' => 'string', - ], - 'Category' => [ - 'type' => 'string', - ], - 'Location' => [ - 'type' => 'string', - ], - 'DeviceName' => [ - 'type' => 'string', - ], - 'DeviceStatus' => [ - 'type' => 'string', - ], - 'AliasList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'title' => '', + 'description' => 'Actual return result of the service', + 'type' => 'object', + 'properties' => [ + 'StartVideoUrl' => ['title' => '', 'description' => 'Startup video', 'type' => 'string', 'example' => '40c8***97'], + 'StartVideoMd5' => ['title' => '', 'description' => 'MD5 hash of the startup video', 'type' => 'string', 'example' => 'https://ai***.mp4'], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fdsgfdscvre', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, commonly used to briefly describe a failed invocation to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'."\n", 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"ConnectType\\": \\"rcu:RCU设备\\\\ninfrared:红外设备\\",\\n \\"PK\\": \\"50255129\\",\\n \\"DN\\": \\"3c5d2ab8f9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"fdsgfdscvre\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"StartVideoUrl\\": \\"40c8***97\\",\\n \\"StartVideoMd5\\": \\"https://ai***.mp4\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Query the configured animation', + 'description' => 'Query the configured animation', + 'changeSet' => [], ], - 'GetHotelRoomDevice' => [ - 'summary' => '获取酒店房间猫精设备信息', - 'path' => '/v1.0/ip/getHotelRoomDevice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotelContactByGenieDevice' => [ + 'summary' => 'Obtain the call information of the current device ', + 'path' => '/v1.0/ip/getHotelContactByGenieDevice', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', + 'name' => 'UserInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', + 'description' => 'User information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. Enter HOTEL here.', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the hotel application ID here. You can view it in the Tmall Genie Industry Management Platform.', 'type' => 'string', 'required' => true, 'example' => '12**45'."\n"], + 'IdType' => ['title' => '', 'description' => 'Type of User ID '."\n" + .'- OPEN_ID: The default User ID identifier. '."\n" + .'- UNION_ID: The organization-dimension User ID identifier. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'], + 'Id' => ['title' => '', 'description' => 'User Identifier. Set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1***2'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RoomNo', + 'name' => 'DeviceInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', + 'description' => 'Device Information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. Enter HOTEL here.', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the hotel application ID here. You can view it in the Tmall Genie Industry Management Platform.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'IdType' => ['title' => '', 'description' => 'User Identifier. Set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'], + 'Id' => ['title' => '', 'description' => 'User ID type '."\n" + .'- OPEN_ID: The default user ID identity. '."\n" + .'- UNION_ID: The organization-dimension user ID identity. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<ListHotelMessageTemplate>>', - 'description' => '', + 'title' => 'Result<HotelCallContact>', + 'description' => 'Result<HotelCallContact>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the convention-based SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'af7***536', - ], - 'RoomNo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1211', - ], - 'Mac' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aa:aa:aa:aa:aa:aa', - ], - 'Sn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dsfdsfrgreg', - ], - 'OnlineStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'FirmwareVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.0.0-release', - ], - ], + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'a7***83'], + 'Type' => ['title' => '', 'description' => 'Contact type, device: device, group: group ', 'type' => 'string', 'example' => 'group'], + 'Uuid' => ['title' => '', 'description' => 'UUID ', 'type' => 'string', 'example' => '2E57***D45F9'], + 'Number' => ['title' => '', 'description' => 'Number', 'type' => 'string', 'example' => '101'], + 'Name' => ['title' => '', 'description' => 'Contact Name', 'type' => 'string', 'example' => '前台'], + 'Icon' => ['title' => '', 'description' => 'Icon', 'type' => 'string', 'example' => 'xxx.icon'], + 'Status' => ['title' => '', 'description' => 'Status, 1: active, 0: inactive ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExpireAt' => ['title' => '', 'description' => 'Expiration Time', 'type' => 'string', 'example' => '1649472283046'], + 'Id' => ['title' => '', 'description' => 'Contact ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'string', 'example' => '2022-07-21 20:02:12'], + 'GmtModified' => ['title' => '', 'description' => 'Last Modified Time', 'type' => 'string', 'example' => '2022-07-27 14:06:27'."\n"], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vrehvuifdsgrts', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C6***E6FA'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"Mac\\": \\"aa:aa:aa:aa:aa:aa\\",\\n \\"Sn\\": \\"dsfdsfrgreg\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"1.0.0-release\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"vrehvuifdsgrts\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\",\\n \\"Id\\": 1,\\n \\"GmtCreate\\": \\"2022-07-21 20:02:12\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'title' => 'Obtain Device Call Contact Information', + 'changeSet' => [], ], - 'ControlRoomDevice' => [ - 'summary' => '控制房间内设备', - 'path' => '/v1.0/ip/controlRoomDevice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetHotelContactByNumber' => [ + 'summary' => 'Query contact information by number ', + 'path' => '/v1.0/ip/getHotelContactByNumber', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', - ], - ], - [ - 'name' => 'Cmd', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'thing.attribute.set'."\n" - .'thing.attribute.adjust', - ], - ], - [ - 'name' => 'DeviceNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'INFRARED49122575595', - ], - ], - [ - 'name' => 'DeviceIndex', + 'name' => 'Number', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['title' => '', 'description' => 'Number, which can be a channel number or a department-defined number ', 'type' => 'string', 'required' => true, 'example' => '101'], ], [ - 'name' => 'Properties', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'User information ', 'type' => 'object', - 'required' => true, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => '{"powerstate":"1"}', - 'required' => true, + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. Set this to HOTEL. ', 'type' => 'string', 'required' => true, 'example' => 'HOTEL', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. Set this to the application ID of the hotel. You can view it on the Tmall Genie Industry Management Platform. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of User ID '."\n" + .'- OPEN_ID: The default User ID identifier. '."\n" + .'- UNION_ID: The organization-dimension User ID identifier. You must apply for an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User Identifier. Set this to userOpenId or userUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<ControlResponse>', - 'description' => 'Result<ControlResponse>', + 'title' => 'Result<HotelCallContact>', + 'description' => 'Result<HotelCallContact>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'type' => 'integer', - 'format' => 'int32', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service ', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'a7***83'], + 'Type' => ['title' => '', 'description' => 'Contact type: device for device, group for group ', 'type' => 'string', 'example' => 'group'], + 'Uuid' => ['title' => '', 'description' => 'UUID ', 'type' => 'string', 'example' => '2E57***D45F9'], + 'Number' => ['title' => '', 'description' => 'Number ', 'type' => 'string', 'example' => '101'], + 'Name' => ['title' => '', 'description' => 'contact Name ', 'type' => 'string', 'example' => '前台'], + 'Icon' => ['title' => '', 'description' => 'icon ', 'type' => 'string', 'example' => 'xxx.icon'], + 'Status' => ['title' => '', 'description' => 'Status: 1 indicates active, 0 indicates inactive ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExpireAt' => ['title' => '', 'description' => 'Expiration time ', 'type' => 'string', 'example' => '1649316479098'], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": 0,\\n \\"Message\\": \\"success\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649316479098\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Query contact by number ', + 'changeSet' => [], ], - 'PushVoiceBoxCommands' => [ - 'summary' => '推送音箱指令', - 'path' => '/v1.0/ip/pushVoiceBoxCommands', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotelContacts' => [ + 'summary' => 'Obtain hotel contacts ', + 'path' => '/v1.0/ip/getHotelContacts', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'Commands', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '命令列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'CommandDomain' => [ - 'title' => '命名空间', - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - 'CommandName' => [ - 'title' => '指令名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - 'Payload' => [ - 'title' => '指令参数', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - ], - ], - 'required' => true, + 'description' => 'User Identifier Information ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. Set this to HOTEL. ', 'type' => 'string', 'required' => true, 'example' => 'HOTEL', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. Set this to the hotel application ID. You can view it in the Tmall Genie Industry Management Platform. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of the user ID: '."\n" + .'- OPEN_ID: The default User ID identifier. '."\n" + .'- UNION_ID: The organization-dimension User ID identifier. You must apply for an organization in the Open Platform in advance. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User identifier. Set this to userOpenId or userUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], - 'required' => true, - 'minItems' => 1, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<HotelCallContact>>', + 'description' => 'Result<List<HotelCallContact>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Code' => [ - 'title' => '调用返回码 pop返回使用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - ], - 'RequestId' => [ 'title' => '', - 'description' => '', - 'type' => 'string', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'description' => 'Contact information ', + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'cf24***96e7'], + 'Type' => ['title' => '', 'description' => 'Contact type; device: device, group: group ', 'type' => 'string', 'example' => 'group'], + 'Uuid' => ['title' => '', 'description' => 'UUID ', 'type' => 'string', 'example' => '0862***A809'], + 'Number' => ['title' => '', 'description' => 'Number ', 'type' => 'string', 'example' => '101'], + 'Name' => ['title' => '', 'description' => 'Contact Name ', 'type' => 'string', 'example' => '前台'], + 'Icon' => ['title' => '', 'description' => 'Icon ', 'type' => 'string', 'example' => 'xxx.icon'], + 'Status' => ['title' => '', 'description' => 'Status; 1: active, 0: inactive ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExpireAt' => ['title' => '', 'description' => 'Expiration Time ', 'type' => 'string', 'example' => '1649472283046'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, commonly used to briefly describe a failed invocation to help the caller locate the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"null\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf24***96e7\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"0862***A809\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain Hotel Contact Information ', + 'changeSet' => [], ], - 'SyncDeviceStatusWithAk' => [ - 'summary' => '同步客控设备状态到主控设备', - 'path' => '/v1.0/ip/syncDeviceStatusWithAk', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetHotelHomeBackImageAndModes' => [ + 'summary' => 'Obtain the home page background image and scenario modes ', + 'path' => '/v1.0/ip/getHotelHomeBackImageAndModes', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', + 'docRequired' => true, + 'title' => 'User information ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID', 'description' => '', 'title' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955', 'description' => '', 'title' => ''], + 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID', 'description' => '', 'title' => ''], + 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', 'description' => '', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'required' => true, - 'example' => '1211', - ], - ], - [ - 'name' => 'DeviceName', - 'in' => 'formData', - 'schema' => [ - 'title' => '设备名称', 'description' => '', - 'type' => 'string', - 'required' => false, 'example' => '', ], ], - [ - 'name' => 'Switch', - 'in' => 'formData', - 'schema' => [ - 'title' => '开关值，0：关，1：开', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'CategoryEnName', - 'in' => 'formData', - 'schema' => [ - 'title' => '设备的品类英文名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'light', - ], - ], - [ - 'name' => 'CategoryCnName', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '设备的品类英文名称，选填', + 'title' => 'Result<HomePageBackImageAndModes> ', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'description' => ''], + 'Result' => [ + 'title' => 'Actual return result of the service ', + 'type' => 'object', + 'properties' => [ + 'BackgroundImage' => ['title' => 'Background image URL ', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhn.jpg', 'description' => ''], + 'HotelName' => ['title' => 'Hotel name ', 'type' => 'string', 'example' => '宣雍测试橙蜂酒店', 'description' => ''], + 'ModeList' => [ + 'title' => 'Mode list ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '模式code', 'type' => 'string', 'example' => 'romantic', 'description' => ''], + 'CnName' => ['title' => '模式名称', 'type' => 'string', 'example' => '浪漫模式', 'description' => ''], + 'Icon' => ['title' => '模式icon', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/langman.png', 'description' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', + ], + ], + 'description' => '', + 'example' => '', + ], + 'Message' => ['title' => 'Additional information ', 'type' => 'string', 'example' => 'success', 'description' => ''], + 'RequestId' => ['title' => 'Request ID ', 'type' => 'string', 'example' => '394450FC-9035-1B7C-8829-BC88832473FC', 'description' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, 'example' => '', ], ], - [ - 'name' => 'Number', - 'in' => 'formData', - 'schema' => [ - 'title' => '设备序号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'bedLight', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => ' AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], + ], + 'title' => '', + 'changeSet' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"BackgroundImage\\": \\"https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhn.jpg\\",\\n \\"HotelName\\": \\"宣雍测试橙蜂酒店\\",\\n \\"ModeList\\": [\\n {\\n \\"Code\\": \\"romantic\\",\\n \\"CnName\\": \\"浪漫模式\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/langman.png\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"394450FC-9035-1B7C-8829-BC88832473FC\\"\\n}","type":"json"}]', + ], + 'GetHotelNotice' => [ + 'summary' => 'Retrieve hotel notifications ', + 'path' => '/v1.0/ip/getHotelNotice', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'security' => [ [ - 'name' => 'Location', - 'in' => 'formData', - 'schema' => [ - 'title' => '位置', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'room', - ], + 'AliGenie_Auth_SPI' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'LocationCnName', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '位置中文名称，选填', - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', + 'description' => 'User information ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. Set this parameter to PROJECT_ID. ', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. Set this parameter to the Project ID of the product. You can view it in the Tmall Genie AI platform console. ', 'type' => 'string', 'required' => false, 'example' => '12**45', 'title' => ''], + 'IdType' => ['description' => 'Type of the device ID: '."\n" + .'OPENID: Default device ID identity. '."\n" + .'UNIONID: Device ID identity at the organization dimension. You must apply for an organization in the Open Platform in advance. ', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User identifier. Set this parameter to the value of userOpenId or userUnionId. ', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej=', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. This parameter is required if IdType is set to UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => true, + 'docRequired' => true, 'example' => '', ], ], - [ - 'name' => 'mode', - 'in' => 'formData', - 'schema' => [ - 'title' => '空调参数，例如制冷、制热模式', - 'type' => 'string', - ], - ], - [ - 'name' => 'fanSpeed', - 'in' => 'formData', - 'schema' => [ - 'title' => '空调字段，风速', - 'type' => 'string', - ], - ], - [ - 'name' => 'temperature', - 'in' => 'formData', - 'schema' => [ - 'title' => '空调字段，温度', - 'type' => 'string', - ], - ], - [ - 'name' => 'roomTemperature', - 'in' => 'formData', - 'schema' => [ - 'title' => '空调字段，当前室温', - 'type' => 'string', - ], - ], - [ - 'name' => 'value', - 'in' => 'formData', - 'schema' => [ - 'title' => '窗帘、纱帘字段，开合度', - 'type' => 'integer', - 'format' => 'int32', - ], - ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<String>', + 'description' => 'Result<String>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'string', 'example' => 'test notice...'], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"test notice...\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'title' => 'Retrieve hotel notifications ', + 'changeSet' => [], ], - 'CreateRcuScene' => [ - 'summary' => '酒店rcu自定义场景创建', - 'path' => '/v1.0/ip/createRcuScene', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetHotelNoticeV2' => [ + 'summary' => 'Obtain hotel notification information, including the notification title and content ', + 'path' => '/v1.0/ip/getHotelNoticeV2', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '520a0c0***5eb', - ], - ], - [ - 'name' => 'SceneId', - 'in' => 'formData', - 'schema' => [ - 'title' => '场景编码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'yoga', - ], - ], - [ - 'name' => 'SceneRelationExtDTO', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '酒店RCU自定义场景', - 'description' => '', + 'title' => '', + 'description' => 'User information ', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '场景名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Icon' => [ - 'title' => '场景图标', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png', - ], - 'Description' => [ - 'title' => '场景描述信息', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'CorpusList' => [ - 'title' => '触发语料', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => true, - ], + 'EncodeType' => ['description' => 'Encoding type; specify HOTEL here. ', 'type' => 'string', 'required' => false, 'example' => 'HOTEL', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type. Enter the application ID of the hotel here. You can view it on the Tmall Genie Industry Management Platform.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID:'."\n" + .'- OPEN_ID: The default User ID identity.'."\n" + .'- UNION_ID: The User ID identity at the organization dimension. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User identifier; set to userOpenId or userUnionId. ', 'type' => 'string', 'required' => false, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. This field is required if IdType is set to UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<HotelNotice>', + 'description' => 'Result<HotelNotice>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '844BA5CE-E30A-53CB-8A11-DE1F344C846D', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'a7***83'], + 'Title' => ['title' => '', 'description' => 'Hotel notification title ', 'type' => 'string', 'example' => '欢迎入住智能酒店'], + 'Content' => ['title' => '', 'description' => 'Hotel notification content ', 'type' => 'string', 'example' => '欢迎入住，我是您的智能语音助手'], + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '0D0C***67DB'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"844BA5CE-E30A-53CB-8A11-DE1F344C846D\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Title\\": \\"欢迎入住智能酒店\\",\\n \\"Content\\": \\"欢迎入住，我是您的智能语音助手\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]', + 'title' => 'Obtain hotel notifications—including title ', + 'changeSet' => [], ], - 'DeleteRcuScene' => [ - 'summary' => '删除酒店自定义rcu场景', - 'path' => '/v1.0/ip/deleteRcuScene', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetHotelOrderDetail' => [ + 'summary' => 'Obtain hotel order details, such as screenless services, maintenance, catering, etc. ', + 'path' => '/v1.0/ip/getHotelOrderDetail', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7a3***013', - ], - ], - [ - 'name' => 'SceneId', - 'in' => 'formData', + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '场景编码', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Order details payload ', + 'type' => 'object', + 'properties' => [ + 'OrderNo' => ['title' => '', 'description' => 'Order number ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20220714150702000168270112410630'], + ], 'required' => true, - 'example' => 'yoga', + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<HotelOrderDetail>>', + 'description' => 'Result<List<HotelOrderDetail>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4F61A7B7-409C-525D-AFDB-238A4E88925A', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'Item Name', 'type' => 'string', 'example' => '窗帘'], + 'ApplyAmt' => ['title' => '', 'description' => 'Item Amount ', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'Quantity' => ['title' => '', 'description' => 'Item Quantity ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ItemUrl' => ['title' => '', 'description' => 'Item icon ', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659952892000'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '6F579407-13C4-1708-AFA2-B657BE5FE8F5'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4F61A7B7-409C-525D-AFDB-238A4E88925A\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"窗帘\\",\\n \\"ApplyAmt\\": 200,\\n \\"Quantity\\": 1,\\n \\"ItemUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png\\",\\n \\"GmtCreate\\": 1659952892000\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6F579407-13C4-1708-AFA2-B657BE5FE8F5\\"\\n}","type":"json"}]', + 'title' => 'Get Order Details ', + 'description' => 'Obtain hotel order details, such as screenless services, maintenance, catering, etc. ', + 'changeSet' => [], ], - 'UpdateRcuScene' => [ - 'summary' => '修改酒店自定义rcu场景', - 'path' => '/v1.0/ip/updateRcuScene', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetHotelRoomDevice' => [ + 'summary' => 'Query channel MeowJing device information, such as device MAC, SN, online status, etc.', + 'path' => '/v1.0/ip/getHotelRoomDevice', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '520a0c0***5eb', - ], - ], - [ - 'name' => 'SceneId', - 'in' => 'formData', - 'schema' => [ - 'title' => '场景编码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'yoga', - ], + 'in' => 'query', + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], ], [ - 'name' => 'SceneRelationExtDTO', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '酒店RCU自定义场景', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '场景名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Icon' => [ - 'title' => '场景图标', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png', - ], - 'Description' => [ - 'title' => '场景描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'CorpusList' => [ - 'title' => '触发语料', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - ], - ], - 'required' => true, - ], + 'name' => 'RoomNo', + 'in' => 'query', + 'schema' => ['description' => 'Channel number ', 'type' => 'string', 'required' => true, 'example' => '1211', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<ListHotelMessageTemplate>>', + 'description' => 'Return Result object', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Invocation return code; 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3A680F3A-6672-5A47-AB28-12BBCD80C679', + 'title' => '', + 'description' => 'List of MeowJing devices', + 'type' => 'array', + 'items' => [ + 'description' => 'MeowJing device information', + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['description' => 'Hotel ID', 'type' => 'string', 'example' => 'af7***536', 'title' => ''], + 'RoomNo' => ['description' => 'Channel number', 'type' => 'string', 'example' => '1211', 'title' => ''], + 'Mac' => ['description' => 'Device MAC information', 'type' => 'string', 'example' => 'aa:aa:aa:aa:aa:aa', 'title' => ''], + 'Sn' => ['description' => 'Device SN information', 'type' => 'string', 'example' => 'dsfdsfrgreg', 'title' => ''], + 'OnlineStatus' => ['description' => 'Device online status'."\n" + ."\n" + .'- 1: Online '."\n" + .'- 0: Offline', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'FirmwareVersion' => ['description' => 'Device firmware version', 'type' => 'string', 'example' => '1.0.0-release', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information; a typical scenario is providing a brief description of a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'vrehvuifdsgrts', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3A680F3A-6672-5A47-AB28-12BBCD80C679\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"Mac\\": \\"aa:aa:aa:aa:aa:aa\\",\\n \\"Sn\\": \\"dsfdsfrgreg\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"1.0.0-release\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"vrehvuifdsgrts\\"\\n}","type":"json"}]', + 'title' => 'Query channel MeowJing device information', + 'changeSet' => [], ], - 'ExecuteScene' => [ - 'summary' => '控制房间场景', - 'path' => '/v1.0/ip/executeScene', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetHotelSampleUtterances' => [ + 'summary' => 'Obtain recommended corpora ', + 'path' => '/v1.0/ip/getHotelSampleUtterances', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', - ], - ], - [ - 'name' => 'SceneName', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '场景名称', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'IdType' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', 'example' => '', ], ], @@ -6184,2582 +2885,1426 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>> ', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '调用返回码 pop返回使用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => 'Return code of the invocation; apart from the conventionally defined SUCCESS_CODE, all others are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ + 'title' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'type' => 'string', - 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920', + 'example' => '', ], + 'Message' => ['title' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'description' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]', + 'title' => '', + 'changeSet' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Result\\": [\\n \\"\\"\\n ],\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', ], - 'QuerySceneList' => [ - 'summary' => '查询酒店场景列表', - 'path' => '/v1.0/ip/querySceneList', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetHotelSceneItemDetail' => [ + 'summary' => 'Hotel scenario details ', + 'path' => '/v1.0/ip/getHotelSceneItemDetail', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], + 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], [ - 'name' => 'SceneTypes', + 'name' => 'ItemId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '场景集合传递（公共：common；自定义：custom）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'common', - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Item ID for the hotel scenario', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10336'], ], [ - 'name' => 'SceneStates', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '场景状态集合传递（1-已关联，0-未关联）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - ], - [ - 'name' => 'TemplateInfoIds', + 'name' => 'Name', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '房型id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '999', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Item name'."\n" + .'You must provide either the ID or the item name.', 'title' => 'Item name'."\n" + .'You must provide either the ID or the item name.', 'type' => 'string', 'required' => false, 'example' => '棉签'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelSceneWrapperResp>>', - 'description' => 'Result<List<HotelSceneWrapperResp>>', + 'title' => 'Result<HotelSceneDetailResp>', + 'description' => 'Result<HotelSceneDetailResp>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Results' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SceneId' => [ - 'title' => '场景id', - 'description' => '', - 'type' => 'string', - 'example' => '73', - ], - 'SceneName' => [ - 'title' => '场景名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Icon' => [ - 'title' => '场景图标', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png', - ], - 'SceneSource' => [ - 'title' => '场景来源；场景来源；精灵（genie）、外部（external）', - 'description' => '', - 'type' => 'string', - 'example' => 'external', - ], - 'SceneType' => [ - 'title' => '场景类型：公共：common；自定义：custom', - 'description' => '', - 'type' => 'string', - 'example' => 'common', - ], - 'SceneState' => [ - 'title' => '场景与房型的关联状态（1-已关联，0-未关联，-1-不可关联）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UnavailableReason' => [ - 'title' => '场景与房型的关联状态为-1（不可关联）的原因', + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => [ + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'object', + 'properties' => [ + 'DialogueList' => [ + 'title' => '', + 'description' => 'List of dialogues for hotel scenario items ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['title' => '', 'description' => 'Item ID in the hotel scenario', 'type' => 'string', 'example' => '10336'], + 'Process' => ['title' => '', 'description' => 'Which round of dialogue', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Question' => ['title' => '', 'description' => 'Question', 'type' => 'string', 'example' => '无'], + 'YesAnswer' => ['title' => '', 'description' => 'Affirmative answer', 'type' => 'string', 'example' => '纸巾1.5元，请问需要么？'], + 'NoAnswer' => ['title' => '', 'description' => 'Negative answer', 'type' => 'string', 'example' => '对不起，暂时不提供此物品'], + 'YesAnswerTemplate' => ['title' => '', 'description' => 'Affirmative answer Template ID', 'type' => 'string', 'example' => '4'], + 'NoAnswerTemplate' => ['title' => '', 'description' => 'Template ID for negative responses', 'type' => 'string', 'example' => '4'], + 'DialogueId' => ['title' => '', 'description' => 'Dialogue ID', 'type' => 'string', 'example' => '336'], + 'UpdateTime' => ['title' => '', 'description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1666164774'], + 'CreateTime' => ['title' => '', 'description' => 'Creation Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1666164774'], + ], 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'TemplateInfoDTOList' => [ - 'title' => '关联的房型', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '房型id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6962', - ], - 'Name' => [ - 'title' => '房型名称', - 'description' => '', - 'type' => 'string', - 'example' => '101', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], + 'example' => '', ], + 'Type' => ['title' => '', 'description' => 'Hotel scenario type ', 'type' => 'string', 'example' => 'GOODS'], + 'Category' => ['title' => '', 'description' => 'Secondary categorization of the hotel scenario type ', 'type' => 'string', 'example' => '客用品类'], + 'Id' => ['title' => '', 'description' => 'Item ID in the hotel scenario', 'type' => 'integer', 'format' => 'int64', 'example' => '10336'], + 'Name' => ['title' => '', 'description' => 'Name', 'type' => 'string', 'example' => '擦鞋布'], + 'Status' => ['title' => '', 'description' => 'Status ', 'type' => 'string', 'example' => '已添加'], + 'UpdateTime' => ['title' => '', 'description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1666168828'], + 'Icon' => ['title' => '', 'description' => 'Icon for items, services, or maintenance', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png'], + 'Price' => ['title' => '', 'description' => 'Price (unit: cent) ', 'type' => 'integer', 'format' => 'int64', 'example' => '170'], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Results\\": [\\n {\\n \\"SceneId\\": \\"73\\",\\n \\"SceneName\\": \\"睡眠模式\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png\\",\\n \\"SceneSource\\": \\"external\\",\\n \\"SceneType\\": \\"common\\",\\n \\"SceneState\\": 1,\\n \\"UnavailableReason\\": \\"不可关联\\",\\n \\"TemplateInfoDTOList\\": [\\n {\\n \\"Id\\": 6962,\\n \\"Name\\": \\"101\\",\\n \\"Description\\": \\"房型描述\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DialogueList\\": [\\n {\\n \\"ServiceId\\": \\"10336\\",\\n \\"Process\\": 0,\\n \\"Question\\": \\"无\\",\\n \\"YesAnswer\\": \\"纸巾1.5元，请问需要么？\\",\\n \\"NoAnswer\\": \\"对不起，暂时不提供此物品\\",\\n \\"YesAnswerTemplate\\": \\"4\\",\\n \\"NoAnswerTemplate\\": \\"4\\",\\n \\"DialogueId\\": \\"336\\",\\n \\"UpdateTime\\": 1666164774,\\n \\"CreateTime\\": 1666164774\\n }\\n ],\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"擦鞋布\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666168828,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png\\",\\n \\"Price\\": 170\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Hotel scenario details', + 'changeSet' => [], ], - 'QueryRoomStatus' => [ - 'summary' => '查询房态信息', - 'path' => '/v1.0/ip/queryRoomStatus', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetHotelScreenSaver' => [ + 'summary' => 'Obtain screen saver information, such as the screen saver Style.', + 'path' => '/v1.0/ip/getHotelScreenSaver', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1211', + 'title' => '', + 'description' => 'User information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID', 'description' => '', 'title' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955', 'description' => '', 'title' => ''], + 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID', 'description' => '', 'title' => ''], + 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', 'description' => '', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<OpenRoomStatusDetailResponse>', - 'description' => 'Result<OpenRoomStatusDetailResponse>', + 'title' => 'Result<HotelScreenSaver>', + 'description' => 'Result<HotelScreenSaver>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '调用返回码 pop返回使用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'The actual Return Result of the service', 'type' => 'object', 'properties' => [ - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', - ], - 'RoomNo' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'example' => '1211', - ], - 'StatusList' => [ - 'title' => '房态属性内容', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StatusName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'StatusValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Thu Jan 09 13:56:51 CST 2025', - ], - ], - ], - ], - 'SceneList' => [ - 'title' => '房间场景', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SceneName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], + 'StyleCode' => ['title' => '', 'description' => 'Screen saver Style code', 'type' => 'string', 'example' => 'common-weather'], + 'PicUrl' => ['title' => '', 'description' => 'Screen saver Image', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg'], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', - ], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '5F0467E1-19F2-1757-B6D0-B79917BA2E81'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"StatusList\\": [\\n {\\n \\"StatusName\\": \\"清理模式：mur\\\\n勿扰模式：dnd \\\\nsos呼叫：sos\\\\ndoorStatus:门状态\\\\nstateOfMagneticInduction：插卡取电状态\\\\nwifiStatus：房间联网状态\\\\nroomPowerState:房间上电状态 1上电 0断电\\\\nroomEcoMode:房间节能模式 1节能模式下 0非节能模式\\",\\n \\"StatusValue\\": \\"true 打开\\\\nfalse 关闭\\",\\n \\"UpdateTime\\": \\"Thu Jan 09 13:56:51 CST 2025\\"\\n }\\n ],\\n \\"SceneList\\": [\\n {\\n \\"SceneName\\": \\"睡眠模式\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"StyleCode\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5F0467E1-19F2-1757-B6D0-B79917BA2E81\\"\\n}","type":"json"}]', + 'title' => 'Obtain screen saver information', + 'description' => 'Obtain screen saver information, such as the screen saver Style.', + 'changeSet' => [], ], - 'QueryRoomControlDevicesAndStatus' => [ - 'summary' => '查询房间被控设备包含设备状态', - 'path' => '/v1.0/ip/queryRoomControlDevicesAndStatus', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetHotelScreenSaverStyle' => [ + 'summary' => 'Query the available styles for the hotel screen saver background ', + 'path' => '/v1.0/ip/getHotelScreenSaverStyle', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => ' '."\n" - .'af7***536'."\n", - ], - ], - [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1211'."\n", - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => false, 'example' => 'af7***536'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<LocationDevices>>', - 'description' => 'Result<List<LocationDevices>>', + 'title' => 'Result<List<HotelScreenSaverStyle>>', + 'description' => 'Result<List<HotelScreenSaverStyle>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'title' => '调用返回码 pop返回使用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Actual return result of the service ', 'type' => 'object', 'properties' => [ - 'RoomNo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1211', - ], - 'Location' => [ - 'title' => '*', - 'description' => '', - 'type' => 'string', - 'example' => 'room', - ], - 'LocationName' => [ - 'title' => '位置中文', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ConnectType' => [ - 'title' => '设备连接类型', - 'description' => '', - 'type' => 'string', - 'example' => 'rcu', - ], - 'Name' => [ - 'title' => '品类英文', - 'description' => '', - 'type' => 'string', - 'example' => 'light', - ], - 'Number' => [ - 'title' => '设备唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => 'night_light', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Brand' => [ - 'title' => '红外参数', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ServiceProvider' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Province' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'City' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'InfraredIndex' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'InfraredId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9**7', - ], - 'InfraredVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3.0', - ], - 'Pk' => [ - 'title' => 'mesh 设备参数', - 'description' => '', - 'type' => 'string', - 'example' => '50255129', - ], - 'Dn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3c5d***9ec', - ], - 'DeviceStatus' => [ - 'title' => '设备状态', - 'description' => '', - 'type' => 'string', - 'example' => '{"powerstate": "1"}', - ], - 'MultiKeySwitchExt' => [ - 'title' => '多键开关子设备信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SwitchList' => [ - 'title' => '开关按键列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'title' => '关联的设备品类英文名', - 'description' => '', - 'type' => 'string', - 'example' => 'light', - ], - 'Location' => [ - 'title' => '关联的设备位置', - 'description' => '', - 'type' => 'string', - 'example' => 'room', - ], - 'DeviceName' => [ - 'title' => '关联的设备别名', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AliasList' => [ - 'title' => '设备别名', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'DeviceIndex' => [ - 'title' => '设备序号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ElementCode' => [ - 'title' => 'iot 多 element 设备的序号', - 'description' => '', - 'type' => 'string', - 'example' => 'e2', - ], - 'DeviceStatus' => [ - 'title' => '子设备状态', - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "powerstate": "0"'."\n" - .'}', - ], - 'Tags' => [ - 'title' => '子设备标签', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SOS', - ], - ], - 'Status' => [ - 'title' => '设备物模型状态', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => '"doorStatus":{"time":1725347306741,"value":"0"}', - ], - ], - ], - ], - ], - ], - ], - 'AliasList' => [ - 'title' => '设备别名', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Status' => [ - 'title' => '设备物模型状态', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'onlinestate":{"time":1725347364693,"value":"online"}', - 'description' => '', - ], - ], - ], - ], - ], + 'Code' => ['title' => '', 'description' => 'Encoding code ', 'type' => 'string', 'example' => 'common-weather'], + 'CnName' => ['title' => '', 'description' => 'Display Name ', 'type' => 'string', 'example' => '天气'], + 'EnName' => ['title' => '', 'description' => 'English Name ', 'type' => 'string', 'example' => 'common-weather'], + 'PicUrl' => ['title' => '', 'description' => 'Image Link ', 'type' => 'string', 'example' => 'https://img.***.png'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C67***6FA'."\n", - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67**6FA'."\n"], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"1211\\",\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"ConnectType\\": \\"rcu\\",\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"Brand\\": \\"奥*斯\\",\\n \\"ServiceProvider\\": \\"吉视传媒****\\",\\n \\"Province\\": \\"吉林省\\",\\n \\"City\\": \\"松原市\\",\\n \\"InfraredIndex\\": \\"2\\",\\n \\"InfraredId\\": \\"9**7\\",\\n \\"InfraredVersion\\": \\"3.0\\",\\n \\"Pk\\": \\"50255129\\",\\n \\"Dn\\": \\"3c5d***9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"Tags\\": [\\n \\"SOS\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"\\\\\\"doorStatus\\\\\\":{\\\\\\"time\\\\\\":1725347306741,\\\\\\"value\\\\\\":\\\\\\"0\\\\\\"}\\"\\n }\\n }\\n ]\\n },\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"onlinestate\\\\\\":{\\\\\\"time\\\\\\":1725347364693,\\\\\\"value\\\\\\":\\\\\\"online\\\\\\"}\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"common-weather\\",\\n \\"CnName\\": \\"天气\\",\\n \\"EnName\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://img.***.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67**6FA\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Query optional styles for hotel screensaver background', + 'description' => 'When adding a screen saver, there is a screenSaverStyle field. Use the code obtained from this API as the base style. ', + 'changeSet' => [], ], - 'ListAllProvinces' => [ - 'summary' => '查询省份', - 'path' => '/v1.0/ip/listAllProvinces', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetHotelSetting' => [ + 'summary' => 'Query hotel customization (including screensaver background, home page background, etc.)', + 'path' => '/v1.0/ip/getHotelSetting', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], - 'parameters' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => false, 'example' => 'af7***536'."\n"], + ], + [ + 'name' => 'SettingType', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The type of Settings: Display Pattern with Screen (SCENE), Screensaver Configuration with Screen (SCREENSAVER), Home Page Background Image with Screen (HOMEPAGE_PIC), Hotel Notifications with Screen (NOTICE), Night Mode (NIGHT_MODE)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['NOTICE' => '', 'NIGHT_MODE' => '', 'SCREENSAVER' => '', 'SCENE' => '', 'HOMEPAGE_PIC' => ''], + 'example' => 'SCREENSAVER', + ], + ], + ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<List<String>>', - 'description' => 'Result<List<String>>', + 'title' => 'Result<HotelSettingInfo>', + 'description' => 'Result<HotelSettingInfo>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', + 'title' => '', + 'description' => 'Actual return result of the service.', + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID.', 'type' => 'string', 'example' => 'af7***536'], + 'SettingType' => [ + 'title' => '', + 'description' => 'Setting type ', + 'type' => 'string', + 'enumValueTitles' => ['SCREENSAVER' => '', 'HOMEPAGE_PIC' => ''], + 'example' => 'SCREENSAVER', + ], + 'Value' => ['title' => '', 'description' => 'Home page background image or hotel notifications ', 'type' => 'string', 'example' => '首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店～～'], + 'DeleteToken' => ['title' => '', 'description' => 'Whether to delete.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ExtInfo' => ['title' => '', 'description' => 'Extension information ', 'type' => 'string', 'example' => '{}'], + 'HotelScreenSaver' => [ + 'title' => '', + 'description' => 'Screen saver object ', + 'type' => 'object', + 'properties' => [ + 'ScreenSaverStyle' => ['title' => '', 'description' => 'Screen saver style code ', 'type' => 'string', 'example' => 'common-weather'], + 'ScreenSaverPicUrl' => ['title' => '', 'description' => 'Screen saver image ', 'type' => 'string', 'example' => 'https://a***png'], + ], + 'example' => '', + ], + 'HotelDeviceModeList' => [ + 'title' => '', + 'description' => 'Device mode.', + 'type' => 'array', + 'items' => ['description' => 'Scenario value.', 'type' => 'string', 'example' => 'sweet', 'title' => ''], + 'example' => '', + ], + 'NightMode' => [ + 'title' => '', + 'description' => 'Night mode ', + 'type' => 'object', + 'properties' => [ + 'Enable' => ['title' => '', 'description' => 'Enable or disable ', 'type' => 'boolean', 'example' => 'true'], + 'Start' => ['title' => '', 'description' => 'Start Time ', 'type' => 'string', 'example' => '07:00'], + 'End' => ['title' => '', 'description' => 'End Time ', 'type' => 'string', 'example' => '22:00'], + 'DefaultVolume' => ['title' => '夜间模式下的默认音量', 'description' => '夜间模式下的默认音量', 'type' => 'string', 'example' => ''], + 'DefaultBright' => ['title' => '夜间模式下的默认亮度', 'description' => '夜间模式下的默认亮度', 'type' => 'string', 'example' => ''], + 'StandbyAction' => ['title' => '', 'description' => 'Action to execute during hibernation: screen off (screenoff) or screensaver (screensaver) ', 'type' => 'string', 'example' => 'screenoff'], + ], + 'example' => '', + ], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '00534880-4397-5134-B212-1030B7A37C27', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'F7E2****B7C94', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"浙江省\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"00534880-4397-5134-B212-1030B7A37C27\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"SettingType\\": \\"SCREENSAVER\\",\\n \\"Value\\": \\"首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店～～\\",\\n \\"DeleteToken\\": 0,\\n \\"ExtInfo\\": \\"{}\\",\\n \\"HotelScreenSaver\\": {\\n \\"ScreenSaverStyle\\": \\"common-weather\\",\\n \\"ScreenSaverPicUrl\\": \\"https://a***png\\"\\n },\\n \\"HotelDeviceModeList\\": [\\n \\"sweet\\"\\n ],\\n \\"NightMode\\": {\\n \\"Enable\\": true,\\n \\"Start\\": \\"07:00\\",\\n \\"End\\": \\"22:00\\",\\n \\"DefaultVolume\\": \\"\\",\\n \\"DefaultBright\\": \\"\\",\\n \\"StandbyAction\\": \\"screenoff\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'title' => 'Query hotel customization ', + 'description' => '> You can query different hotel customization configurations based on the input parameter settingType. '."\n" + .'> - Home page background: settingType="HOMEPAGE_PIC" '."\n" + .'> - Screensaver background: settingType="SCREENSAVER" '."\n" + .'> - Display mode with screen: settingType="SCENE" '."\n" + .'> - Hotel notifications with screen: settingType="NOTICE" '."\n" + .'> - Night mode: settingType="NIGHT_MODE"', + 'changeSet' => [], ], - 'ListCitiesByProvince' => [ - 'summary' => '查询城市', - 'path' => '/v1.0/ip/listCitiesByProvince', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetRelationProductList' => [ + 'summary' => 'Obtain the list of associated products used for hotel creation.', + 'path' => '/v1.0/ip/getRelationProductList', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'Province', - 'in' => 'formData', - 'schema' => [ - 'title' => '省份', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<String>>', - 'description' => 'Result<List<String>>', + 'title' => 'Result<List<ProductInfo>>', + 'description' => 'Result<List<ProductInfo>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'The actual return result of the service.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Detailed returned information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'Product name', 'type' => 'string', 'example' => '橙蜂中控面板'], + 'Pk' => ['title' => '', 'description' => 'Product PK', 'type' => 'string', 'example' => 'jTOSl***l1odxImRw'], + ], + 'title' => '', 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00', + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is to provide a brief description of a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'Extension fields', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'Extension information', 'example' => 'any', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"北京市\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"橙蜂中控面板\\",\\n \\"Pk\\": \\"jTOSl***l1odxImRw\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"any\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain the list of associated products', + 'description' => 'Obtain the list of associated products used for hotel creation.', + 'changeSet' => [], ], - 'ListSTBServiceProviders' => [ - 'summary' => '查询服务提供商', - 'path' => '/v1.0/ip/listSTBServiceProviders', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetUnionId' => [ + 'summary' => 'Exchange an Open ID for a cross-domain Union ID ', + 'path' => '/v1.0/ip/getUnionId', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Province', + 'name' => 'EncodeType', 'in' => 'formData', - 'schema' => [ - 'title' => '省份', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'Encoding type, obtained from the Tmall Genie Open Platform ', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'], ], [ - 'name' => 'City', + 'name' => 'EncodeKey', 'in' => 'formData', - 'schema' => [ - 'title' => '城市', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'Encoding Key, obtained from the Tmall Genie Open Platform ', 'type' => 'string', 'required' => true, 'example' => '125****0946'], + ], + [ + 'name' => 'IdType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Open ID type, which can be a User ID or Device ID '."\n" + .'- USER_ID: User ID '."\n" + .'- DEVICE_ID: Device ID ', 'type' => 'string', 'required' => true, 'example' => 'DEVICE_ID'], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The Open ID value corresponding to the ID type ', 'type' => 'string', 'required' => true, 'example' => '62a319****abdc'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<Map<String, List<String>>>', - 'description' => 'Result<Map<String, List<String>>>', + 'title' => 'Result<List<UnionInfo>>', + 'description' => 'Result<List<UnionInfo>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'example' => '', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID, which can be managed on the Tmall Genie Open Platform ', 'type' => 'string', 'example' => '4325***765'], + 'UnionId' => ['title' => '', 'description' => 'The unique ID value of the Open ID provided in the request parameter within this organization ', 'type' => 'string', 'example' => '8bh2****8s8'], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1036C376-7A37-5A73-BE8B-C6DB40107EC1', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe failed calls to help the caller troubleshoot issues ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"Z\\\\\\":[\\\\\\"浙江华数\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1036C376-7A37-5A73-BE8B-C6DB40107EC1\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"OrganizationId\\": \\"4325***765\\",\\n \\"UnionId\\": \\"8bh2****8s8\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Exchange for Union ID ', + 'description' => 'Under the current Tmall Genie open ecosystem, there are multiple domains, such as the Tmall Genie AI Platform, Skill Application Platform, and Industry Open Platform. Each domain maintains its own closed-loop Open ID system. To enable cross-domain request interactions, you must first create an organization and then associate entities from each domain (for example, a hotel application\'s AppID or an application created on the Skill Application Platform) under this organization. After association, you can use this API to exchange a hotel\'s Open ID for the corresponding Union ID within the organization. The Union ID can then be used to invoke APIs across different domains. '."\n" + .' ', + 'changeSet' => [], ], - 'ListInfraredDeviceBrands' => [ - 'summary' => '查询红外品牌列表', - 'path' => '/v1.0/ip/listInfraredDeviceBrands', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'GetWelcomeTextAndMusic' => [ + 'summary' => 'Obtain welcome message configuration ', + 'path' => '/v1.0/ip/getWelcomeTextAndMusic', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Category', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '设备名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'ServiceProvider', - 'in' => 'formData', - 'schema' => [ - 'title' => '服务提供商（品类为机顶盒时必传）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Map<String, List<String>>>', - 'description' => 'Result<Map<String, List<String>>>', + 'title' => 'Result<WelcomeResp>', + 'description' => 'Result<WelcomeResp>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. 200 indicates success. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'example' => '"A":["Addsion", "Ambassador"]', - ], - 'description' => '', + 'properties' => [ + 'HotelId' => ['description' => 'Hotel ID ', 'type' => 'string', 'example' => 'a7***83', 'title' => ''], + 'Text' => ['description' => 'Welcome message text ', 'type' => 'string', 'example' => '尊贵的客人，您好，欢迎入住，我是您的房间智能助理，我可以播放音乐，控制空调、灯光等，也能提供酒店的各种服务，回答酒店相关问题。只需要唤醒后，就能和我开始互动，我的更多能力，可以参考我旁边的立牌使用哦，祝您在本酒店度过一段愉快的入住时光。', 'title' => ''], + 'MusicUrl' => ['description' => 'Background music link ', 'type' => 'string', 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav', 'title' => ''], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00', + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is providing a brief description of a failed invocation to help the caller identify the issue. ', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'Extension fields ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'Extension information ', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"A\\\\\\":[\\\\\\"Addsion\\\\\\", \\\\\\"Ambassador\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]', + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Text\\": \\"尊贵的客人，您好，欢迎入住，我是您的房间智能助理，我可以播放音乐，控制空调、灯光等，也能提供酒店的各种服务，回答酒店相关问题。只需要唤醒后，就能和我开始互动，我的更多能力，可以参考我旁边的立牌使用哦，祝您在本酒店度过一段愉快的入住时光。\\",\\n \\"MusicUrl\\": \\"http://ailabsaicloudservice.alicdn.com/tmp/a.wav\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain welcome message configuration ', + 'description' => 'Obtain welcome message configuration ', + 'changeSet' => [], ], - 'ListInfraredRemoteControllers' => [ - 'summary' => '查询红外码库列表', - 'path' => '/v1.0/ip/listInfraredRemoteControllers', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'HotelQrBind' => [ + 'summary' => 'Scan a QR code to attach a hotel screen-equipped device.', + 'path' => '/v1.0/ip/hotelQrBind', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83'], ], [ - 'name' => 'Province', - 'in' => 'formData', - 'schema' => [ - 'title' => '省份'."\n" - .'品类为机顶盒时必传', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'City', + 'name' => 'RoomNo', 'in' => 'formData', - 'schema' => [ - 'title' => '城市'."\n" - .'品类为机顶盒时必传', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'Channel number', 'type' => 'string', 'required' => true, 'example' => '1211'], ], [ - 'name' => 'Category', + 'name' => 'Code', 'in' => 'formData', - 'schema' => [ - 'title' => '品类', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The code parameter from the QR code used to attach a screen-equipped device', 'type' => 'string', 'required' => true, 'example' => 'freuisghrtiesnvfkdsvbfuidslnvfs'], ], [ - 'name' => 'Brand', + 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'title' => '品牌'."\n" - .'品类非机顶盒必填，为机顶盒同时供应商为IPTV时必传', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The clientId parameter from the QR code used to attach a screen-equipped device', 'type' => 'string', 'required' => true, 'example' => 'xxxxxx'], ], [ - 'name' => 'ServiceProvider', + 'name' => 'ExtInfo', 'in' => 'formData', - 'schema' => [ - 'title' => '服务提供商'."\n" - .'品类为机顶盒时必传', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'Extra information in JSON string format', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<List<InfraredControlCodeResp>>', - 'description' => 'Result<List<InfraredControlCodeResp>>', + 'title' => 'Result<UserAndDeviceInfo>', + 'description' => 'Result<UserAndDeviceInfo>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'title' => '当前索引', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Rid' => [ - 'title' => '遥控器编号', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3747', + 'title' => '', + 'description' => 'Actual return result of the service.', + 'type' => 'object', + 'properties' => [ + 'OpenUserInfo' => [ + 'title' => '', + 'description' => 'Open user information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['title' => '', 'description' => 'Encoding type, obtained from the Tmall Genie Open Platform', 'type' => 'string', 'example' => 'HOTEL'], + 'EncodeKey' => ['title' => '', 'description' => 'Encoding key, obtained from the Tmall Genie Open Platform', 'type' => 'string', 'example' => '123'], + 'IdType' => ['title' => '', 'description' => 'Encoding information, obtained from the Tmall Genie Open Platform', 'type' => 'string', 'example' => 'OPEN_ID'], + 'Id' => ['title' => '', 'description' => 'User UUID', 'type' => 'string', 'example' => 'xxxxxx'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID, returned when IdType is UNION_ID', 'type' => 'string', 'example' => 'aaaaaaaa'], ], - 'Version' => [ - 'title' => '版本信息', - 'description' => '', - 'type' => 'string', - 'example' => '4', + 'example' => '', + ], + 'OpenDeviceInfo' => [ + 'title' => '', + 'description' => 'Open device information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['title' => '', 'description' => 'Encoding type, obtained from the Tmall Genie Open Platform.', 'type' => 'string', 'example' => 'HOTEL'], + 'EncodeKey' => ['title' => '', 'description' => 'Encoding key, obtained from the Tmall Genie Open Platform', 'type' => 'string', 'example' => '123'], + 'IdType' => ['title' => '', 'description' => 'Encoding information, obtained from the Tmall Genie Open Platform', 'type' => 'string', 'example' => 'OPEN_ID'], + 'Id' => ['title' => '', 'description' => 'UUID of the device', 'type' => 'string', 'example' => 'xxxxxxx'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID, returned when IdType is UNION_ID.', 'type' => 'string', 'example' => 'aaaaaaaa'], ], + 'example' => '', ], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0C90A059-3653-5356-A78E-8A6BDA606155', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '73****9-175A-1324-8202-9FAAB*****A'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Index\\": 1,\\n \\"Rid\\": 3747,\\n \\"Version\\": \\"4\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0C90A059-3653-5356-A78E-8A6BDA606155\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"OpenUserInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n },\\n \\"OpenDeviceInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\"\\n}","type":"json"}]', + 'title' => 'Hotel QR code binding', + 'description' => 'Scan a QR code to attach a hotel screen-equipped device, which can be used to manage devices through a self-built application.', + 'changeSet' => [], ], - 'ListCustomQA' => [ - 'summary' => '查询自定义问答列表', - 'path' => '/v1.0/ip/listCustomQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ImportHotelConfig' => [ + 'summary' => 'Batch import hotel-related configuration.', + 'path' => '/v1.0/ip/importHotelConfig', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '520a0c0***5eb', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'ImportHotelConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Import configuration', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页size大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', + 'RcuCustomScenes' => [ + 'description' => 'RCU custom scenarios', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SceneId' => ['description' => 'Scene encoding', 'type' => 'string', 'required' => true, 'example' => 'yoga', 'title' => ''], + 'Name' => ['description' => 'Scenario Name ', 'type' => 'string', 'required' => true, 'example' => '瑜伽模式', 'title' => ''], + 'Icon' => ['description' => 'Scenario Icon ', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com/yyy.png', 'title' => ''], + 'Description' => ['description' => 'Scenario Description ', 'type' => 'string', 'required' => false, 'example' => '做瑜伽的酒店场景', 'title' => ''], + 'CorpusList' => [ + 'description' => 'List of trigger corpora', + 'type' => 'array', + 'items' => ['description' => 'Trigger corpus', 'type' => 'string', 'required' => true, 'example' => '打开瑜伽模式', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'PageResult<List<QAInfoResponse>>', - 'description' => 'PageResult<List<QAInfoResponse>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Page' => [ - 'title' => '翻页参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页size大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '21', - ], - ], - ], - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CustomQAId' => [ - 'title' => 'qaID', - 'description' => '', - 'type' => 'string', - 'example' => '111', - ], - 'MajorQuestion' => [ - 'title' => '主要问题', - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'SupplementaryQuestion' => [ - 'title' => '辅助问题', - 'description' => '', - 'type' => 'string', - 'example' => '22;11', - ], - 'Answers' => [ - 'title' => '回答，多个回答用;隔开', - 'description' => '', - 'type' => 'string', - 'example' => '22;11', - ], - 'KeyWords' => [ - 'title' => '关键字', - 'description' => '', - 'type' => 'string', - 'example' => '22;11', - ], - 'HotelId' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-10 10:01:59', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-10 10:01:59', - ], - 'Status' => [ - 'title' => '状态：0，使用中， 1：删除', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E'."\n", - ], + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"CustomQAId\\": \\"111\\",\\n \\"MajorQuestion\\": \\"***\\",\\n \\"SupplementaryQuestion\\": \\"22;11\\",\\n \\"Answers\\": \\"22;11\\",\\n \\"KeyWords\\": \\"22;11\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Batch Import Hotel Configuration', + 'changeSet' => [], ], - 'AddCustomQA' => [ - 'summary' => '新增自定义问答', - 'path' => '/v1.0/ip/addCustomQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ImportRoomControlDevices' => [ + 'summary' => 'Import the list of guest room control devices for a channel ', + 'path' => '/v1.0/ip/importRoomControlDevices', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7a3***013', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'vdgrefds'], ], [ - 'name' => 'MajorQuestion', + 'name' => 'RoomNo', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], + 'schema' => ['title' => '', 'description' => 'channel number ', 'type' => 'string', 'required' => true, 'example' => '1211'], ], [ - 'name' => 'SupplementaryQuestions', + 'name' => 'LocationDevices', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of locations and devices to import ', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Location information and device information ', + 'type' => 'object', + 'properties' => [ + 'Location' => ['description' => 'Location information ', 'type' => 'string', 'required' => true, 'example' => 'room', 'title' => ''], + 'LocationName' => ['description' => 'Location name ', 'type' => 'string', 'required' => false, 'example' => '房间', 'title' => ''], + 'Devices' => [ + 'description' => 'List of devices under the location ', + 'type' => 'array', + 'items' => [ + 'description' => 'Device information ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Device type, such as:'."\n" + ."\n" + .'- light: light'."\n" + .'- aircondition: air conditioner', 'type' => 'string', 'required' => true, 'example' => 'light', 'title' => ''], + 'Number' => ['description' => 'Device serial number ', 'type' => 'string', 'required' => false, 'example' => 'night_light', 'title' => ''], + 'DeviceName' => ['description' => 'device name ', 'type' => 'string', 'required' => true, 'example' => '小夜灯', 'title' => ''], + 'ConnectType' => ['description' => 'Device connection type', 'title' => 'Device connection type: rcu, infrared, mesh. Defaults to rcu if not specified.', 'type' => 'string', 'required' => false, 'example' => 'infrared'], + 'Brand' => ['description' => 'Brand. ', 'title' => 'Brand ', 'type' => 'string', 'required' => false, 'example' => '百视通'], + 'Province' => ['description' => 'Province', 'title' => 'Province', 'type' => 'string', 'required' => false, 'example' => '浙江省'], + 'City' => ['description' => 'City. ', 'title' => 'City ', 'type' => 'string', 'required' => false, 'example' => '杭州市'], + 'ServiceProvider' => ['description' => 'Service provider (SP) ', 'title' => 'Service provider (SP) ', 'type' => 'string', 'required' => false, 'example' => '浙江华数'], + 'InfraredIndex' => ['description' => 'Infrared code library index ', 'title' => 'Infrared code library index ', 'type' => 'string', 'required' => false, 'example' => '1'], + 'InfraredId' => ['description' => 'Infrared code library ID', 'title' => 'Infrared code library ID', 'type' => 'string', 'required' => false, 'example' => '1232'], + 'InfraredVersion' => ['description' => 'Infrared code library version number ', 'title' => 'Infrared code library version number ', 'type' => 'string', 'required' => false, 'example' => '4.0'], + 'MultiKeySwitchExt' => [ + 'description' => 'Multi-key switch configuration information ', + 'type' => 'object', + 'properties' => [ + 'SwitchList' => [ + 'description' => 'Toggle button list ', + 'type' => 'array', + 'items' => [ + 'description' => 'Content ', + 'type' => 'object', + 'properties' => [ + 'DeviceIndex' => ['description' => 'Device ordinal number', 'title' => 'Device ordinal number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Category' => ['description' => 'English name of the associated device class', 'title' => 'English name of the associated device class', 'type' => 'string', 'required' => false, 'example' => 'light'], + 'Location' => ['description' => 'English name of the associated device location', 'title' => 'Associated device location (in English)', 'type' => 'string', 'required' => false, 'example' => 'room'], + 'DeviceName' => ['description' => 'Alias of the associated device', 'title' => 'Alias of the associated device', 'type' => 'string', 'required' => false, 'example' => '吧台灯'], + 'AliasList' => [ + 'description' => 'Alias list of the sub-device', + 'title' => 'Device multi-alias List', + 'type' => 'array', + 'items' => ['description' => 'Device alias', 'title' => 'Custom device alias', 'type' => 'string', 'required' => false, 'example' => '左灯'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Dn' => ['description' => 'Device DN information ', 'title' => 'Device DN Code ', 'type' => 'string', 'required' => false, 'example' => '3c5****db98'], + 'Pk' => ['description' => 'Device PK number ', 'title' => 'Device PK ', 'type' => 'string', 'required' => false, 'example' => '17****26'], + 'AliasList' => [ + 'description' => 'List of device aliases', + 'title' => 'Device Multi-alias List ', + 'type' => 'array', + 'items' => ['description' => 'Device alias ', 'title' => 'Custom Device Alias ', 'type' => 'string', 'required' => false, 'example' => '夜灯'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '***', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'KeyWords', + 'name' => 'EnableInfraredDeviceImport', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'required' => false, - ], + 'schema' => ['description' => 'true: overwrite the infrared devices configured on the page with the infrared device list provided in the API; false: ignore the infrared devices provided in the API and retain the infrared devices configured on the platform page. Default value is false. ', 'title' => 'is infrared supported: true for supported, false for not supported ', 'type' => 'string', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'Answers', + 'name' => 'EnableMeshDeviceImport', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Whether Mesh is supported: true or null means supported and triggers the cleanup logic; false means not supported, but existing Mesh devices are retained. If Mesh data is included in the request parameters when this value is false, an error occurs. ', 'title' => 'Whether Mesh is supported: true or null means supported and triggers the cleanup logic; false means not supported, but existing Mesh devices are retained. If Mesh data is included in the request parameters when this value is false, an error occurs. ', 'type' => 'string', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<Integer>', + 'description' => 'Result<Integer>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E', + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Number of devices successfully imported ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Message' => ['title' => '', 'description' => 'Additional information; typical scenario is providing a brief description of a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'Extension fields ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => 'xxxx', 'description' => 'Extension information content ', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'fdsfregtre', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 10,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"xxxx\\"\\n },\\n \\"RequestId\\": \\"fdsfregtre\\"\\n}","type":"json"}]', + 'title' => 'Import the list of guest room control devices for a channel ', + 'description' => 'Batch import controlled devices into the room type corresponding to each channel '."\n" + .'><notice>Currently supports only pure RCU scenarios. Supported associated products are: ***Fangtang R Hotel Edition, INtang Hotel Edition***></notice> ', + 'changeSet' => [ + ['createdAt' => '2025-12-29T10:47:10.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', ], - 'AddCustomQAV2' => [ - 'summary' => '添加问答V2', - 'path' => '/v1.0/ip/addQAV2', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ImportRoomGenieScenes' => [ + 'summary' => 'Batch import the list of Intelligent scenarios in a channel. ', + 'path' => '/v1.0/ip/importRoomGenieScenes', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '520a0c0***5eb', - ], - ], - [ - 'name' => 'MajorQuestion', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013', 'title' => ''], ], [ - 'name' => 'SupplementaryQuestions', + 'name' => 'RoomNo', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Channel number ', 'type' => 'string', 'required' => true, 'example' => '1211', 'title' => ''], ], [ - 'name' => 'KeyWords', + 'name' => 'SceneList', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of scenarios ', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Scenario information. ', + 'type' => 'object', + 'properties' => [ + 'SceneName' => ['title' => '', 'description' => 'Scenario name ', 'type' => 'string', 'required' => true, 'example' => '瑜伽模式'], + 'Description' => ['title' => '', 'description' => 'Scenario description ', 'type' => 'string', 'required' => false, 'example' => '做瑜伽的模式'], + 'Icon' => ['title' => '', 'description' => 'scenario icon', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com/yyy.png'], + 'Display' => ['title' => '', 'description' => 'whether to display on the screen-equipped side', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'TriggerLogical' => ['title' => '', 'description' => 'Scenario trigger logic (0: AND condition, 1: OR condition) ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'Triggers' => [ + 'title' => '', + 'description' => 'Trigger Condition List ', + 'type' => 'array', + 'items' => [ + 'description' => 'Trigger Condition', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Trigger Type', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1：语音触发'."\n" + .'2：设备触发'], + 'CorpusList' => [ + 'title' => '', + 'description' => 'Trigger Corpus', + 'type' => 'array', + 'items' => ['description' => 'Trigger Corpus', 'type' => 'string', 'required' => false, 'example' => '打开瑜伽模式', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'Device' => [ + 'description' => 'Trigger Device', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'Device Category', 'type' => 'string', 'required' => true, 'example' => 'KeyCardSwitch', 'title' => ''], + 'DeviceNumber' => ['description' => 'Device serial number, which is the serial number of the device under the Room Type Guest Control Category Settings in the Tmall Genie Industry Management Platform', 'type' => 'string', 'required' => true, 'example' => '3c5d2ab8f9ec', 'title' => ''], + 'DeviceIndex' => ['description' => 'Ordinal number of multi-button Toggle devices', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AttributeValues' => [ + 'description' => 'Device trigger properties', + 'type' => 'array', + 'items' => [ + 'description' => 'trigger property', + 'type' => 'object', + 'properties' => [ + 'AttributeName' => ['description' => 'property name', 'type' => 'string', 'required' => true, 'example' => 'stateOfMagneticInduction', 'title' => ''], + 'AttributeValue' => ['description' => 'Attribute Value', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + 'Actions' => [ + 'title' => '', + 'description' => 'Action List', + 'type' => 'array', + 'items' => [ + 'description' => 'Action', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Action Type', 'title' => 'Action Type', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1：设备控制'."\n" + .'2：音箱播报'], + 'Reply' => ['description' => 'Speaker reply content ', 'title' => 'Speaker reply content ', 'type' => 'string', 'required' => false, 'example' => '欢迎光临'], + 'Device' => [ + 'title' => '', + 'description' => 'Target Device', + 'type' => 'object', + 'properties' => [ + 'Category' => ['title' => '', 'description' => 'Device Category', 'type' => 'string', 'required' => true, 'example' => 'light'], + 'DeviceNumber' => ['title' => '', 'description' => 'Device Number', 'type' => 'string', 'required' => true, 'example' => '3c5d2ab8f9ec'], + 'DeviceIndex' => ['title' => '', 'description' => 'For multi-button toggle devices, specify the button ordinal number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Type' => ['title' => '', 'description' => 'Device Type (Deprecated)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '无需填写'], + ], + 'required' => false, + 'example' => '', + ], + 'AttributeValues' => [ + 'title' => '', + 'description' => 'Target device properties ', + 'type' => 'array', + 'items' => [ + 'description' => 'Target property ', + 'type' => 'object', + 'properties' => [ + 'AttributeName' => ['title' => '', 'description' => 'Property name ', 'type' => 'string', 'required' => true, 'example' => 'powerstate'], + 'AttributeValue' => ['title' => '', 'description' => 'Attribute Value ', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], 'required' => false, + 'title' => '', 'example' => '', ], 'required' => false, - ], - ], - [ - 'name' => 'Answers', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<QAInfoResponse>', - 'description' => 'Result<QAInfoResponse>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'QaId' => [ - 'title' => 'qaID', - 'description' => 'qaID', - 'type' => 'string', - 'example' => '1', - ], - 'MajorQuestion' => [ - 'title' => '主要问题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SupplementaryQuestion' => [ - 'title' => '辅助问题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Answers' => [ - 'title' => '回答，多个回答用;隔开', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'KeyWords' => [ - 'title' => '关键字', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotelId' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'UpdateTime' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-10 10:01:59', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-10 10:01:59', - ], - 'Status' => [ - 'title' => '状态：0，使用中， 1：删除', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'LastOperator' => [ - 'title' => '最后操作人', - 'description' => '', - 'type' => 'string', - 'example' => '8xxx9', - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result of the service. ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '73C6***E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Result\\": {\\n \\"QaId\\": \\"1\\",\\n \\"MajorQuestion\\": \\"今天天气怎么样\\",\\n \\"SupplementaryQuestion\\": \\"室外温度多少\\",\\n \\"Answers\\": \\"你好,您可以再说一遍吗 不好意思我刚才没有听清\\",\\n \\"KeyWords\\": \\"天气\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0,\\n \\"LastOperator\\": \\"8xxx9\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'title' => 'Import Intelligent scenarios in a channel ', + 'changeSet' => [], ], - 'UpdateCustomQA' => [ - 'summary' => '修改自定义问答', - 'path' => '/v1.0/ip/updateCustomQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'InsertHotelSceneBookItem' => [ + 'summary' => 'Add a new hotel scenario booking', + 'path' => '/v1.0/ip/insertHotelSceneBookItem', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CustomQAId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], + 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], [ - 'name' => 'MajorQuestion', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - ], - [ - 'name' => 'SupplementaryQuestions', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'required' => false, - ], - ], - [ - 'name' => 'KeyWords', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Answers', - 'in' => 'formData', + 'name' => 'AddHotelSceneItemReq', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', + 'title' => 'addHotelSceneItemReq', + 'description' => 'addHotelSceneItemReq', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Hotel scenario booking Type (FOOD: dining, LEISURE: SPA and leisure, CAR_SERVICE: car hailing)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FOOD'], + 'Name' => ['title' => '', 'description' => 'Name of the hotel scenario booking item ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '青椒肉丝'], + 'Price' => ['title' => '', 'description' => 'Price (unit: cent)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1250'], + 'Icon' => ['title' => 'icon', 'description' => 'icon', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Result<Boolean>', 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C6***BB3E6FA', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invoke to help the caller identify the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '36FB***80C2'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***BB3E6FA\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"36FB***80C2\\"\\n}","type":"json"}]', + 'title' => 'Add a new hotel booking service item', + 'changeSet' => [], ], - 'DeleteCustomQA' => [ - 'summary' => '删除自定义问答', - 'path' => '/v1.0/ip/deleteCustomQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'InvokeRobotPush' => [ + 'summary' => 'Push robot notifications, which can be used to notify when placing or retrieving items via a robot.', + 'path' => '/v1.0/ip/invokeRobotPush', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'CustomQAIds', + 'name' => 'RoomNo', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '11', - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Channel number', 'type' => 'string', 'required' => false, 'example' => '1211'], + ], + [ + 'name' => 'RoomName', + 'in' => 'formData', + 'schema' => ['description' => 'Channel name', 'type' => 'string', 'required' => false, 'example' => '8022房间', 'title' => ''], ], [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7a3***013', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'af7***536'], + ], + [ + 'name' => 'PushType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Push type: PUT for placing an item, GET for retrieving an item.', 'type' => 'string', 'required' => true, 'example' => 'GET'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Result<Boolean>', 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C6***E6FA', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used in failure scenarios to briefly describe the reason for the failure, helping the caller to troubleshoot.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '73C6***E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'title' => 'Push robot notifications', + 'changeSet' => [], ], - 'GetBasicInfoQA' => [ - 'summary' => '获取基础信息问答', - 'path' => '/v1.0/ip/getBasicInfoQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListAllProvinces' => [ + 'summary' => 'Query the provinces where infrared is used', + 'path' => '/v1.0/ip/listAllProvinces', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], - ], - ], + 'parameters' => [], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<IntentionQATemplateResponse>', - 'description' => 'Result<IntentionQATemplateResponse>', + 'title' => 'Result<List<String>>', + 'description' => 'Result<List<String>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HotelAddress' => [ - 'title' => '酒店地址', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'PhoneNumber' => [ - 'title' => '前台电话', - 'description' => '', - 'type' => 'string', - 'example' => '123***', - ], - 'CheckInTime' => [ - 'title' => '入住时间 格式xx:xx 时分', - 'description' => '', - 'type' => 'string', - 'example' => '11:11', - ], - 'CheckOutTime' => [ - 'title' => '退房时间', - 'description' => '', - 'type' => 'string', - 'example' => '11:11', - ], - 'WifiName' => [ - 'title' => 'wifi名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'WifiPassword' => [ - 'title' => 'wifi密码', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotelMember' => [ - 'title' => '酒店会员相关介绍', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotelService' => [ - 'title' => '酒店特色服务相关介绍', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotelIntroduction' => [ - 'title' => '酒店介绍', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ParkingPosition' => [ - 'title' => '停车场位置', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ParkingExpenses' => [ - 'title' => '停车费用，免费停车/收费停车', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '收费停车' => '', - '免费停车' => '', - ], - 'example' => '', - 'enum' => [], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E', + 'title' => '', + 'description' => 'Actual return result of the service', + 'type' => 'array', + 'items' => ['description' => 'Actual return result of the service', 'type' => 'string', 'example' => '浙江省', 'title' => ''], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '00534880-4397-5134-B212-1030B7A37C27', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelAddress\\": \\"杭州市***\\",\\n \\"PhoneNumber\\": \\"123***\\",\\n \\"CheckInTime\\": \\"11:11\\",\\n \\"CheckOutTime\\": \\"11:11\\",\\n \\"WifiName\\": \\"名称***\\",\\n \\"WifiPassword\\": \\"密码***\\",\\n \\"HotelMember\\": \\"会员***\\\\n\\",\\n \\"HotelService\\": \\"服务***\\",\\n \\"HotelIntroduction\\": \\"酒店***\\",\\n \\"ParkingPosition\\": \\"杭州市***\\",\\n \\"ParkingExpenses\\": \\"免费停车\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"浙江省\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"00534880-4397-5134-B212-1030B7A37C27\\"\\n}","type":"json"}]', + 'title' => 'Query provinces', + 'description' => 'Query the provinces where infrared is used', + 'changeSet' => [], ], - 'UpdateBasicInfoQA' => [ - 'summary' => '修改基础信息问答', - 'path' => '/v1.0/ip/updateBasicInfoQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListCitiesByProvince' => [ + 'summary' => 'Query the list of cities where infrared is used by province ', + 'path' => '/v1.0/ip/listCitiesByProvince', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536'."\n", - ], - ], - [ - 'name' => 'HotelAddress', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店地址', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'PhoneNumber', - 'in' => 'formData', - 'schema' => [ - 'title' => '前台电话', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], - ], - [ - 'name' => 'CheckInTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '入住时间 格式xx:xx 时分', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11:11'."\n", - ], - ], - [ - 'name' => 'CheckOutTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '退房时间', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11:11', - ], - ], - [ - 'name' => 'WifiName', - 'in' => 'formData', - 'schema' => [ - 'title' => 'wifi名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'WifiPassword', - 'in' => 'formData', - 'schema' => [ - 'title' => 'wifi密码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'HotelMember', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店会员相关介绍', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'HotelService', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店特色服务相关介绍', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'HotelIntroduction', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店介绍', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'ParkingPosition', - 'in' => 'formData', - 'schema' => [ - 'title' => '停车场位置', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'ParkingExpenses', + 'name' => 'Province', 'in' => 'formData', - 'schema' => [ - 'title' => '停车费用，免费停车/收费停车', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - 'enum' => [ - '免费停车', - '收费停车', - ], - ], + 'schema' => ['title' => '', 'description' => 'Province ', 'type' => 'string', 'required' => true, 'example' => '北京市'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<String>>', + 'description' => 'Result<List<String>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E'."\n", + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => ['description' => 'List of information ', 'type' => 'string', 'example' => '北京市', 'title' => ''], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"北京市\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]', + 'title' => 'Query cities ', + 'description' => 'Query the list of cities where infrared is used by province ', + 'changeSet' => [], ], - 'ListServiceQA' => [ - 'summary' => '查询服务设施问答列表', - 'path' => '/v1.0/ip/listServiceQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListCustomQA' => [ + 'summary' => 'The feature of querying the custom Q&A pair list in the Custom Q&A module.', + 'path' => '/v1.0/ip/listCustomQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], @@ -8767,63 +4312,27 @@ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], - ], - [ - 'name' => 'Active', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否激活', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], + 'schema' => ['description' => 'Keyword (used for fuzzy query on main question, auxiliary questions, answers, and keywords)', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Pagination Parameters', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'PageNumber' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -8831,2341 +4340,1745 @@ 200 => [ 'headers' => [], 'schema' => [ - 'title' => 'PageResult<List<IntentionQAResponse>>', - 'description' => 'PageResult<List<IntentionQAResponse>>', + 'title' => 'PageResult<List<QAInfoResponse>>', + 'description' => 'PageResult<List<QAInfoResponse>>', 'type' => 'object', 'properties' => [ 'Page' => [ - 'title' => '翻页参数', - 'description' => '', + 'title' => '', + 'description' => 'Pagination parameters', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页size大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], + 'PageNumber' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['description' => 'Total number of data entries', 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], ], + 'example' => '', ], - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the predefined SUCCESS_CODE, other codes are defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result from the service', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'object', 'properties' => [ - 'ServiceQAId' => [ - 'title' => '通用问答信息', - 'description' => '', + 'CustomQAId' => ['title' => 'qaID', 'description' => 'Custom Q&A pair ID', 'type' => 'string', 'example' => '111'], + 'MajorQuestion' => ['title' => '', 'description' => 'Main question', 'type' => 'string', 'example' => '***'], + 'SupplementaryQuestion' => ['title' => '', 'description' => 'Supplementary questions, separated by semicolons (;)', 'type' => 'string', 'example' => '22;11'], + 'Answers' => ['title' => '', 'description' => 'Answers, separated by semicolons (;)', 'type' => 'string', 'example' => '22;11'], + 'KeyWords' => ['title' => '', 'description' => 'Keywords, separated by semicolons (;)', 'type' => 'string', 'example' => '22;11'], + 'HotelId' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'example' => 'a7***83'], + 'UpdateTime' => ['title' => '', 'description' => 'Update Time', 'type' => 'string', 'example' => '2023-01-10 10:01:59'], + 'CreateTime' => ['title' => '', 'description' => 'Creation Time', 'type' => 'string', 'example' => '2023-01-10 10:01:59'], + 'Status' => [ + 'title' => '', + 'description' => 'Status (0: in use, 1: deleted)', 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Question' => [ - 'title' => '问题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Answer' => [ - 'title' => '答案', - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-07-27 14:06:27'."\n", - ], - 'Active' => [ - 'title' => '是否启用', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Templates' => [ - 'title' => '例句列表', - 'description' => '', - 'type' => 'string', - 'example' => '', + 'format' => 'int32', + 'enumValueTitles' => ['', ''], + 'example' => '0', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7***726E'."\n", 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"ServiceQAId\\": 1,\\n \\"Question\\": \\"测试文本\\\\n\\",\\n \\"Answer\\": \\"***\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\",\\n \\"Active\\": true,\\n \\"Templates\\": \\"酒店有提供送餐服务吗;酒店能送餐吗;酒店送餐怎么收费\\\\n\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"CustomQAId\\": \\"111\\",\\n \\"MajorQuestion\\": \\"***\\",\\n \\"SupplementaryQuestion\\": \\"22;11\\",\\n \\"Answers\\": \\"22;11\\",\\n \\"KeyWords\\": \\"22;11\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Query Custom Q&A List', + 'changeSet' => [], ], - 'UpdateServiceQA' => [ - 'summary' => '修改服务设施问答', - 'path' => '/v1.0/ip/updateServiceQA', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListDialogueTemplate' => [ + 'summary' => 'Dialogue template for hotel scenarios ', + 'path' => '/v1.0/ip/listDialogueTemplate', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], - ], - [ - 'name' => 'ServiceQAId', - 'in' => 'formData', - 'schema' => [ - 'title' => '通用问答信息', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Answer', - 'in' => 'formData', - 'schema' => [ - 'title' => '答案', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'isActive', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否启用', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'schema' => ['title' => 'hotelId', 'description' => 'hotelId', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<DialogueTemplate>>', + 'description' => 'Result<List<DialogueTemplate>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C67***6FA'."\n", + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '', 'description' => 'Template ID', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'TemplateName' => ['title' => '', 'description' => 'Template Name', 'type' => 'string', 'example' => '物品多轮模板'], + 'TemplateDetail' => [ + 'title' => '', + 'description' => 'Template details (maintenance involves only one round of dialogue) ', + 'type' => 'object', + 'properties' => [ + 'FirstDialogueTemplate' => [ + 'title' => '', + 'description' => 'First round of dialogue ', + 'type' => 'object', + 'properties' => [ + 'ZeroPriceYesAnswer' => ['title' => '', 'description' => 'Price = 0 && Yes', 'type' => 'string', 'example' => '好的，服务员会尽快送来。'], + 'ZeroPriceNoAnswer' => ['title' => '', 'description' => 'Price = 0 && negative response', 'type' => 'string', 'example' => '对不起，暂时不提供此物品。'], + 'NonzeroPriceYesAnswer' => ['title' => '', 'description' => 'Price != 0 && Yes', 'type' => 'string', 'example' => '${goodsName}${price}元，请问需要服务员送来吗？'], + ], + 'example' => '', + ], + 'SecondDialogueTemplate' => [ + 'title' => '', + 'description' => 'Second-round dialogue', + 'type' => 'object', + 'properties' => [ + 'NonzeroPriceYesAnswer' => ['title' => '', 'description' => 'Price != 0 && Yes', 'type' => 'string', 'example' => '好的，服务员会尽快送来${goodsName}'], + 'NonzeroPriceNoAnswer' => ['title' => '', 'description' => 'Price != 0 && Negative answer', 'type' => 'string', 'example' => '好的，已取消。'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Type' => ['title' => '', 'description' => 'templatetype ', 'type' => 'string', 'example' => 'GOODS'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 4,\\n \\"TemplateName\\": \\"物品多轮模板\\",\\n \\"TemplateDetail\\": {\\n \\"FirstDialogueTemplate\\": {\\n \\"ZeroPriceYesAnswer\\": \\"好的，服务员会尽快送来。\\",\\n \\"ZeroPriceNoAnswer\\": \\"对不起，暂时不提供此物品。\\",\\n \\"NonzeroPriceYesAnswer\\": \\"${goodsName}${price}元，请问需要服务员送来吗？\\"\\n },\\n \\"SecondDialogueTemplate\\": {\\n \\"NonzeroPriceYesAnswer\\": \\"好的，服务员会尽快送来${goodsName}\\",\\n \\"NonzeroPriceNoAnswer\\": \\"好的，已取消。\\"\\n }\\n },\\n \\"Type\\": \\"GOODS\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Hotel scenario service dialogue template', + 'changeSet' => [], ], - 'AddCartoon' => [ - 'summary' => '添加动画', - 'path' => '/v1.0/ip/addCartoon', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelAlarm' => [ + 'summary' => 'Query hotel alarm information ', + 'path' => '/v1.0/ip/getHotelAlarmList', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '520a0***eb', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => false, 'example' => 'a7a3***013', 'title' => ''], ], [ - 'name' => 'StartVideoUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => '开机动画url', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://***.mp4', - ], - ], - [ - 'name' => 'StartVideoMd5', + 'name' => 'Rooms', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '开机动画md5', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '40c804***697', + 'description' => 'Room numbers', + 'type' => 'array', + 'items' => ['description' => 'channel', 'type' => 'string', 'required' => false, 'example' => '101', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<HotelAlarmDetailResponse>>', + 'description' => 'Result<List<HotelAlarmDetailResponse>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code. Except for the agreed-upon SUCCESS_CODE, all other codes are defined by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'description' => 'Object ', + 'type' => 'object', + 'properties' => [ + 'AlarmId' => ['title' => '', 'description' => 'Alarm ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '5039'], + 'UserOpenId' => ['title' => '', 'description' => 'Open user ID', 'type' => 'string', 'example' => 'mgw/k***HQd'], + 'DeviceOpenId' => ['title' => 'uuid', 'description' => 'Open device ID ', 'type' => 'string', 'example' => 'PvkB****VVTA=='], + 'ScheduleInfo' => [ + 'title' => '', + 'description' => 'Alarm information in Settings ', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', 'description' => 'ONCE, WEEKLY', 'type' => 'string', 'example' => 'ONCE'], + 'Once' => [ + 'description' => 'One-time alarm ', + 'type' => 'object', + 'properties' => [ + 'Year' => ['description' => 'Year ', 'type' => 'integer', 'format' => 'int32', 'example' => '2022', 'title' => ''], + 'Month' => ['description' => 'Month ', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], + 'Day' => ['description' => 'Day', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Hour' => ['description' => 'Hour ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Minute' => ['description' => 'Minute ', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Weekly' => [ + 'description' => 'Weekly loop: This property is active when the loop Type is WEEKLY.'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'description' => 'Set of days of the week to trigger', + 'type' => 'array', + 'items' => ['description' => 'Set of days of the week to trigger: Numeric values range from 1 to 7, where each number corresponds to a specific day of the week (1 = Monday, 7 = Sunday). To trigger every day, include all numbers from 1 to 7.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Hour' => ['description' => 'Trigger Time: hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Minute' => ['description' => 'Trigger Time: minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E'."\n", + 'Message' => ['title' => '', 'description' => 'Additional information. A typical scenario is providing a brief description for a failed invocation to help the caller identify the issue. ', 'type' => 'string', 'example' => 'xx为空'], + 'Extentions' => [ + 'title' => '', + 'description' => 'Extension fields ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => 'Extension content ', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '43***881', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"AlarmId\\": 5039,\\n \\"UserOpenId\\": \\"mgw/k***HQd\\",\\n \\"DeviceOpenId\\": \\"PvkB****VVTA==\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 9,\\n \\"Day\\": 20,\\n \\"Hour\\": 10,\\n \\"Minute\\": 30\\n },\\n \\"Weekly\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n }\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + 'title' => 'Query hotel alarm clock information List', + 'description' => 'Query hotel alarm information. ', + 'changeSet' => [], ], - 'GetCartoon' => [ - 'summary' => '查询动画', - 'path' => '/v1.0/ip/getCartoon', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelControlDevice' => [ + 'summary' => 'Hotel device List', + 'path' => '/v1.0/ip/listHotelControlDevice', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '酒店id', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'IdType' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '520a0c0***5eb', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HotelCartoonResponse>', - 'description' => 'Result<HotelCartoonResponse>', + 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => 'The invoke return code; apart from the conventionally defined SUCCESS_CODE, all others are Custom by the service provider', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartVideoUrl' => [ - 'title' => '开机启动视频', - 'description' => '', - 'type' => 'string', - 'example' => '40c8***97', - ], - 'StartVideoMd5' => [ - 'title' => '开机视频md5', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ai***.mp4', - ], + 'title' => 'The actual Return Result of the service', + 'type' => 'array', + 'items' => [ + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E'."\n", + 'example' => '', ], + 'Message' => ['title' => 'Additional information, commonly used to briefly describe a failed invoke to help the caller identify the issue', 'type' => 'string', 'description' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"StartVideoUrl\\": \\"40c8***97\\",\\n \\"StartVideoMd5\\": \\"https://ai***.mp4\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]', + 'title' => '', + 'changeSet' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Result\\": [\\n {\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', ], - 'DeleteCartoon' => [ - 'summary' => '删除动画', - 'path' => '/v1.0/ip/deleteCartoon', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelInfo' => [ + 'summary' => 'Query hotel list information, such as hotel name, address, and authorized account.', + 'path' => '/v1.0/ip/listHotelInfo', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => ' 酒店id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a7***83'."\n", - ], - ], - ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<HotelInfoResponse>>', + 'description' => 'Result<List<HotelInfoResponse>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'description' => 'The actual return result of the service.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['description' => 'Hotel ID', 'type' => 'string', 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', 'title' => ''], + 'HotelName' => ['description' => 'Hotel name', 'type' => 'string', 'example' => '酒店', 'title' => ''], + 'HotelAddress' => ['description' => 'Hotel address', 'type' => 'string', 'example' => '浙江身杭州市', 'title' => ''], + 'AuthAccount' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserName' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'example' => 'leetest'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E'."\n", + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is to provide a brief description of a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => ''], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension field', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"HotelName\\": \\"酒店\\",\\n \\"HotelAddress\\": \\"浙江身杭州市\\",\\n \\"AuthAccount\\": [\\n {\\n \\"UserName\\": \\"leetest\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Query hotel list', + 'description' => 'Query hotel list information, such as hotel name, address, and authorized account.', + 'changeSet' => [], ], - 'GetHotelScreenSaverStyle' => [ - 'summary' => '获取屏保列表', - 'path' => '/v1.0/ip/getHotelScreenSaverStyle', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelMessageTemplate' => [ + 'summary' => 'Obtain hotel message templates ', + 'path' => '/v1.0/ip/listHotelMessageTemplate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'af7***536'."\n", - ], - ], - ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelScreenSaverStyle>>', - 'description' => 'Result<List<HotelScreenSaverStyle>>', + 'title' => 'Result<List<ListHotelMessageTemplate>>', + 'description' => 'Result<List<ListHotelMessageTemplate>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service ', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '编码code', - 'description' => '', - 'type' => 'string', - 'example' => 'common-weather', - ], - 'CnName' => [ - 'title' => '中文名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'EnName' => [ - 'title' => '英文名称', - 'description' => '', - 'type' => 'string', - 'example' => 'common-weather', - ], - 'PicUrl' => [ - 'title' => '图片链接', - 'description' => '', - 'type' => 'string', - 'example' => 'https://img.***.png', - ], + 'TemplateId' => ['title' => '', 'description' => 'Template ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TemplateDetail' => ['title' => '', 'description' => 'Template Content ', 'type' => 'string', 'example' => '这是${hotel}的一个测试模板'], + 'TemplateName' => ['title' => '', 'description' => 'Template Name ', 'type' => 'string', 'example' => '测试模板'], + 'AuditMark' => ['title' => '', 'description' => 'Review remarks ', 'type' => 'string', 'example' => '不通过'], + 'AuditStatus' => ['title' => '', 'description' => 'Review Status ', 'type' => 'string', 'example' => 'COMMIT'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '73C67**6FA'."\n", - ], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"common-weather\\",\\n \\"CnName\\": \\"天气\\",\\n \\"EnName\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://img.***.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67**6FA\\\\n\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 1,\\n \\"TemplateDetail\\": \\"这是${hotel}的一个测试模板\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"AuditMark\\": \\"不通过\\",\\n \\"AuditStatus\\": \\"COMMIT\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Obtain hotel message templates', + 'changeSet' => [], ], - 'AddOrUpdateHotelSetting' => [ - 'summary' => '新增或者编辑定制配置', - 'path' => '/v1.0/ip/addOrUpdateHotelSetting', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelOrder' => [ + 'summary' => 'Query the order list on a device ', + 'path' => '/v1.0/ip/listHotelOrder', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a7a3***013', - ], - ], - [ - 'name' => 'SettingType', - 'in' => 'formData', - 'schema' => [ - 'title' => '设置的类型，带屏展示模式（SCENE），'."\n" - .'带屏屏保配置（SCREENSAVER），'."\n" - .'带屏首页背景图（HOMEPAGE_PIC）'."\n" - .'带屏酒店通知（NOTICE），'."\n" - .'夜间模式（NIGHT_MODE）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NOTICE' => '', - 'NIGHT_MODE' => '', - 'SCREENSAVER' => '', - 'SCENE' => '', - 'HOMEPAGE_PIC' => '', - ], - 'example' => 'SCREENSAVER', - ], - ], - [ - 'name' => 'Value', - 'in' => 'formData', - 'schema' => [ - 'title' => '配置值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'HotelScreenSaver', - 'in' => 'formData', + 'name' => 'Payload', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '屏保', - 'description' => '', + 'title' => '', + 'description' => 'Payload for hotel order list ', 'type' => 'object', 'properties' => [ - 'ScreenSaverStyle' => [ - 'title' => '屏保样式code', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'common-weather', - ], - 'ScreenSaverPicUrl' => [ - 'title' => '屏保图片', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://a****jpg', + 'UserId' => ['title' => 'User ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1345480696877233314', 'description' => ''], + 'Page' => [ + 'title' => '', + 'description' => 'Pagination Parameters ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of data entries per page ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], - 'required' => false, - ], - ], - [ - 'name' => 'HotelDeviceModeList', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '模式', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sleep', - ], - 'required' => false, + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], [ - 'name' => 'NightMode', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '夜间模式', - 'description' => '', + 'title' => '', + 'description' => 'User information', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '启用、禁用', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Start' => [ - 'title' => '开始时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7:00', - ], - 'End' => [ - 'title' => '结束时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '22:00', - ], - 'DefaultVolume' => [ - 'title' => '夜间模式下的默认音量', - 'type' => 'string', - 'required' => false, - ], - 'DefaultBright' => [ - 'title' => '夜间模式下的默认亮度', - 'type' => 'string', - 'required' => false, - ], - 'StandbyAction' => [ - 'title' => '休眠时执行，息屏(screenoff)、屏保(screensaver)', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'screenoff', - ], + 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID', 'description' => '', 'title' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955', 'description' => '', 'title' => ''], + 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID', 'description' => '', 'title' => ''], + 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', 'description' => '', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'PageResult<List<HotelOrderListResp>>', + 'description' => 'PageResult<List<HotelOrderListResp>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'Page' => [ + 'title' => '', + 'description' => 'Paging result ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of data entries per page ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['title' => '', 'description' => 'Total number of data entries ', 'type' => 'integer', 'format' => 'int32', 'example' => '21'], + 'TotalPage' => ['title' => '', 'description' => 'Total number of pages ', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'HasNext' => ['title' => '', 'description' => 'Whether there is a next page ', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'title' => '', + 'description' => 'Actual return result of the service', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RoomNo' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'example' => '2001'], + 'OrderNo' => ['title' => '', 'description' => 'Order number', 'type' => 'string', 'example' => '20220808180132000114508555527711'], + 'Quantity' => ['title' => '', 'description' => 'Total number of items ', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'ApplyAmt' => ['title' => '', 'description' => 'Total amount required ', 'type' => 'integer', 'format' => 'int64', 'example' => '21.5'], + 'Status' => ['title' => '', 'description' => 'Order status ', 'type' => 'string', 'example' => 'INIT'], + 'GmtCreate' => ['title' => '', 'description' => 'Order Creation Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659952892000'], + 'Type' => ['title' => '', 'description' => 'Category of the order product ', 'type' => 'string', 'example' => 'REPAIR'], + 'TypeName' => ['title' => '', 'description' => 'Name of the categorization to which the order item belongs ', 'type' => 'string', 'example' => '设备维修'], + 'TypeIconUrl' => ['title' => '', 'description' => 'Icon of the category to which the ordered item belongs ', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png'], + 'Amt' => ['description' => 'Unit price ', 'title' => 'Unit price ', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'Icon' => ['description' => 'Product image ', 'title' => 'Product image ', 'type' => 'string', 'example' => ''], + 'Name' => ['description' => 'Product Name ', 'title' => 'Product Name ', 'type' => 'string', 'example' => ''], + 'ItemType' => ['description' => 'Product type ', 'title' => 'Product type ', 'type' => 'string', 'example' => ''], + 'ItemId' => ['description' => 'Product ID ', 'title' => 'Product ID ', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'DeliveryTime' => ['description' => 'Estimated delivery time of the product ', 'title' => 'Estimated delivery time of the product ', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'PaymentMethod' => ['description' => 'Product settlement method ', 'title' => 'Product settlement method ', 'type' => 'string', 'example' => ''], + 'StartTime' => ['description' => 'Start time of the data query ', 'title' => 'Start time of the data query ', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'SumAmt' => ['description' => 'Total amount of the current check-in order ', 'title' => 'Total amount of the current check-in order ', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'OrderStatus' => ['description' => 'Order status', 'title' => 'Order status ', 'type' => 'string', 'example' => ''], + 'DeliveryRoomName' => ['description' => 'Delivery channel name ', 'title' => 'Delivery channel name ', 'type' => 'string', 'example' => ''], + 'DeliveryMethod' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '07F61FDA-606F-10A0-8ED0-C6CE62710A48'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21,\\n \\"TotalPage\\": 7,\\n \\"HasNext\\": false\\n },\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"2001\\",\\n \\"OrderNo\\": \\"20220808180132000114508555527711\\",\\n \\"Quantity\\": 12,\\n \\"ApplyAmt\\": 21.5,\\n \\"Status\\": \\"INIT\\",\\n \\"GmtCreate\\": 1659952892000,\\n \\"Type\\": \\"REPAIR\\",\\n \\"TypeName\\": \\"设备维修\\",\\n \\"TypeIconUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png\\",\\n \\"Amt\\": 0,\\n \\"Icon\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ItemType\\": \\"\\",\\n \\"ItemId\\": 0,\\n \\"DeliveryTime\\": 0,\\n \\"PaymentMethod\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"SumAmt\\": 0,\\n \\"OrderStatus\\": \\"\\",\\n \\"DeliveryRoomName\\": \\"\\",\\n \\"DeliveryMethod\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"07F61FDA-606F-10A0-8ED0-C6CE62710A48\\"\\n}","type":"json"}]', + 'title' => 'Query order ', + 'description' => 'Query the order list on a device ', + 'changeSet' => [], ], - 'GetHotelSetting' => [ - 'summary' => '查询定制配置', - 'path' => '/v1.0/ip/getHotelSetting', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelRooms' => [ + 'summary' => 'Retrieve hotel channels, which can be refined to a specific channel number ', + 'path' => '/v1.0/ip/listHotelRooms', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'af7***536'."\n", - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'], ], [ - 'name' => 'SettingType', + 'name' => 'HotelAdminRoom', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '设置的类型，带屏展示模式（SCENE），'."\n" - .'带屏屏保配置（SCREENSAVER），'."\n" - .'带屏首页背景图（HOMEPAGE_PIC）'."\n" - .'带屏酒店通知（NOTICE），'."\n" - .'夜间模式（NIGHT_MODE）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NOTICE' => '', - 'NIGHT_MODE' => '', - 'SCREENSAVER' => '', - 'SCENE' => '', - 'HOMEPAGE_PIC' => '', + 'description' => 'Additional information for the query ', + 'type' => 'object', + 'properties' => [ + 'RoomNo' => ['description' => 'Channel number ', 'type' => 'string', 'required' => false, 'example' => '1001', 'title' => ''], ], - 'example' => 'SCREENSAVER', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<HotelSettingInfo>', - 'description' => 'Result<HotelSettingInfo>', + 'title' => 'Result<List<HotelRoomResp>>', + 'description' => 'Result<List<HotelRoomResp>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'af7***536', - ], - 'SettingType' => [ - 'title' => '设置类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'SCREENSAVER' => '', - 'HOMEPAGE_PIC' => '', - ], - 'example' => 'SCREENSAVER', - ], - 'Value' => [ - 'title' => '对应的值', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DeleteToken' => [ - 'title' => '是否删除', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExtInfo' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'HotelScreenSaver' => [ - 'title' => '屏保对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ScreenSaverStyle' => [ - 'title' => '屏保样式code', - 'description' => '', - 'type' => 'string', - 'example' => 'common-weather', - ], - 'ScreenSaverPicUrl' => [ - 'title' => '屏保图片', - 'description' => '', - 'type' => 'string', - 'example' => 'https://a***png', - ], - ], - ], - 'HotelDeviceModeList' => [ - 'title' => '设备模式', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sweet', - ], - ], - 'NightMode' => [ - 'title' => '夜间模式', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Enable' => [ - 'title' => '启用、禁用', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Start' => [ - 'title' => '开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '07:00', - ], - 'End' => [ - 'title' => '结束时间', - 'description' => '', - 'type' => 'string', - 'example' => '22:00', - ], - 'DefaultVolume' => [ - 'title' => '夜间模式下的默认音量', - 'description' => '夜间模式下的默认音量', - 'type' => 'string', - ], - 'DefaultBright' => [ - 'title' => '夜间模式下的默认亮度', - 'description' => '夜间模式下的默认亮度', - 'type' => 'string', - ], - 'StandbyAction' => [ - 'title' => '休眠时执行，息屏(screenoff)、屏保(screensaver)', - 'description' => '', - 'type' => 'string', - 'example' => 'screenoff', - ], - ], + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'], + 'RoomNo' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'example' => '102'], ], + 'description' => 'Channel information returned by the service ', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F7E2****B7C94', - ], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['type' => 'string', 'description' => 'Request ID ', 'example' => 'D75D971E-33E8-1C48-A4B7-5FA6CC386146', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"SettingType\\": \\"SCREENSAVER\\",\\n \\"Value\\": \\"首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店～～\\",\\n \\"DeleteToken\\": 0,\\n \\"ExtInfo\\": \\"{}\\",\\n \\"HotelScreenSaver\\": {\\n \\"ScreenSaverStyle\\": \\"common-weather\\",\\n \\"ScreenSaverPicUrl\\": \\"https://a***png\\"\\n },\\n \\"HotelDeviceModeList\\": [\\n \\"sweet\\"\\n ],\\n \\"NightMode\\": {\\n \\"Enable\\": true,\\n \\"Start\\": \\"07:00\\",\\n \\"End\\": \\"22:00\\",\\n \\"DefaultVolume\\": \\"\\",\\n \\"DefaultBright\\": \\"\\",\\n \\"StandbyAction\\": \\"screenoff\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"e6dd44fd16084db8a60d69fd625d9f0f\\",\\n \\"RoomNo\\": \\"102\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D75D971E-33E8-1C48-A4B7-5FA6CC386146\\"\\n}","type":"json"}]', + 'title' => 'Query hotel channel list ', + 'requestParamsDescription' => 'If you want to query a specific channel, enter the channel number. '."\n" + .'If you want to query all channels of the hotel, do not enter a channel number. ', + 'responseParamsDescription' => 'If the returned result is empty, it indicates that the requested channel number does not exist. ', + 'extraInfo' => 'If an error occurs, check whether the input parameters are correct.', + 'changeSet' => [], ], - 'DeleteHotelSetting' => [ - 'summary' => '删除定制配置', - 'path' => '/v1.0/ip/deleteHotelSetting', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelSceneBookItems' => [ + 'summary' => 'Hotel scenario reservation list (dining / SPA and leisure / ride-hailing) ', + 'path' => '/v1.0/ip/listHotelSceneBookItems', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'af7***536', - ], + 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], [ - 'name' => 'SettingType', + 'name' => 'Type', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel scenario reservation type (FOOD: Dining, LEISURE: SPA and leisure, CAR_SERVICE: Ride-hailing)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FOOD'], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '设置类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NOTICE' => '', - 'NIGHT_MODE' => '', - 'SCREENSAVER' => '', - 'SCENE' => '', - 'HOMEPAGE_PIC' => '', + 'title' => '', + 'description' => 'Pagination Parameters', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of data entries per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], - 'example' => 'SCREENSAVER', + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<HotelSceneListResp>', + 'description' => 'Result<HotelSceneListResp>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C67****BB3E6FA', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'object', + 'properties' => [ + 'Page' => [ + 'title' => '', + 'description' => 'Paging result', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of data entries per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['title' => '', 'description' => 'Total number of data entries', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], + 'TotalPage' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'HasNext' => ['title' => '', 'description' => 'Whether there is a next page', 'type' => 'boolean', 'example' => 'True'], + ], + 'example' => '', + ], + 'SceneItemList' => [ + 'description' => 'Reservation item list ', + 'type' => 'array', + 'items' => [ + 'description' => 'Reservation item ', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Hotel scenario reservation type (FOOD: dining, LEISURE: SPA and leisure, CAR_SERVICE: ride-hailing) ', 'type' => 'string', 'example' => 'FOOD'], + 'Id' => ['title' => '', 'description' => 'Hotel scenario booking item ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11824'], + 'Name' => ['title' => '', 'description' => 'Name', 'type' => 'string', 'example' => '青椒肉丝'], + 'Status' => ['title' => '', 'description' => 'Status (added) ', 'type' => 'string', 'example' => '已添加'], + 'UpdateTime' => ['title' => '', 'description' => 'Update Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1666161803'], + 'Icon' => ['title' => '', 'description' => 'Icon for item, service, or maintenance', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png'], + 'Price' => ['title' => '', 'description' => 'Price (unit: cent)', 'type' => 'integer', 'format' => 'int64', 'example' => '1850'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67****BB3E6FA\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"FOOD\\",\\n \\"Id\\": 11824,\\n \\"Name\\": \\"青椒肉丝\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666161803,\\n \\"Icon\\": \\"https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png\\",\\n \\"Price\\": 1850\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Query hotel reservation list', + 'changeSet' => [], ], - 'AddOrUpdateWelcomeText' => [ - 'summary' => '添加/更新欢迎语信息', - 'path' => '/v1.0/ip/addOrUpdateWelcomeText', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelSceneItem' => [ + 'summary' => 'Query the list of service items in hotel scenarios, such as the service item list for item services ', + 'path' => '/v1.0/ip/listHotelSceneItem', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], - ], - [ - 'name' => 'WelcomeText', - 'in' => 'formData', + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '欢迎语文本，建议150字以内', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Scenario service payload ', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => 'User ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1345480696877233314', 'description' => ''], + 'Type' => ['title' => '', 'description' => 'Scenario service categorization ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GOODS'], + ], 'required' => true, + 'docRequired' => true, 'example' => '', ], ], [ - 'name' => 'MusicUrl', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '背景音链接'."\n" - ."\n" - .'上传要求：'."\n" - .'1. 仅支持采样率16KHz、单声道 .wav格式的文件。（如果您的背景音不是wav格式，'."\n" - .'可使用 ffmpeg将其转为wav格式：ffmpeg -i 输入音频 -acodec pcm_s16le -ac 1 -ar 16000 目标.wav）'."\n" - .'2. 大小不超过2MB。'."\n" - .'3.合成时长超出背景音时长时，背景音将循环合成播放。', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'User information ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID', 'description' => 'Encoding type ', 'title' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955', 'description' => 'Encoding key ', 'title' => ''], + 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID', 'description' => 'ID type', 'title' => ''], + 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', 'description' => 'ID ', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => 'Organization ID ', 'example' => '""', 'title' => ''], + ], 'required' => true, - 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav', + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'PageResult<ListItemResponse>', + 'description' => 'PageResult<ListItemResponse>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'Page' => [ + 'title' => '', + 'description' => 'Paging result ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['title' => '', 'description' => 'Total number of data entries ', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'TotalPage' => ['title' => '', 'description' => 'Total number of pages ', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'HasNext' => ['title' => '', 'description' => 'Whether there is a next page ', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', + 'properties' => [ + 'SecondCategoryList' => [ + 'title' => '', + 'description' => 'List of service categorizations ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecondCategoryName' => ['title' => '', 'description' => 'Categorization name ', 'type' => 'string', 'example' => '客用品类'], + 'ItemList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Item ID ', 'type' => 'string', 'example' => '152860'], + 'Type' => ['title' => '', 'description' => 'Item category', 'type' => 'string', 'example' => 'GOODS'], + 'Category' => ['title' => '', 'description' => 'Item secondary categorization ', 'type' => 'string', 'example' => '客用品类'], + 'Name' => ['title' => '', 'description' => 'Item name ', 'type' => 'string', 'example' => '棉签'], + 'Status' => ['title' => '', 'description' => 'Item status ', 'type' => 'string', 'example' => '已添加'], + 'Icon' => ['title' => '', 'description' => 'Item icon ', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png'], + 'Price' => ['title' => '', 'description' => 'Item price ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ResidueLimit' => ['description' => 'Remaining order quantity '."\n" + .'-1 indicates no limit, 0 indicates no remaining order quantity, and a value greater than 0 indicates the available order quantity. ', 'title' => 'Remaining order quantity '."\n" + .'-1 indicates no limit, 0 indicates no remaining order quantity, and a value greater than 0 indicates the available order quantity. ', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + ], + 'description' => 'Item object ', + 'title' => '', + 'example' => '', + ], + 'description' => 'List of items ', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Service object ', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"TotalPage\\": 6,\\n \\"HasNext\\": false\\n },\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"SecondCategoryList\\": [\\n {\\n \\"SecondCategoryName\\": \\"客用品类\\",\\n \\"ItemList\\": [\\n {\\n \\"Id\\": \\"152860\\",\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 1,\\n \\"ResidueLimit\\": 2\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CEADB586-51CB-1B6B-95BD-AB85A7A08E97\\"\\n}","type":"json"}]', + 'title' => 'Query the list of service items in the hotel scenario ', + 'description' => 'Query the list of service items in hotel scenarios, such as the service item list for item services ', + 'changeSet' => [], ], - 'GetWelcomeTextAndMusic' => [ - 'summary' => '查询欢迎语信息', - 'path' => '/v1.0/ip/getWelcomeTextAndMusic', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelSceneItems' => [ + 'summary' => 'Query hotel scenario services (items/services/maintenance)', + 'path' => '/v1.0/ip/listHotelSceneItems', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', + 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], + ], + [ + 'name' => 'ListHotelSceneReq', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '酒店 id', - 'description' => '', - 'type' => 'string', + 'title' => 'ListHotelSceneReq', + 'description' => 'ListHotelSceneReq', + 'type' => 'object', + 'properties' => [ + 'Page' => [ + 'title' => '', + 'description' => 'Pagination Parameters', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size, default is 10', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + 'Type' => ['title' => '', 'description' => 'Service Type of the hotel scenario (GOODS for items, SERVICE for services, REPAIR for maintenance)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GOODS'], + 'Category' => ['title' => '', 'description' => 'Secondary categorization of the hotel scenario service type', 'type' => 'string', 'required' => false, 'example' => '客用品类'], + 'Status' => ['title' => '', 'description' => 'Whether to add', 'type' => 'string', 'required' => false, 'example' => '已添加'], + 'Keywords' => ['title' => '', 'description' => 'Name of the hotel scenario service item', 'type' => 'string', 'required' => false, 'example' => '棉签'], + ], 'required' => true, - 'example' => 'a7a3***013', + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<WelcomeResp>', - 'description' => 'Result<WelcomeResp>', + 'title' => 'Result<HotelSceneListResp>', + 'description' => 'Result<HotelSceneListResp>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service', 'type' => 'object', 'properties' => [ - 'HotelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'Text' => [ - 'description' => '', - 'type' => 'string', + 'Page' => [ + 'title' => '', + 'description' => 'Paging Result ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of data entries per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['title' => '', 'description' => 'Total number of data entries', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], + 'TotalPage' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'HasNext' => ['title' => '', 'description' => 'Whether there is a next page', 'type' => 'boolean', 'example' => 'False'], + ], 'example' => '', ], - 'MusicUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav', + 'SceneItemList' => [ + 'description' => 'List of service items', + 'type' => 'array', + 'items' => [ + 'description' => 'Service item', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Hotel scenario service type', 'type' => 'string', 'example' => 'GOODS'], + 'Category' => ['title' => '', 'description' => 'Secondary categorization of hotel scenario types', 'type' => 'string', 'example' => '客用品类'], + 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '10336'], + 'Name' => ['title' => '', 'description' => 'Name', 'type' => 'string', 'example' => '棉签'], + 'Status' => ['title' => '', 'description' => 'Status (added or not added)', 'type' => 'string', 'example' => '已添加'], + 'UpdateTime' => ['title' => '', 'description' => 'Update Time ', 'type' => 'integer', 'format' => 'int64', 'example' => '1666163226'], + 'Icon' => ['title' => '', 'description' => 'icon for item, service, or maintenance ', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png'], + 'Price' => ['title' => '', 'description' => 'Price (unit: cent; for example, 160 represents CNY 1.60)', 'type' => 'integer', 'format' => 'int64', 'example' => '160'], + 'DeliveryMethod' => ['description' => 'Item delivery method: waiter (waiter), robot (robot)', 'title' => 'Item delivery method: waiter, robot', 'type' => 'string', 'example' => 'robot'], + 'RobotName' => ['description' => 'Robot name', 'title' => 'Robot name', 'type' => 'string', 'example' => '测试机器人'], + 'PaymentMethod' => ['description' => 'Settlement method: room for room charge settlement, robot for robot settlement ', 'title' => 'Settlement method: room for room charge settlement, robot for robot settlement ', 'type' => 'string', 'example' => 'robot'], + 'LimitSwitch' => ['description' => 'Is quantity limited: 0 or not provided means unlimited, 1 means limited ', 'title' => 'Is quantity limited: 0 or not provided means unlimited, 1 means limited ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LimitNumber' => ['description' => 'Limit quantity', 'title' => 'Limit Quantity ', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'BeyondLimitReply' => ['description' => 'Reply when limit is exceeded', 'title' => 'Reply when limit is exceeded', 'type' => 'string', 'example' => '顾客您好，该物品已超出酒店今日供应限制，请联系前台。'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Text\\": \\"尊贵的客人，您好，欢迎入住，我是您的房间智能助理，我可以播放音乐，控制空调、灯光等，也能提供酒店的各种服务，回答酒店相关问题。只需要唤醒后，就能和我开始互动，我的更多能力，可以参考我旁边的立牌使用哦，祝您在本酒店度过一段愉快的入住时光。\\",\\n \\"MusicUrl\\": \\"http://ailabsaicloudservice.alicdn.com/tmp/a.wav\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666163226,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 160,\\n \\"DeliveryMethod\\": \\"robot\\",\\n \\"RobotName\\": \\"测试机器人\\",\\n \\"PaymentMethod\\": \\"robot\\",\\n \\"LimitSwitch\\": 1,\\n \\"LimitNumber\\": 2,\\n \\"BeyondLimitReply\\": \\"顾客您好，该物品已超出酒店今日供应限制，请联系前台。\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Query hotel scenario service', + 'changeSet' => [], ], - 'ResetWelcomeTextAndMusic' => [ - 'summary' => '重置欢迎语信息', - 'path' => '/v1.0/ip/resetWelcomeTextAndMusic', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListHotelServiceCategory' => [ + 'summary' => 'Obtain hotel service categories, such as the various categories under hotel services and hotel reservations. ', + 'path' => '/v1.0/ip/listHotelServiceCategory', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Service categorization ', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Service categorization type ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOTEL_SERVICE'], + ], 'required' => true, - 'example' => 'af7***536', + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<SceneServiceCategory>>', + 'description' => 'Result<List<SceneServiceCategory>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Service category type ', 'type' => 'string', 'example' => 'HOTEL_SERVICE'], + 'Code' => ['title' => '', 'description' => 'Service category code ', 'type' => 'string', 'example' => 'GOODS'], + 'Name' => ['title' => '', 'description' => 'Service category name', 'type' => 'string', 'example' => '物品添加'], + 'Desc' => ['title' => '', 'description' => 'Service category description ', 'type' => 'string', 'example' => '生活及洗漱用品'], + 'Icon' => ['title' => '', 'description' => 'Service category icon ', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png'], + ], 'description' => '', - 'example' => ' ', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '5373C821-65D2-1764-B9F9-951914937FF5'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" \\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Type\\": \\"HOTEL_SERVICE\\",\\n \\"Code\\": \\"GOODS\\",\\n \\"Name\\": \\"物品添加\\",\\n \\"Desc\\": \\"生活及洗漱用品\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5373C821-65D2-1764-B9F9-951914937FF5\\"\\n}","type":"json"}]', + 'title' => 'Retrieve hotel service categories ', + 'description' => 'Obtain hotel service categories, such as the various categories under hotel services and hotel reservations. ', + 'changeSet' => [], ], - 'PushWelcomeTextAndMusic' => [ - 'summary' => '推送欢迎语', - 'path' => '/v1.0/ip/pushWelcomeTextAndMusic', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListHotels' => [ + 'summary' => 'Obtain a hotel List (pending approval, denied, or passed), which can be refined to a single hotel ', + 'path' => '/v1.0/ip/listHotels', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], + 'schema' => ['title' => '', 'description' => 'Approval status (0: pending, 1: Pass, 2: deny) ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1211', - ], - ], - [ - 'name' => 'RoomName', - 'in' => 'formData', + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'title' => '', + 'description' => 'Pagination Parameters ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of data entries per page ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'TemplateVariable', - 'in' => 'formData', + 'name' => 'HotelRequest', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '参数映射表，例如欢迎语文本中的表达式：${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”', - 'description' => '', + 'description' => 'Hotel-related information ', 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'hotelName', + 'properties' => [ + 'HotelId' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => false, 'example' => 'e02e9c59f35845979418df2ab409a4c4', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<HotelListResp>', + 'description' => 'Result<HotelListResp>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', + 'title' => '', + 'description' => 'Actual return Result of the service ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => ' ', + 'properties' => [ + 'Page' => [ + 'title' => '', + 'description' => 'Paging result ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['title' => '', 'description' => 'Total number of Data entries', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], + 'TotalPage' => ['title' => '', 'description' => 'Total number of pages ', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'HasNext' => ['title' => '', 'description' => 'Indicates whether there is a next page', 'type' => 'boolean', 'example' => 'True'], + ], + 'example' => '', + ], + 'HotelInfoList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'example' => '73ab1b03018d4da69b5bef17095f569b'], + 'HotelName' => ['title' => '', 'description' => 'Hotel Name ', 'type' => 'string', 'example' => '酒店名称'], + 'CreateTime' => ['title' => '', 'description' => 'Creation Time (long type) ', 'type' => 'integer', 'format' => 'int64', 'example' => '1654568802000'], + 'HotelAddress' => ['title' => '', 'description' => 'Hotel address', 'type' => 'string', 'example' => '酒店地址'], + 'PhoneNumber' => ['title' => '', 'description' => 'Contact Information ', 'type' => 'string', 'example' => '13312340987'], + 'IndustryType' => ['title' => '', 'description' => 'Industry Type ', 'type' => 'string', 'example' => '酒店'], + 'RoomNum' => ['title' => '', 'description' => 'Number of Rooms ', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'RelatedProductName' => ['title' => '', 'description' => 'Associated product name', 'type' => 'string', 'example' => '测试产品'], + 'AccountNames' => [ + 'title' => '', + 'description' => 'Taobao Account ', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Account Name ', 'type' => 'string', 'example' => 'testAccount'], + 'example' => '', + ], + 'Status' => ['title' => '', 'description' => 'Status (0: pending approval, 1: Pass, 2: deny)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'description' => 'List of hotel information', + 'title' => '', + 'example' => '', + ], + 'description' => 'List of hotel information', + 'title' => '', + 'example' => '', + ], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F7E2****B7C94', - ], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '85789C64-3644-56C0-9C0F-D2E0ECC227EF'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" *\\"\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"HotelInfoList\\": [\\n {\\n \\"HotelId\\": \\"73ab1b03018d4da69b5bef17095f569b\\",\\n \\"HotelName\\": \\"酒店名称\\",\\n \\"CreateTime\\": 1654568802000,\\n \\"HotelAddress\\": \\"酒店地址\\",\\n \\"PhoneNumber\\": \\"13312340987\\",\\n \\"IndustryType\\": \\"酒店\\",\\n \\"RoomNum\\": 12,\\n \\"RelatedProductName\\": \\"测试产品\\",\\n \\"AccountNames\\": [\\n \\"testAccount\\"\\n ],\\n \\"Status\\": 1\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"85789C64-3644-56C0-9C0F-D2E0ECC227EF\\"\\n}","type":"json"}]', + 'title' => 'Hotel List ', + 'changeSet' => [], ], - 'PushWelcome' => [ - 'summary' => '直接推送欢迎语', - 'path' => '/v1.0/ip/pushWelcome', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInfraredDeviceBrands' => [ + 'summary' => 'Query the list of infrared brands ', + 'path' => '/v1.0/ip/listInfraredDeviceBrands', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], - ], - [ - 'name' => 'WelcomeText', - 'in' => 'formData', - 'schema' => [ - 'title' => '配置信息 欢迎语文本', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'WelcomeMusicUrl', - 'in' => 'formData', - 'schema' => [ - 'title' => '配置信息 欢迎语音乐url', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav', - ], - ], - [ - 'name' => 'RoomNo', + 'name' => 'Category', 'in' => 'formData', - 'schema' => [ - 'title' => '欢迎语推送 房间号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1211', - ], + 'schema' => ['title' => '', 'description' => 'Device name ', 'type' => 'string', 'required' => true, 'example' => '机顶盒'], ], [ - 'name' => 'RoomName', + 'name' => 'ServiceProvider', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'Service provider (SP) (required when the category is set-top box) ', 'type' => 'string', 'required' => false, 'example' => '浙江省电信IPTV'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<Map<String, List<String>>>', + 'description' => 'Result<Map<String, List<String>>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the agreed-upon SUCCESS_CODE, all other codes are defined by the service provider (SP) ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'Collection content ', 'example' => '"A":["Addsion", "Ambassador"]', 'title' => ''], + 'description' => 'List of detailed information returned ', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"A\\\\\\":[\\\\\\"Addsion\\\\\\", \\\\\\"Ambassador\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]', + 'title' => 'Query the list of infrared brands ', + 'changeSet' => [], ], - 'AddMessageTemplate' => [ - 'summary' => '添加消息模板', - 'path' => '/v1.0/ip/addMessageTemplate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListInfraredRemoteControllers' => [ + 'summary' => 'Query the list of infrared code libraries', + 'path' => '/v1.0/ip/listInfraredRemoteControllers', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateName', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '消息模板名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '测试模板', - ], + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], ], [ - 'name' => 'TemplateDetail', + 'name' => 'Province', 'in' => 'formData', - 'schema' => [ - 'title' => '消息模板内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '这是${hotel}的一个测试模板', - ], + 'schema' => ['title' => '', 'description' => 'Province '."\n" + .'Required when the category is set-top box ', 'type' => 'string', 'required' => false, 'example' => '浙江省'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Long>', - 'description' => 'Result<Long>', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '消息模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + [ + 'name' => 'City', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'City '."\n" + .'Required when the category is set-top box ', 'type' => 'string', 'required' => false, 'example' => '杭州市'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + [ + 'name' => 'Category', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Category ', 'type' => 'string', 'required' => true, 'example' => '机顶盒'], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": 11,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', - ], - 'ListHotelMessageTemplate' => [ - 'summary' => '获取消息模板', - 'path' => '/v1.0/ip/listHotelMessageTemplate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AliGenie_Auth_SPI' => [], + 'name' => 'Brand', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Brand '."\n" + .'Required if category is not set-top box; required if category is set-top box and the supplier is IPTV', 'type' => 'string', 'required' => false, 'example' => '奥图码'], + ], + [ + 'name' => 'ServiceProvider', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Service provider (SP) '."\n" + .'Required when the category is set-top box ', 'type' => 'string', 'required' => false, 'example' => '浙江省移动IPTV'], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<ListHotelMessageTemplate>>', - 'description' => 'Result<List<ListHotelMessageTemplate>>', + 'title' => 'Result<List<InfraredControlCodeResp>>', + 'description' => 'Result<List<InfraredControlCodeResp>>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service', 'type' => 'array', 'items' => [ + 'description' => 'Actual return result of the service', 'type' => 'object', 'properties' => [ - 'TemplateId' => [ - 'title' => '消息模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TemplateDetail' => [ - 'title' => '消息模板内容', - 'description' => '', - 'type' => 'string', - 'example' => '这是${hotel}的一个测试模板', - ], - 'TemplateName' => [ - 'title' => '消息模板名称', - 'description' => '', - 'type' => 'string', - 'example' => '测试模板', - ], - 'AuditMark' => [ - 'title' => '审核备注', - 'description' => '', - 'type' => 'string', - 'example' => '不通过', - ], - 'AuditStatus' => [ - 'title' => '审核状态', - 'description' => '', - 'type' => 'string', - 'example' => 'COMMIT', - ], + 'Index' => ['title' => '', 'description' => 'Current index', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Rid' => ['title' => '', 'description' => 'Remote control ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3747'], + 'Version' => ['title' => '', 'description' => 'Version information', 'type' => 'string', 'example' => '4'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0C90A059-3653-5356-A78E-8A6BDA606155'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 1,\\n \\"TemplateDetail\\": \\"这是${hotel}的一个测试模板\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"AuditMark\\": \\"不通过\\",\\n \\"AuditStatus\\": \\"COMMIT\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Index\\": 1,\\n \\"Rid\\": 3747,\\n \\"Version\\": \\"4\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0C90A059-3653-5356-A78E-8A6BDA606155\\"\\n}","type":"json"}]', + 'title' => 'Query the list of infrared code libraries', + 'changeSet' => [], ], - 'DeleteMessageTemplate' => [ - 'summary' => '删除消息通知模板', - 'path' => '/v1.0/ip/deleteMessageTemplate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListSTBServiceProviders' => [ + 'summary' => 'Query service provider (SP)', + 'path' => '/v1.0/ip/listSTBServiceProviders', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'Province', 'in' => 'formData', - 'schema' => [ - 'title' => '消息模板id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '234', - ], + 'schema' => ['title' => '', 'description' => 'Province', 'type' => 'string', 'required' => true, 'example' => '浙江省'], + ], + [ + 'name' => 'City', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'City', 'type' => 'string', 'required' => true, 'example' => '杭州市'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<Map<String, List<String>>>', + 'description' => 'Result<Map<String, List<String>>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider (SP)', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F7E2****B7C94', + 'title' => '', + 'description' => 'Actual return result of the service', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'Return content', 'example' => '"Z":["浙江华数"]', 'title' => ''], + 'description' => 'Actual return result of the service', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '1036C376-7A37-5A73-BE8B-C6DB40107EC1', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"Z\\\\\\":[\\\\\\"浙江华数\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1036C376-7A37-5A73-BE8B-C6DB40107EC1\\"\\n}","type":"json"}]', + 'title' => 'Query service provider (SP)', + 'changeSet' => [], ], - 'UpdateMessageTemplate' => [ - 'summary' => '更新消息通知模板', - 'path' => '/v1.0/ip/updateMessageTemplate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ListSceneCategory' => [ + 'summary' => 'Hotel scenario categorization ', + 'path' => '/v1.0/ip/listSceneCategory', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板主键id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123123', - ], - ], - [ - 'name' => 'TemplateName', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '模板名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => 'hotelId', 'description' => 'hotelId', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], [ - 'name' => 'TemplateDetail', + 'name' => 'Type', 'in' => 'formData', - 'schema' => [ - 'title' => '模板详情', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'Scenario categorization type (GOODS for items, SERVICE for services, REPAIR for maintenance) ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'REPAIR'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'Result<List<String>>', + 'description' => 'Result<List<String>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '返回的请求id', - 'description' => '', - 'type' => 'string', - 'example' => '43***881', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => ['description' => 'Category name ', 'type' => 'string', 'example' => '[ "电器类", "家具类", "卫生间类" ]', 'title' => ''], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n \\"[ \\\\\\"电器类\\\\\\", \\\\\\"家具类\\\\\\", \\\\\\"卫生间类\\\\\\" ]\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Hotel scenario service categorization ', + 'changeSet' => [], ], - 'PushHotelMessage' => [ - 'summary' => '推送酒店消息', - 'path' => '/v1.0/ip/pushHotelMessage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListServiceQA' => [ + 'summary' => 'The feature of querying the Q&A pair list for service facilities under the General Q&A module. ', + 'path' => '/v1.0/ip/listServiceQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PushHotelMessageReq', - 'in' => 'query', + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83'], + ], + [ + 'name' => 'Active', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Whether enabled (true: Enabled, false: shutdown)', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'Keyword (used for fuzzy query on questions, example sentences, and answers)', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => 'pushHotelMessageReq', - 'description' => 'pushHotelMessageReq', + 'description' => 'Pagination Parameters', 'type' => 'object', 'properties' => [ - 'TemplateId' => [ - 'title' => '消息模板ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - 'HotelId' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', - ], - 'RoomNo' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '102', - ], - 'ParamMap' => [ - 'title' => '消息内容参数Map', - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"hotel": "aaaa测试酒店"}', - ], - ], + 'PageNumber' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'PageResult<List<IntentionQAResponse>>', + 'description' => 'PageResult<List<IntentionQAResponse>>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'Page' => [ + 'title' => '', + 'description' => 'Pagination parameters ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['description' => 'Total number of data entries ', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + ], + 'example' => '', ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; apart from the convention-defined SUCCESS_CODE, all other codes are custom-defined by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'type' => 'string', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result ', + 'type' => 'object', + 'properties' => [ + 'ServiceQAId' => ['title' => '', 'description' => 'Service facility Q&A pair ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Question' => ['title' => '', 'description' => 'Question', 'type' => 'string', 'example' => '测试文本'."\n"], + 'Answer' => ['title' => '', 'description' => 'Answer ', 'type' => 'string', 'example' => '***'], + 'GmtModified' => ['title' => '', 'description' => 'Update Time', 'type' => 'string', 'example' => '2022-07-27 14:06:27'."\n"], + 'Active' => ['title' => '', 'description' => 'Whether enabled (true: Enabled, false: shutdown)', 'type' => 'boolean', 'example' => 'true'], + 'Templates' => ['title' => '', 'description' => 'List of example sentences', 'type' => 'string', 'example' => '酒店有提供送餐服务吗;酒店能送餐吗;酒店送餐怎么收费'."\n"], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller locate the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7***726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"ServiceQAId\\": 1,\\n \\"Question\\": \\"测试文本\\\\n\\",\\n \\"Answer\\": \\"***\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\",\\n \\"Active\\": true,\\n \\"Templates\\": \\"酒店有提供送餐服务吗;酒店能送餐吗;酒店送餐怎么收费\\\\n\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'title' => 'Query service facility Q&A pair list', + 'changeSet' => [], ], 'ListTickets' => [ - 'summary' => '查询工单列表', + 'summary' => 'Query the ticket list.', 'path' => '/v1.0/ip/listTickets', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], @@ -11173,146 +6086,82 @@ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Pagination Parameters ', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页size大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-08 09:39:00', - ], + 'schema' => ['description' => 'Start Time, string format: yyyy-mm-dd hh24:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2022-04-08 09:39:00', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-09-14 14:23:00', - ], + 'schema' => ['description' => 'End Time, string format: yyyy-mm-dd hh24:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2022-09-14 14:23:00', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Status: handled: Completed, waiting: Pending, delayed: Delayed', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'waiting' => '', - 'handled' => '', - 'delayed' => '', - ], + 'enumValueTitles' => ['waiting' => '', 'handled' => '', 'delayed' => ''], 'example' => 'waiting', + 'title' => '', ], ], [ 'name' => 'RoomNo', 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1211', - ], + 'schema' => ['title' => '', 'description' => 'Channel number', 'type' => 'string', 'required' => false, 'example' => '1211'], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'title' => '类型', - 'description' => '', + 'title' => '', + 'description' => 'Type 1: "" (All), 2: Hotel service (Hotel service), 3: Hotel maintenance (Hotel maintenance)', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - '""' => '', - '酒店服务' => '', - '酒店维修' => '', - ], + 'enumValueTitles' => ['""' => '', '酒店服务' => '', '酒店维修' => ''], 'example' => '""', ], ], [ 'name' => 'IsNeedCallback', 'in' => 'formData', - 'schema' => [ - 'title' => '是否需要回电', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '', 'description' => 'Is callback required', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'IsNeedCharges', 'in' => 'formData', - 'schema' => [ - 'title' => '是否需要收费', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '', 'description' => 'Is charging required', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'SortField', 'in' => 'formData', - 'schema' => [ - 'title' => '排序字段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gmtCalled', - ], + 'schema' => ['title' => '', 'description' => 'Sorting field ', 'type' => 'string', 'required' => false, 'example' => 'gmtCalled'], ], [ 'name' => 'IsDesc', 'in' => 'formData', - 'schema' => [ - 'title' => '是否为降序', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'Is descending order ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -11324,1266 +6173,500 @@ 'type' => 'object', 'properties' => [ 'Page' => [ - 'title' => '翻页参数', - 'description' => '', + 'title' => '', + 'description' => 'Pagination parameters', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页size大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'PageNumber' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['description' => 'Total number of data entries', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], + 'example' => '', ], - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result from the service', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Actual return result from the service', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '主键', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45', - ], - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-09 00:00:00', - ], - 'GmtModified' => [ - 'title' => '修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-09 00:00:00', - ], + 'Id' => ['title' => '', 'description' => 'Primary key ', 'type' => 'integer', 'format' => 'int64', 'example' => '45'], + 'GmtCreate' => ['title' => '', 'description' => 'Creation Time ', 'type' => 'string', 'example' => '2023-01-09 00:00:00'], + 'GmtModified' => ['title' => '', 'description' => 'Updated At ', 'type' => 'string', 'example' => '2023-01-09 00:00:00'], 'Dialogs' => [ - 'title' => '单轮对话', - 'description' => '', + 'title' => '', + 'description' => 'Single-turn dialogues ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Dialogue ', 'type' => 'object', 'properties' => [ - 'Question' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Answer' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'Question' => ['description' => 'Question. ', 'type' => 'string', 'example' => '我要1份***', 'title' => ''], + 'Answer' => ['description' => 'Answer. ', 'type' => 'string', 'example' => '好的，服务员会尽快送来。', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'RoomNo' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'example' => '101', - ], + 'RoomNo' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'example' => '101'], 'Type' => [ - 'title' => '类型', - 'description' => '', + 'title' => '', + 'description' => 'Type: 1: "" (All), 2: Hotel Service, 3: Hotel Maintenance ', 'type' => 'string', - 'enumValueTitles' => [ - '""' => '', - '酒店服务' => '', - '酒店维修' => '', - ], + 'enumValueTitles' => ['""' => '', '酒店服务' => '', '酒店维修' => ''], 'example' => '""', ], - 'IsNeedCallback' => [ - 'title' => '是否需要回电', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsNeedCharges' => [ - 'title' => '是否需要收费', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsAcceptedCharges' => [ - 'title' => '客户是否接受收费', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AssignedHandler' => [ - 'title' => '指派人', - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'Remark' => [ - 'title' => '备注', - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], + 'IsNeedCallback' => ['title' => '', 'description' => 'Whether a callback is required ', 'type' => 'boolean', 'example' => 'false'], + 'IsNeedCharges' => ['title' => '', 'description' => 'Whether charges are required ', 'type' => 'boolean', 'example' => 'false'], + 'IsAcceptedCharges' => ['title' => '', 'description' => 'Whether the customer accepts charges ', 'type' => 'boolean', 'example' => 'false'], + 'AssignedHandler' => ['title' => '', 'description' => 'Assigned handler', 'type' => 'string', 'example' => '***'], + 'Remark' => ['title' => '', 'description' => 'Remark ', 'type' => 'string', 'example' => '***'], 'Status' => [ - 'title' => '状态', - 'description' => '', + 'title' => '', + 'description' => 'Status: handled: Completed, waiting: Pending, delayed: Delayed ', 'type' => 'string', - 'enumValueTitles' => [ - 'waiting' => '', - 'handled' => '', - 'delayed' => '', - ], + 'enumValueTitles' => ['waiting' => '', 'handled' => '', 'delayed' => ''], 'example' => 'waiting', ], 'Operations' => [ - 'title' => '操作', - 'description' => '', + 'title' => '', + 'description' => 'Operations ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Key-value pairs ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - 'example' => '', - ], + 'additionalProperties' => ['type' => 'any', 'description' => 'isOperable: Indicates whether the operation is allowed. '."\n" + .'nextStatus: The next status. '."\n" + .'name: Name '."\n" + .'currStatus: The current status.', 'example' => '"isOperable":true,'."\n" + .'"nextStatus":"handled",'."\n" + .'"name":"处理完成",'."\n" + .'"currStatus":"delayed"', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'IsDelayed' => [ - 'title' => '是否延时处理', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtDelayed' => [ - 'title' => '延时处理时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-09 00:00:00', - ], - 'ChargesRemark' => [ - 'title' => '收费信息备注', - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'CompleteRemark' => [ - 'title' => '完成情况备注', - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'GmtCalled' => [ - 'title' => '呼叫时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-01-09 00:00:00', - ], - 'GroupKey' => [ - 'title' => '分组键', - 'description' => '', - 'type' => 'string', - 'example' => '2023***93975', - ], - 'Action' => [ - 'title' => '是否是操作', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'IsDelayed' => ['title' => '', 'description' => 'Indicates whether the processing is delayed. ', 'type' => 'boolean', 'example' => 'true'], + 'GmtDelayed' => ['title' => '', 'description' => 'Processing time for delayed tickets', 'type' => 'string', 'example' => '2023-01-09 00:00:00'], + 'ChargesRemark' => ['title' => '', 'description' => 'Charge information remark', 'type' => 'string', 'example' => '***'], + 'CompleteRemark' => ['title' => '', 'description' => 'Completion remark ', 'type' => 'string', 'example' => '***'], + 'GmtCalled' => ['title' => '', 'description' => 'Call time ', 'type' => 'string', 'example' => '2023-01-09 00:00:00'], + 'GroupKey' => ['title' => '', 'description' => 'Group key, which represents a single conversation or order operation. Multi-turn conversations share the same group key and are automatically merged into one ticket with multiple conversation entries.', 'type' => 'string', 'example' => '2023***93975'], + 'Action' => ['title' => '', 'description' => 'Whether an operation has been performed ', 'type' => 'boolean', 'example' => 'false'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7***726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 5\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Id\\": 45,\\n \\"GmtCreate\\": \\"2023-01-09 00:00:00\\",\\n \\"GmtModified\\": \\"2023-01-09 00:00:00\\",\\n \\"Dialogs\\": [\\n {\\n \\"Question\\": \\"我要1份***\\",\\n \\"Answer\\": \\"好的，服务员会尽快送来。\\"\\n }\\n ],\\n \\"RoomNo\\": \\"101\\",\\n \\"Type\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IsNeedCallback\\": false,\\n \\"IsNeedCharges\\": false,\\n \\"IsAcceptedCharges\\": false,\\n \\"AssignedHandler\\": \\"***\\",\\n \\"Remark\\": \\"***\\",\\n \\"Status\\": \\"waiting\\",\\n \\"Operations\\": [\\n {\\n \\"key\\": \\"\\\\\\"isOperable\\\\\\":true,\\\\n\\\\\\"nextStatus\\\\\\":\\\\\\"handled\\\\\\",\\\\n\\\\\\"name\\\\\\":\\\\\\"处理完成\\\\\\",\\\\n\\\\\\"currStatus\\\\\\":\\\\\\"delayed\\\\\\"\\"\\n }\\n ],\\n \\"IsDelayed\\": true,\\n \\"GmtDelayed\\": \\"2023-01-09 00:00:00\\",\\n \\"ChargesRemark\\": \\"***\\",\\n \\"CompleteRemark\\": \\"***\\",\\n \\"GmtCalled\\": \\"2023-01-09 00:00:00\\",\\n \\"GroupKey\\": \\"2023***93975\\",\\n \\"Action\\": false\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'title' => 'Query ticket list', + 'changeSet' => [], ], - 'UpdateTicket' => [ - 'summary' => '修改工单', - 'path' => '/v1.0/ip/updateTicket', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PageGetHotelRoomDevices' => [ + 'summary' => 'Paged query of channel master control devices by hotel ', + 'path' => '/v1.0/ip/pageGetHotelRoomDevices', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '520a0c0***5eb', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83'], ], [ - 'name' => 'Status', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'waiting' => '', - 'handled' => '', - 'delayed' => '', - ], - 'example' => 'waiting', - ], + 'schema' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'GroupKey', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '分组键', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2023***93975', - ], + 'schema' => ['title' => '', 'description' => 'Page size, with a default maximum limit of 20', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => 'PageResult<List<HotelDeviceInfo>>', + 'description' => 'PageResult<List<HotelDeviceInfo>>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'Page' => [ + 'title' => '', + 'description' => 'Paging parameters ', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['title' => '', 'description' => 'Total count ', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'TotalPage' => ['title' => '', 'description' => 'Total number of pages ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Start' => ['title' => '', 'description' => 'Starting ordinal number ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'End' => ['title' => '', 'description' => 'End ordinal number ', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'HasNext' => ['title' => '', 'description' => 'Indicates whether there is a next page ', 'type' => 'boolean', 'example' => 'False'], + ], + 'example' => '', ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined value 200, which indicates success, all other values are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7***726E', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', - ], - 'DeleteHotelAlarm' => [ - 'summary' => '删除酒店闹钟', - 'path' => '/v1.0/ip/deleteHotelAlarm', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], - ], - [ - 'name' => 'Alarms', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RoomNo' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '101', - ], - 'AlarmId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5029', - ], - 'UserOpenId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mgw/k***HQd', - ], - 'DeviceOpenId' => [ + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Mac' => ['title' => '', 'description' => 'Device MAC ', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'], + 'Sn' => ['title' => '', 'description' => 'Device SN ', 'type' => 'string', 'example' => '1200xxx048'], + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'a7***83'], + 'RoomNo' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'example' => '2001'], + 'OnlineStatus' => ['title' => '', 'description' => 'Device online status: 1 indicates online; 0 indicates offline ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'FirmwareVersion' => ['title' => '', 'description' => 'Device firmware version number', 'type' => 'string', 'example' => 'V21.10.00.313'], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PvkB***TA==', + 'title' => '', + 'example' => '', ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Integer>', - 'description' => 'Result<Integer>', - 'type' => 'object', - 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller locate the issue ', 'type' => 'string', 'example' => 'success'], 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', + 'title' => '', + 'description' => 'Extension fields ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '""', - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***881', + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'Request Parameters ', 'type' => 'string', 'example' => '4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"xxx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 5,\\n \\"TotalPage\\": 1,\\n \\"Start\\": 0,\\n \\"End\\": 4,\\n \\"HasNext\\": true\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"V21.10.00.313\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE\\"\\n}","type":"json"}]', + 'title' => 'Paged query of channel master control devices by hotel', + 'changeSet' => [], ], - 'ListHotelAlarm' => [ - 'summary' => '查询酒店闹钟', - 'path' => '/v1.0/ip/getHotelAlarmList', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PmsEventReport' => [ + 'summary' => 'PMS management event Reporting', + 'path' => '/v1.0/ip/pmsEventReport', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a7a3***013', - ], - ], - [ - 'name' => 'Rooms', + 'name' => 'Payload', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '101', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Content of PMS management event Reporting', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "eventId": "123342",'."\n" + .' "eventType": 2,'."\n" + .' "hotelId": "95fc******4f7b",'."\n" + .' "pmsPartnerName": "XX科技",'."\n" + .' "orderItemList": ['."\n" + .' {'."\n" + .' "orderItemId": "12345",'."\n" + .' "channelName": "飞猪",'."\n" + .' "checkinTime": "2023-04-15 12:03:20",'."\n" + .' "checkoutTime": "2023-04-16 11:12:04",'."\n" + .' "guests": ['."\n" + .' {'."\n" + .' "name": "张*",'."\n" + .' "familyName": "张",'."\n" + .' "phone": "187***0967",'."\n" + .' "email": "****@qq.com",'."\n" + .' "telephone": "0571-433**343",'."\n" + .' "gender": 1,'."\n" + .' "identityType": "idCard",'."\n" + .' "identityNo": "330**********3538"'."\n" + .' }'."\n" + .' ],'."\n" + .' "price": "318",'."\n" + .' "lastRoomNo": "119",'."\n" + .' "roomNo": "210",'."\n" + .' "roomTypeCode": "1023",'."\n" + .' "roomTypeName": "大床房",'."\n" + .' "status": 2'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelAlarmDetailResponse>>', - 'description' => 'Result<List<HotelAlarmDetailResponse>>', + 'title' => 'Result<Boolean>', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AlarmId' => [ - 'title' => '闹钟id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5039', - ], - 'UserOpenId' => [ - 'title' => '用户Id', - 'description' => '', - 'type' => 'string', - 'example' => 'mgw/k***HQd', - ], - 'DeviceOpenId' => [ - 'title' => 'uuid', - 'description' => '', - 'type' => 'string', - 'example' => 'PvkB****VVTA==', - ], - 'ScheduleInfo' => [ - 'title' => '设置的闹钟信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', - 'description' => 'ONCE, WEEKLY', - 'type' => 'string', - 'example' => 'ONCE', - ], - 'Once' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2022', - ], - 'Month' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'Day' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Hour' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'Weekly' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'Hour' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '""', - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***881', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invoke; 200 indicates Succeeded', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return Result of the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invoke to help the caller identify the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['type' => 'string', 'description' => 'Request ID', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"AlarmId\\": 5039,\\n \\"UserOpenId\\": \\"mgw/k***HQd\\",\\n \\"DeviceOpenId\\": \\"PvkB****VVTA==\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 9,\\n \\"Day\\": 20,\\n \\"Hour\\": 10,\\n \\"Minute\\": 30\\n },\\n \\"Weekly\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n }\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'PMS management event synchronization', + 'changeSet' => [], ], - 'CreateHotelAlarm' => [ - 'summary' => '批量创建闹钟', - 'path' => '/v1.0/ip/createHotelAlarm', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PushHotelMessage' => [ + 'summary' => 'Push hotel message ', + 'path' => '/v1.0/ip/pushHotelMessage', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'HotelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', - ], - ], - [ - 'name' => 'Rooms', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '批量最多支持10个房间的闹钟设置，此处房间号请控制在10个以内', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '101', - ], - 'required' => true, - ], - ], - [ - 'name' => 'ScheduleInfo', - 'in' => 'formData', + 'name' => 'PushHotelMessageReq', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => 'pushHotelMessageReq', + 'description' => 'pushHotelMessageReq', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', - 'description' => 'ONCE, WEEKLY', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'Once' => [ - 'description' => '', + 'TemplateId' => ['title' => '', 'description' => 'Template ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'], + 'RoomNo' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '102'], + 'ParamMap' => [ + 'title' => '', + 'description' => 'Map of message content parameters ', 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2022', - ], - 'Month' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9', - ], - 'Day' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'Hour' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '19', - ], - 'Minute' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - 'Weekly' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'Hour' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{"hotel": "aaaa测试酒店"}', 'description' => '', 'title' => ''], + 'example' => '', ], ], 'required' => true, - ], - ], - [ - 'name' => 'MusicType', - 'in' => 'formData', - 'schema' => [ - 'title' => '目前支持 (DOU_YIN, JING_DIAN)', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DOU_YIN', - 'enum' => [ - 'DOU_YIN', - 'JING_DIAN', - ], + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelAlarmResponse>>', - 'description' => 'Result<List<HotelAlarmResponse>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RoomNo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '101', - ], - 'AlarmId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], - 'DeviceOpenId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Pvk***TA==', - ], - 'UserOpenId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mg***Qd', - ], - 'FailMsg' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '""', - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***86881', - ], + 'Code' => ['title' => '', 'description' => 'Status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => ''], + 'Message' => ['title' => '', 'description' => 'Additional information ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"101\\",\\n \\"AlarmId\\": 94,\\n \\"DeviceOpenId\\": \\"Pvk***TA==\\",\\n \\"UserOpenId\\": \\"mg***Qd\\",\\n \\"FailMsg\\": \\"设备离线，闹钟创建失败\\"\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***86881\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": false,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Push custom hotel message ', + 'changeSet' => [], ], - 'UpdateHotelAlarm' => [ - 'summary' => '修改酒店闹钟', - 'path' => '/v1.0/ip/updateHotelAlarm', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PushVoiceBoxCommands' => [ + 'summary' => 'Push speaker instructions ', + 'path' => '/v1.0/ip/pushVoiceBoxCommands', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7a381a668bc485980bed3876a75e013', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'a4d9a9cfcdef4c39b2b1a9724eae906b'], ], [ - 'name' => 'Alarms', + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'required' => true, 'example' => '111'], + ], + [ + 'name' => 'Commands', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Command List ', 'type' => 'array', 'items' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'RoomNo' => [ - 'description' => '', + 'CommandDomain' => ['title' => '', 'description' => 'namespace ', 'type' => 'string', 'required' => true, 'example' => 'AliGenie.Video.Control'], + 'CommandName' => ['title' => '', 'description' => 'instruction Name', 'type' => 'string', 'required' => true, 'example' => 'Pause'], + 'Payload' => [ + 'title' => '', + 'description' => 'instruction parameter', 'type' => 'string', 'required' => false, - 'example' => '101', - ], - 'AlarmId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567', - ], - 'UserOpenId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mgw/***dHQd', - ], - 'DeviceOpenId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Pvk***VTA==', + 'enumValueTitles' => [], + 'example' => '可为空', ], ], - 'required' => false, + 'required' => true, + 'description' => '', + 'example' => '', ], 'required' => true, - ], - ], - [ - 'name' => 'ScheduleInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', - 'description' => 'ONCE, WEEKLY', - 'type' => 'string', - 'required' => false, - 'example' => 'ONCE', - ], - 'Once' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2022', - ], - 'Month' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9', - ], - 'Day' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'Hour' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'Weekly' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'Hour' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - ], - 'required' => false, + 'minItems' => 1, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<Integer>', - 'description' => 'Result<Integer>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '""', - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code; apart from the conventionally defined SUCCESS_CODE, other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Invocation return code used for POP responses ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'null'], + 'RequestId' => ['title' => '', 'description' => 'None ', 'type' => 'string', 'example' => 'null'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"null\\"\\n}","type":"json"}]', + 'title' => 'Push speaker instructions ', + 'requestParamsDescription' => '**commands:** '."\n" + ."\n" + .'Currently supported instructions '."\n" + .'| / | commandDomain | commandName | payload | '."\n" + .'| ---- | ---- | ---- | ---- | '."\n" + .'| Pause instruction for screen-equipped devices | AliGenie.Video.Control | Pause | Can be empty | '."\n" + .'| Pause instruction for screenless devices | AliGenie.System.Control | Pause | Can be empty | '."\n" + .'| Screen-off instruction | AliGenie.Screen | UnlitScreen | Can be empty | '."\n" + .'| Screen-on instruction | AliGenie.Screen | LightScreen | Can be empty | ', + 'changeSet' => [], ], - 'ChildAccountAuth' => [ - 'summary' => '子账号授权', - 'path' => '/v1.0/ip/childAccountAuth', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PushWelcome' => [ + 'summary' => 'Push welcome message directly ', + 'path' => '/v1.0/ip/pushWelcome', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Account', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '淘宝账号名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'lee', - ], + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], ], [ - 'name' => 'TbOpenId', + 'name' => 'WelcomeText', 'in' => 'formData', - 'schema' => [ - 'title' => '淘宝开放id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AAEV***E3d3Z2ETwh', - ], + 'schema' => ['title' => '', 'description' => 'Configuration Information: Text of the welcome message ', 'type' => 'string', 'required' => true, 'example' => '尊贵的客人，您好，欢迎入住，我是您的房间智能助理，我可以播放音乐，控制空调、灯光等，也能提供酒店的各种服务，回答酒店相关问题。只需要唤醒后，就能和我开始互动，我的更多能力，可以参考我旁边的立牌使用哦，祝您在本酒店度过一段愉快的入住时光。'], ], [ - 'name' => 'AppKey', + 'name' => 'WelcomeMusicUrl', 'in' => 'formData', - 'schema' => [ - 'title' => '开放平台appKey', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30471753', - ], + 'schema' => ['title' => '', 'description' => 'Configuration Information: URL of the welcome message audio ', 'type' => 'string', 'required' => false, 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav'], ], [ - 'name' => 'HotelId', + 'name' => 'RoomNo', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], + 'schema' => ['title' => '', 'description' => 'Channel number for welcome message push ', 'type' => 'string', 'required' => false, 'example' => '1211'], + ], + [ + 'name' => 'RoomName', + 'in' => 'formData', + 'schema' => ['description' => 'Channel name ', 'type' => 'string', 'required' => false, 'example' => '8022房间', 'title' => ''], ], ], 'responses' => [ @@ -12593,216 +6676,68 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Extentions' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3DB51A10-327C-58D3-91DF-3A5A471C51E7', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"3DB51A10-327C-58D3-91DF-3A5A471C51E7\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Push welcome message directly to channel devices ', + 'changeSet' => [], ], - 'RemoveChildAccountAuth' => [ - 'summary' => '删除子账号授权', - 'path' => '/v1.0/ip/removeChildAccountAuth', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PushWelcomeTextAndMusic' => [ + 'summary' => 'Push welcome message playback ', + 'path' => '/v1.0/ip/pushWelcomeTextAndMusic', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'TbOpenId', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '授权人（平台登录用户）淘宝开放id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AAEV***E3d3Z2ETwh', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536'], ], [ - 'name' => 'AppKey', + 'name' => 'RoomNo', 'in' => 'formData', - 'schema' => [ - 'title' => 'top开放平台appKey', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '30**53', - ], + 'schema' => ['title' => '', 'description' => 'channel number ', 'type' => 'string', 'required' => false, 'example' => '1211'], ], [ - 'name' => 'ChildAccountName', + 'name' => 'RoomName', 'in' => 'formData', - 'schema' => [ - 'title' => '被授权账号的淘宝账号名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tbxxxx', - ], + 'schema' => ['description' => 'channel name ', 'type' => 'string', 'required' => false, 'example' => '8022房间', 'title' => ''], ], [ - 'name' => 'HotelId', + 'name' => 'TemplateVariable', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'af7***536', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Result<Boolean>', - 'description' => 'Result<Boolean>', + 'title' => '', + 'description' => 'Parameter mapping table. For example, the expression ${hotelName} in a welcome message text can be replaced with "Smart Hotel" by using the parameter mapping table {"hotelName": "Smart Hotel"}.', 'type' => 'object', - 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，200标识为成功，非200详细见错误码表', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B***F34E', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], - ], - 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B***F34E\\"\\n}","type":"json"}]', - ], - 'PmsEventReport' => [ - 'summary' => 'pms事件上报', - 'path' => '/v1.0/ip/pmsEventReport', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'Payload', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'Template Variable', 'example' => '{"name": "李先生"}', 'title' => ''], 'example' => '', ], ], @@ -12811,135 +6746,106 @@ 200 => [ 'schema' => [ 'title' => 'Result<Boolean>', - 'description' => 'Schema of Response', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'type' => 'string', + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return Result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information; a typical scenario is providing a brief description for a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension field ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'extension information ', 'example' => ' *', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'F7E2****B7C94', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" *\\"\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'title' => 'Push welcome message playback ', + 'description' => 'Push welcome message playback: '."\n" + .'- Welcome message text: '."\n" + .' - If no welcome message is configured, the default message is used directly: "Dear guest, hello! Welcome to our hotel. I am your Intelligent channel assistant. I can play music, control the air conditioner, lights, and more, as well as provide various hotel services and answer hotel-related questions. Simply wake me up to start interacting with me. For more of my capabilities, please refer to the standing card next to me. We wish you a pleasant stay at our hotel." '."\n" + .' - Expressions in the welcome message text, such as ${hotelName}, can be replaced via the parameter mapping table {"hotelName":"Smart Hotel"} to become "Smart Hotel". '."\n" + ."\n" + .'- Background audio Link: If not configured, the default link is used: http://ailabsaicloudservice.alicdn.com/tmp/a.wav ', + 'changeSet' => [], ], 'QueryDeviceStatus' => [ - 'summary' => '查询酒店设备状态/模式状态查询', + 'summary' => 'Query the status of guest room control devices, such as the toggle status of lights or the current temperature setting of an air conditioner. You can also query the status of certain patterns, such as Do Not Disturb mode (requires prior support from the ISV).', 'path' => '/v1.0/ip/queryDeviceStatus', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Parameters for the query', 'type' => 'object', 'properties' => [ 'LocationDevices' => [ - 'description' => '', + 'description' => 'List of location and device information', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Location and device information', 'type' => 'object', 'properties' => [ - 'Location' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'room', - ], - 'DeviceNumber' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'night_light', - ], - 'DeviceType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'light', - ], + 'Location' => ['description' => 'Location information, such as:'."\n" + ."\n" + .'- room: channel'."\n" + .'- livingroom: living room', 'type' => 'string', 'required' => false, 'example' => 'room', 'title' => ''], + 'DeviceNumber' => ['description' => 'Device number', 'type' => 'string', 'required' => false, 'example' => 'night_light', 'title' => ''], + 'DeviceType' => ['description' => 'Device type, such as:'."\n" + ."\n" + .'- light: light'."\n" + .'- aircondition: air conditioner', 'type' => 'string', 'required' => false, 'example' => 'light', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'Properties' => [ - 'description' => '', + 'description' => 'Additional information, such as pattern-related data.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'mode', - 'description' => '', - ], + 'additionalProperties' => ['type' => 'string', 'example' => 'mode', 'description' => 'For example, pass parameters in query scenarios such as mode:'."\n" + .'mode: dnd', 'title' => ''], + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ @@ -12947,41 +6853,21 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'EncodeType' => ['description' => 'Encoding type. Enter **HOTEL** here.', 'type' => 'string', 'required' => true, 'example' => 'HOTEL', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type. Enter the application ID for this hotel here. You can view it on the Tmall Genie Industry Management Platform.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of the User ID:'."\n" + ."\n" + .'- OPEN_ID: The default User ID identifier.'."\n" + .'- UNION_ID: The organization-dimension User ID identifier. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User identifier. Set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -12989,1354 +6875,874 @@ 200 => [ 'schema' => [ 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', - 'description' => '', + 'description' => 'Return Result object', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Device status information', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'value', - 'description' => '', - ], + 'additionalProperties' => ['type' => 'string', 'example' => 'value', 'description' => 'Device status information', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fdsgrefds', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'fdsgrefds', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"key\\": \\"value\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"fdsgrefds\\"\\n}","type":"json"}]', + 'title' => 'Query Guest Room Control Device Status', + 'changeSet' => [], ], - 'ListHotelControlDevice' => [ - 'summary' => '酒店设备列表', - 'path' => '/v1.0/ip/listHotelControlDevice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'QueryHotelRoomDetail' => [ + 'summary' => 'Query room details, including hotel information, guest control information, CatGenie device information, guest service requests, and more.', + 'path' => '/v1.0/ip/queryHotelRoomDetail', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => true, - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - ], - 'IdType' => [ - 'type' => 'string', - 'required' => true, - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - ], - 'OrganizationId' => [ - 'type' => 'string', - ], - ], - ], + 'name' => 'Mac', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Device MAC address '."\n" + .'Note: If MAC, UUID, and SN are all provided, the system queries based on the correctly entered values. If all provided values are valid, the query Priority follows the order: UUID > MAC > SN. '."\n" + .'If any one of MAC, UUID, or SN is provided, the hotel ID and channel number do not need to be provided. ', 'type' => 'string', 'required' => false, 'example' => '38:c8:**:**:f5:22'], + ], + [ + 'name' => 'Uuid', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Device UUID, which can be viewed in the App '."\n" + .'Note: If MAC, UUID, and SN are all provided, the system queries based on the correctly entered values. If all inputs are valid, the query priority is UUID > MAC > SN. '."\n" + .'If any one of MAC, UUID, or SN is provided, the hotel ID and room number are optional. ', 'type' => 'string', 'required' => false, 'example' => '588***96j5WU'], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID '."\n" + .'Note: When querying using the hotel ID and channel number, the query Priority is lower than when providing the device SN, MAC, or UUID. If none of SN, MAC, or UUID are provided, the hotel ID must be provided. ', 'type' => 'string', 'required' => false, 'example' => '520a0c0***5eb'], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Room number '."\n" + .'Note: When querying using hotel ID and room number, the query priority is lower than when providing device SN, MAC, or UUID. If none of SN, MAC, or UUID are provided, the room number must be specified. ', 'type' => 'string', 'required' => false, 'example' => '1211'], + ], + [ + 'name' => 'Sn', + 'in' => 'formData', + 'schema' => ['title' => '设备sn信息'."\n" + .'在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', 'description' => '设备sn信息'."\n" + .'注：若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n" + .'传入mac uuid sn其中一个 则酒店id和房间号可不传', 'type' => 'string', 'required' => false, 'example' => '280**28'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', + 'title' => 'Result<HotelRoomDetail>', + 'description' => 'Result<HotelRoomDetail>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'type' => 'integer', - 'format' => 'int32', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', + 'title' => '', + 'description' => 'Actual return result of the service', + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'a7***83'], + 'HotelName' => ['title' => '', 'description' => 'Hotel name', 'type' => 'string', 'example' => 'xx酒店'], + 'CreatorAccountName' => ['title' => '', 'description' => 'Hotel creator account name', 'type' => 'string', 'example' => 'xx淘宝昵称'], + 'ConnectType' => ['title' => '', 'description' => 'Hotel connection type, either rcu or mesh ', 'type' => 'string', 'example' => 'rcu'], + 'RoomNo' => ['title' => '', 'description' => 'Room number', 'type' => 'string', 'example' => '2001'], + 'RoomControlInfo' => [ + 'title' => '', + 'description' => 'Room control information', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '', 'description' => 'Room Type ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1170'], + 'TemplateName' => ['title' => '', 'description' => 'Room Type Name ', 'type' => 'string', 'example' => '大床房'], + 'AppId' => ['title' => '', 'description' => 'Cloud-to-cloud integration application ID', 'type' => 'integer', 'format' => 'int64', 'example' => '78'], + 'AppName' => ['title' => '', 'description' => 'Cloud-to-cloud integration application name ', 'type' => 'string', 'example' => 'app'], + 'RcuUrl' => ['title' => '', 'description' => 'RCU cloud-to-cloud invoke Link ', 'type' => 'string', 'example' => 'http://www.xxx.com'], + 'DeviceInfos' => [ + 'title' => '', + 'description' => 'List of room control device information', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Room control device information', + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['title' => '', 'description' => 'Alias of the device', 'type' => 'string', 'example' => '阅读灯'], + 'CategoryId' => ['title' => '', 'description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'CategoryEnName' => ['title' => '', 'description' => 'English name of the category', 'type' => 'string', 'example' => 'light'], + 'CategoryName' => ['title' => '', 'description' => 'Display Name of the category', 'type' => 'string', 'example' => '灯'], + 'LocationId' => ['title' => '', 'description' => 'Location ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'LocationEnName' => ['title' => '', 'description' => 'Location English name', 'type' => 'string', 'example' => 'room'], + 'LocationName' => ['title' => '', 'description' => 'Location Display Name ', 'type' => 'string', 'example' => '房间'], + 'DeviceId' => ['title' => '', 'description' => 'Unique device ID', 'type' => 'string', 'example' => 'readLight'], + 'DeviceConnectType' => ['title' => '', 'description' => 'Device connection type:'."\n" + .'- rcu: cloud-to-cloud integration'."\n" + .'- mesh: local direct connection'."\n" + .'- infrared: infrared integration', 'type' => 'string', 'example' => 'rcu'], + 'ProductKey' => ['title' => '', 'description' => 'ProductKey of the mesh product', 'type' => 'string', 'example' => 'a1ueWGP6W2L'], + 'DeviceCount' => ['title' => '', 'description' => 'Device Quantity ', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'AuthAccounts' => [ + 'title' => '', + 'description' => 'List of authorized accounts ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountName' => ['title' => '', 'description' => 'Account name', 'type' => 'string', 'example' => 'xx淘宝昵称'], + 'AuthTime' => ['title' => '', 'description' => 'Authorization time ', 'type' => 'string', 'example' => '2023-01-01 12:00:00'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'DeviceInfos' => [ + 'title' => '', + 'description' => 'List of Maojing devices ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => ['title' => '', 'description' => 'UUID of the Maojing device ', 'type' => 'string', 'example' => '41c95c18a0a643bcb58edf438877def5'], + 'DeviceName' => ['title' => '', 'description' => 'Device name', 'type' => 'string', 'example' => 'IN糖酒店版'], + 'OnlineStatus' => ['title' => '', 'description' => 'Device online status. 1: online, 0: offline ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Mac' => ['title' => '', 'description' => 'Device MAC address ', 'type' => 'string', 'example' => 'fa:03:23:58:c3:00'], + 'Sn' => ['title' => '', 'description' => 'Device serial number (SN) ', 'type' => 'string', 'example' => 'sag42dlz4qf'], + 'FirmwareVersion' => ['title' => '', 'description' => 'Device firmware version', 'type' => 'string', 'example' => '6.1.8-RS-20230425.1806'], + 'ActiveTime' => ['title' => '', 'description' => 'Device activation time ', 'type' => 'string', 'example' => '2023-01-01 12:00:00'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'RoomServiceInfo' => [ + 'title' => '', + 'description' => 'Guest service request information', + 'type' => 'object', + 'properties' => [ + 'RoomServiceCnt' => ['title' => '', 'description' => 'Configured service quantity, such as laundry service ', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'RepairServiceCnt' => ['title' => '', 'description' => 'Configured repair request quantity, such as a broken TV ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'GoodsServiceCnt' => ['title' => '', 'description' => 'Quantity of configured items, such as "I need a pack of tissues."', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'BookServiceCnt' => ['title' => '', 'description' => 'Configured booking quantity, such as booking a spa session ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', + ], + 'OtherService' => [ + 'title' => '', + 'description' => 'Other information ', + 'type' => 'object', + 'properties' => [ + 'OpenCall' => ['title' => '', 'description' => 'Whether voice calling is enabled ', 'type' => 'boolean', 'example' => 'false'], + 'UnhandleTickets' => ['title' => '', 'description' => 'Number of remaining unprocessed tickets ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', ], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is providing a brief description of a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => null, + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"HotelName\\": \\"xx酒店\\",\\n \\"CreatorAccountName\\": \\"xx淘宝昵称\\",\\n \\"ConnectType\\": \\"rcu\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"RoomControlInfo\\": {\\n \\"TemplateId\\": 1170,\\n \\"TemplateName\\": \\"大床房\\",\\n \\"AppId\\": 78,\\n \\"AppName\\": \\"app\\",\\n \\"RcuUrl\\": \\"http://www.xxx.com\\",\\n \\"DeviceInfos\\": [\\n {\\n \\"DeviceName\\": \\"阅读灯\\",\\n \\"CategoryId\\": 3,\\n \\"CategoryEnName\\": \\"light\\",\\n \\"CategoryName\\": \\"灯\\",\\n \\"LocationId\\": 1,\\n \\"LocationEnName\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"DeviceId\\": \\"readLight\\",\\n \\"DeviceConnectType\\": \\"rcu\\",\\n \\"ProductKey\\": \\"a1ueWGP6W2L\\",\\n \\"DeviceCount\\": 4\\n }\\n ]\\n },\\n \\"AuthAccounts\\": [\\n {\\n \\"AccountName\\": \\"xx淘宝昵称\\",\\n \\"AuthTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"DeviceInfos\\": [\\n {\\n \\"Uuid\\": \\"41c95c18a0a643bcb58edf438877def5\\",\\n \\"DeviceName\\": \\"IN糖酒店版\\",\\n \\"OnlineStatus\\": 1,\\n \\"Mac\\": \\"fa:03:23:58:c3:00\\",\\n \\"Sn\\": \\"sag42dlz4qf\\",\\n \\"FirmwareVersion\\": \\"6.1.8-RS-20230425.1806\\",\\n \\"ActiveTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"RoomServiceInfo\\": {\\n \\"RoomServiceCnt\\": 12,\\n \\"RepairServiceCnt\\": 10,\\n \\"GoodsServiceCnt\\": 10,\\n \\"BookServiceCnt\\": 0\\n },\\n \\"OtherService\\": {\\n \\"OpenCall\\": false,\\n \\"UnhandleTickets\\": 0\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Query room details ', + 'description' => 'The following query methods are provided:'."\n" + .'- Hotel ID + room number: Query hotel-related information and all CatGenie device information under the room.'."\n" + .'- CatGenie device UUID: Query information for a single CatGenie device and the corresponding hotel-related information.'."\n" + .'- CatGenie device MAC address: Query information for a single CatGenie device and the corresponding hotel-related information.'."\n" + .'- CatGenie device SN: Query information for a single CatGenie device and the corresponding hotel-related information.', + 'changeSet' => [], ], - 'DeviceControl' => [ - 'summary' => '设备控制', - 'path' => '/v1.0/ip/deviceControl', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'QueryRoomControlDevices' => [ + 'summary' => 'Query the list of guest room control devices, excluding information such as status ', + 'path' => '/v1.0/ip/queryRoomControlDevices', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', + 'name' => 'HotelId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '', - 'type' => 'string', - ], - 'Location' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'room', - 'title' => '位置，例如room(房间)，livingroom(客厅)等', - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aircondition', - 'title' => '客控设备品类，例如aircondition(空调)，light(灯)等', - ], - 'Cmd' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'open', - 'title' => '指令名称，例如open，close，详细支持指令见酒店行业对接文档', - ], - 'Properties' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'value', - 'description' => '', - 'title' => '可选配置，执行部分指令时需要附加的参数，例如设置空调温度时，需要附加需要调到的温度值，详细参数见酒店行业对接文档', - ], - 'title' => '可选配置，执行部分指令时需要附加的参数，例如设置空调温度时，需要附加需要调到的温度值，详细参数见酒店行业对接文档', - ], - 'ExtendInfo' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - 'title' => '扩展信息，预留字段', - ], - 'DeviceNumber' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'air_condition', - 'title' => '设备编号，即在天猫精灵行业管理平台房型客控品类设置下设备的序列号', - ], - ], - 'required' => false, - 'title' => '业务参数', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], ], [ - 'name' => 'UserInfo', + 'name' => 'RoomNo', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - 'title' => '编码类型，此处填写 **HOTEL**。', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - 'title' => '编码类型对应的值，此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'title' => '用户Id的类型'."\n" - ."\n" - .'- OPEN_ID：默认的用户ID标识。'."\n" - .'- UNION_ID: 组织维度的用户ID标识，需要提前在开放平台申请组织。', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - 'title' => '用户标识，设置为userOpenId或userUnionId。', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - ], - ], - 'required' => false, - 'title' => '用户标识信息', - ], + 'schema' => ['description' => 'Room number', 'type' => 'string', 'required' => true, 'example' => '1211', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回结果对象', - 'description' => '', + 'title' => 'Result<List<ListHotelMessageTemplate>>', + 'description' => 'Return Result object ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，200表示成功', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Invocation return code; apart from the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - 'title' => '业务执行结果状态，200为执行成功', + 'title' => '', + 'description' => 'List of guest room control devices ', + 'type' => 'array', + 'items' => [ + 'description' => 'Device Information ', + 'type' => 'object', + 'properties' => [ + 'Location' => ['description' => 'Location information, such as room', 'type' => 'string', 'example' => 'room', 'title' => ''], + 'LocationName' => ['description' => 'Location name, such as "channel"', 'type' => 'string', 'example' => '房间', 'title' => ''], + 'Devices' => [ + 'description' => 'Device list ', + 'type' => 'array', + 'items' => [ + 'description' => 'Device Information ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Device type, such as:'."\n" + ."\n" + .'- light: light'."\n" + .'- aircondition: air conditioner', 'type' => 'string', 'example' => 'light', 'title' => ''], + 'Number' => ['description' => 'Device number ', 'type' => 'string', 'example' => 'night_light', 'title' => ''], + 'DeviceName' => ['description' => 'Device name, such as "night light"', 'type' => 'string', 'example' => '小夜灯', 'title' => ''], + 'ConnectType' => ['description' => 'Device connection type', 'title' => 'Device connection type: rcu/infrared', 'type' => 'string', 'example' => 'rcu:RCU设备'."\n" + .'infrared:红外设备'], + 'PK' => ['description' => 'The pid of the Mesh device trituple ', 'type' => 'string', 'example' => '50255129', 'title' => ''], + 'DN' => ['description' => 'The deviceName of the Mesh device trituple ', 'type' => 'string', 'example' => '3c5d2ab8f9ec', 'title' => ''], + 'DeviceStatus' => ['description' => 'Device status ', 'type' => 'string', 'example' => '{"powerstate": "1"}', 'title' => ''], + 'AliasList' => [ + 'description' => 'List of device aliases ', + 'type' => 'array', + 'items' => ['description' => 'Device alias ', 'type' => 'string', 'example' => '卫生间灯', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MultiKeySwitchExt' => [ + 'description' => 'Device information for multi-key Toggle class devices ', + 'type' => 'object', + 'properties' => [ + 'SwitchList' => [ + 'description' => 'Toggle List ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceIndex' => ['description' => 'Ordinal number of a multi-key switch device ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ElementCode' => ['description' => 'The elementCode corresponding to a multi-element device ', 'type' => 'string', 'example' => 'e2', 'title' => ''], + 'Category' => ['description' => 'Device category ', 'type' => 'string', 'example' => 'light', 'title' => ''], + 'Location' => ['description' => 'Location information ', 'type' => 'string', 'example' => 'room', 'title' => ''], + 'DeviceName' => ['description' => 'Device alias ', 'type' => 'string', 'example' => '廊灯', 'title' => ''], + 'DeviceStatus' => ['description' => 'Device status ', 'type' => 'string', 'example' => '{'."\n" + .' "powerstate": "0"'."\n" + .'}', 'title' => ''], + 'AliasList' => [ + 'description' => 'Alias list of the sub-device ', + 'type' => 'array', + 'items' => ['description' => 'Device alias ', 'type' => 'string', 'example' => '卫生间灯', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', - 'title' => '请求id', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'fdsgfdscvre', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": \\"200\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<DeviceControlResponse>\\n <Code>200</Code>\\n <Result>\\n <Status>200</Status>\\n </Result>\\n <Message>success</Message>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</DeviceControlResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"ConnectType\\": \\"rcu:RCU设备\\\\ninfrared:红外设备\\",\\n \\"PK\\": \\"50255129\\",\\n \\"DN\\": \\"3c5d2ab8f9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"fdsgfdscvre\\"\\n}","type":"json"}]', + 'title' => 'Query room guest control devices', + 'changeSet' => [], ], - 'ListHotelSceneItem' => [ - 'summary' => '服务项目', - 'path' => '/v1.0/ip/listHotelSceneItem', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'QueryRoomControlDevicesAndStatus' => [ + 'summary' => 'Query the controlled devices in a channel, including device status ', + 'path' => '/v1.0/ip/queryRoomControlDevicesAndStatus', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '场景服务payload', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1345480696877233314', - ], - 'Type' => [ - 'title' => '场景服务分类', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GOODS', - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => false, 'example' => ' '."\n" + .'af7***536'."\n", 'title' => ''], ], [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1248494721591392955', - ], - 'IdType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => ['description' => 'Channel number ', 'type' => 'string', 'required' => false, 'example' => '1211'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PageResult<ListItemResponse>', - 'description' => 'PageResult<ListItemResponse>', + 'title' => 'Result<List<LocationDevices>>', + 'description' => 'Result<List<LocationDevices>>', 'type' => 'object', 'properties' => [ - 'Page' => [ - 'title' => '分页结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'title' => '共多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'TotalPage' => [ - 'title' => '共多少页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'HasNext' => [ - 'title' => '是否有下一页', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'The return code used for POP responses. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SecondCategoryList' => [ - 'title' => '服务分类list', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SecondCategoryName' => [ - 'title' => '分类名称', - 'description' => '', - 'type' => 'string', - 'example' => '客用品类', - ], - 'ItemList' => [ - 'type' => 'array', - 'items' => [ + 'title' => '', + 'description' => 'The actual return result of the service. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Device content ', + 'type' => 'object', + 'properties' => [ + 'RoomNo' => ['description' => 'Channel number ', 'type' => 'string', 'example' => '1211', 'title' => ''], + 'Location' => ['title' => '*', 'description' => 'Location information, such as "room" ', 'type' => 'string', 'example' => 'room'], + 'LocationName' => ['title' => '', 'description' => 'Location name in Chinese', 'type' => 'string', 'example' => '房间'], + 'Devices' => [ + 'description' => 'List of devices. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Device Information ', + 'type' => 'object', + 'properties' => [ + 'ConnectType' => ['title' => '', 'description' => 'Device connection type ', 'type' => 'string', 'example' => 'rcu'], + 'Name' => ['title' => '', 'description' => 'Device category, such as: '."\n" + ."\n" + .'light: light '."\n" + .'aircondition: air conditioner ', 'type' => 'string', 'example' => 'light'], + 'Number' => ['title' => '', 'description' => 'UUID of the device ', 'type' => 'string', 'example' => 'night_light'], + 'DeviceName' => ['description' => 'Device name, such as "night light" ', 'type' => 'string', 'example' => '小夜灯', 'title' => ''], + 'Brand' => ['title' => '', 'description' => 'Infrared parameters ', 'type' => 'string', 'example' => '奥*斯'], + 'ServiceProvider' => ['description' => 'Service provider (infrared device information) ', 'type' => 'string', 'example' => '吉视传媒****', 'title' => ''], + 'Province' => ['description' => 'Province (infrared device information) ', 'type' => 'string', 'example' => '吉林省', 'title' => ''], + 'City' => ['description' => 'City (infrared device information) ', 'type' => 'string', 'example' => '松原市', 'title' => ''], + 'InfraredIndex' => ['description' => 'Infrared code library index ', 'type' => 'string', 'example' => '2', 'title' => ''], + 'InfraredId' => ['description' => 'Infrared code library ID ', 'type' => 'string', 'example' => '9**7', 'title' => ''], + 'InfraredVersion' => ['description' => 'Infrared code library version number ', 'type' => 'string', 'example' => '3.0', 'title' => ''], + 'Pk' => ['title' => '', 'description' => 'PID of the mesh device trituple ', 'type' => 'string', 'example' => '50255129'], + 'Dn' => ['description' => 'deviceName of the Mesh device trituple ', 'type' => 'string', 'example' => '3c5d***9ec', 'title' => ''], + 'DeviceStatus' => ['title' => '', 'description' => 'Device status ', 'type' => 'string', 'example' => '{"powerstate": "1"}'], + 'MultiKeySwitchExt' => [ + 'title' => '', + 'description' => 'Sub-device information for multi-key Toggle ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '物品ID', - 'description' => '', - 'type' => 'string', - 'example' => '152860', - ], - 'Type' => [ - 'title' => '物品分类', - 'description' => '', - 'type' => 'string', - 'example' => 'GOODS', - ], - 'Category' => [ - 'title' => '物品二级分类', - 'description' => '', - 'type' => 'string', - 'example' => '客用品类', - ], - 'Name' => [ - 'title' => '物品名称', - 'description' => '', - 'type' => 'string', - 'example' => '棉签', - ], - 'Status' => [ - 'title' => '物品状态', - 'description' => '', - 'type' => 'string', - 'example' => '已添加', - ], - 'Icon' => [ - 'title' => '物品icon', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png', - ], - 'Price' => [ - 'title' => '物品价格', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ResidueLimit' => [ - 'title' => '剩余下单数量'."\n" - .' -1表示 不限制 0表示无剩余下单量 >0为可下单的数量', - 'type' => 'integer', - 'format' => 'int64', + 'SwitchList' => [ + 'title' => '', + 'description' => 'List of Toggle buttons', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Category' => ['title' => '', 'description' => 'English name of the associated device category ', 'type' => 'string', 'example' => 'light'], + 'Location' => ['title' => '', 'description' => 'Associated device location ', 'type' => 'string', 'example' => 'room'], + 'DeviceName' => ['title' => '', 'description' => 'Device name', 'type' => 'string', 'example' => '廊灯'], + 'AliasList' => [ + 'title' => '', + 'description' => 'Device alias list ', + 'type' => 'array', + 'items' => ['description' => 'Device alias ', 'type' => 'string', 'example' => '卫生间灯', 'title' => ''], + 'example' => '', + ], + 'DeviceIndex' => ['title' => '', 'description' => 'Device ordinal number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ElementCode' => ['title' => '', 'description' => 'Ordinal number of the IoT multi-element device ', 'type' => 'string', 'example' => 'e2'], + 'DeviceStatus' => ['title' => '', 'description' => 'Sub-device status ', 'type' => 'string', 'example' => '{'."\n" + .' "powerstate": "0"'."\n" + .'}'], + 'Tags' => [ + 'title' => '', + 'description' => 'Sub-device tags ', + 'type' => 'array', + 'items' => ['description' => 'Tag ', 'type' => 'string', 'example' => 'SOS', 'title' => ''], + 'example' => '', + ], + 'Status' => [ + 'title' => '', + 'description' => 'Device Thing Specification Language model status '."\n" + .'Thing Specification Language model information. For more details, see the following document link: https://www.aligenie.com/docs/business/5189157 ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'Thing Specification Language model information. For more details, see the following document link: https://www.aligenie.com/docs/business/5189157 ', 'example' => '"doorStatus":{"time":1725347306741,"value":"0"}', 'title' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', + ], + 'AliasList' => [ + 'title' => '', + 'description' => 'List of device aliases ', + 'type' => 'array', + 'items' => ['description' => 'Device alias ', 'type' => 'string', 'example' => '卫生间灯', 'title' => ''], + 'example' => '', + ], + 'Status' => [ + 'title' => '', + 'description' => 'Device Thing Specification Language model status. '."\n" + .'For details about the Thing Specification Language model, see the following document link: https://www.aligenie.com/docs/business/5189157', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'onlinestate":{"time":1725347364693,"value":"online"}', 'description' => 'Thing Specification Language model information. For details, see the following document link: https://www.aligenie.com/docs/business/5189157 ', 'title' => ''], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97', - ], + 'Message' => ['title' => '', 'description' => 'Additional information. A typical scenario is providing a brief description for a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '73C67***6FA'."\n", 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"TotalPage\\": 6,\\n \\"HasNext\\": true\\n },\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"SecondCategoryList\\": [\\n {\\n \\"SecondCategoryName\\": \\"客用品类\\",\\n \\"ItemList\\": [\\n {\\n \\"Id\\": \\"152860\\",\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 1,\\n \\"ResidueLimit\\": 2\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CEADB586-51CB-1B6B-95BD-AB85A7A08E97\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"1211\\",\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"ConnectType\\": \\"rcu\\",\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"Brand\\": \\"奥*斯\\",\\n \\"ServiceProvider\\": \\"吉视传媒****\\",\\n \\"Province\\": \\"吉林省\\",\\n \\"City\\": \\"松原市\\",\\n \\"InfraredIndex\\": \\"2\\",\\n \\"InfraredId\\": \\"9**7\\",\\n \\"InfraredVersion\\": \\"3.0\\",\\n \\"Pk\\": \\"50255129\\",\\n \\"Dn\\": \\"3c5d***9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"Tags\\": [\\n \\"SOS\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"\\\\\\"doorStatus\\\\\\":{\\\\\\"time\\\\\\":1725347306741,\\\\\\"value\\\\\\":\\\\\\"0\\\\\\"}\\"\\n }\\n }\\n ]\\n },\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"onlinestate\\\\\\":{\\\\\\"time\\\\\\":1725347364693,\\\\\\"value\\\\\\":\\\\\\"online\\\\\\"}\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Query channel guest control devices and device status ', + 'changeSet' => [], ], - 'ListHotelServiceCategory' => [ - 'summary' => '服务分类列表', - 'path' => '/v1.0/ip/listHotelServiceCategory', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'QueryRoomStatus' => [ + 'summary' => 'Query channel status information ', + 'path' => '/v1.0/ip/queryRoomStatus', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '服务分类', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '服务分类类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOTEL_SERVICE', - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => false, 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', 'title' => ''], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Channel number', 'type' => 'string', 'required' => false, 'example' => '1211'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<SceneServiceCategory>>', - 'description' => 'Result<List<SceneServiceCategory>>', + 'title' => 'Result<OpenRoomStatusDetailResponse>', + 'description' => 'Result<OpenRoomStatusDetailResponse>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code; apart from the convention-defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['title' => '', 'description' => 'Invocation return code used for POP responses ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '服务分类类型', - 'description' => '', - 'type' => 'string', - 'example' => 'HOTEL_SERVICE', - ], - 'Code' => [ - 'title' => '服务分类code', - 'description' => '', - 'type' => 'string', - 'example' => 'GOODS', - ], - 'Name' => [ - 'title' => '服务分类名称', - 'description' => '', - 'type' => 'string', - 'example' => '物品添加', - ], - 'Desc' => [ - 'title' => '服务分类描述', - 'description' => '', - 'type' => 'string', - 'example' => '生活及洗漱用品', + 'title' => '', + 'description' => 'Actual return result of the service ', + 'type' => 'object', + 'properties' => [ + 'HotelId' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7'], + 'RoomNo' => ['title' => '', 'description' => 'Channel number ', 'type' => 'string', 'example' => '1211'], + 'StatusList' => [ + 'title' => '', + 'description' => 'Content of channel status properties ', + 'type' => 'array', + 'items' => [ + 'description' => 'Status content ', + 'type' => 'object', + 'properties' => [ + 'StatusName' => ['description' => 'Status name', 'type' => 'string', 'example' => '清理模式：mur'."\n" + .'勿扰模式：dnd '."\n" + .'sos呼叫：sos'."\n" + .'doorStatus:门状态'."\n" + .'stateOfMagneticInduction：插卡取电状态'."\n" + .'wifiStatus：房间联网状态'."\n" + .'roomPowerState:房间上电状态 1上电 0断电'."\n" + .'roomEcoMode:房间节能模式 1节能模式下 0非节能模式', 'title' => ''], + 'StatusValue' => ['description' => 'Status content', 'type' => 'string', 'example' => 'true 打开'."\n" + .'false 关闭', 'title' => ''], + 'UpdateTime' => ['description' => 'Update Time', 'type' => 'string', 'example' => 'Thu Jan 09 13:56:51 CST 2025', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Icon' => [ - 'title' => '服务分类icon', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png', + 'example' => '', + ], + 'SceneList' => [ + 'title' => '', + 'description' => 'Channel scenarios', + 'type' => 'array', + 'items' => [ + 'description' => 'Scenario list', + 'type' => 'object', + 'properties' => [ + 'SceneName' => ['description' => 'Scenario name', 'type' => 'string', 'example' => '睡眠模式', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '5373C821-65D2-1764-B9F9-951914937FF5', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Type\\": \\"HOTEL_SERVICE\\",\\n \\"Code\\": \\"GOODS\\",\\n \\"Name\\": \\"物品添加\\",\\n \\"Desc\\": \\"生活及洗漱用品\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5373C821-65D2-1764-B9F9-951914937FF5\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"StatusList\\": [\\n {\\n \\"StatusName\\": \\"清理模式：mur\\\\n勿扰模式：dnd \\\\nsos呼叫：sos\\\\ndoorStatus:门状态\\\\nstateOfMagneticInduction：插卡取电状态\\\\nwifiStatus：房间联网状态\\\\nroomPowerState:房间上电状态 1上电 0断电\\\\nroomEcoMode:房间节能模式 1节能模式下 0非节能模式\\",\\n \\"StatusValue\\": \\"true 打开\\\\nfalse 关闭\\",\\n \\"UpdateTime\\": \\"Thu Jan 09 13:56:51 CST 2025\\"\\n }\\n ],\\n \\"SceneList\\": [\\n {\\n \\"SceneName\\": \\"睡眠模式\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]', + 'title' => 'Query room status information', + 'changeSet' => [], ], - 'GetHotelOrderDetail' => [ - 'summary' => '获取酒店订单详情', - 'path' => '/v1.0/ip/getHotelOrderDetail', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QuerySceneList' => [ + 'summary' => 'Query the list of hotel scenarios ', + 'path' => '/v1.0/ip/querySceneList', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'query', + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], + ], + [ + 'name' => 'SceneTypes', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '订单详情payload', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OrderNo' => [ - 'title' => '订单号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '20220714150702000168270112410630', - ], - ], - 'required' => true, - 'docRequired' => true, + 'title' => '', + 'description' => 'Scenario set to pass (common: common; custom: custom) ', + 'type' => 'array', + 'items' => ['description' => 'common or custom ', 'type' => 'string', 'required' => false, 'example' => 'common', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'SceneStates', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Scenario status set to pass (1 – associated, 0 – not associated) ', + 'type' => 'array', + 'items' => ['description' => '0 or 1 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TemplateInfoIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Room type ID ', + 'type' => 'array', + 'items' => ['description' => 'Room type ID ', 'type' => 'string', 'required' => false, 'example' => '999', 'title' => ''], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelOrderDetail>>', - 'description' => 'Result<List<HotelOrderDetail>>', + 'title' => 'Result<List<HotelSceneWrapperResp>>', + 'description' => 'Result<List<HotelSceneWrapperResp>>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'StatusCode' => ['title' => '', 'description' => 'Invocation return code; except for the conventionally defined SUCCESS_CODE, all others are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Results' => [ + 'title' => '', + 'description' => 'The actual return result of the service ', 'type' => 'array', 'items' => [ + 'description' => 'List of results. ', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '物品名称', - 'description' => '', - 'type' => 'string', - 'example' => '窗帘', - ], - 'ApplyAmt' => [ - 'title' => '物品金额', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Quantity' => [ - 'title' => '物品数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ItemUrl' => [ - 'title' => '物品icon', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png', - ], - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1659952892000', + 'SceneId' => ['title' => '', 'description' => 'Scenario ID ', 'type' => 'string', 'example' => '73'], + 'SceneName' => ['title' => '', 'description' => 'Scenario name ', 'type' => 'string', 'example' => '睡眠模式'], + 'Icon' => ['title' => '', 'description' => 'Scenario icon ', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png'], + 'SceneSource' => ['title' => '', 'description' => 'Scenario source; scenario source; genie or external ', 'type' => 'string', 'example' => 'external'], + 'SceneType' => ['title' => '', 'description' => 'Scenario type: public: common; custom: custom ', 'type' => 'string', 'example' => 'common'], + 'SceneState' => ['title' => '', 'description' => 'Association status between scenario and room category (1 – associated, 0 – not associated, -1 – unassociable) ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UnavailableReason' => ['title' => '', 'description' => 'Reason why the association status between the scenario and room type is -1 (unassociable) ', 'type' => 'string', 'example' => '不可关联'], + 'TemplateInfoDTOList' => [ + 'title' => '', + 'description' => 'Associated room categories ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Room category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '6962'], + 'Name' => ['title' => '', 'description' => 'Room category name ', 'type' => 'string', 'example' => '101'], + 'Description' => ['title' => '', 'description' => 'Description ', 'type' => 'string', 'example' => '房型描述'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '6F579407-13C4-1708-AFA2-B657BE5FE8F5', - ], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"窗帘\\",\\n \\"ApplyAmt\\": 200,\\n \\"Quantity\\": 1,\\n \\"ItemUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png\\",\\n \\"GmtCreate\\": 1659952892000\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6F579407-13C4-1708-AFA2-B657BE5FE8F5\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Results\\": [\\n {\\n \\"SceneId\\": \\"73\\",\\n \\"SceneName\\": \\"睡眠模式\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png\\",\\n \\"SceneSource\\": \\"external\\",\\n \\"SceneType\\": \\"common\\",\\n \\"SceneState\\": 1,\\n \\"UnavailableReason\\": \\"不可关联\\",\\n \\"TemplateInfoDTOList\\": [\\n {\\n \\"Id\\": 6962,\\n \\"Name\\": \\"101\\",\\n \\"Description\\": \\"房型描述\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]', + 'title' => 'Query hotel scenario list ', + 'description' => 'Query the list of hotel scenarios based on the request parameters. ', + 'changeSet' => [], ], - 'ListHotelOrder' => [ - 'summary' => '酒店订单列表', - 'path' => '/v1.0/ip/listHotelOrder', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveChildAccountAuth' => [ + 'summary' => 'Delete RAM user authorization ', + 'path' => '/v1.0/ip/removeChildAccountAuth', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '酒店订单列表payload', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1345480696877233314', - ], - 'Page' => [ - 'title' => '分页参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Taobao Open ID of the authorizer (platform logon user) ', 'type' => 'string', 'required' => true, 'example' => 'AAEV***E3d3Z2ETwh'], ], [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1248494721591392955', - ], - 'IdType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'AppKey of the Taobao Open Platform ', 'type' => 'string', 'required' => true, 'example' => '30**53'], + ], + [ + 'name' => 'ChildAccountName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Taobao account name of the authorized account ', 'type' => 'string', 'required' => true, 'example' => 'tbxxxx'], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PageResult<List<HotelOrderListResp>>', - 'description' => 'PageResult<List<HotelOrderListResp>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Page' => [ - 'title' => '分页结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'title' => '共多少条数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '21', - ], - 'TotalPage' => [ - 'title' => '共多少页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'HasNext' => [ - 'title' => '是否有下一页', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RoomNo' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'example' => '2001', - ], - 'OrderNo' => [ - 'title' => '订单号', - 'description' => '', - 'type' => 'string', - 'example' => '20220808180132000114508555527711', - ], - 'Quantity' => [ - 'title' => '共多少个物品', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'ApplyAmt' => [ - 'title' => '共需要多少钱', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21.5', - ], - 'Status' => [ - 'title' => '订单状态', - 'description' => '', - 'type' => 'string', - 'example' => 'INIT', - ], - 'GmtCreate' => [ - 'title' => '订单创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1659952892000', - ], - 'Type' => [ - 'title' => '订单商品所属分类', - 'description' => '', - 'type' => 'string', - 'example' => 'REPAIR', - ], - 'TypeName' => [ - 'title' => '订单物品所属分类名称', - 'description' => '', - 'type' => 'string', - 'example' => '设备维修', - ], - 'TypeIconUrl' => [ - 'title' => '订单物品所属分类icon', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png', - ], - 'Amt' => [ - 'title' => '单价', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Icon' => [ - 'title' => '商品图片', - 'type' => 'string', - ], - 'Name' => [ - 'title' => '商品名称', - 'type' => 'string', - ], - 'ItemType' => [ - 'title' => '商品类型', - 'type' => 'string', - ], - 'ItemId' => [ - 'title' => '商品id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'DeliveryTime' => [ - 'title' => '商品预计送达时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'PaymentMethod' => [ - 'title' => '商品结算方式', - 'type' => 'string', - ], - 'StartTime' => [ - 'title' => '数据查询开始时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SumAmt' => [ - 'title' => '当前入住下单汇总金额', - 'type' => 'integer', - 'format' => 'int64', - ], - 'OrderStatus' => [ - 'title' => '订单状态', - 'type' => 'string', - ], - 'DeliveryRoomName' => [ - 'title' => '配送房间名称', - 'type' => 'string', - ], - 'DeliveryMethod' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '07F61FDA-606F-10A0-8ED0-C6CE62710A48', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. A value of 200 indicates success. For non-200 values, see the error code lookup table for details ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'True'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'F12B***F34E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21,\\n \\"TotalPage\\": 7,\\n \\"HasNext\\": true\\n },\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"2001\\",\\n \\"OrderNo\\": \\"20220808180132000114508555527711\\",\\n \\"Quantity\\": 12,\\n \\"ApplyAmt\\": 21.5,\\n \\"Status\\": \\"INIT\\",\\n \\"GmtCreate\\": 1659952892000,\\n \\"Type\\": \\"REPAIR\\",\\n \\"TypeName\\": \\"设备维修\\",\\n \\"TypeIconUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png\\",\\n \\"Amt\\": 0,\\n \\"Icon\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ItemType\\": \\"\\",\\n \\"ItemId\\": 0,\\n \\"DeliveryTime\\": 0,\\n \\"PaymentMethod\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"SumAmt\\": 0,\\n \\"OrderStatus\\": \\"\\",\\n \\"DeliveryRoomName\\": \\"\\",\\n \\"DeliveryMethod\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"07F61FDA-606F-10A0-8ED0-C6CE62710A48\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B***F34E\\"\\n}","type":"json"}]', + 'title' => 'Delete RAM user authorization ', + 'changeSet' => [], ], - 'SubmitHotelOrder' => [ - 'summary' => '提交酒店订单', - 'path' => '/v1.0/ip/submitHotelOrder', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveHotel' => [ + 'summary' => 'Delete hotel information.', + 'path' => '/v1.0/ip/removeHotel', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '提交订单payload', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1345480696877233314', - ], - 'Type' => [ - 'title' => '物品所属分类', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GOODS', - ], - 'ItemList' => [ - 'title' => '物品list', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemId' => [ - 'title' => '物品ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '152860', - ], - 'Quantity' => [ - 'title' => '物品数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], - 'Remark' => [ - 'title' => '备注', - 'type' => 'string', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Taobao Open ID', 'type' => 'string', 'required' => true, 'example' => 'AAEVK***UE3d3Z2ETwh'], ], [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1248494721591392955', - ], - 'IdType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => ['description' => 'appkey', 'type' => 'string', 'required' => true, 'example' => '30193305', 'title' => ''], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'], ], ], 'responses' => [ @@ -14346,1516 +7752,1020 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '订单号', - 'description' => '', - 'type' => 'string', - 'example' => '20220809104752000114671478353329', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CCCF2E86-D9B5-12A6-AD25-8A06933D2B0F', - ], - 'StatusCode' => [ - 'type' => 'integer', - 'format' => 'int32', + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the convention-defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is to provide a brief description of a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension field', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'extension information', 'example' => '{}', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"20220809104752000114671478353329\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CCCF2E86-D9B5-12A6-AD25-8A06933D2B0F\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'title' => 'Delete Hotel', + 'description' => 'Delete hotel information.', + 'changeSet' => [], ], - 'GetHotelNotice' => [ - 'summary' => '获取酒店通知', - 'path' => '/v1.0/ip/getHotelNotice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ResetWelcomeTextAndMusic' => [ + 'summary' => 'Reset welcome message configuration ', + 'path' => '/v1.0/ip/resetWelcomeTextAndMusic', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<String>', - 'description' => 'Result<String>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'string', - 'example' => 'test notice...', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'RequestId', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation; 200 indicates success ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information; typical scenario is providing a brief description for failed invocations to help the caller troubleshoot issues ', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension field ', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'extension information ', 'example' => ' ', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7*726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"test notice...\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" \\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Reset welcome message configuration ', + 'description' => 'Reset the welcome message configuration to the default settings: '."\n" + .'- Welcome message text: Dear guest, hello! Welcome to your stay. I am your channel\'s Intelligent Assistant. I can play music, control the air conditioner, lighting, and more, as well as provide various hotel services and answer hotel-related questions. Simply wake me up to start interacting with me. For more of my capabilities, please refer to the stand card next to me. We wish you a pleasant stay at our hotel. '."\n" + .'- Background audio Link: http://ailabsaicloudservice.alicdn.com/tmp/a.wav ', + 'changeSet' => [], ], - 'GetHotelNoticeV2' => [ - 'summary' => '获取酒店通知', - 'path' => '/v1.0/ip/getHotelNoticeV2', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'RoomCheckOut' => [ + 'summary' => 'Clicking Check-out on the device panel initiates an informal check-out process, which only sends a ticket and prompts the user to check out at the front desk.', + 'path' => '/v1.0/ip/roomCheckOut', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户信息', - 'description' => '', + 'description' => 'User identification information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'EncodeType' => ['description' => 'Encoding type. Enter **HOTEL** here.', 'type' => 'string', 'required' => true, 'example' => 'HOTEL', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type. Enter the application ID of the hotel here. You can view it in the Tmall Genie Industry Management Platform.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of the User ID'."\n" + ."\n" + .'- OPEN_ID: The default User ID identifier.'."\n" + .'- UNION_ID: The organization-dimension User ID identifier. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], - 'required' => true, - 'docRequired' => true, + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Device identification information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. Enter **HOTEL** here.', 'type' => 'string', 'required' => true, 'example' => 'HOTEL', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. Enter the hotel application ID here. You can find it in the Tmall Genie Industry Management Platform.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of the device ID.'."\n" + ."\n" + .'- OPEN_ID: Default device ID identifier.'."\n" + .'- UNION_ID: Organization-level device ID identifier. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User identifier. Set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HotelNotice>', - 'description' => 'Result<HotelNotice>', + 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', + 'description' => 'Return Result object', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，200标识成功', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'Title' => [ - 'title' => '酒店通知标题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Content' => [ - 'title' => '酒店通知内容', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => '0D0C***67DB', - ], + 'Code' => ['title' => '', 'description' => 'Return code of the invocation. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['description' => 'Indicates whether the execution succeeded or failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'dsvrevd', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Title\\": \\"欢迎入住智能酒店\\",\\n \\"Content\\": \\"欢迎入住，我是您的智能语音助手\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"dsvrevd\\"\\n}","type":"json"}]', + 'title' => 'Check-out', + 'changeSet' => [], ], - 'GetHotelHomeBackImageAndModes' => [ - 'summary' => '获取首页背景图和场景模式', - 'path' => '/v1.0/ip/getHotelHomeBackImageAndModes', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'SubmitHotelOrder' => [ + 'summary' => 'Submit an order, such as an order for items or reserved meals.', + 'path' => '/v1.0/ip/submitHotelOrder', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'UserInfo', + 'name' => 'Payload', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户信息', + 'title' => '', + 'description' => 'Payload for submitting an order', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1248494721591392955', - ], - 'IdType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'type' => 'string', + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1345480696877233314', 'description' => ''], + 'Type' => ['title' => '', 'description' => 'Categorization of the item', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GOODS'], + 'ItemList' => [ + 'title' => '', + 'description' => 'List of items', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemId' => ['title' => '', 'description' => 'Item ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '152860'], + 'Quantity' => ['title' => '', 'description' => 'Quantity of the item', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2'], + 'Remark' => ['description' => 'Remark ', 'title' => 'Remark ', 'type' => 'string', 'required' => false, 'example' => '备注信息'], + ], + 'required' => false, + 'description' => 'Item information', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', - ], - 'OrganizationId' => [ - 'type' => 'string', + 'example' => '', ], ], 'required' => true, 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'User information ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID', 'description' => 'Encoding type ', 'title' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955', 'description' => 'Encoding key ', 'title' => ''], + 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID', 'description' => 'ID type ', 'title' => ''], + 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', 'description' => 'ID ', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => 'Organization ID ', 'example' => '""', 'title' => ''], + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HomePageBackImageAndModes>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'type' => 'object', - 'properties' => [ - 'BackgroundImage' => [ - 'title' => '背景图URL', - 'type' => 'string', - 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhn.jpg', - ], - 'HotelName' => [ - 'title' => '酒店名称', - 'type' => 'string', - 'example' => '宣雍测试橙蜂酒店', - ], - 'ModeList' => [ - 'title' => '模式list', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '模式code', - 'type' => 'string', - 'example' => 'romantic', - ], - 'CnName' => [ - 'title' => '模式名称', - 'type' => 'string', - 'example' => '浪漫模式', - ], - 'Icon' => [ - 'title' => '模式icon', - 'type' => 'string', - 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/langman.png', - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'type' => 'string', - 'example' => '394450FC-9035-1B7C-8829-BC88832473FC', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Order ID', 'type' => 'string', 'example' => '20220809104752000114671478353329'], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'CCCF2E86-D9B5-12A6-AD25-8A06933D2B0F'], + 'StatusCode' => ['description' => 'Return code of the invocation. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => ' AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => null, + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"20220809104752000114671478353329\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CCCF2E86-D9B5-12A6-AD25-8A06933D2B0F\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'Submit Order', + 'description' => 'Submit an order, such as an order for items or reserved meals.', + 'changeSet' => [], ], - 'GetHotelSampleUtterances' => [ - 'summary' => '获取推荐语料', - 'path' => '/v1.0/ip/getHotelSampleUtterances', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'SyncDeviceStatusWithAk' => [ + 'summary' => 'Synchronize the status of guest room control (RCU) devices integrated via cloud-to-cloud integration to the Maojing side, where Maojing stores the status information or notifies the device side to update its status display.', + 'path' => '/v1.0/ip/syncDeviceStatusWithAk', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => true, - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - ], - 'IdType' => [ - 'type' => 'string', - 'required' => true, - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - ], - 'OrganizationId' => [ - 'type' => 'string', - ], - ], - ], + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'af7***536'], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Channel number', 'type' => 'string', 'required' => true, 'example' => '1211'], + ], + [ + 'name' => 'DeviceName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Device name ', 'type' => 'string', 'required' => false, 'example' => '床头灯'], + ], + [ + 'name' => 'Switch', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Toggle value: 0 for off, 1 for on', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'CategoryEnName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Device category English name ', 'type' => 'string', 'required' => true, 'example' => 'light'], + ], + [ + 'name' => 'CategoryCnName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'English name of the device category (optional)', 'type' => 'string', 'required' => false, 'example' => '灯'], + ], + [ + 'name' => 'Number', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Device ordinal number', 'type' => 'string', 'required' => true, 'example' => 'bedLight'], + ], + [ + 'name' => 'Location', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Location ', 'type' => 'string', 'required' => true, 'example' => 'room'], + ], + [ + 'name' => 'LocationCnName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Location Display Name (optional) ', 'type' => 'string', 'required' => false, 'example' => '房间'], + ], + [ + 'name' => 'mode', + 'in' => 'formData', + 'schema' => ['description' => 'Air conditioner mode '."\n" + .'- auto: automatic '."\n" + .'- cold: refrigeration '."\n" + .'- hot: heating', 'title' => 'Air conditioner parameter, such as refrigeration or heating mode', 'type' => 'string', 'required' => false, 'example' => 'auto'], + ], + [ + 'name' => 'fanSpeed', + 'in' => 'formData', + 'schema' => ['description' => 'Air conditioner fan speed; 1, 2, and 3 correspond to low, medium, and high speed respectively ', 'title' => 'Air conditioner field, fan speed ', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'temperature', + 'in' => 'formData', + 'schema' => ['description' => 'Air conditioner temperature ', 'title' => 'Air conditioner field, temperature ', 'type' => 'string', 'required' => false, 'example' => '22'], + ], + [ + 'name' => 'roomTemperature', + 'in' => 'formData', + 'schema' => ['description' => 'Room temperature', 'title' => 'Air conditioner field: current room temperature', 'type' => 'string', 'required' => false, 'example' => '21'], + ], + [ + 'name' => 'value', + 'in' => 'formData', + 'schema' => ['description' => 'Curtain opening degree; used only for curtain categories ', 'title' => 'Curtain and sheer curtain field, opening degree ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual result returned by the service, indicating whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used in failure scenarios to briefly describe the cause of the failure, helping the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => null, + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","type":"json"}]', + 'title' => 'Guest Room Control Device Status Synchronization', + 'changeSet' => [], ], - 'GetHotelScreenSaver' => [ - 'summary' => '获取酒店屏保', - 'path' => '/v1.0/ip/getHotelScreenSaver', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateBasicInfoQA' => [ + 'summary' => 'Modify the basic information Q&A feature under the general Q&A module. ', + 'path' => '/v1.0/ip/updateBasicInfoQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => 'af7***536'."\n", 'title' => ''], + ], + [ + 'name' => 'HotelAddress', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel Address ', 'type' => 'string', 'required' => true, 'example' => '浙江省杭州市xxxx'], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Front Desk Phone Number ', 'type' => 'string', 'required' => true, 'example' => '123***'], + ], + [ + 'name' => 'CheckInTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Check-in Time (format: xx:xx, hour:minute) ', 'type' => 'string', 'required' => true, 'example' => '11:11'."\n"], + ], + [ + 'name' => 'CheckOutTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Check-out time (format: xx:xx, hour:minute) ', 'type' => 'string', 'required' => true, 'example' => '11:11'], + ], + [ + 'name' => 'WifiName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Wi-Fi Name ', 'type' => 'string', 'required' => true, 'example' => '名称***'], + ], + [ + 'name' => 'WifiPassword', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Wi-Fi password ', 'type' => 'string', 'required' => true, 'example' => '密码***'], + ], + [ + 'name' => 'HotelMember', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Introduction to hotel membership ', 'type' => 'string', 'required' => false, 'example' => '会员***'], + ], + [ + 'name' => 'HotelService', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Introduction to the hotel\'s featured services ', 'type' => 'string', 'required' => false, 'example' => '服务***'], + ], + [ + 'name' => 'HotelIntroduction', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel Introduction ', 'type' => 'string', 'required' => false, 'example' => '酒店***'], + ], + [ + 'name' => 'ParkingPosition', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Parking location ', 'type' => 'string', 'required' => true, 'example' => '杭州市xx'], + ], + [ + 'name' => 'ParkingExpenses', + 'in' => 'formData', 'schema' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1248494721591392955', - ], - 'IdType' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==', - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], - ], + 'title' => '', + 'description' => 'Parking fee (free parking or paid parking)', + 'type' => 'string', 'required' => true, - 'docRequired' => true, + 'example' => '免费停车', + 'enum' => ['免费停车', '收费停车'], ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<HotelScreenSaver>', - 'description' => 'Result<HotelScreenSaver>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StyleCode' => [ - 'title' => '屏保样式code', - 'description' => '', - 'type' => 'string', - 'example' => 'common-weather', - ], - 'PicUrl' => [ - 'title' => '屏保图片', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg', - ], - ], - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '5F0467E1-19F2-1757-B6D0-B79917BA2E81', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '0EC7***726E'."\n", 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"StyleCode\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5F0467E1-19F2-1757-B6D0-B79917BA2E81\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Modify Basic Information Q&A ', + 'changeSet' => [], ], - 'RoomCheckOut' => [ - 'summary' => '退房', - 'path' => '/v1.0/ip/roomCheckOut', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateCustomQA' => [ + 'summary' => 'The feature for modifying custom Q&A pairs in the Custom Q&A module.', + 'path' => '/v1.0/ip/updateCustomQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', + 'name' => 'CustomQAId', + 'in' => 'formData', + 'schema' => ['description' => 'Custom Q&A ID', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], + ], + [ + 'name' => 'MajorQuestion', + 'in' => 'formData', + 'schema' => ['description' => 'Main question', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + ], + [ + 'name' => 'SupplementaryQuestions', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], + 'description' => 'List of supplementary questions', + 'type' => 'array', + 'items' => ['description' => 'Supplementary question', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DeviceInfo', - 'in' => 'query', + 'name' => 'KeyWords', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], + 'description' => 'List of keywords', + 'type' => 'array', + 'items' => ['description' => 'Keyword', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Answers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'List of answers', + 'type' => 'array', + 'items' => ['description' => 'Answer', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', - 'description' => '', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dsvrevd', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '73C6***BB3E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"dsvrevd\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***BB3E6FA\\"\\n}","type":"json"}]', + 'title' => 'Modify Custom Q&A', + 'changeSet' => [], ], - 'GetHotelContacts' => [ - 'summary' => '获取酒店联系人', - 'path' => '/v1.0/ip/getHotelContacts', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateHotel' => [ + 'summary' => 'Modify hotel information.', + 'path' => '/v1.0/ip/updateHotel', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Taobao Open ID ', 'type' => 'string', 'required' => true, 'example' => 'AAEVK***UE3d3Z2ETwh'], + ], + [ + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Open Platform appKey', 'type' => 'string', 'required' => true, 'example' => '31342884'], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'], + ], + [ + 'name' => 'HotelName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel Name ', 'type' => 'string', 'required' => false, 'example' => '天奥酒店'], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Remark ', 'type' => 'string', 'required' => false, 'example' => '测试'], + ], + [ + 'name' => 'HotelAddress', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel address', 'type' => 'string', 'required' => false, 'example' => '浙江省杭州市xxxx'], + ], + [ + 'name' => 'HotelEmail', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel contact mailbox', 'type' => 'string', 'required' => false, 'example' => 'a*****@hotel.com'], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Hotel contact number ', 'type' => 'string', 'required' => false, 'example' => '130***'], + ], + [ + 'name' => 'RoomNum', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Number of rooms ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + ], + [ + 'name' => 'EstOpenTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Estimated Published At: a string in the format yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2022-02-22 00:00:00'], + ], + [ + 'name' => 'RelatedPks', + 'in' => 'formData', 'style' => 'json', 'schema' => [ + 'title' => 'List of associated products ', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<List<HotelCallContact>>', - 'description' => 'Result<List<HotelCallContact>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，200标识成功', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'cf24***96e7', - ], - 'Type' => [ - 'title' => '联系人类型，device：设备，group：分组', - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'Uuid' => [ - 'title' => '唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '0862***A809', - ], - 'Number' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', - 'example' => '101', - ], - 'Name' => [ - 'title' => '联系人名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Icon' => [ - 'title' => '图标', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.icon', - ], - 'Status' => [ - 'title' => '状态，1：可用，0：不可用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExpireAt' => [ - 'title' => '失效时间', - 'description' => '', - 'type' => 'string', - 'example' => '1649472283046', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is to provide a brief description of a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension field', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'extension information', 'title' => '', 'example' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request. ', 'type' => 'string', 'example' => '46C53AEB-B19C-5C42-B32E-A726979C126F', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf24***96e7\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"0862***A809\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"46C53AEB-B19C-5C42-B32E-A726979C126F\\"\\n}","type":"json"}]', + 'title' => 'Modify hotel information', + 'changeSet' => [], ], - 'GetHotelContactByNumber' => [ - 'summary' => '根据号码获取酒店联系人', - 'path' => '/v1.0/ip/getHotelContactByNumber', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateHotelAlarm' => [ + 'summary' => 'Modify hotel alarm', + 'path' => '/v1.0/ip/updateHotelAlarm', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Number', + 'name' => 'HotelId', 'in' => 'formData', + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'a7a381a668bc485980bed3876a75e013', 'title' => ''], + ], + [ + 'name' => 'Alarms', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', + 'description' => 'Alarm information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RoomNo' => ['description' => 'Channel number', 'type' => 'string', 'required' => false, 'example' => '101', 'title' => ''], + 'AlarmId' => ['description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567', 'title' => ''], + 'UserOpenId' => ['description' => 'Open User ID', 'type' => 'string', 'required' => true, 'example' => 'mgw/***dHQd', 'title' => ''], + 'DeviceOpenId' => ['description' => 'Open Device ID', 'type' => 'string', 'required' => true, 'example' => 'Pvk***VTA==', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '101', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserInfo', - 'in' => 'query', + 'name' => 'ScheduleInfo', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户信息', - 'description' => '', + 'description' => 'Alarm schedule information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', + 'Type' => ['title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', 'description' => 'ONCE, WEEKLY', 'type' => 'string', 'required' => false, 'example' => 'ONCE'], + 'Once' => [ + 'description' => 'One-time', + 'type' => 'object', + 'properties' => [ + 'Year' => ['description' => 'Year', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022', 'title' => ''], + 'Month' => ['description' => 'Month', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9', 'title' => ''], + 'Day' => ['description' => 'Day', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'Hour' => ['description' => 'Hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Minute' => ['description' => 'Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', + 'Weekly' => [ + 'description' => 'Weekly loop: This property is active when the loop type is WEEKLY.', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'description' => 'Collection of days of the week to trigger', + 'type' => 'array', + 'items' => ['description' => 'Collection of days of the week to trigger: Numeric values range from 1 to 7, where each number corresponds to a specific day of the week. If the alarm triggers every day, include all numbers.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Hour' => ['description' => 'Hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Minute' => ['description' => 'Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], 'required' => false, - 'example' => '123', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HotelCallContact>', - 'description' => 'Result<HotelCallContact>', + 'title' => 'Result<Integer>', + 'description' => 'Result<Integer>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，200标识成功', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Message' => ['title' => '', 'description' => 'Additional information. A common scenario is to provide a brief description of a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'Extentions' => [ + 'title' => '', + 'description' => 'extension field', 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'Type' => [ - 'title' => '联系人类型，device：设备，group：分组', - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'Uuid' => [ - 'title' => '唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '2E57***D45F9', - ], - 'Number' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', - 'example' => '101', - ], - 'Name' => [ - 'title' => '联系人名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Icon' => [ - 'title' => '图标', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.icon', - ], - 'Status' => [ - 'title' => '状态，1：可用，0：不可用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExpireAt' => [ - 'title' => '失效时间', - 'description' => '', - 'type' => 'string', - 'example' => '1649316479098', - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => 'extension content', 'title' => ''], + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649316479098\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + 'title' => 'Modify hotel alarm', + 'description' => 'Modify hotel alarm.', + 'changeSet' => [], ], - 'GetHotelContactByGenieDevice' => [ - 'summary' => '获取当前设备的通话信息', - 'path' => '/v1.0/ip/getHotelContactByGenieDevice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateHotelSceneBookItem' => [ + 'summary' => 'Edit hotel scenario booking', + 'path' => '/v1.0/ip/updateHotelSceneBookItem', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写HOTEL。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45'."\n", - ], - 'IdType' => [ - 'title' => '用户Id的类型'."\n" - ."\n" - .'OPEN_ID：默认的用户ID标识。'."\n" - .'UNION_ID: 组织维度的用户ID标识，需要提前在开放平台申请组织。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'title' => '用户标识，设置为userOpenId或userUnionId。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1***2', - ], - ], - 'required' => false, - ], + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], ], [ - 'name' => 'DeviceInfo', + 'name' => 'UpdateHotelSceneBookReq', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => 'updateHotelSceneBookReq', + 'description' => 'updateHotelSceneBookReq', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写HOTEL。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'IdType' => [ - 'title' => '用户标识，设置为userOpenId或userUnionId。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'title' => '用户Id的类型'."\n" - ."\n" - .'OPEN_ID：默认的用户ID标识。'."\n" - .'UNION_ID: 组织维度的用户ID标识，需要提前在开放平台申请组织。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'Id' => ['title' => '', 'description' => 'Hotel scenario booking item ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'Name', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '青椒肉丝'], + 'Icon' => ['title' => 'icon', 'description' => 'icon', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png'], + 'Price' => ['title' => '', 'description' => 'Price (unit: cent)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1250'], ], - 'required' => false, + 'required' => true, + 'docRequired' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result<HotelCallContact>', - 'description' => 'Result<HotelCallContact>', + 'title' => '', + 'description' => '', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HotelId' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'example' => 'a7***83', - ], - 'Type' => [ - 'title' => '联系人类型，device：设备，group：分组', - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'Uuid' => [ - 'title' => '唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '2E57***D45F9', - ], - 'Number' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', - 'example' => '101', - ], - 'Name' => [ - 'title' => '联系人名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Icon' => [ - 'title' => '图标', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx.icon', - ], - 'Status' => [ - 'title' => '状态，1：可用，0：不可用', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExpireAt' => [ - 'title' => '失效时间', - 'description' => '', - 'type' => 'string', - 'example' => '1649472283046', - ], - 'Id' => [ - 'title' => '联系人id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-07-21 20:02:12', - ], - 'GmtModified' => [ - 'title' => '最后修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-07-27 14:06:27'."\n", - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '73C6***E6FA', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return Result of the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invoke to help the caller troubleshoot the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\",\\n \\"Id\\": 1,\\n \\"GmtCreate\\": \\"2022-07-21 20:02:12\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Edit hotel scenario booking', + 'changeSet' => [], ], - 'AddOrUpdateScreenSaver' => [ - 'summary' => '新增或者编辑带屏屏保', - 'path' => '/v1.0/ip/addOrUpdateScreenSaver', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateHotelSceneItem' => [ + 'summary' => 'Modify hotel scenario (enable/disable/edit)', + 'path' => '/v1.0/ip/updateHotelSceneItem', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', + 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'], + ], + [ + 'name' => 'UpdateHotelSceneOperateReq', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', + 'title' => 'updateHotelSceneReq', + 'description' => 'updateHotelSceneReq', + 'type' => 'object', + 'properties' => [ + 'OperateType' => ['title' => '', 'description' => 'Operation Type (OPEN: Enabled, CLOSE: shutdown, EDIT: Edit)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN'], + 'IsUseTemplateAnswer' => ['title' => '', 'description' => 'Whether to use template answer (true/false)', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], + ], 'required' => true, - 'example' => 'a7a3***013', + 'docRequired' => true, + 'example' => '', ], ], [ - 'name' => 'HotelScreenSaver', - 'in' => 'formData', + 'name' => 'UpdateHotelSceneReq', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '屏保', - 'description' => '', + 'title' => 'UpdateHotelSceneReq', + 'description' => 'UpdateHotelSceneReq', 'type' => 'object', 'properties' => [ - 'ScreenSaverStyle' => [ - 'title' => '屏保样式code', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'common-weather', - ], - 'ScreenSaverPicUrl' => [ - 'title' => '屏保图片', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx.png', + 'Id' => ['title' => 'itemID', 'description' => 'itemID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10337'], + 'Name' => ['description' => 'Item Name ', 'title' => 'Item Name (either ID or Name must be provided) ', 'type' => 'string', 'required' => false, 'example' => '棉签'], + 'Status' => ['title' => '', 'description' => 'Status (added/not added)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '已添加'], + 'Icon' => ['title' => 'icon', 'description' => 'icon', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png'], + 'Price' => ['title' => '', 'description' => 'Price (unit: cent)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '165'], + 'DialogueList' => [ + 'title' => '', + 'description' => 'Dialogue list', + 'type' => 'array', + 'items' => [ + 'description' => 'Dialogue information', + 'type' => 'object', + 'properties' => [ + 'ServiceId' => ['title' => 'itemId', 'description' => 'itemId', 'type' => 'string', 'required' => false, 'example' => '10337'], + 'Process' => ['title' => '', 'description' => 'Round number of the dialogue', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Question' => ['title' => '', 'description' => 'Question', 'type' => 'string', 'required' => false, 'example' => '无'], + 'YesAnswer' => ['title' => '', 'description' => 'Affirmative response', 'type' => 'string', 'required' => false, 'example' => '纸巾1.5元，请问需要么？'], + 'NoAnswer' => ['title' => '', 'description' => 'Negative reply', 'type' => 'string', 'required' => false, 'example' => '对不起，暂时不提供此物品'], + 'YesAnswerTemplate' => ['title' => '', 'description' => 'Template ID for affirmative response', 'type' => 'string', 'required' => false, 'example' => '4'], + 'NoAnswerTemplate' => ['title' => '', 'description' => 'Template ID for negative response', 'type' => 'string', 'required' => false, 'example' => '4'], + 'DialogueId' => ['title' => '', 'description' => 'Dialogue ID', 'type' => 'string', 'required' => false, 'example' => '335'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', ], + 'DeliveryMethod' => ['description' => 'Item delivery method: waiter (waiter), robot (robot)', 'title' => 'Item delivery method: waiter (waiter, default), robot (robot)', 'type' => 'string', 'required' => false, 'example' => 'robot'], + 'RobotName' => ['description' => 'Robot name.', 'title' => 'Robot name. Required when the item delivery method is robot.', 'type' => 'string', 'required' => false, 'example' => '测试机器人'], + 'PaymentMethod' => ['description' => 'Settlement method: room for room charge settlement, robot for robot settlement ', 'title' => 'Settlement method: room for room charge settlement (default), robot for robot settlement ', 'type' => 'string', 'required' => false, 'example' => 'robot'], + 'LimitSwitch' => ['description' => 'Whether quantity is limited: 1 indicates limited, 0 or empty indicates unlimited ', 'title' => 'Whether to limit quantity: 1 means limited, others mean unlimited ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'LimitNumber' => ['description' => 'Quantity limit', 'title' => 'Quantity limit', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + 'BeyondLimitReply' => ['description' => 'Reply when exceeding the limit', 'title' => 'Reply when exceeding the limit', 'type' => 'string', 'required' => false, 'example' => '尊敬的客户您好，该物品今日已超出酒店供应数量，有需要请联系前台。'], ], 'required' => true, + 'example' => '', ], ], ], @@ -15866,100 +8776,174 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4EED***9661', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'Request ID', 'type' => 'string', 'example' => '0D0C***67DB'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4EED***9661\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]', + 'title' => 'Edit hotel scenario service', + 'description' => '- ***Impact factors:***'."\n" + .'> '."\n" + .'> - `1. Whether the price equals 0;`'."\n" + .'> - `2. Whether a template is used;`'."\n" + .'> - `3. Adding or modifying a dialogue;`'."\n" + ."\n" + .'- ***Modification rules:***'."\n" + .'> '."\n" + .'> 1. **Whether the price is 0 CNY**'."\n" + .'> - Equals 0: `dialogueList.size = 1` and parameter content is `process = 0` (one-round dialogue, free service);'."\n" + .'> - Greater than 0: `dialogueList.size = 2` and parameter content includes `process = 0` (one-round dialogue, paid service, asking whether needed) + `process = 1` (two-round dialogue, response to whether needed)'."\n" + .'> 2. **Whether a template is used**'."\n" + .'> - `"isUseTemplateAnswer": true/false`'."\n" + .'> 3. **Adding or modifying a dialogue**'."\n" + ."\n" + .'1. ***Adding a dialogue:***'."\n" + .'> - **Using a template**: `yesAnswerTemplate` && `noAnswerTemplate` && `process` are not null; all others are null;'."\n" + .'> - **Not using a template**: `yesAnswer` && `noAnswer` && `process` are not null; all others are null'."\n" + ."\n" + .'1. ***Modifying a dialogue***'."\n" + ."\n" + .' > - **Using a template**: `yesAnswerTemplate` && `noAnswerTemplate` && `process` && `dialogueId` && `serviceId` are not null; all others are null;'."\n" + .' > - **Not using a template**: `yesAnswer` && `noAnswer` && `process` && `dialogueId` && `serviceId` are not null; all others are null', + 'extraInfo' => '| <div style="width:250px">Scenario</div> | Sample parameter |'."\n" + .'| ---- | ---- |'."\n" + .'| 1. Enabled && 0 CNY && template response | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":0,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n" + .'| 2. Enabled && 0 CNY && do not use template | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"The waiter will bring it to you right away!!!","noAnswer":"Sorry, we don\'t have this item!!!"}],"price":0,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n" + .'| 3. Enabled && >0 CNY && template response | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"},{"process":1,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":33333,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n" + .'| 4. Enabled && >0 CNY && do not use template | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX costs 6 CNY!!!","noAnswer":"Sorry, we don\'t have this item!!!"},{"process":1,"yesAnswer":"OK, the waiter will bring it to you as soon as possible!!!","noAnswer":"OK, canceled!!!"}],"price":33322,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n" + .'| 5. Shutdown | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":0,"id":xxx,"status":"Not added"},"updateHotelSceneOperateReq":{"operateType":"CLOSE","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n" + .'| 6. Edit && 0 CNY **changed to** >0 CNY && template response | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"},{"process":1,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":55656,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n" + .'| 7. Edit && 0 CNY **changed to** >0 CNY && do not use template | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX costs 6 CNY!!!","dialogueId":"xxx","noAnswer":"Sorry, we don\'t have this item!!!","serviceId":"166033"},{"process":1,"yesAnswer":"OK, the waiter will bring it to you as soon as possible!!!","noAnswer":"OK, canceled!!!"}],"price":3322,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n" + .'| 8. Edit && 0 CNY && template response | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":0,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n" + .'| 9. Edit && 0 CNY && do not use template | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"","yesAnswer":"The waiter will bring it to you right away!!!!!!!!!","dialogueId":"xxx","noAnswer":"Sorry, we don\'t have this item","serviceId":"166033"}],"price":0,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n" + .'| 10. Edit && >0 CNY **changed to** 0 CNY && template response | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":0,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n" + .'| 11. Edit && >0 CNY **changed to** 0 CNY && do not use template | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"The waiter will bring it to you right away!!!!!!!!!","dialogueId":"xxx","noAnswer":"Sorry, we don\'t have this item!!!","serviceId":"166033"}],"price":0,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n" + .'| 12. Edit && >0 CNY **changed to** >0 CNY && template response | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"},{"process":1,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":5555,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n" + .'| 13. Edit && >0 CNY **changed to** >0 CNY && do not use template | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX costs 6 CNY!!!","dialogueId":"xxx","noAnswer":"Sorry, we don\'t have this item!!!","serviceId":"166033"},{"process":1,"yesAnswer":"OK, the waiter will bring it to you right away!!!!","dialogueId":"xxx","noAnswer":"OK, canceled","serviceId":"166033"}],"price":5555,"id":xxx,"status":"Added"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |', + 'changeSet' => [], ], - 'AddOrUpdateDisPlayModes' => [ - 'summary' => '新增或者编辑带屏展示模式', - 'path' => '/v1.0/ip/addOrUpdateDisPlayModes', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateMessageTemplate' => [ + 'summary' => 'Edit a message notification template ', + 'path' => '/v1.0/ip/updateMessageTemplate', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Primary key ID of the template ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Template Name ', 'type' => 'string', 'required' => false, 'example' => '测试一下'], + ], + [ + 'name' => 'TemplateDetail', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Template details ', 'type' => 'string', 'required' => false, 'example' => '模板的详情'], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result of the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'The returned request ID ', 'type' => 'string', 'example' => '43***881'], + ], + 'example' => '', + ], + ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + 'title' => 'Modify a message notification template ', + 'description' => '> Modify a message notification template '."\n" + .'> - You must query the templateId of the template and then modify other parameters based on the templateId. ', + 'changeSet' => [], + ], + 'UpdateRcuScene' => [ + 'summary' => 'Modify the RCU custom scenario ', + 'path' => '/v1.0/ip/updateRcuScene', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], + 'schema' => ['title' => '', 'description' => 'Hotel ID ', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'], ], [ - 'name' => 'HotelDeviceModeList', + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Scenario encoding ', 'type' => 'string', 'required' => true, 'example' => 'yoga'], + ], + [ + 'name' => 'SceneRelationExtDTO', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '带屏设备展示的模式code列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dndMode', + 'title' => '', + 'description' => 'Hotel RCU custom scenario ', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'Scenario name', 'type' => 'string', 'required' => false, 'example' => '瑜伽模式'], + 'Icon' => ['title' => '', 'description' => 'Scenario icon', 'type' => 'string', 'required' => false, 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png'], + 'Description' => ['title' => '', 'description' => 'Scenario description ', 'type' => 'string', 'required' => false, 'example' => '做做瑜伽'], + 'CorpusList' => [ + 'title' => '', + 'description' => 'Trigger phrases (support multiple scenarios; pass a list according to your needs—the existing trigger phrases will be overwritten. If you need to retain all previous phrases, include them all in the modification request, for example: "yoga mode", "start yoga") ', + 'type' => 'array', + 'items' => ['description' => 'Trigger phrase ', 'type' => 'string', 'required' => false, 'example' => '开始瑜伽', 'title' => ''], + 'required' => false, + 'example' => '', + ], ], 'required' => true, + 'example' => '', ], ], ], @@ -15970,118 +8954,70 @@ 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'Return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are customized by the service provider. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Actual return result from the service ', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information. A typical scenario is providing a brief description for a failed invocation to help the caller locate the issue. ', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '3A680F3A-6672-5A47-AB28-12BBCD80C679', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3A680F3A-6672-5A47-AB28-12BBCD80C679\\"\\n}","type":"json"}]', + 'title' => 'Modify the RCU custom scenario ', + 'description' => 'Modify the RCU custom scenario according to the request parameters. ', + 'changeSet' => [], ], - 'GetUnionId' => [ - 'summary' => '获取组织下unionId列表', - 'path' => '/v1.0/ip/getUnionId', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateServiceQA' => [ + 'summary' => 'Modify the service facility Q&A feature under the general Q&A module.', + 'path' => '/v1.0/ip/updateServiceQA', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'EncodeType', + 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '编码类型，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOTEL', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => 'af7***536', 'title' => ''], ], [ - 'name' => 'EncodeKey', + 'name' => 'ServiceQAId', 'in' => 'formData', - 'schema' => [ - 'title' => '编码Key，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '125****0946', - ], + 'schema' => ['title' => '', 'description' => 'Service facility Q&A ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'IdType', + 'name' => 'Answer', 'in' => 'formData', - 'schema' => [ - 'title' => 'open id类型，可为用户id或设备id；'."\n" - .'USER_ID: 用户id'."\n" - .'DEVICE_ID: 设备id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEVICE_ID', - ], + 'schema' => ['title' => '', 'description' => 'Answer', 'type' => 'string', 'required' => false, 'example' => '测试'], ], [ - 'name' => 'Id', + 'name' => 'isActive', 'in' => 'formData', 'schema' => [ - 'title' => 'id类型对应的open id值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '62a319****abdc', + 'title' => '', + 'description' => 'Whether to enable (true: Enabled, false: Shutdown)', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', ], ], ], @@ -16089,92 +9025,44 @@ 200 => [ 'headers' => [], 'schema' => [ - 'title' => 'Result<List<UnionInfo>>', - 'description' => 'Result<List<UnionInfo>>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织id，可在天猫精灵开放平台管理', - 'description' => '', - 'type' => 'string', - 'example' => '4325***765', - ], - 'UnionId' => [ - 'title' => '请求参数的open id在该组织下的唯一id值', - 'description' => '', - 'type' => 'string', - 'example' => '8bh2****8s8', - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the conventionally defined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result of the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller locate the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '73C67***6FA'."\n", 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"OrganizationId\\": \\"4325***765\\",\\n \\"UnionId\\": \\"8bh2****8s8\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Modify Service Facility Q&A', + 'changeSet' => [], ], - 'HotelQrBind' => [ - 'summary' => '酒店带屏设备扫码绑定', - 'path' => '/v1.0/ip/hotelQrBind', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'UpdateTicket' => [ + 'summary' => 'Modify a ticket.', + 'path' => '/v1.0/ip/updateTicket', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], @@ -16182,194 +9070,111 @@ [ 'name' => 'HotelId', 'in' => 'formData', - 'schema' => [ - 'title' => '酒店ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a7***83', - ], + 'schema' => ['description' => 'Hotel ID', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb', 'title' => ''], ], [ - 'name' => 'RoomNo', - 'in' => 'formData', - 'schema' => [ - 'title' => '房间号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1211', - ], - ], - [ - 'name' => 'Code', - 'in' => 'formData', - 'schema' => [ - 'title' => '带屏设备绑定二维码中的code参数', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'freuisghrtiesnvfkdsvbfuidslnvfs', - ], - ], - [ - 'name' => 'ClientId', + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'title' => '带屏设备绑定二维码中的clientId参数', - 'description' => '', + 'title' => '', + 'description' => 'Status: handled: Completed, waiting: Pending, delayed: Delayed', 'type' => 'string', 'required' => true, - 'example' => 'xxxxxx', + 'enumValueTitles' => ['waiting' => '', 'handled' => '', 'delayed' => ''], + 'example' => 'waiting', ], ], [ - 'name' => 'ExtInfo', + 'name' => 'GroupKey', 'in' => 'formData', - 'schema' => [ - 'title' => '额外信息jsonString', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Group key, which represents a multi-turn conversation or an order operation. Multiple rounds of conversation sharing the same group key are automatically merged into a single ticket with multiple conversation entries.', 'type' => 'string', 'required' => true, 'example' => '2023***93975'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ - 'title' => 'Result<UserAndDeviceInfo>', - 'description' => 'Result<UserAndDeviceInfo>', + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', 'type' => 'object', 'properties' => [ - 'StatusCode' => [ - 'title' => '调用返回码，200标识为成功', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OpenUserInfo' => [ - 'title' => '开放用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'title' => '编码Key，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'IdType' => [ - 'title' => '编码信息，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'title' => '用户唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时返回', - 'description' => '', - 'type' => 'string', - 'example' => 'aaaaaaaa', - ], - ], - ], - 'OpenDeviceInfo' => [ - 'title' => '开放设备信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'example' => 'HOTEL', - ], - 'EncodeKey' => [ - 'title' => '编码Key，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'IdType' => [ - 'title' => '编码信息，从天猫精灵开放平台中获取', - 'description' => '', - 'type' => 'string', - 'example' => 'OPEN_ID', - ], - 'Id' => [ - 'title' => '设备唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxx', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时返回', - 'description' => '', - 'type' => 'string', - 'example' => 'aaaaaaaa', - ], - ], - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '73****9-175A-1324-8202-9FAAB*****A', - ], + 'StatusCode' => ['title' => '', 'description' => 'The return code of the invocation. Except for the predefined SUCCESS_CODE, all other codes are custom-defined by the service provider.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'The actual return result from the service.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0EC7***726E', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The request parameter is invalid', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'ServerError', - 'errorMessage' => 'internal server error', - ], + ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"OpenUserInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n },\\n \\"OpenDeviceInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]', + 'title' => 'Modify a ticket', + 'changeSet' => [], ], ], - 'endpoints' => [ + 'endpoints' => [], + 'errorCodes' => [ + ['code' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.GetPhoneNumber.BizError', 'message' => 'The user has no phoneNumber.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', 'message' => 'The user information does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Notifications.Application.Invalid', 'message' => 'The AliGenie app info is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Notifications.Application.Status', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Notifications.Application.Url', 'message' => 'The AliGenie app awaken url is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'The device not bind user.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'Failed to identify device.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'message' => 'Failed to identify user.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Public.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'AliGenie.Public.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.PushNotifications.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template information is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template is unavailable.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'message' => 'The template placeholder information is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'message' => 'Failed to identify message target.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.Reminder.CreateFail', 'message' => 'The creation request is not allowed.', 'http_code' => 403, 'description' => ''], + ['code' => 'AliGenie.Reminder.DeviceError', 'message' => 'The device is offline.', 'http_code' => 504, 'description' => ''], + ['code' => 'AliGenie.Reminder.HasNoAuthority', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 505, 'description' => ''], + ['code' => 'AliGenie.Reminder.StopService', 'message' => 'The servic has stopped.', 'http_code' => 503, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.Device.Offline', 'message' => 'The target device is not online.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Body', 'message' => 'You must specify request body.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', 'message' => 'You must specify EncodeKey.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'You must specify EncodeType.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'The specified EncodeType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'You must specify GenieAppId.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The GenieApp information is inmcomplete.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not configured wake up link.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The application is not installed.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', 'message' => 'You must specify OrganizationId.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'You must specify Path.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'The wake up path is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', 'message' => 'You must specify TargetIdentity.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'You must specify TargetInfo.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'The specified TargetInfo is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'You must specify TargetType.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'The specified TargetType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid', 'http_code' => 400, 'description' => ''], + ['code' => 'ServerError', 'message' => 'internal server error', 'http_code' => 500, 'description' => ''], + ['code' => 'SystemError', 'message' => 'System Error occured.', 'http_code' => 400, 'description' => '.'], + ], + 'changeSet' => [ [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'openapi.aligenie.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ImportRoomControlDevices'], + ], + 'createdAt' => '2025-12-29T10:47:10.000Z', + 'description' => '', ], ], ]; |