diff options
Diffstat (limited to 'data/en_us/aligenie')
| -rw-r--r-- | data/en_us/aligenie/aiso_1.0/api-docs.php | 92 | ||||
| -rw-r--r-- | data/en_us/aligenie/iap_1.0/api-docs.php | 4543 | ||||
| -rw-r--r-- | data/en_us/aligenie/ip_1.0/api-docs.php | 18335 | ||||
| -rw-r--r-- | data/en_us/aligenie/oauth2_1.0/api-docs.php | 769 | ||||
| -rw-r--r-- | data/en_us/aligenie/ssp_1.0/api-docs.php | 18507 |
5 files changed, 12766 insertions, 29480 deletions
diff --git a/data/en_us/aligenie/aiso_1.0/api-docs.php b/data/en_us/aligenie/aiso_1.0/api-docs.php index dd7f054..0bc7a74 100644 --- a/data/en_us/aligenie/aiso_1.0/api-docs.php +++ b/data/en_us/aligenie/aiso_1.0/api-docs.php @@ -1,18 +1,12 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'AliGenie', - 'product' => 'AliGenie', - 'version' => 'aiso_1.0', - ], + 'info' => ['style' => 'AliGenie', 'product' => 'AliGenie', 'version' => 'aiso_1.0'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'AppAuth', - ], + 'children' => ['AppAuth'], ], ], 'components' => [ @@ -21,39 +15,26 @@ 'apis' => [ 'AppAuth' => [ 'path' => '/v1.0/aiso/AppAuth', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AccessKey', 'in' => 'formData', - 'schema' => [ - 'title' => 'ak', - 'type' => 'string', - ], + 'schema' => ['title' => 'ak', 'type' => 'string'], ], [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'title' => '应用id', - 'type' => 'string', - ], + 'schema' => ['title' => '应用id', 'type' => 'string'], ], ], 'responses' => [ @@ -62,57 +43,25 @@ 'title' => 'Result<AuthTokenDTO>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Code' => ['type' => 'integer', 'format' => 'int32'], 'Result' => [ 'type' => 'object', 'properties' => [ - 'AccessKey' => [ - 'title' => '应用凭证ak', - 'type' => 'string', - ], - 'AccessToken' => [ - 'title' => '访问令牌', - 'type' => 'string', - ], - 'RefreshToken' => [ - 'title' => '刷新令牌', - 'type' => 'string', - ], - 'AccessTokenExpire' => [ - 'title' => '有效时间单位:s', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RefreshTokenExpire' => [ - 'title' => '有效时间单位:s', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AppId' => [ - 'title' => '应用id', - 'type' => 'string', - ], - 'Uuid' => [ - 'title' => '分配到的sdk所处设备的uuid', - 'type' => 'string', - ], + 'AccessKey' => ['title' => '应用凭证ak', 'type' => 'string'], + 'AccessToken' => ['title' => '访问令牌', 'type' => 'string'], + 'RefreshToken' => ['title' => '刷新令牌', 'type' => 'string'], + 'AccessTokenExpire' => ['title' => '有效时间单位:s', 'type' => 'integer', 'format' => 'int64'], + 'RefreshTokenExpire' => ['title' => '有效时间单位:s', 'type' => 'integer', 'format' => 'int64'], + 'AppId' => ['title' => '应用id', 'type' => 'string'], + 'Uuid' => ['title' => '分配到的sdk所处设备的uuid', 'type' => 'string'], ], ], - 'Message' => [ - 'type' => 'string', - ], + 'Message' => ['type' => 'string'], 'ExtendInfo' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - ], - ], - 'RequestId' => [ - 'type' => 'string', + 'additionalProperties' => ['type' => 'any'], ], + 'RequestId' => ['type' => 'string'], ], ], ], @@ -121,9 +70,6 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'openapi.aligenie.com', - ], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'openapi.aligenie.com'], ], ]; diff --git a/data/en_us/aligenie/iap_1.0/api-docs.php b/data/en_us/aligenie/iap_1.0/api-docs.php index d0f2c45..0eb701f 100644 --- a/data/en_us/aligenie/iap_1.0/api-docs.php +++ b/data/en_us/aligenie/iap_1.0/api-docs.php @@ -1,257 +1,173 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'AliGenie', - 'product' => 'AliGenie', - 'version' => 'iap_1.0', - ], + 'info' => ['style' => 'ROA', 'product' => 'AliGenie', 'version' => 'iap_1.0'], 'directories' => [ [ - 'id' => 167271, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'GetBusAppConfig', - 'AppUseTimeReport', - 'PullCashier', - 'VideoAppReport', - 'GetAccountForApp', - ], - ], - [ - 'id' => 95708, - 'title' => null, + 'children' => ['GetBusAppConfig', 'AppUseTimeReport', 'PullCashier', 'VideoAppReport', 'GetAccountForApp'], 'type' => 'directory', - 'children' => [ - 'GetPhoneNumber', - ], + 'title' => 'Application Monetization', ], [ - 'id' => 95710, - 'title' => null, + 'children' => ['GetPhoneNumber'], 'type' => 'directory', - 'children' => [ - 'CreateReminder', - 'GetReminder', - 'ListReminders', - 'UpdateReminder', - 'DeleteReminder', - ], + 'title' => 'Obtain Phone Number', ], [ - 'id' => 95716, - 'title' => null, + 'children' => ['CreateReminder', 'GetReminder', 'ListReminders', 'UpdateReminder', 'DeleteReminder'], 'type' => 'directory', - 'children' => [ - 'WakeUpApp', - ], + 'title' => 'Calendar Reminder', ], [ - 'id' => 95719, - 'title' => null, + 'children' => ['WakeUpApp'], 'type' => 'directory', - 'children' => [ - 'PushNotifications', - 'SendNotifications', - ], + 'title' => 'Application Invocation', ], [ - 'id' => 263437, - 'title' => null, + 'children' => ['PushNotifications', 'SendNotifications'], 'type' => 'directory', - 'children' => [ - 'CheckThirdRightSendPlan', - 'CallBackThirdRightSendPlan', - ], + 'title' => 'Message Push', ], [ - 'id' => 0, - 'title' => '其它', + 'children' => ['CheckThirdRightSendPlan', 'CallBackThirdRightSendPlan'], 'type' => 'directory', - 'children' => [ - 'ThirdImmediateMsgPush', - ], + 'title' => 'Other', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'GetBusAppConfig' => [ - 'summary' => '获取应用配置', - 'path' => '/v1.0/iap/app/config/get', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AppUseTimeReport' => [ + 'summary' => 'Used to report application usage duration on Tmall Genie devices. ', + 'path' => '/v1.0/iap/vip/use/time/report', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '业务参数', - 'description' => '', + 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'type' => 'string', - 'required' => false, - ], - 'SubjectId' => [ - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - ], - 'phone' => [ - 'title' => '手机号', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '136****1111', - ], - 'originUuid' => [ - 'title' => '明文uuid', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '731D5F********DC3B', - ], + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'SubjectId' => ['title' => 'Application ID', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'Action' => ['title' => '', 'description' => 'Action item'."\n" + ."\n" + .'- start indicates Start'."\n" + .'- end indicates End', 'type' => 'string', 'required' => true, 'example' => 'start'], + 'StepCode' => ['title' => '', 'description' => 'Step code. The start and end actions must be uniquely matched.', 'type' => 'string', 'required' => true, 'example' => '2'], + 'ResourceId' => ['title' => '', 'description' => 'Resource ID.', 'type' => 'string', 'required' => true, 'example' => '1'], + 'ResourceType' => ['title' => 'resourceType', 'description' => 'Resource type:'."\n" + ."\n" + .'- 0 indicates game'."\n" + .'- 1 indicates audio'."\n" + .'- 2 indicates video', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'IsPrivilege' => ['title' => '', 'description' => 'Indicates whether the benefit is exclusive to members:'."\n" + ."\n" + .'- 1 indicates Yes '."\n" + .'- 0 indicates No', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'VipType' => ['title' => '', 'description' => 'Membership type:'."\n" + ."\n" + .'- 0 indicates Cat Spirit Membership'."\n" + .'- 1 indicates third-party proprietary membership', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'originUuid' => ['description' => 'Plaintext UUID', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识(UserOpenId或UserUnionId)', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of User ID '."\n" + .'- OPEN_ID: Default User ID identifier. '."\n" + .'- UNION_ID: Organization-dimension User ID identifier. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SKILL_ID', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier from Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer flow. '."\n" + .'- SKILL_ID: Skill ID, used for the cloud-based flow.', 'type' => 'string', 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type '."\n" + ."\n" + .'- When the encoding type is SKILL_ID, the value is the application\'s Skill ID. '."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device identity information ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID, set to deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID '."\n" + .'- OPEN_ID: Default device ID. '."\n" + .'- UNION_ID: Organization-dimension device ID, available only after an organization has been requested in the Tmall Genie Skill Application Open Platform. ', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SKILL_ID', - 'enum' => [ - 'SKILL_ID', - 'PACKAGE_NAME', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used for Android application customer-side integration. '."\n" + .'- SKILL_ID: Skill ID, used for cloud-side integration. ', 'type' => 'string', 'required' => false, - 'example' => '1**2', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'- When the encoding type is SKILL_ID, the value is the application\'s Skill ID.'."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID, required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => false, + 'example' => '', ], ], ], @@ -262,280 +178,152 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RetCode' => [ - 'title' => '返回的错误码，0表示成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => ' 0', - ], - 'RetMsg' => [ - 'title' => '返回的错误信息，成功则不返回信息。', - 'description' => '', - 'type' => 'string', - 'example' => ' 请求异常', - ], - 'RetValue' => [ - 'title' => '返回的结果对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VipLabel' => [ - 'title' => 'VIP透标URL', - 'description' => '', - 'type' => 'string', - 'example' => 'https://******.com/design/******?imageId=xxxxx', - ], - 'ShoppingBar' => [ - 'title' => '导购条URL', - 'description' => '', - 'type' => 'string', - 'example' => 'https://******.com/design/******?imageId=xxxxx', - ], - 'ShoppingWindow' => [ - 'title' => '导购弹窗URL', - 'description' => '', - 'type' => 'string', - 'example' => 'https://******.com/design/******?imageId=xxxxx', - ], - 'Cashier' => [ - 'title' => '收银台URL', - 'type' => 'string', - 'example' => 'https://******.com/*****/******?appId=xxxxx', - ], - ], - ], + 'RetCode' => ['description' => 'Error code returned; `0` indicates success. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RetMsg' => ['description' => 'Error message returned; no message is returned upon success. ', 'type' => 'string', 'example' => '请求异常', 'title' => ''], + 'RetValue' => ['description' => 'Result of invoking the API '."\n" + ."\n" + .'- true indicates success '."\n" + .'- false indicates failure ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + 400 => [ + ['errorCode' => '500', 'errorMessage' => '内部服务错误_xxx', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"\\\\t请求异常\\",\\n \\"RetValue\\": {\\n \\"VipLabel\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingBar\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingWindow\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"Cashier\\": \\"https://******.com/*****/******?appId=xxxxx\\"\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","type":"json"}]', + 'title' => 'Report Application Usage Duration ', + 'translator' => 'machine', + 'changeSet' => [], ], - 'AppUseTimeReport' => [ - 'summary' => '应用使用时长上报', - 'path' => '/v1.0/iap/vip/use/time/report', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CallBackThirdRightSendPlan' => [ + 'summary' => 'Third-party membership redemption callback API.', + 'path' => '/v1.0/iap/business/CallBackThirdRightSendPlan', + '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' => 'none'], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户id', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'title' => '设备di', - 'type' => 'string', - 'required' => false, - ], - 'SubjectId' => [ - 'title' => '应用id', - 'type' => 'string', - 'required' => true, - ], - 'Action' => [ - 'title' => '操作', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'start', - ], - 'StepCode' => [ - 'title' => '步进码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], - 'ResourceId' => [ - 'title' => '资源id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'ResourceType' => [ - 'title' => 'resourceType', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'IsPrivilege' => [ - 'title' => '是否会员专享权益：1-是 0-否', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'VipType' => [ - 'title' => '会员类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'originUuid' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '731D5F********DC3B', - ], - ], - 'required' => false, - ], + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'device Type', 'type' => 'string', 'required' => false, 'example' => 'ailabs'], ], [ - 'name' => 'UserInfo', - 'in' => 'formData', + 'name' => 'BizGroup', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'device group', 'type' => 'string', 'required' => false, 'example' => 'cc'], + ], + [ + 'name' => 'Sn', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'SN of the device ', 'type' => 'string', 'required' => false, 'example' => '01000019100307010000600'], + ], + [ + 'name' => 'SupplierId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Supplier ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'GenieOpenId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Genie ID', 'type' => 'string', 'required' => false, 'example' => '1dsds2FzCXFGVA1ADS'], + ], + [ + 'name' => 'ReceiveStatus', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'redemption status', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CardType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => '1001 daily card, 1002 monthly card, 1003 quarterly card, 1004 annual card', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1001'], + ], + [ + 'name' => 'ErrorMsg', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'required' => false, 'example' => '领取异常'], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'Extension fields ', 'type' => 'object', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'RetValue' => ['title' => '', 'description' => 'Return Result true/false', 'type' => 'boolean', 'example' => ''], + 'RetMsg' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '系统异常'], + 'RetCode' => ['title' => '', 'description' => 'fault status code', 'type' => 'string', 'example' => '400'], + 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F'], ], - 'required' => true, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetValue\\": false,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetCode\\": \\"400\\",\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]', + 'title' => 'Third-party membership redemption callback', + 'translator' => 'machine', + 'changeSet' => [], + ], + 'CheckThirdRightSendPlan' => [ + 'summary' => 'Commercial mobile screen third-party app card issuance validation.', + 'path' => '/v1.0/iap/business/CheckThirdRightSendPlan', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'DeviceInfo', - 'in' => 'formData', + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Device type', 'type' => 'string', 'required' => false, 'example' => 'ailabs'], + ], + [ + 'name' => 'BizGroup', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Device group', 'type' => 'string', 'required' => false, 'example' => 'cc'], + ], + [ + 'name' => 'Sn', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Device SN', 'type' => 'string', 'required' => false, 'example' => '01000019100307010000600'], + ], + [ + 'name' => 'SupplierId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Supplier ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Extension field', 'type' => 'object', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -545,198 +333,196 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RetCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RetMsg' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'RetCode' => ['title' => '', 'description' => 'Return code', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'RetMsg' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '系统异常'], 'RetValue' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'Result of invoking the API', + 'type' => 'object', + 'properties' => [ + 'CardType' => ['title' => '', 'description' => 'Card type', 'type' => 'integer', 'format' => 'int32', 'example' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡'], + 'RightsExpiredDate' => ['title' => '', 'description' => 'Rights expiration time', 'type' => 'string', 'example' => '"1713262192005"'], + 'ActivateDate' => ['title' => '', 'description' => 'Activation time', 'type' => 'string', 'example' => '"1713262192005"'], + 'ChannelCode' => ['title' => '', 'description' => 'Channel code', 'type' => 'string', 'example' => 'TB'], + 'ChannelName' => ['title' => '', 'description' => 'Channel Name', 'type' => 'string', 'example' => '淘宝'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F'], + 'ExtendInfo' => ['title' => '', 'description' => 'Extension field', 'type' => 'object', 'example' => '{}'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => '500', - 'errorMessage' => '内部服务错误_xxx', - ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<AppUseTimeReportResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</AppUseTimeReportResponse>","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetValue\\": {\\n \\"CardType\\": 0,\\n \\"RightsExpiredDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ActivateDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ChannelCode\\": \\"TB\\",\\n \\"ChannelName\\": \\"淘宝\\",\\n \\"RequestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\",\\n \\"ExtendInfo\\": {}\\n }\\n}","type":"json"}]', + 'title' => 'Third-party membership validation', + 'translator' => 'machine', + 'changeSet' => [], ], - 'PullCashier' => [ - 'summary' => '拉取收银台', - 'path' => '/v1.0/iap/pull/cashier/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateReminder' => [ + 'summary' => 'Used to create a reminder on a Tmall Genie device. ', + 'path' => '/v1.0/iap/reminder/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AliGenie_Auth_SPI' => [], + 'AliGenie_Auth_Token' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The input parameters for this service request.', 'type' => 'object', 'properties' => [ - 'SubjectId' => [ - 'title' => '应用id', - 'type' => 'string', + 'Content' => ['title' => '', 'description' => 'The detailed content of the reminder message.', 'type' => 'string', 'required' => true, 'example' => '提醒内容'], + 'UserId' => ['title' => 'Genie ID', 'type' => 'string', 'required' => true, 'example' => '12****78', 'description' => ''], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC', 'description' => ''], + 'SubjectId' => ['title' => 'Application ID', 'type' => 'string', 'required' => true, 'example' => '20******01', 'description' => ''], + 'IsDebug' => ['title' => '', 'description' => 'Indicates whether this invocation is for debug purposes.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'], + 'RecurrenceRule' => [ + 'title' => '', + 'description' => 'Scheduling information for the reminder.', + 'type' => 'object', + 'properties' => [ + 'Year' => ['title' => '', 'description' => 'The year of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2021'], + 'Month' => ['title' => '', 'description' => 'The month in which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Day' => ['title' => '', 'description' => 'The date on which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25'], + 'Hour' => ['title' => '', 'description' => 'The hour of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12'], + 'Minute' => ['title' => '', 'description' => 'The minute of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Second' => ['title' => '', 'description' => 'The second of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Freq' => [ + 'title' => '', + 'description' => 'Loop type:'."\n" + ."\n" + .'- ONCE: One-time'."\n" + .'- DAILY: Daily'."\n" + .'- WEEKLY: Weekly'."\n" + .'- MONTHLY: Monthly', + 'type' => 'string', + 'required' => true, + 'example' => 'ONCE', + 'enum' => ['ONCE', 'DAILY', 'WEEKLY', 'MONTHLY'], + ], + 'StartDateTime' => ['title' => '', 'description' => 'The effective start time of the reminder, in milliseconds as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134400000'], + 'EndDateTime' => ['title' => '', 'description' => 'The expiration time when the reminder ends, in milliseconds UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134700000'], + 'DaysOfMonth' => [ + 'title' => '', + 'description' => 'Configure monthly reminders, indicating the day of the month when the reminder is triggered.', + 'type' => 'array', + 'items' => ['description' => 'Set the specific dates for monthly reminders. The value range is 1 to 31.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'Configure weekly reminders, indicating on which days of the week the reminder is triggered.', + 'type' => 'array', + 'items' => ['description' => 'Specific days for weekly reminders, with values ranging from 1 to 7.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - 'required' => false, - ], - 'originUuid' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '731D5F********DC3B', + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identifier information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID: '."\n" + .'- OPEN_ID: The default User ID identity. '."\n" + .'- UNION_ID: The User ID identity at the organization dimension. This value is available only after an organization has been requested on the Tmall Genie Skills Application Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow '."\n" + .'- SKILL_ID: Skill ID, used in the cloud-based flow', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type: '."\n" + .'- When the encoding type is SKILL_ID, the value is the Skill ID of the application. '."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This parameter is required when **IdType** is configured as **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device identification information. ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID, set to either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the device ID: '."\n" + .'- OPEN_ID: Default device ID identifier. '."\n" + .'- UNION_ID: Organization-level device ID identifier. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow. '."\n" + .'- SKILL_ID: Skill ID, used in the cloud-based flow. ', 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'- When the encoding type is set to SKILL_ID, the value is the application\'s Skill ID.'."\n" + .'- When the encoding type is set to PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This parameter is required when **IdType** is set to **UNION_ID**. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], @@ -744,243 +530,129 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response information returned by calling this API. ', 'type' => 'object', 'properties' => [ - 'RetCode' => [ - 'title' => '错误吗', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RetMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RetValue' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['title' => '', 'description' => 'Indicates the result of the API call. true indicates success, and false indicates failure. ', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'Error code. ', 'type' => 'string', 'example' => '400'], + 'ErrorMsg' => ['title' => '', 'description' => 'Detailed description of the error message. ', 'type' => 'string', 'example' => '不能设置过去的时间。'], + 'Model' => ['title' => '', 'description' => 'The ID of the created reminder. ', 'type' => 'integer', 'format' => 'int64', 'example' => '20****1'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => '500', - 'errorMessage' => '内部服务错误_xxx', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求成功\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<PullCashierResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</PullCashierResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","type":"json"}]', + 'title' => 'Create Reminder ', + 'translator' => 'machine', + 'changeSet' => [], ], - 'VideoAppReport' => [ - 'summary' => '视频类应用会员信息上报', - 'path' => '/v1.0/iap/vip/use/video/report', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteReminder' => [ + 'summary' => 'User deletes a reminder created on a Tmall Genie device. ', + 'path' => '/v1.0/iap/reminder/delete', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AliGenie_Auth_SPI' => [], + 'AliGenie_Auth_Token' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'DeviceId' => [ - 'title' => '设备di', - 'type' => 'string', - 'required' => false, - ], - 'isLogin' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'isVip' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'startTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1652337963097', - ], - 'endTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1652337963097', - ], - 'loginNick' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'phone' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '188*777', - ], - 'pkgName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.***.test', - ], - 'originUuid' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '731D5F********DC3B', - ], + 'Id' => ['title' => '', 'description' => 'Unique ID of the reminder', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20****34'], + 'UserId' => ['title' => 'Genie ID', 'type' => 'string', 'required' => true, 'example' => '12****56', 'description' => ''], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC', 'description' => ''], + 'SubjectId' => ['title' => 'Application ID', 'type' => 'string', 'required' => true, 'example' => '20****01', 'description' => ''], + 'IsDebug' => ['title' => '', 'description' => 'Debug flag', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID:'."\n" + .'- OPEN_ID: The default User ID identity.'."\n" + .'- UNION_ID: The User ID identity at the organization dimension. This is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer ingest endpoint '."\n" + .'- SKILL_ID: Skill ID, used for the cloud service ingest endpoint', 'type' => 'string', 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'example' => 'SKILL_ID', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'device identity information ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'type of device ID '."\n" + .'- OPEN_ID: default device ID '."\n" + .'- UNION_ID: organization-level device ID; available only after an organization has been requested on the Tmall Genie Skill Application Open Platform ', 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', + 'title' => '', + 'description' => 'encoding type; there are multiple ways to obtain the Tmall Genie device ID, and each method corresponds to a different encoding type '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow '."\n" + .'- SKILL_ID: skill ID, used in the cloud-based flow ', 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'required' => true, + 'example' => 'SKILL_ID', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'organization ID; required if IdType is `UNION_ID` ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], ], @@ -991,57 +663,31 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RetCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RetMsg' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RetValue' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['title' => '', 'description' => 'service success indicator ', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'error code ', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'ErrorMsg' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => '参数错误。'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => '500', - 'errorMessage' => '内部服务错误_xxx', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<VideoAppReportResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</VideoAppReportResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数错误。\\"\\n}","type":"json"}]', + 'title' => 'Delete Reminder ', + 'translator' => 'machine', + 'changeSet' => [], ], 'GetAccountForApp' => [ - 'summary' => '获取会员信息', + 'summary' => 'Used by developers to obtain membership information in business scenarios that depend on CatGenie Membership.', 'path' => '/v1.0/iap/vip/account/get', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], @@ -1051,34 +697,18 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'SubjectId' => [ - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - ], - 'Phone' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '188*777', - ], - 'originUuid' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '731D5F********DC3B', - ], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'SubjectId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Phone' => ['description' => 'Phone number of the authorized membership user.', 'type' => 'string', 'required' => false, 'example' => '188*777', 'title' => ''], + 'originUuid' => ['description' => 'Plaintext UUID', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ @@ -1086,55 +716,38 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User identifier, which can be set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of User ID: '."\n" + .'- OPEN_ID: The default user ID identity. '."\n" + .'- UNION_ID: Organization-dimension user ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each way corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer link. '."\n" + .'- SKILL_ID: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type: '."\n" + .'- When the encoding type is SKILL_ID, the value is the application\'s Skill ID. '."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This field is required if IdType is set to UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ @@ -1142,55 +755,38 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device ID information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the device ID: '."\n" + .'- OPEN_ID: Default device ID identifier '."\n" + .'- UNION_ID: Device ID identifier at the organization dimension. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow.'."\n" + .'- SKILL_ID: Skill ID, used in the cloud-based flow.', 'type' => 'string', 'required' => false, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type: '."\n" + .'- When the encoding type is SKILL_ID, the value is the application\'s Skill ID. '."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => false, + 'example' => '', ], ], ], @@ -1201,142 +797,104 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RetCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RetMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'RetCode' => ['title' => '', 'description' => 'Error code returned. A value of `0` indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'RetMsg' => ['title' => '', 'description' => 'Error message returned. No message is returned upon success.', 'type' => 'string', 'example' => '请求异常'], 'RetValue' => [ - 'title' => '用户信息', - 'description' => '', + 'title' => '', + 'description' => 'List of result objects returned.', 'type' => 'object', 'properties' => [ - 'IsVip' => [ - 'title' => '是否VIP', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'VipExpireAt' => [ - 'title' => '若以前开通过会员，返回会员失效时间，若从未开通过会员，此字段为0', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1652340138347', - ], - 'StrVipExpire' => [ - 'title' => '日期格式，到期时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-05-12 15:22:18', - ], + 'IsVip' => ['title' => '', 'description' => 'Indicates whether the user is an authorized member.', 'type' => 'boolean', 'example' => 'true'], + 'VipExpireAt' => ['title' => '', 'description' => 'Millisecond-level UNIX timestamp.'."\n" + ."\n" + .'- If the user has activated membership, returns the membership expiration time.'."\n" + .'- If the user has never activated membership, the value is always `0`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652340138347'], + 'StrVipExpire' => ['title' => '', 'description' => 'Membership expiration time.', 'type' => 'string', 'example' => '2022-05-12 15:22:18'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '500', - 'errorMessage' => '内部服务错误_xx', - ], - [ - 'errorCode' => '10000', - 'errorMessage' => '猫精用户已更换手机号，请重登', - ], + ['errorCode' => '500', 'errorMessage' => '内部服务错误_xx', 'description' => ''], + ['errorCode' => '10000', 'errorMessage' => '猫精用户已更换手机号，请重登', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": {\\n \\"IsVip\\": true,\\n \\"VipExpireAt\\": 1652340138347,\\n \\"StrVipExpire\\": \\"2022-05-12 15:22:18\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAccountForAppResponse>\\n <RetCode>0</RetCode>\\n <RetValue>\\n <IsVip>true</IsVip>\\n <VipExpireAt>1652340138347</VipExpireAt>\\n <StrVipExpire>2022-05-12 15:22:18</StrVipExpire>\\n </RetValue>\\n</GetAccountForAppResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": {\\n \\"IsVip\\": true,\\n \\"VipExpireAt\\": 1652340138347,\\n \\"StrVipExpire\\": \\"2022-05-12 15:22:18\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain CatGenie Membership Information', + 'translator' => 'machine', + 'changeSet' => [], ], - 'GetPhoneNumber' => [ - 'summary' => '用户手机号获取', - 'path' => '/v1.0/iap/profile/phoneNumber', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetBusAppConfig' => [ + 'summary' => 'Obtain application configuration.', + 'path' => '/v1.0/iap/app/config/get', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AliGenie_Auth_Token' => [], + 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Business parameters', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'SubjectId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'phone' => ['title' => '', 'description' => 'Phone number', 'type' => 'string', 'required' => false, 'example' => '136****1111'], + 'originUuid' => ['title' => '', 'description' => 'Plaintext UUID', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B'], + ], + 'required' => false, + 'example' => '', + ], + ], + [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identity information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (UserOpenId or UserUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of User ID: OPEN_ID: default User ID identity; UNION_ID: organization-dimension User ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer ingest endpoints; SKILL_ID: skill ID, used for cloud-based ingest endpoints.', 'type' => 'string', 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'example' => 'SKILL_ID', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s Skill ID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ @@ -1344,442 +902,199 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device ID information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID: OPEN_ID: default device ID; UNION_ID: organization-dimension device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', - 'required' => true, + 'required' => false, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer journeys; SKILL_ID: skill ID, used for cloud-based journeys.', 'type' => 'string', 'required' => false, - 'example' => '1**2', + 'example' => 'SKILL_ID', + 'enum' => ['SKILL_ID', 'PACKAGE_NAME'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s Skill ID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回结果', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'phoneNumber' => [ - 'title' => '用户手机号', - 'description' => '', - 'type' => 'string', - 'example' => '137****', + 'RetCode' => ['title' => '', 'description' => 'Error code returned. 0 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => ' 0'], + 'RetMsg' => ['title' => '', 'description' => 'Error message returned. No message is returned if the operation succeeded.', 'type' => 'string', 'example' => ' 请求异常'], + 'RetValue' => [ + 'title' => '', + 'description' => 'Configuration Information (VIP label, shopping guide bar, shopping guide pop-up)', + 'type' => 'object', + 'properties' => [ + 'VipLabel' => ['title' => '', 'description' => 'VIP label transparency URL', 'type' => 'string', 'example' => 'https://******.com/design/******?imageId=xxxxx'], + 'ShoppingBar' => ['title' => '', 'description' => 'Shopping guide bar URL', 'type' => 'string', 'example' => 'https://******.com/design/******?imageId=xxxxx'], + 'ShoppingWindow' => ['title' => '', 'description' => 'Shopping guide pop-up URL', 'type' => 'string', 'example' => 'https://******.com/design/******?imageId=xxxxx'], + 'Cashier' => ['description' => 'Cashier URL', 'title' => 'Cashier URL', 'type' => 'string', 'example' => 'https://******.com/*****/******?appId=xxxxx'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', - 'errorMessage' => 'The user information does not exist.', - ], - [ - 'errorCode' => 'AliGenie.GetPhoneNumber.BizError', - 'errorMessage' => 'The user has no phoneNumber.', - ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"phoneNumber\\": \\"137****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPhoneNumberResponse>\\n <phoneNumber>137****</phoneNumber>\\n</GetPhoneNumberResponse>","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"\\\\t请求异常\\",\\n \\"RetValue\\": {\\n \\"VipLabel\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingBar\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingWindow\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"Cashier\\": \\"https://******.com/*****/******?appId=xxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain application configuration', + 'translator' => 'machine', + 'changeSet' => [], ], - 'CreateReminder' => [ - 'summary' => '创建提醒', - 'path' => '/v1.0/iap/reminder/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetPhoneNumber' => [ + 'summary' => 'Obtain the phone number bound to the user\'s Maojing device. You must first request this capability on the Maojing Skill Application Platform and obtain user authorization on the device side. ', + 'path' => '/v1.0/iap/profile/phoneNumber', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_Token' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '提醒内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '提醒内容', - ], - 'UserId' => [ - 'title' => '精灵id', - 'type' => 'string', - 'required' => true, - 'example' => '12****78', - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => true, - 'example' => 'BED****AAC', - ], - 'SubjectId' => [ - 'title' => '应用id', - 'type' => 'string', - 'required' => true, - 'example' => '20******01', - ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], - 'RecurrenceRule' => [ - 'title' => '提醒调度信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'title' => '触发时间的年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2021', - ], - 'Month' => [ - 'title' => '触发时间的月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Day' => [ - 'title' => '触发时间的日', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '25', - ], - 'Hour' => [ - 'title' => '触发时间的时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12', - ], - 'Minute' => [ - 'title' => '触发时间的分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Second' => [ - 'title' => '触发时间的秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Freq' => [ - 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ONCE', - 'enum' => [ - 'ONCE', - 'DAILY', - 'WEEKLY', - 'MONTHLY', - ], - ], - 'StartDateTime' => [ - 'title' => '开始时间，时间戳毫秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1635134400000', - ], - 'EndDateTime' => [ - 'title' => '结束时间，时间戳毫秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1635134700000', - ], - 'DaysOfMonth' => [ - 'title' => '月循环相关，表示每月的几号的集合,数值范围为1-31', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'DaysOfWeek' => [ - 'title' => '周循环相关，表示每周几触发，数值范围为1-7', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - 'required' => true, - ], - ], - [ 'name' => 'UserInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of User ID: '."\n" + .'- OPEN_ID: Default User ID identifier '."\n" + .'- UNION_ID: Organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name, used for Android application customer journeys '."\n" + .'- SKILL_ID: Skill ID, used for cloud-based journeys', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device identification information ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID: '."\n" + .'- OPEN_ID: Default device ID '."\n" + .'- UNION_ID: Organization-dimension device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the Maojing device ID, and each method corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow '."\n" + .'- SKILL_ID: Skill ID, used in the cloud-based flow ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. If the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is `UNION_ID`. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '服务成功标识', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '不能设置过去的时间。', - ], - 'Model' => [ - 'title' => '创建的提醒id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20****1', - ], + 'phoneNumber' => ['title' => '', 'description' => 'User\'s phone number ', 'type' => 'string', 'example' => '137****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateReminderResponse>\\n <Success>true</Success>\\n</CreateReminderResponse>","errorExample":""}]', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', 'errorMessage' => 'The user information does not exist.', 'description' => ''], + ['errorCode' => 'AliGenie.GetPhoneNumber.BizError', 'errorMessage' => 'The user has no phoneNumber.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"phoneNumber\\": \\"137****\\"\\n}","type":"json"}]', + 'title' => 'Obtain the phone number bound to the user\'s Maojing device ', + 'translator' => 'machine', + 'changeSet' => [], ], 'GetReminder' => [ - 'summary' => '查询提醒', + 'summary' => 'User retrieves reminders created on Tmall Genie devices. ', 'path' => '/v1.0/iap/reminder/get', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_Token' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ @@ -1788,46 +1103,18 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '提醒的唯一id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20****34', - ], - 'UserId' => [ - 'title' => '精灵id', - 'type' => 'string', - 'required' => true, - 'example' => '12****56', - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => true, - 'example' => 'BED****AAC', - ], - 'SubjectId' => [ - 'title' => '应用id', - 'type' => 'string', - 'required' => true, - 'example' => '20****01', - ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], + 'Id' => ['title' => '', 'description' => 'The unique ID of the reminder.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20****34'], + 'UserId' => ['title' => 'Genie ID', 'type' => 'string', 'required' => true, 'example' => '12****56', 'description' => ''], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC', 'description' => ''], + 'SubjectId' => ['title' => 'Application ID', 'type' => 'string', 'required' => true, 'example' => '20****01', 'description' => ''], + 'IsDebug' => ['title' => '', 'description' => 'Indicates whether this invocation is for debug purposes.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'], ], 'required' => true, + 'example' => '', ], ], [ @@ -1835,55 +1122,39 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'List of user identity information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID '."\n" + .'- OPEN_ID: The default User ID identifier. '."\n" + .'- UNION_ID: The organization-dimension User ID identifier. This value is available only after an organization has been requested on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer ingest endpoint.'."\n" + .'- SKILL_ID: Skill ID, used for the cloud-based ingest endpoint.', 'type' => 'string', 'required' => true, 'example' => 'SKILL_ID', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. '."\n" + ."\n" + .'- When the encoding type is SKILLID, the value is the application\'s Skill ID. '."\n" + .'- When the encoding type is PACKAGENAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when **IdType** is set to **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ @@ -1891,55 +1162,39 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'List of device identity information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID. '."\n" + .'- OPEN_ID: The default device ID. '."\n" + .'- UNION_ID: Organization-level device ID, available only after an organization has been requested on the Tmall Genie Skill Application Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer link. '."\n" + .'- SKILL_ID: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'SKILL_ID', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'- When the encoding type is SKILLID, the value is the application\'s Skill ID.'."\n" + .'- When the encoding type is PACKAGENAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when **IdType** is set to **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], @@ -1947,202 +1202,93 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'List of response messages returned by invoking this API. ', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '服务成功标识', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '参数不合法。', - ], + 'Success' => ['title' => '', 'description' => 'Indicates the result of the API call. true means succeeded, and false means failed.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'ErrorMsg' => ['title' => '', 'description' => 'Detailed description of the error message. ', 'type' => 'string', 'example' => '参数不合法。'], 'Model' => [ - 'title' => '提醒信息', - 'description' => '', + 'title' => '', + 'description' => 'Reminder information. ', 'type' => 'object', 'properties' => [ 'RemindResponses' => [ - 'title' => '提醒信息', - 'description' => '', + 'title' => '', + 'description' => 'List of reminder information returned by invoking this API. ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of information entries. ', 'type' => 'object', 'properties' => [ - 'RemindId' => [ - 'title' => '提醒id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20*****1', - ], - 'RepeatCount' => [ - 'title' => '重复次数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ActionTopic' => [ - 'title' => '执行动作topic', - 'description' => '', - 'type' => 'string', - 'example' => '宝宝快去刷牙', - ], - 'DayDesc' => [ - 'title' => '触发条件描述', - 'description' => '', - 'type' => 'string', - 'example' => '每天', - ], - 'RemindTime' => [ - 'title' => '下次提醒时间', - 'description' => '', - 'type' => 'string', - 'example' => '1629850800000', - ], - 'Week' => [ - 'title' => '触发为周几', - 'description' => '', - 'type' => 'string', - 'example' => '周三', - ], + 'RemindId' => ['title' => '', 'description' => 'The ID of the reminder message.', 'type' => 'integer', 'format' => 'int64', 'example' => '20*****1'], + 'RepeatCount' => ['title' => '', 'description' => 'The number of times the reminder repeats.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ActionTopic' => ['title' => '', 'description' => 'The topic of the action executed by the reminder.', 'type' => 'string', 'example' => '宝宝快去刷牙'], + 'DayDesc' => ['title' => '', 'description' => 'Description of the trigger condition for the reminder.', 'type' => 'string', 'example' => '每天'], + 'RemindTime' => ['title' => '', 'description' => 'Next reminder time. ', 'type' => 'string', 'example' => '1629850800000'], + 'Week' => ['title' => '', 'description' => 'The day of the week on which the reminder is triggered, indicating which day of the week the reminder occurs.', 'type' => 'string', 'example' => '周三'], 'RecurrenceRule' => [ - 'title' => '调度信息', - 'description' => '', + 'title' => '', + 'description' => 'Schedule information list, which contains detailed timing information for the reminder. ', 'type' => 'object', 'properties' => [ - 'Freq' => [ - 'title' => '调度类型', - 'description' => '', - 'type' => 'string', - 'example' => 'WEEKLY', - ], - 'Year' => [ - 'title' => '年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2021', - ], - 'Month' => [ - 'title' => '月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'Day' => [ - 'title' => '天', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], - 'Hour' => [ - 'title' => '小时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18', - ], - 'Minute' => [ - 'title' => '分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Second' => [ - 'title' => '秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'Freq' => ['title' => '', 'description' => 'The loop epoch of the reminder.', 'type' => 'string', 'example' => 'WEEKLY'], + 'Year' => ['title' => '', 'description' => 'The year when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '2021'], + 'Month' => ['title' => '', 'description' => 'Month in which the reminder is triggered. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'Day' => ['title' => '', 'description' => 'The date on which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '27'], + 'Hour' => ['title' => '', 'description' => 'The hour of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '18'], + 'Minute' => ['title' => '', 'description' => 'The minute when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Second' => ['title' => '', 'description' => 'The second of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'DaysOfMonth' => [ - 'title' => '月的第几天 可用作月循环', - 'description' => '', + 'title' => '', + 'description' => 'Information for monthly reminders.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'items' => ['description' => 'The day of the month on which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', ], 'DaysOfWeek' => [ - 'title' => '周循环字段，取值范围：1-7', - 'description' => '', + 'title' => '', + 'description' => 'Information for weekly reminders.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'StartDateTime' => [ - 'title' => '调度开始时间', - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '1630054800000', - ], - 'EndDateTime' => [ - 'title' => '调度结束时间', - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '1661598000000', + 'items' => ['description' => 'The day(s) of the week on which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', ], + 'StartDateTime' => ['title' => '', 'description' => 'The start time when the reminder becomes effective.', 'type' => 'string', 'format' => 'int64', 'example' => '1630054800000'], + 'EndDateTime' => ['title' => '', 'description' => 'The end time when the reminder becomes inactive.', 'type' => 'string', 'format' => 'int64', 'example' => '1661598000000'], ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数不合法。\\",\\n \\"Model\\": {\\n \\"RemindResponses\\": [\\n {\\n \\"RemindId\\": 0,\\n \\"RepeatCount\\": 1,\\n \\"ActionTopic\\": \\"宝宝快去刷牙\\",\\n \\"DayDesc\\": \\"每天\\",\\n \\"RemindTime\\": \\"1629850800000\\",\\n \\"Week\\": \\"周三\\",\\n \\"RecurrenceRule\\": {\\n \\"Freq\\": \\"WEEKLY\\",\\n \\"Year\\": 2021,\\n \\"Month\\": 8,\\n \\"Day\\": 27,\\n \\"Hour\\": 18,\\n \\"Minute\\": 0,\\n \\"Second\\": 0,\\n \\"DaysOfMonth\\": [\\n 1\\n ],\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"StartDateTime\\": 1630054800000,\\n \\"EndDateTime\\": 1661598000000\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetReminderResponse>\\n <Success>true</Success>\\n <ErrorCode>400</ErrorCode>\\n <ErrorMsg>参数不合法。</ErrorMsg>\\n <Model>\\n <RemindResponses>\\n <RepeatCount>1</RepeatCount>\\n <ActionTopic>宝宝快去刷牙</ActionTopic>\\n <DayDesc>每天</DayDesc>\\n <RemindTime>1629850800000</RemindTime>\\n <Week>周三</Week>\\n <RecurrenceRule>\\n <Freq>WEEKLY</Freq>\\n <Year>2021</Year>\\n <Month>8</Month>\\n <Day>27</Day>\\n <Hour>18</Hour>\\n <Minute>0</Minute>\\n <Second>0</Second>\\n <DaysOfMonth>1</DaysOfMonth>\\n <DaysOfWeek>1</DaysOfWeek>\\n <StartDateTime>1630054800000</StartDateTime>\\n <EndDateTime>1661598000000</EndDateTime>\\n </RecurrenceRule>\\n </RemindResponses>\\n </Model>\\n</GetReminderResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数不合法。\\",\\n \\"Model\\": {\\n \\"RemindResponses\\": [\\n {\\n \\"RemindId\\": 0,\\n \\"RepeatCount\\": 1,\\n \\"ActionTopic\\": \\"宝宝快去刷牙\\",\\n \\"DayDesc\\": \\"每天\\",\\n \\"RemindTime\\": \\"1629850800000\\",\\n \\"Week\\": \\"周三\\",\\n \\"RecurrenceRule\\": {\\n \\"Freq\\": \\"WEEKLY\\",\\n \\"Year\\": 2021,\\n \\"Month\\": 8,\\n \\"Day\\": 27,\\n \\"Hour\\": 18,\\n \\"Minute\\": 0,\\n \\"Second\\": 0,\\n \\"DaysOfMonth\\": [\\n 1\\n ],\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"StartDateTime\\": \\"1630054800000\\",\\n \\"EndDateTime\\": \\"1661598000000\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve Reminders', + 'translator' => 'machine', + 'changeSet' => [], ], 'ListReminders' => [ - 'summary' => '查询提醒列表', + 'summary' => 'The User batch retrieves reminders created on Tmall Genie devices. ', 'path' => '/v1.0/iap/reminder/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_Token' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ @@ -2151,38 +1297,17 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request.', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'title' => '精灵id', - 'type' => 'string', - 'required' => true, - 'example' => '12****56', - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => true, - 'example' => 'BED****AAC', - ], - 'SubjectId' => [ - 'title' => '应用id', - 'type' => 'string', - 'required' => true, - 'example' => '20****01', - ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], + 'UserId' => ['title' => 'Genie ID', 'type' => 'string', 'required' => true, 'example' => '12****56', 'description' => ''], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC', 'description' => ''], + 'SubjectId' => ['title' => 'Application ID', 'type' => 'string', 'required' => true, 'example' => '20****01', 'description' => ''], + 'IsDebug' => ['title' => '', 'description' => 'Indicates whether this invocation is for debug purposes.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'], ], 'required' => true, + 'example' => '', ], ], [ @@ -2190,55 +1315,38 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'List of user identity information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier, either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID:'."\n" + .' - OPEN_ID: The default User ID identity.'."\n" + .' - UNION_ID: The User ID identity at the organization dimension. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer ingest endpoint. '."\n" + .'- SKILL_ID: Skill ID, used for the cloud-side ingest endpoint.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type:'."\n" + .' - When the encoding type is SKILLID, the value is the application\'s Skill ID.'."\n" + .' - When the encoding type is PACKAGENAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This parameter is required when **IdType** is configured as **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ @@ -2246,55 +1354,39 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'List of device identity information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID, either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the device ID. '."\n" + .'- OPEN_ID: The default device ID. '."\n" + .'- UNION_ID: Organization-level device ID. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow. '."\n" + .'- SKILL_ID: Skill ID, used in the cloud-based flow.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'- When the encoding type is SKILLID, the value is the application\'s Skill ID. '."\n" + .'- When the encoding type is PACKAGENAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when **IdType** is set to **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], @@ -2302,544 +1394,94 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The list of return information from invoking this API. ', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '服务成功标识', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '参数不合法。', - ], + 'Success' => ['title' => '', 'description' => 'Indicates the result of the API call. true indicates success, and false indicates failure.', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'ErrorMsg' => ['title' => '', 'description' => 'Detailed description of the error message. ', 'type' => 'string', 'example' => '参数不合法。'], 'Model' => [ - 'title' => '提醒信息', - 'description' => '', + 'title' => '', + 'description' => 'Reminder information. ', 'type' => 'object', 'properties' => [ 'RemindResponses' => [ - 'title' => '提醒信息', - 'description' => '', + 'title' => '', + 'description' => 'The list of reminder information returned by invoking this API. ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of information. ', 'type' => 'object', 'properties' => [ - 'RemindId' => [ - 'title' => '提醒id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20****1', - ], - 'RepeatCount' => [ - 'title' => '重复次数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ActionTopic' => [ - 'title' => '执行动作topic', - 'description' => '', - 'type' => 'string', - 'example' => '宝宝快去刷牙', - ], - 'DayDesc' => [ - 'title' => '触发条件描述', - 'description' => '', - 'type' => 'string', - 'example' => '每天', - ], - 'RemindTime' => [ - 'title' => '下次提醒时间', - 'description' => '', - 'type' => 'string', - 'example' => '1629850800000', - ], - 'Week' => [ - 'title' => '触发为周几', - 'description' => '', - 'type' => 'string', - 'example' => '周三', - ], + 'RemindId' => ['title' => '', 'description' => 'The ID of the reminder message.', 'type' => 'integer', 'format' => 'int64', 'example' => '20****1'], + 'RepeatCount' => ['title' => '', 'description' => 'The number of times the reminder repeats.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ActionTopic' => ['title' => '', 'description' => 'The topic of the action executed by the reminder.', 'type' => 'string', 'example' => '宝宝快去刷牙'], + 'DayDesc' => ['title' => '', 'description' => 'Description of the trigger condition for the reminder.', 'type' => 'string', 'example' => '每天'], + 'RemindTime' => ['title' => '', 'description' => 'The next reminder time. ', 'type' => 'string', 'example' => '1629850800000'], + 'Week' => ['title' => '', 'description' => 'The day of the week on which the reminder is triggered weekly.', 'type' => 'string', 'example' => '周三'], 'RecurrenceRule' => [ - 'title' => '调度信息', - 'description' => '', + 'title' => '', + 'description' => 'The schedule information list, which contains detailed timing information for the reminder. ', 'type' => 'object', 'properties' => [ - 'Freq' => [ - 'title' => '调度类型', - 'description' => '', - 'type' => 'string', - 'example' => 'WEEKLY', - ], - 'Year' => [ - 'title' => '年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2021', - ], - 'Month' => [ - 'title' => '月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'Day' => [ - 'title' => '天', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], - 'Hour' => [ - 'title' => '小时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18', - ], - 'Minute' => [ - 'title' => '分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Second' => [ - 'title' => '秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'Freq' => ['title' => '', 'description' => 'The recurrence epoch of the reminder.', 'type' => 'string', 'example' => 'WEEKLY'], + 'Year' => ['title' => '', 'description' => 'The year when the reminder is triggered. ', 'type' => 'integer', 'format' => 'int32', 'example' => '2021'], + 'Month' => ['title' => '', 'description' => 'The month when the reminder is triggered. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'Day' => ['title' => '', 'description' => 'The date on which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '27'], + 'Hour' => ['title' => '', 'description' => 'The hour of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '18'], + 'Minute' => ['title' => '', 'description' => 'The minute of the hour when the reminder is triggered. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Second' => ['title' => '', 'description' => 'The second of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'DaysOfMonth' => [ - 'title' => '月的第几天 可用作月循环', - 'description' => '', + 'title' => '', + 'description' => 'Information for monthly reminders.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'items' => ['description' => 'The day of the month on which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', ], 'DaysOfWeek' => [ - 'title' => '周循环字段，取值范围：1-7', - 'description' => '', + 'title' => '', + 'description' => 'Information for weekly reminders. ', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'StartDateTime' => [ - 'title' => '调度开始时间', - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '1630054800000', - ], - 'EndDateTime' => [ - 'title' => '调度结束时间', - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '1661598000000', + 'items' => ['description' => 'The day(s) of the week on which the reminder is triggered. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', ], + 'StartDateTime' => ['title' => '', 'description' => 'The start time when the reminder becomes effective. ', 'type' => 'string', 'format' => 'int64', 'example' => '1630054800000'], + 'EndDateTime' => ['title' => '', 'description' => 'The end time when the reminder becomes inactive.', 'type' => 'string', 'format' => 'int64', 'example' => '1661598000000'], ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数不合法。\\",\\n \\"Model\\": {\\n \\"RemindResponses\\": [\\n {\\n \\"RemindId\\": 0,\\n \\"RepeatCount\\": 1,\\n \\"ActionTopic\\": \\"宝宝快去刷牙\\",\\n \\"DayDesc\\": \\"每天\\",\\n \\"RemindTime\\": \\"1629850800000\\",\\n \\"Week\\": \\"周三\\",\\n \\"RecurrenceRule\\": {\\n \\"Freq\\": \\"WEEKLY\\",\\n \\"Year\\": 2021,\\n \\"Month\\": 8,\\n \\"Day\\": 27,\\n \\"Hour\\": 18,\\n \\"Minute\\": 0,\\n \\"Second\\": 0,\\n \\"DaysOfMonth\\": [\\n 1\\n ],\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"StartDateTime\\": 1630054800000,\\n \\"EndDateTime\\": 1661598000000\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListRemindersResponse>\\n <Success>true</Success>\\n <ErrorCode>400</ErrorCode>\\n <ErrorMsg>参数不合法。</ErrorMsg>\\n <Model>\\n <RemindResponses>\\n <RepeatCount>1</RepeatCount>\\n <ActionTopic>宝宝快去刷牙</ActionTopic>\\n <DayDesc>每天</DayDesc>\\n <RemindTime>1629850800000</RemindTime>\\n <Week>周三</Week>\\n <RecurrenceRule>\\n <Freq>WEEKLY</Freq>\\n <Year>2021</Year>\\n <Month>8</Month>\\n <Day>27</Day>\\n <Hour>18</Hour>\\n <Minute>0</Minute>\\n <Second>0</Second>\\n <DaysOfMonth>1</DaysOfMonth>\\n <DaysOfWeek>1</DaysOfWeek>\\n <StartDateTime>1630054800000</StartDateTime>\\n <EndDateTime>1661598000000</EndDateTime>\\n </RecurrenceRule>\\n </RemindResponses>\\n </Model>\\n</ListRemindersResponse>","errorExample":""}]', - ], - 'UpdateReminder' => [ - 'summary' => '更新提醒', - 'path' => '/v1.0/iap/reminder/update', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_Token' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'Payload', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '提醒id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20***34', - ], - 'Content' => [ - 'title' => '提醒内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '更新提醒内容', - ], - 'SubjectId' => [ - 'title' => '应用id', - 'type' => 'string', - 'required' => true, - 'example' => '20****01', - ], - 'UserId' => [ - 'title' => '精灵id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12****56', - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => true, - 'example' => 'BED****AAC', - ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], - 'RecurrenceRule' => [ - 'title' => '提醒调度信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'title' => '触发时间的年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2021', - ], - 'Month' => [ - 'title' => '触发时间的月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Day' => [ - 'title' => '触发时间的日', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '25', - ], - 'Hour' => [ - 'title' => '触发时间的时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12', - ], - 'Minute' => [ - 'title' => '触发时间的分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Second' => [ - 'title' => '触发时间的秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Freq' => [ - 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ONCE', - 'enum' => [ - 'ONCE', - 'DAILY', - 'WEEKLY', - 'MONTHLY', - ], - ], - 'StartDateTime' => [ - 'title' => '开始时间，时间戳，毫秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1635134400000', - ], - 'EndDateTime' => [ - 'title' => '结束时间，时间戳，毫秒', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1635134700000', - ], - 'DaysOfMonth' => [ - 'title' => '月循环相关，表示每月的几号的集合,数值范围为1-31', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'DaysOfWeek' => [ - 'title' => '周循环相关，表示每周几触发，数值范围为1-7', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'UserInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'title' => '服务成功标识', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '不能设置过去的时间。', - ], - 'Model' => [ - 'title' => '更新提醒的id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20****1', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"<UpdateReminderResponse>\\n <Success>true</Success>\\n</UpdateReminderResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数不合法。\\",\\n \\"Model\\": {\\n \\"RemindResponses\\": [\\n {\\n \\"RemindId\\": 0,\\n \\"RepeatCount\\": 1,\\n \\"ActionTopic\\": \\"宝宝快去刷牙\\",\\n \\"DayDesc\\": \\"每天\\",\\n \\"RemindTime\\": \\"1629850800000\\",\\n \\"Week\\": \\"周三\\",\\n \\"RecurrenceRule\\": {\\n \\"Freq\\": \\"WEEKLY\\",\\n \\"Year\\": 2021,\\n \\"Month\\": 8,\\n \\"Day\\": 27,\\n \\"Hour\\": 18,\\n \\"Minute\\": 0,\\n \\"Second\\": 0,\\n \\"DaysOfMonth\\": [\\n 1\\n ],\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"StartDateTime\\": \\"1630054800000\\",\\n \\"EndDateTime\\": \\"1661598000000\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve Reminder List', + 'translator' => 'machine', + 'changeSet' => [], ], - 'DeleteReminder' => [ - 'summary' => '删除提醒', - 'path' => '/v1.0/iap/reminder/delete', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PullCashier' => [ + 'summary' => 'The user launches the checkout page on a Tmall Genie device. ', + 'path' => '/v1.0/iap/pull/cashier/', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AliGenie_Auth_Token' => [], + 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ @@ -2848,46 +1490,16 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '提醒的唯一id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20****34', - ], - 'UserId' => [ - 'title' => '精灵id', - 'type' => 'string', - 'required' => true, - 'example' => '12****56', - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => true, - 'example' => 'BED****AAC', - ], - 'SubjectId' => [ - 'title' => '应用id', - 'type' => 'string', - 'required' => true, - 'example' => '20****01', - ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], + 'SubjectId' => ['title' => 'Application ID', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'originUuid' => ['description' => 'Plaintext UUID', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ @@ -2895,55 +1507,40 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID.'."\n" + ."\n" + .'- OPEN_ID: The default User ID identity.'."\n" + .'- UNION_ID: Organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SKILL_ID', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier from Tmall Genie, and each method corresponds to a different encoding type.'."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer ingest endpoint.'."\n" + .'- SKILL_ID: Skill ID, used for the cloud-based ingest endpoint.', 'type' => 'string', 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'- When the encoding type is SKILL_ID, the value is the application\'s Skill ID.'."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ @@ -2951,55 +1548,39 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'device ID information ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID, set to deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID '."\n" + .'- OPEN_ID: The default device ID. '."\n" + .'- UNION_ID: Organization-level device ID. This value is available only after an organization has been requested on the Tmall Genie skill application Open Platform. ', 'type' => 'string', - 'required' => true, + 'required' => false, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SKILL_ID', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID of Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow. '."\n" + .'- SKILL_ID: Skill ID, used in the cloud-based flow. ', 'type' => 'string', 'required' => false, - 'example' => '1**2', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'- When the encoding type is SKILL_ID, the value is the Skill ID of the application.'."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], ], @@ -3010,218 +1591,36 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '服务成功标识', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '参数错误。', - ], + 'RetCode' => ['title' => '', 'description' => 'The returned error code. `0` indicates success. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'RetMsg' => ['title' => '', 'description' => 'The returned error message. No message is returned upon success. ', 'type' => 'string', 'example' => '请求成功'], + 'RetValue' => ['description' => 'The result of pulling up the checkout page. true indicates success, and false indicates failure. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数错误。\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteReminderResponse>\\n <Success>true</Success>\\n</DeleteReminderResponse>","errorExample":""}]', - ], - 'WakeUpApp' => [ - 'summary' => '猫精应用唤起', - 'path' => '/v1.0/iap/wakeup', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'title' => '应用拉起路径，类似在技能应用控制台中填的唤起链接。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '应用拉起路径', - ], - 'SubjectId' => [ - 'title' => '猫精应用id', - 'type' => 'string', - 'required' => true, - 'example' => '2021****001', - ], - 'TargetInfo' => [ - 'title' => '要拉起的目标设备信息。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TargetType' => [ - 'title' => '推送目标类型，获取到对应设备标识时的类型 DEVICE_UNION_ID：设备unionId； DEVICE_OPEN_ID：设备openId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DEVICE_OPEN_ID', - 'enum' => [ - 'DEVICE_UNION_ID', - 'DEVICE_OPEN_ID', - ], - ], - 'TargetIdentity' => [ - 'title' => '推送目标类型对应的标识值', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=', - ], - 'OrganizationId' => [ - 'title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '11', - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型： PACKAGE_NAME：apk包名 SKILL_ID：技能id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，例如：编码类型是SKILLID，其值就为webhook服务中得到的skillId；编码类似是PACKAGENAME，其值就为对应客户端app的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'apk包名', - ], - ], - 'required' => true, - ], - 'IsDebug' => [ - 'title' => '是否调试', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [], - ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.WakeUpApp.Device.Offline', - 'errorMessage' => 'The Target Device is not online.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', - 'errorMessage' => 'The AliGenie app does not release.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Body', - 'errorMessage' => 'You must specify request body.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', - 'errorMessage' => 'You must specify TargetInfo.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Path', - 'errorMessage' => 'You must specify Path.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', - 'errorMessage' => 'You must specify TargetIdentity.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', - 'errorMessage' => 'You must specify EncodeKey.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', - 'errorMessage' => 'You must specify EncodeType.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', - 'errorMessage' => 'You must specify TargetType.', - ], - [ - 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', - 'errorMessage' => 'You must specify OrganizationId.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => '500', 'errorMessage' => '内部服务错误_xxx', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<WakeUpAppResponse/>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求成功\\",\\n \\"RetValue\\": true\\n}","type":"json"}]', + 'title' => 'Launch Checkout Page ', + 'translator' => 'machine', + 'changeSet' => [], ], 'PushNotifications' => [ - 'summary' => '猫精系统消息推送', + 'summary' => 'Execute the message push feature of Tmall Genie. You must first request the capability and configure the message template on the Tmall Genie Skill Application Platform.', 'path' => '/v1.0/iap/notifications', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -3231,92 +1630,59 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '消息推送入参对象。', - 'description' => '', + 'title' => '', + 'description' => 'Input parameter object for message push.', 'type' => 'object', 'properties' => [ 'SendTarget' => [ - 'title' => '消息推送的目标信息。', - 'description' => '', + 'title' => '', + 'description' => 'The target information for message push.', 'type' => 'object', 'properties' => [ 'TargetType' => [ - 'title' => '推送的目标类型，获取到对应设备或用户标识时的类型 - DEVICE_UNION_ID：设备unionId - DEVICE_OPEN_ID：设备openId - USER_UNION_ID：用户unionId - USER_OPEN_ID：用户openId', - 'description' => '', + 'title' => '', + 'description' => 'The type of the Push Target, indicating the type when obtaining the corresponding device or User Identifier: '."\n" + .'- `DEVICE_UNION_ID`: device unionId '."\n" + .'- `DEVICE_OPEN_ID`: device openId '."\n" + .'- `USER_UNION_ID`: user unionId '."\n" + .'- `USER_OPEN_ID`: user openId', 'type' => 'string', 'required' => false, 'example' => 'DEVICE_OPEN_ID', - 'enum' => [ - 'DEVICE_UNION_ID', - 'DEVICE_OPEN_ID', - 'USER_UNION_ID', - 'USER_OPEN_ID', - ], - ], - 'TargetIdentity' => [ - 'title' => '推送目标类型对应的标识值。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=', + 'enum' => ['DEVICE_UNION_ID', 'DEVICE_OPEN_ID', 'USER_UNION_ID', 'USER_OPEN_ID'], ], + 'TargetIdentity' => ['title' => '', 'description' => 'The identity value corresponding to the Push Target Type.', 'type' => 'string', 'required' => false, 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY='], ], 'required' => true, + 'example' => '', ], - 'MessageTemplateId' => [ - 'title' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2iU81*****G9elJ', - ], + 'MessageTemplateId' => ['title' => '', 'description' => 'Message template ID obtained when applying for a message template on the Tmall Genie Application Platform.', 'type' => 'string', 'required' => true, 'example' => '2iU81*****G9elJ'], 'PlaceHolder' => [ - 'title' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', - 'description' => '', + 'title' => '', + 'description' => 'Placeholder information. For example, for the template ["Hello, {nick}!"], this could be {"nick":"Sweetie"}. Additionally, within the placeholder parameters, you can append parameters to the application launch link to support hyperlinking to a specific address, such as: `{"nick":"Sweetie","_URL_SUFFIX_":"xxx"}`. The hyperlink address in the message pop-up will then be: application launch link + `${_URL_SUFFIX_}`. This feature only works for applications that have configured a launch link.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '', - 'description' => '', - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{"nick":"小甜甜"}', 'description' => 'Placeholder information. For example, for the template ["Hello, {nick}!"], this could be {"nick":"Sweetie"}.', 'title' => ''], 'example' => '{"nick":"张三"}', ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型： PACKAGE_NAME：apk包名 SKILL_ID：技能id', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the Tmall Genie device ID, and each method corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name '."\n" + .'- SKILL_ID: Skill ID', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，例如：编码类型是SKILLID，其值就为webhook服务中得到的skillId；编码类似是PACKAGENAME，其值就为对应客户端app的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'apk包名', - ], - 'OrganizationId' => [ - 'title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. '."\n" + .'- When the encoding type is SKILL_ID, the value is the skill ID obtained from the webhook service. '."\n" + .'- When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => 'apk包名'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization Identifier. This parameter is required only when the push type is `XX_UNION_XX`. If you obtain CatGenie device or user identifiers through multiple channels and need interoperability among them, you must request an organization from the platform. After approval, the platform will assign an organization identifier.', 'type' => 'string', 'required' => false, 'example' => '2'], + 'IsDebug' => ['title' => '', 'description' => 'Debug flag. When the skill application is in the debug phase, setting this flag determines whether the retrieved skill application information is from the editing state or the online state.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], 'required' => true, + 'example' => '', ], ], [ @@ -3324,17 +1690,14 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '身份信息。', - 'description' => '', + 'title' => '', + 'description' => 'Identity information.', 'type' => 'object', 'properties' => [ - 'SubjectId' => [ - 'title' => '猫精应用id，【开发者平台-技能应用】创建应用后得到的应用id', - 'type' => 'string', - 'example' => '20*****01', - ], + 'SubjectId' => ['title' => 'The application ID obtained after creating an application in the Developer Platform under Skill Applications.', 'type' => 'string', 'example' => '20*****01', 'description' => ''], ], 'required' => false, + 'example' => '', ], ], ], @@ -3343,73 +1706,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', - 'errorMessage' => 'The template placeholder information is missing.', - ], - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', - 'errorMessage' => 'Failed to identify message target.', - ], - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', - 'errorMessage' => 'The template information is invalid.', - ], - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.Application.Invalid', - 'errorMessage' => 'The AliGenie app info is invalid.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.Application.Status', - 'errorMessage' => 'The AliGenie app has not been released.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.Application.Url', - 'errorMessage' => 'The AliGenie app awaken url is missing.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', - 'errorMessage' => 'Failed to identify device.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', - 'errorMessage' => 'Failed to identify user.', - ], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'errorMessage' => 'The template placeholder information is missing.', 'description' => ''], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'errorMessage' => 'Failed to identify message target.', 'description' => ''], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'errorMessage' => 'The template information is invalid.', 'description' => ''], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.Application.Invalid', 'errorMessage' => 'The AliGenie app info is invalid.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.Application.Status', 'errorMessage' => 'The AliGenie app has not been released.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.Application.Url', 'errorMessage' => 'The AliGenie app awaken url is missing.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'errorMessage' => 'Failed to identify device.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'errorMessage' => 'Failed to identify user.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<PushNotificationsResponse/>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'Message Push_Custom Device Version', + 'translator' => 'machine', + 'changeSet' => [], ], 'SendNotifications' => [ - 'summary' => '消息推送服务（普通版）', + 'summary' => 'Execute the message push feature of Tmall Genie. You must first request the capability and configure the message template in the Tmall Genie Skill Application Platform.', 'path' => '/v1.0/iap/general/notifications', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ @@ -3418,52 +1745,33 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '消息推送入参对象。', - 'description' => '', + 'title' => '', + 'description' => 'Input parameter object for message push.', 'type' => 'object', 'properties' => [ 'SendTarget' => [ - 'title' => '消息推送的目标信息。', - 'description' => '', + 'title' => '', + 'description' => 'Target information for message push.', 'type' => 'object', 'properties' => [ - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => true, - ], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], ], 'required' => true, + 'example' => '', ], - 'MessageTemplateId' => [ - 'title' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2iU81*****G9elJ', - ], + 'MessageTemplateId' => ['title' => '', 'description' => 'Message template ID obtained when requesting a message template in the Tmall Genie Application Platform.', 'type' => 'string', 'required' => true, 'example' => '2iU81*****G9elJ'], 'PlaceHolder' => [ - 'title' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', - 'description' => '', + 'title' => '', + 'description' => 'Placeholder information. For example, for the template ["Hello, {nick}!"], this can be: {"nick":"Xiao Tian Tian"}. Additionally, within the placeholder parameters, you can append parameters to the application launch link to support hyperlinking to a specific address, such as: `{"nick":"Xiao Tian Tian","_URL_SUFFIX_":"xxx"}`. The hyperlink address in the message pop-up will then be: application launch link + `${_URL_SUFFIX_}`. This feature is only effective for applications that have configured a launch link.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => '', - ], + 'additionalProperties' => ['type' => 'string', 'description' => 'Placeholder information. For example, for the template ["Hello, {nick}!"], this can be: {"nick":"Xiao Tian Tian"}.', 'example' => '{"nick":"小甜甜"}', 'title' => ''], 'example' => '{"nick":"张三"}', ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'IsDebug' => ['title' => '', 'description' => 'Debug flag. When the skill application is in the debugging phase, setting this flag determines whether the retrieved skill application information is from the editing state or the online state.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], 'required' => true, + 'example' => '', ], ], [ @@ -3471,18 +1779,14 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '身份信息。', - 'description' => '', + 'title' => '', + 'description' => 'Identity information.', 'type' => 'object', 'properties' => [ - 'SubjectId' => [ - 'title' => '猫精应用标识', - 'type' => 'string', - 'required' => true, - 'example' => '20********01', - ], + 'SubjectId' => ['title' => 'Maojing application identifier', 'type' => 'string', 'required' => true, 'example' => '20********01', 'description' => ''], ], 'required' => false, + 'example' => '', ], ], [ @@ -3490,55 +1794,36 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID: '."\n" + .'- OPEN_ID: Default User ID identifier '."\n" + .'- UNION_ID: Organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the Maojing User Identifier, and each method corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application customer link '."\n" + .'- SKILL_ID: Skill ID, used for the cloud-based link', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s Skill ID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ @@ -3546,55 +1831,36 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device identity information ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID: '."\n" + .' - OPEN_ID: Default device ID '."\n" + .' - UNION_ID: Organization-dimension device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: '."\n" + .' - PACKAGE_NAME: APK package name, used for the Android application customer link '."\n" + .' - SKILL_ID: Skill ID, used for the cloud link ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s Skill ID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], @@ -3603,136 +1869,184 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', - 'errorMessage' => 'The template placeholder information is missing.', - ], - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', - 'errorMessage' => 'Failed to identify message target.', - ], - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', - 'errorMessage' => 'The template information is invalid.', - ], - [ - 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.Application.Invalid', - 'errorMessage' => 'The AliGenie app info is invalid.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.Application.Status', - 'errorMessage' => 'The AliGenie app has not been released.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.Application.Url', - 'errorMessage' => 'The AliGenie app awaken url is missing.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', - 'errorMessage' => 'Failed to identify device.', - ], - [ - 'errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', - 'errorMessage' => 'Failed to identify user.', - ], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'errorMessage' => 'The template placeholder information is missing.', 'description' => ''], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'errorMessage' => 'Failed to identify message target.', 'description' => ''], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'errorMessage' => 'The template information is invalid.', 'description' => ''], + ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.Application.Invalid', 'errorMessage' => 'The AliGenie app info is invalid.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.Application.Status', 'errorMessage' => 'The AliGenie app has not been released.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.Application.Url', 'errorMessage' => 'The AliGenie app awaken url is missing.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'errorMessage' => 'Failed to identify device.', 'description' => ''], + ['errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'errorMessage' => 'Failed to identify user.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<SendNotificationsResponse/>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'Message Push_General-purpose Edition', + 'translator' => 'machine', + 'changeSet' => [], ], - 'CheckThirdRightSendPlan' => [ - 'summary' => '商业化移动屏三方app领卡校验', - 'path' => '/v1.0/iap/business/CheckThirdRightSendPlan', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateReminder' => [ + 'summary' => 'The user updates a reminder created on a Tmall Genie device. ', + 'path' => '/v1.0/iap/reminder/update', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AliGenie_Auth_SPI' => [], + 'AliGenie_Auth_Token' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'title' => '设备类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ailabs', - ], - ], - [ - 'name' => 'BizGroup', - 'in' => 'query', - 'schema' => [ - 'title' => '设备分组', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cc', - ], - ], - [ - 'name' => 'Sn', - 'in' => 'query', + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '设备sn', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '01000019100307010000600', + 'title' => '', + 'description' => 'The input parameters for this service request.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the reminder to update.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20***34'], + 'Content' => ['title' => '', 'description' => 'The detailed content of the reminder message.', 'type' => 'string', 'required' => true, 'example' => '更新提醒内容'], + 'SubjectId' => ['title' => 'Application ID', 'type' => 'string', 'required' => true, 'example' => '20****01', 'description' => ''], + 'UserId' => ['title' => 'Genie ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****56', 'description' => ''], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC', 'description' => ''], + 'IsDebug' => ['title' => '', 'description' => 'Indicates whether this invocation is for debugging.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'], + 'RecurrenceRule' => [ + 'title' => '', + 'description' => 'Scheduling information for the reminder.', + 'type' => 'object', + 'properties' => [ + 'Year' => ['title' => '', 'description' => 'The year of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2021'], + 'Month' => ['title' => '', 'description' => 'The month in which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Day' => ['title' => '', 'description' => 'The date on which the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25'], + 'Hour' => ['title' => '', 'description' => 'The hour of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12'], + 'Minute' => ['title' => '', 'description' => 'The minute of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Second' => ['title' => '', 'description' => 'The second of the time when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Freq' => [ + 'title' => '', + 'description' => 'Recurrence type:'."\n" + ."\n" + .'- ONCE: One-time'."\n" + .'- DAILY: Daily'."\n" + .'- WEEKLY: Weekly'."\n" + .'- MONTHLY: Monthly', + 'type' => 'string', + 'required' => true, + 'example' => 'ONCE', + 'enum' => ['ONCE', 'DAILY', 'WEEKLY', 'MONTHLY'], + ], + 'StartDateTime' => ['title' => '', 'description' => 'The effective start time of the reminder, in milliseconds as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134400000'], + 'EndDateTime' => ['title' => '', 'description' => 'The expiration time when the reminder ends, in milliseconds as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134700000'], + 'DaysOfMonth' => [ + 'title' => '', + 'description' => 'Configure monthly reminders, specifying on which day(s) of each month the reminder is triggered.', + 'type' => 'array', + 'items' => ['description' => 'Set the specific day of the month for the reminder. Valid values range from 1 to 31.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'Configure weekly reminders, indicating on which days of the week the reminder is triggered.', + 'type' => 'array', + 'items' => ['description' => 'Specific days of the week for weekly reminders. The valid values are 1–7.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'SupplierId', - 'in' => 'query', + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '供应商id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'title' => '', + 'description' => 'User identifier information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of User ID '."\n" + .'- OPEN_ID: The default User ID identifier. '."\n" + .'- UNION_ID: The organization-dimension User ID identifier. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer link. '."\n" + .'- SKILL_ID: Skill ID, used in the cloud link.', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. '."\n" + ."\n" + .'- When the encoding type is set to SKILL_ID, the value is the application\'s Skill ID. '."\n" + .'- When the encoding type is set to PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This parameter is required when **IdType** is set to **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'ExtendInfo', - 'in' => 'query', + 'name' => 'DeviceInfo', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '扩展字段', - 'description' => '', + 'title' => '', + 'description' => 'Device identity information. ', 'type' => 'object', - 'required' => false, - 'example' => '{}', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID, set to either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of the device ID. '."\n" + .'- OPEN_ID: Default device ID. '."\n" + .'- UNION_ID: Organization-level device ID. This value is available only after an organization has been registered on the Tmall Genie skill application platform.', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + .'- PACKAGE_NAME: APK package name, used in the Android application customer flow. '."\n" + .'- SKILL_ID: Skill ID, used in the cloud-based flow. ', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'- When the encoding type is set to SKILL_ID, the value is the application\'s Skill ID.'."\n" + .'- When the encoding type is set to PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This parameter is required when **IdType** is set to **UNION_ID**. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => true, + 'example' => '', ], ], ], @@ -3743,212 +2057,137 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RetCode' => [ - 'title' => '返回code', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RetMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '系统异常', - ], - 'RetValue' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CardType' => [ - 'title' => '卡种', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡', - ], - 'RightsExpiredDate' => [ - 'title' => '权益失效时间', - 'description' => '', - 'type' => 'string', - 'example' => '"1713262192005"', - ], - 'ActivateDate' => [ - 'title' => '激活时间', - 'description' => '', - 'type' => 'string', - 'example' => '"1713262192005"', - ], - 'ChannelCode' => [ - 'title' => '渠道code', - 'description' => '', - 'type' => 'string', - 'example' => 'TB', - ], - 'ChannelName' => [ - 'title' => '渠道名称', - 'description' => '', - 'type' => 'string', - 'example' => '淘宝', - ], - 'RequestId' => [ - 'title' => '请求iid', - 'description' => '', - 'type' => 'string', - 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F', - ], - 'ExtendInfo' => [ - 'title' => '扩展字段', - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], - ], - ], + 'Success' => ['title' => '', 'description' => 'Service success indicator ', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['title' => '', 'description' => 'Error code ', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'ErrorMsg' => ['title' => '', 'description' => 'Error message ', 'type' => 'string', 'example' => '不能设置过去的时间。'], + 'Model' => ['title' => '', 'description' => 'ID of the updated reminder ', 'type' => 'integer', 'format' => 'int64', 'example' => '20****1'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetValue\\": {\\n \\"CardType\\": 0,\\n \\"RightsExpiredDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ActivateDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ChannelCode\\": \\"TB\\",\\n \\"ChannelName\\": \\"淘宝\\",\\n \\"RequestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\",\\n \\"ExtendInfo\\": {}\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","type":"json"}]', + 'title' => 'Update Reminder ', + 'translator' => 'machine', + 'changeSet' => [], ], - 'CallBackThirdRightSendPlan' => [ - 'summary' => '三方领取回调接口', - 'path' => '/v1.0/iap/business/CallBackThirdRightSendPlan', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'VideoAppReport' => [ + 'summary' => 'Used by developers to report membership information in scenarios involving membership collaboration with CatGenie.', + 'path' => '/v1.0/iap/vip/use/video/report', + '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' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'title' => '设备类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ailabs', - ], - ], - [ - 'name' => 'BizGroup', - 'in' => 'query', - 'schema' => [ - 'title' => '设备分组', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cc', - ], - ], - [ - 'name' => 'Sn', - 'in' => 'query', - 'schema' => [ - 'title' => '设备对应的sn', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '01000019100307010000600', - ], - ], - [ - 'name' => 'SupplierId', - 'in' => 'query', - 'schema' => [ - 'title' => '供应商id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'GenieOpenId', - 'in' => 'query', - 'schema' => [ - 'title' => '精灵id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1dsds2FzCXFGVA1ADS', - ], - ], - [ - 'name' => 'ReceiveStatus', - 'in' => 'query', - 'schema' => [ - 'title' => '领取状态', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'CardType', - 'in' => 'query', + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '业务参数', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['title' => '设备di', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'isLogin' => ['description' => '会员是否登录。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + 'isVip' => ['description' => '该账号是否为会员。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + 'startTime' => ['description' => '会员的开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1652337963097', 'title' => ''], + 'endTime' => ['description' => '会员的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1652337963097', 'title' => ''], + 'loginNick' => ['description' => '账号的昵称。', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'phone' => ['description' => '账户的手机号码。', 'type' => 'string', 'required' => false, 'example' => '188*777', 'title' => ''], + 'pkgName' => ['description' => '应用包名。', 'type' => 'string', 'required' => true, 'example' => 'com.***.test', 'title' => ''], + 'originUuid' => ['description' => '明文uuid', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B', 'title' => ''], + ], 'required' => false, - 'example' => '1001', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ErrorMsg', - 'in' => 'query', + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '领取异常', + 'title' => '', + 'description' => '用户标识信息', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => '用户标识，设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], + 'IdType' => [ + 'title' => '', + 'description' => '用户Id的类型 '."\n" + .'- OPEN_ID：默认的用户ID标识。'."\n" + .'- UNION_ID: 组织维度的用户ID标识，在天猫精灵技能应用开放平台申请过组织后才会有该值。', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'EncodeType' => [ + 'title' => '', + 'description' => '编码类型，获取天猫精灵的用户标识的途径有多种，不同途径对应不同的编码类型。'."\n" + .'- PACKAGE_NAME：apk包名，Android应用客户链路的编码类型。'."\n" + .'- SKILL_ID：技能ID，云端链路的编码类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => '编码类型对应的值'."\n" + ."\n" + .'- 编码类型是SKILL_ID时，其值为应用的Skill ID。'."\n" + .'- 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => '组织ID，如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'ExtendInfo', - 'in' => 'query', + 'name' => 'DeviceInfo', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '扩展字段', - 'description' => '', + 'title' => '', + 'description' => 'Device identity information', 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of the device ID.'."\n" + .'- OPEN_ID: The default device ID.'."\n" + .'- UNION_ID: Organization-level device ID. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID from Tmall Genie, and each method corresponds to a different encoding type.'."\n" + .'- PACKAGE_NAME: APK package name, used for Android application customer flows.'."\n" + .'- SKILL_ID: Skill ID, used for cloud-based flows.', + 'type' => 'string', + 'required' => false, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => '编码类型对应的值'."\n" + ."\n" + .'- 编码类型是SKILL_ID时，其值为应用的Skill ID。'."\n" + .'- 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], 'required' => false, - 'example' => '{}', + 'example' => '', ], ], ], @@ -3959,221 +2198,167 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RetValue' => [ - 'title' => '返回结果 true/false', - 'description' => '', - 'type' => 'boolean', - ], - 'RetMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '系统异常', - ], - 'RetCode' => [ - 'title' => '错误状态码', - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F', - ], + 'RetCode' => ['description' => 'The returned error code. `0` indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RetMsg' => ['description' => 'The returned error message. This field is not returned if the operation succeeded.', 'type' => 'string', 'example' => '请求异常', 'title' => ''], + 'RetValue' => ['description' => 'The returned invocation result.'."\n" + ."\n" + .'- true indicates success.'."\n" + .'- false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => '500', 'errorMessage' => '内部服务错误_xxx', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetValue\\": true,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetCode\\": \\"400\\",\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","type":"json"}]', + 'title' => 'Report Third-party Membership Information', + 'changeSet' => [], + 'translator' => 'machine', ], - 'ThirdImmediateMsgPush' => [ - 'summary' => '三方即时信息数据变更事件推送', - 'path' => '/v1.0/iap/thirdImmediateMsgPush', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'WakeUpApp' => [ + 'summary' => 'On a smart speaker with a screen, proactively launch the MeowGenie screen-display application. You must first request this capability on the MeowGenie skill application platform.', + 'path' => '/v1.0/iap/wakeup', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'title' => '用户id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'userId', - ], - ], - [ - 'name' => 'OrderId', - 'in' => 'query', - 'schema' => [ - 'title' => '订单id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'orderId', - ], - ], - [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'title' => '业务类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FLIGHT', - ], - ], - [ - 'name' => 'TrafficChangeType', - 'in' => 'query', - 'schema' => [ - 'title' => '变动类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficChangeType', - ], - ], - [ - 'name' => 'TrafficChangeTypeDesc', - 'in' => 'query', - 'schema' => [ - 'title' => '变动类型描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficChangeTypeDesc', - ], - ], - [ - 'name' => 'ChangeDetail', - 'in' => 'query', - 'schema' => [ - 'title' => '变动信息明细', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'changeDetail', - ], - ], - [ - 'name' => 'TrafficJourneyIds', - 'in' => 'query', - 'schema' => [ - 'title' => '变更的行程id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficJourneyIds', - ], - ], - [ - 'name' => 'TrafficSubOrderIds', - 'in' => 'query', - 'schema' => [ - 'title' => '变更的火车申请单子订单id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficSubOrderIds', - ], - ], - [ - 'name' => 'PsgIds', - 'in' => 'query', - 'schema' => [ - 'title' => '变更的乘客id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'psgIds', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => '', + 'description' => 'Input parameters for the service request.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '调用是否成功', - 'description' => '', - 'type' => 'boolean', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '500000000', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '服务器内部异常', - ], - 'Model' => [ - 'title' => '推送结果', - 'description' => '', + 'Path' => ['title' => '', 'description' => 'The path to launch the application, similar to the Link you enter in the skill application console.', 'type' => 'string', 'required' => true, 'example' => '应用拉起路径'], + 'SubjectId' => ['title' => 'CatGenie application ID ', 'type' => 'string', 'required' => true, 'example' => '2021****001', 'description' => ''], + 'TargetInfo' => [ + 'title' => '', + 'description' => 'Device Information of the target to be launched.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', + 'TargetType' => [ + 'title' => '', + 'description' => 'Push Target Type, which indicates the type of the obtained device identity: '."\n" + .'- `DEVICE_UNION_ID`: Device unionId '."\n" + .'- `DEVICE_OPEN_ID`: Device openId', 'type' => 'string', - 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B', + 'required' => true, + 'example' => 'DEVICE_OPEN_ID', + 'enum' => ['DEVICE_UNION_ID', 'DEVICE_OPEN_ID'], ], - 'Success' => [ - 'title' => '是否推送成功', - 'description' => '', - 'type' => 'boolean', + 'TargetIdentity' => ['title' => '', 'description' => 'The identity value corresponding to the Push Target Type.', 'type' => 'string', 'required' => true, 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This is required only when the push type is `XX_UNION_XX`. If you have multiple methods to obtain MeowGenie device IDs and need interoperability among them, you must request an organization from the platform. After approval, the platform will assign an organization ID.', 'type' => 'string', 'required' => false, 'example' => '11'], + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the MeowGenie device ID, and each method corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name '."\n" + .'- SKILL_ID: Skill ID', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. '."\n" + .'- When the encoding type is SKILLID, the value is the skill ID obtained from the webhook service. '."\n" + .'- When the encoding type is PACKAGENAME, the value is the packageName of the corresponding client application. ', 'type' => 'string', 'required' => true, 'example' => 'apk包名'], ], + 'required' => true, + 'example' => '', ], + 'IsDebug' => ['title' => '', 'description' => 'The debug identity. When the skill application is in the debugging phase, this setting determines whether the retrieved skill application information is from the editing state or the online state. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], + 'required' => true, + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"500000000\\",\\n \\"ErrorMsg\\": \\"服务器内部异常\\",\\n \\"Model\\": {\\n \\"RequestId\\": \\"2DF6FEFE-3301-16DD-ABCC-968A9524920B\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.WakeUpApp.Device.Offline', 'errorMessage' => 'The Target Device is not online.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'errorMessage' => 'The AliGenie app does not release.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Body', 'errorMessage' => 'You must specify request body.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'errorMessage' => 'You must specify TargetInfo.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'errorMessage' => 'You must specify Path.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', 'errorMessage' => 'You must specify TargetIdentity.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', 'errorMessage' => 'You must specify EncodeKey.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'errorMessage' => 'You must specify EncodeType.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'errorMessage' => 'You must specify TargetType.', 'description' => ''], + ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', 'errorMessage' => 'You must specify OrganizationId.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'Proactively Launch Screen-Display Application', + 'translator' => 'machine', + 'changeSet' => [], ], ], - 'endpoints' => [ - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'openapi.aligenie.com', - ], + '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' => [], ]; 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' => '', ], ], ]; diff --git a/data/en_us/aligenie/oauth2_1.0/api-docs.php b/data/en_us/aligenie/oauth2_1.0/api-docs.php index c03e466..e4c52df 100644 --- a/data/en_us/aligenie/oauth2_1.0/api-docs.php +++ b/data/en_us/aligenie/oauth2_1.0/api-docs.php @@ -1,35 +1,18 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'AliGenie', - 'product' => 'AliGenie', - 'version' => 'oauth2_1.0', - ], + 'info' => ['style' => 'AliGenie', 'product' => 'AliGenie', 'version' => 'oauth2_1.0'], 'directories' => [ [ 'id' => 196076, 'title' => null, 'type' => 'directory', - 'children' => [ - 'GetSmartHomeSceneList', - 'ExecuteSmartHomeScene', - 'GetUserBasicInfo', - 'GetUserPhone', - 'GetSceneList', - 'ExecuteScene', - 'QueryDeviceList', - 'PushDeviceNotification', - 'CreatePlayingList', - ], + 'children' => ['GetSmartHomeSceneList', 'ExecuteSmartHomeScene', 'GetUserBasicInfo', 'GetUserPhone', 'GetSceneList', 'ExecuteScene', 'QueryDeviceList', 'PushDeviceNotification', 'CreatePlayingList'], ], [ 'id' => 196077, 'title' => null, 'type' => 'directory', - 'children' => [ - 'OAuth2TokenEndpoint', - 'OAuth2RevocationEndpoint', - ], + 'children' => ['OAuth2TokenEndpoint', 'OAuth2RevocationEndpoint'], ], ], 'components' => [ @@ -39,25 +22,17 @@ 'GetSmartHomeSceneList' => [ 'summary' => '获取场景列表（全屋）', 'path' => '/v1.0/oauth2/iot/smart_home/scene/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ @@ -65,12 +40,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'."\n"], 'FamilySceneList' => [ 'description' => '', 'type' => 'array', @@ -78,32 +48,16 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'familyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2iS1AH5eo8qrw1PYBL/Ulq==', - ], - 'familyName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'familyId' => ['description' => '', 'type' => 'string', 'example' => '2iS1AH5eo8qrw1PYBL/Ulq=='], + 'familyName' => ['description' => '', 'type' => 'string', 'example' => ''], 'sceneList' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SceneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6813AH5586qrw1P5ln/123==', - ], - 'SceneName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'SceneId' => ['description' => '', 'type' => 'string', 'example' => '6813AH5586qrw1P5ln/123=='], + 'SceneName' => ['description' => '', 'type' => 'string', 'example' => ''], ], ], ], @@ -114,55 +68,33 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"435CF567-12DC-5761-AFA8-650774502E2D\\\\n\\",\\n \\"FamilySceneList\\": [\\n {\\n \\"familyId\\": \\"2iS1AH5eo8qrw1PYBL/Ulq==\\",\\n \\"familyName\\": \\"我的家\\",\\n \\"sceneList\\": [\\n {\\n \\"SceneId\\": \\"6813AH5586qrw1P5ln/123==\\",\\n \\"SceneName\\": \\"温馨模式\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'ExecuteSmartHomeScene' => [ 'summary' => '执行场景（全屋）', 'path' => '/v1.0/oauth2/iot/smart_home/scene/execute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'FamilyId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2iS1AH5eo8qrw1PYBL/Ulq==', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => '2iS1AH5eo8qrw1PYBL/Ulq=='], ], [ 'name' => 'SceneId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Y1lCALepjYmTEouxsTrkjB==', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'Y1lCALepjYmTEouxsTrkjB=='], ], ], 'responses' => [ @@ -172,43 +104,28 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '435CF567-12DC-5761-AFA8-650774502E2D', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"435CF567-12DC-5761-AFA8-650774502E2D\\"\\n}","type":"json"}]', ], 'GetUserBasicInfo' => [ 'summary' => '获取', 'path' => '/v1.0/oauth2/users/basic', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ @@ -217,78 +134,42 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'OpenId' => [ - 'title' => '用户openId', - 'description' => '', - 'type' => 'string', - 'example' => '3hPPBd9YuhfJQCzZ/07AAWdoO3K8zCb/KAqW96zPHXPiFkzjB/JfcWuuFHQQDaGZ4wVbNMV6wYuj075p/rhVLg==', - ], + 'OpenId' => ['title' => '用户openId', 'description' => '', 'type' => 'string', 'example' => '3hPPBd9YuhfJQCzZ/07AAWdoO3K8zCb/KAqW96zPHXPiFkzjB/JfcWuuFHQQDaGZ4wVbNMV6wYuj075p/rhVLg=='], 'UnionIds' => [ 'title' => '用户unionId列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织id', - 'type' => 'string', - ], - 'UnionId' => [ - 'title' => 'unionId', - 'type' => 'string', - ], + 'OrganizationId' => ['title' => '组织id', 'type' => 'string'], + 'UnionId' => ['title' => 'unionId', 'type' => 'string'], ], ], ], - 'Nickname' => [ - 'title' => '用户昵称', - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'AvatarUrl' => [ - 'title' => '用户头像地址', - 'description' => '', - 'type' => 'string', - 'example' => 'https://xxxxxx', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5', - ], + 'Nickname' => ['title' => '用户昵称', 'description' => '', 'type' => 'string', 'example' => 'xxxxxx'], + 'AvatarUrl' => ['title' => '用户头像地址', 'description' => '', 'type' => 'string', 'example' => 'https://xxxxxx'], + 'RequestId' => ['title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OpenId\\": \\"3hPPBd9YuhfJQCzZ/07AAWdoO3K8zCb/KAqW96zPHXPiFkzjB/JfcWuuFHQQDaGZ4wVbNMV6wYuj075p/rhVLg==\\",\\n \\"UnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"\\",\\n \\"UnionId\\": \\"\\"\\n }\\n ],\\n \\"Nickname\\": \\"xxxxxx\\",\\n \\"AvatarUrl\\": \\"https://xxxxxx\\",\\n \\"RequestId\\": \\"4070039E-5822-1F32-9295-1D2883E48BA5\\"\\n}","type":"json"}]', ], 'GetUserPhone' => [ 'summary' => '获取天猫精灵用户绑定的手机号', 'path' => '/v1.0/oauth2/user/profile/phone', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ @@ -297,49 +178,29 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Phone' => [ - 'title' => '天猫精灵用户绑定的手机号', - 'description' => '', - 'type' => 'string', - 'example' => '18612345678', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97', - ], + 'Phone' => ['title' => '天猫精灵用户绑定的手机号', 'description' => '', 'type' => 'string', 'example' => '18612345678'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Phone\\": \\"18612345678\\",\\n \\"RequestId\\": \\"CEADB586-51CB-1B6B-95BD-AB85A7A08E97\\"\\n}","type":"json"}]', ], 'GetSceneList' => [ 'summary' => '获取场景列表', 'path' => '/v1.0/oauth2/iot/scene/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ @@ -357,71 +218,38 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'SceneId' => [ - 'title' => '场景Id', - 'description' => '', - 'type' => 'string', - 'example' => '840960b85c3c48e0bd7260c1718295fd', - ], - 'SceneName' => [ - 'title' => '场景名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'SceneId' => ['title' => '场景Id', 'description' => '', 'type' => 'string', 'example' => '840960b85c3c48e0bd7260c1718295fd'], + 'SceneName' => ['title' => '场景名称', 'description' => '', 'type' => 'string', 'example' => ''], ], ], ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '435CF567-58DC-5761-AFA8-650772602E2D', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => '435CF567-58DC-5761-AFA8-650772602E2D'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SceneList\\": [\\n {\\n \\"SceneId\\": \\"840960b85c3c48e0bd7260c1718295fd\\",\\n \\"SceneName\\": \\"回家场景\\"\\n }\\n ],\\n \\"RequestId\\": \\"435CF567-58DC-5761-AFA8-650772602E2D\\"\\n}","type":"json"}]', ], 'ExecuteScene' => [ 'summary' => '执行场景', 'path' => '/v1.0/oauth2/iot/scene/execute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'formData', - 'schema' => [ - 'title' => '场景Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a84a55aa410e460a9ac753570c76fecc', - ], + 'schema' => ['title' => '场景Id', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'a84a55aa410e460a9ac753570c76fecc'], ], ], 'responses' => [ @@ -431,42 +259,28 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920', - ], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]', ], 'QueryDeviceList' => [ 'summary' => '查询设备列表', 'path' => '/v1.0/oauth2/device/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ @@ -475,18 +289,8 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '实体类型', - 'description' => '', - 'type' => 'string', - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '实体key', - 'description' => '', - 'type' => 'string', - 'example' => '125****0946', - ], + 'EncodeType' => ['title' => '实体类型', 'description' => '', 'type' => 'string', 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '实体key', 'description' => '', 'type' => 'string', 'example' => '125****0946'], 'DeviceList' => [ 'title' => '设备列表', 'description' => '', @@ -494,12 +298,7 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'DeviceOpenId' => [ - 'title' => '设备唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => 'jMR2********ojVJXk=', - ], + 'DeviceOpenId' => ['title' => '设备唯一标识', 'description' => '', 'type' => 'string', 'example' => 'jMR2********ojVJXk='], 'DeviceUnionIds' => [ 'title' => '设备UnionId信息列表', 'type' => 'array', @@ -507,78 +306,40 @@ 'title' => '设备UnionId信息', 'type' => 'object', 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织ID', - 'type' => 'string', - ], - 'UnionId' => [ - 'title' => 'UnionId', - 'type' => 'string', - ], + 'OrganizationId' => ['title' => '组织ID', 'type' => 'string'], + 'UnionId' => ['title' => 'UnionId', 'type' => 'string'], ], ], ], - 'DeviceName' => [ - 'title' => '设备名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DeviceIconUrl' => [ - 'title' => '设备图片地址', - 'description' => '', - 'type' => 'string', - 'example' => 'https://XXXXXX', - ], - 'Online' => [ - 'title' => '在线状态，1:在线，0离线', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'DeviceName' => ['title' => '设备名称', 'description' => '', 'type' => 'string', 'example' => ''], + 'DeviceIconUrl' => ['title' => '设备图片地址', 'description' => '', 'type' => 'string', 'example' => 'https://XXXXXX'], + 'Online' => ['title' => '在线状态，1:在线，0离线', 'description' => '', 'type' => 'string', 'example' => '1'], ], ], ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'RequestId' => ['title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '0EC7*726E'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"125****0946\\",\\n \\"DeviceList\\": [\\n {\\n \\"DeviceOpenId\\": \\"jMR2********ojVJXk=\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"123456\\",\\n \\"UnionId\\": \\"cJwXrIut3zIgcKyCiS7aKMAiEiE\\"\\n }\\n ],\\n \\"DeviceName\\": \\"CC10电池版\\",\\n \\"DeviceIconUrl\\": \\"https://XXXXXX\\",\\n \\"Online\\": \\"1\\"\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', ], 'PushDeviceNotification' => [ 'summary' => '推送设备通知', 'path' => '/v1.0/oauth2/device/notification/push', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', @@ -602,67 +363,24 @@ 'type' => 'string', 'required' => false, 'example' => 'DEVICE_OPEN_ID', - 'enum' => [ - 'DEVICE_UNION_ID', - 'DEVICE_OPEN_ID', - ], - ], - 'TargetIdentity' => [ - 'title' => '推送目标类型对应的标识值。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=', + 'enum' => ['DEVICE_UNION_ID', 'DEVICE_OPEN_ID'], ], + 'TargetIdentity' => ['title' => '推送目标类型对应的标识值。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY='], ], 'required' => true, ], - 'MessageTemplateId' => [ - 'title' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2iU81*****G9elJ', - ], + 'MessageTemplateId' => ['title' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '2iU81*****G9elJ'], 'PlaceHolder' => [ 'title' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', 'description' => '', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '', - 'description' => '', - ], - ], - 'EncodeType' => [ - 'title' => '实体类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '实体key', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1923792******8R7392', - ], - 'OrganizationId' => [ - 'title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '29837******2938', - ], - 'IsDebug' => [ - 'title' => '调试标识', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'additionalProperties' => ['type' => 'string', 'example' => '', 'description' => ''], ], + 'EncodeType' => ['title' => '实体类型', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '实体key', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '1923792******8R7392'], + 'OrganizationId' => ['title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '29837******2938'], + 'IsDebug' => ['title' => '调试标识', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], 'required' => false, ], @@ -676,13 +394,7 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'SubjectId' => [ - 'title' => '猫精应用id，【开发者平台-技能应用】创建应用后得到的应用id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12797******304102', - ], + 'SubjectId' => ['title' => '猫精应用id，【开发者平台-技能应用】创建应用后得到的应用id', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '12797******304102'], ], 'required' => false, ], @@ -695,46 +407,29 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F', - ], + 'requestId' => ['title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]', ], 'CreatePlayingList' => [ 'summary' => '创建播放列表', 'path' => '/v1.0/oauth2/content/playing/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'OAuth 2.0 Bearer Token' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'OpenCreatePlayingListRequest', @@ -745,15 +440,9 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'PlayFrom' => [ - 'title' => '播放来源,配置播控能力的唯一标识'."\n" - ."\n" - .'可空，默认为default', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'PlayFrom' => ['title' => '播放来源,配置播控能力的唯一标识'."\n" + ."\n" + .'可空，默认为default', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'default'], 'ContentType' => [ 'title' => '播放内容类型'."\n" ."\n" @@ -762,11 +451,7 @@ 'type' => 'string', 'required' => true, 'example' => 'content', - 'enum' => [ - 'content', - 'album', - 'collect', - ], + 'enum' => ['content', 'album', 'collect'], ], 'ContentList' => [ 'title' => '播放内容列表'."\n" @@ -777,45 +462,19 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'RawId' => [ - 'title' => '三方id'."\n" - ."\n" - .'如果是内容则是内容id；如果是专辑则是专辑id'."\n", - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'Source' => [ - 'title' => '来源'."\n", - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ximalayaH5', - ], + 'RawId' => ['title' => '三方id'."\n" + ."\n" + .'如果是内容则是内容id；如果是专辑则是专辑id'."\n", 'description' => '', 'type' => 'string', 'required' => true, 'example' => '12345'], + 'Source' => ['title' => '来源'."\n", 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'ximalayaH5'], ], 'required' => true, ], 'required' => true, ], - 'Index' => [ - 'title' => '播放的index'."\n" - ."\n" - .'可空。默认为0，表示从头播放', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'NeedAlbumContinued' => [ - 'title' => '专辑是否续播，比如上次专辑听到第五集，是否继续从第五集开始。默认为true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'Index' => ['title' => '播放的index'."\n" + ."\n" + .'可空。默认为0，表示从头播放', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'NeedAlbumContinued' => ['title' => '专辑是否续播，比如上次专辑听到第五集，是否继续从第五集开始。默认为true', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], 'PlayMode' => [ 'title' => '播放模式'."\n" ."\n" @@ -824,24 +483,10 @@ 'type' => 'string', 'required' => false, 'example' => 'Normal', - 'enum' => [ - 'Repeat', - 'Shuffle', - 'RepeatOne', - 'Normal', - ], - ], - 'ExtendInfo' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - 'RequestId' => [ - 'title' => '系统RequestId，调用方不需要传 系统自动填写', - 'type' => 'string', + 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'], ], + 'ExtendInfo' => ['title' => '扩展信息', 'description' => '', 'type' => 'object', 'required' => false, 'example' => '{}'], + 'RequestId' => ['title' => '系统RequestId，调用方不需要传 系统自动填写', 'type' => 'string'], ], 'required' => true, ], @@ -861,42 +506,19 @@ 'type' => 'string', 'required' => true, 'example' => 'UC_CLIENT_ID', - 'enum' => [ - 'UC_CLIENT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'enum' => ['UC_CLIENT_ID'], ], + 'EncodeKey' => ['title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ 'title' => '设备Id的类型 ： OPEN_ID：默认的设备ID标识。 UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识，填写deviceOpenId或deviceUnionId的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['title' => '设备标识，填写deviceOpenId或deviceUnionId的值。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '123'], + 'OrganizationId' => ['title' => '组织ID，如果IdType为UNION_ID时必填。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, ], @@ -909,90 +531,50 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '10002398812'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10002398812\\"\\n}","type":"json"}]', ], 'OAuth2TokenEndpoint' => [ 'summary' => 'OAuth2令牌端点', 'path' => '/v1.0/oauth2/token', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'GrantType', 'in' => 'formData', - 'schema' => [ - 'title' => '授权类型，必填。'."\n" - .'authorization_code: 用授权码来获取访问令牌'."\n" - .'refresh_token: 刷新访问令牌', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'authorization_code', - ], + 'schema' => ['title' => '授权类型，必填。'."\n" + .'authorization_code: 用授权码来获取访问令牌'."\n" + .'refresh_token: 刷新访问令牌', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'authorization_code'], ], [ 'name' => 'Code', 'in' => 'formData', - 'schema' => [ - 'title' => '授权码，通过授权码换取访问令牌时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rf3mi4JOU-xRIX2zEuRLHi-U9mPnvISeSphbwiBHJ5mEKZtG-xJsbBWrq8RmhQEPRYh0JOd3DaS_VZ90soD_YrsT4OBtgD06DmdIKL2_5KFfI6p_SjXX2-UMJuGfXDkB', - ], + 'schema' => ['title' => '授权码，通过授权码换取访问令牌时必填。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rf3mi4JOU-xRIX2zEuRLHi-U9mPnvISeSphbwiBHJ5mEKZtG-xJsbBWrq8RmhQEPRYh0JOd3DaS_VZ90soD_YrsT4OBtgD06DmdIKL2_5KFfI6p_SjXX2-UMJuGfXDkB'], ], [ 'name' => 'RedirectUri', 'in' => 'formData', - 'schema' => [ - 'title' => '重定向地址，该值必须与您发起授权请求的参数值完全一致。通过授权码换取访问令牌时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://xxx.xxx.com/xxx', - ], + 'schema' => ['title' => '重定向地址，该值必须与您发起授权请求的参数值完全一致。通过授权码换取访问令牌时必填。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'https://xxx.xxx.com/xxx'], ], [ 'name' => 'RefreshToken', 'in' => 'formData', - 'schema' => [ - 'title' => '刷新令牌，刷新访问令牌时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A', - ], + 'schema' => ['title' => '刷新令牌，刷新访问令牌时必填。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A'], ], ], 'responses' => [ @@ -1002,100 +584,45 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'AccessToken' => [ - 'title' => '天猫精灵给您的应用颁发的令牌。', - 'description' => '', - 'type' => 'string', - 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0', - ], - 'ExpiresIn' => [ - 'title' => '访问令牌的剩余生命周期（以秒为单位）。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '604799', - ], - 'RefreshToken' => [ - 'title' => '可用于获取新访问令牌的令牌。', - 'description' => '', - 'type' => 'string', - 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A'."\n", - ], - 'Scope' => [ - 'title' => 'access_token 授予的访问权限范围，表示为以空格分隔、区分大小写的字符串列表。', - 'description' => '', - 'type' => 'string', - 'example' => 'aligenie:user:basic:read aligenie:iot:scene:read', - ], - 'TokenType' => [ - 'title' => '返回的令牌的类型。此时，此字段的值始终设置为 Bearer。', - 'description' => '', - 'type' => 'string', - 'example' => 'Bearer', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5', - ], + 'AccessToken' => ['title' => '天猫精灵给您的应用颁发的令牌。', 'description' => '', 'type' => 'string', 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0'], + 'ExpiresIn' => ['title' => '访问令牌的剩余生命周期（以秒为单位）。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '604799'], + 'RefreshToken' => ['title' => '可用于获取新访问令牌的令牌。', 'description' => '', 'type' => 'string', 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A'."\n"], + 'Scope' => ['title' => 'access_token 授予的访问权限范围，表示为以空格分隔、区分大小写的字符串列表。', 'description' => '', 'type' => 'string', 'example' => 'aligenie:user:basic:read aligenie:iot:scene:read'], + 'TokenType' => ['title' => '返回的令牌的类型。此时，此字段的值始终设置为 Bearer。', 'description' => '', 'type' => 'string', 'example' => 'Bearer'], + 'RequestId' => ['title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessToken\\": \\"UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0\\",\\n \\"ExpiresIn\\": 604799,\\n \\"RefreshToken\\": \\"zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A\\\\n\\",\\n \\"Scope\\": \\"aligenie:user:basic:read aligenie:iot:scene:read\\",\\n \\"TokenType\\": \\"Bearer\\",\\n \\"RequestId\\": \\"4070039E-5822-1F32-9295-1D2883E48BA5\\"\\n}","type":"json"}]', ], 'OAuth2RevocationEndpoint' => [ 'summary' => 'OAuth2令牌撤销端点', 'path' => '/v1.0/oauth2/revoke', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'Token', 'in' => 'formData', - 'schema' => [ - 'title' => '要撤销的令牌，可以是访问令牌或刷新令牌。'."\n" - .'如果传递的是access_token，则仅会撤销access_token，refresh_token依然可以刷新获取新的访问令牌。'."\n" - .'如果传递的是refresh_token，则会同时撤销access_token和对应的refresh_token。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0', - ], + 'schema' => ['title' => '要撤销的令牌，可以是访问令牌或刷新令牌。'."\n" + .'如果传递的是access_token，则仅会撤销access_token，refresh_token依然可以刷新获取新的访问令牌。'."\n" + .'如果传递的是refresh_token，则会同时撤销access_token和对应的refresh_token。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0'], ], [ 'name' => 'TokenTypeHint', 'in' => 'formData', - 'schema' => [ - 'title' => '令牌类型的提示，可以是access_token或refresh_token，用于帮助授权服务器理解要撤销的是哪种类型的令牌。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'refresh_token', - ], + 'schema' => ['title' => '令牌类型的提示，可以是access_token或refresh_token，用于帮助授权服务器理解要撤销的是哪种类型的令牌。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'refresh_token'], ], ], 'responses' => [ @@ -1105,26 +632,16 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4070039E-5822-1F32-9295-1D2883E48BA5\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'openapi.aligenie.com', - ], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'openapi.aligenie.com'], ], ]; diff --git a/data/en_us/aligenie/ssp_1.0/api-docs.php b/data/en_us/aligenie/ssp_1.0/api-docs.php index b8a7c44..2743cfd 100644 --- a/data/en_us/aligenie/ssp_1.0/api-docs.php +++ b/data/en_us/aligenie/ssp_1.0/api-docs.php @@ -1,250 +1,177 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'AliGenie', - 'product' => 'AliGenie', - 'version' => 'ssp_1.0', - ], + 'info' => ['style' => 'ROA', 'product' => 'AliGenie', 'version' => 'ssp_1.0'], 'directories' => [ [ - 'id' => 171020, - 'title' => null, + 'children' => ['AuthLoginWithThirdUserInfo', 'EcologyOpennessSendVerificationCode', 'FindUserlistToAuthLoginWithPhoneNumber', 'AuthLoginWithAligenieUserInfo', 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber', 'AuthLoginWithTaobaoUserInfo', 'EcologyOpennessAuthenticate', 'GetAligenieUserInfo', 'UnbindAligenieUser', 'QueryUserDeviceListByTmeUserId', 'InvalidateThirdPartyAppLoginState'], 'type' => 'directory', - 'children' => [ - 'AuthLoginWithThirdUserInfo', - 'EcologyOpennessSendVerificationCode', - 'FindUserlistToAuthLoginWithPhoneNumber', - 'AuthLoginWithAligenieUserInfo', - 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber', - 'AuthLoginWithTaobaoUserInfo', - 'EcologyOpennessAuthenticate', - 'GetAligenieUserInfo', - 'UnbindAligenieUser', - 'QueryUserDeviceListByTmeUserId', - 'InvalidateThirdPartyAppLoginState', - ], + 'title' => 'Account Binding and User Authorization', ], [ - 'id' => 170170, - 'title' => null, + 'children' => ['CheckAuthCodeBindForExt', 'GetCodeEnhance', 'ScanCodeBind'], 'type' => 'directory', - 'children' => [ - 'CheckAuthCodeBindForExt', - 'GetCodeEnhance', - 'ScanCodeBind', - ], + 'title' => 'Activate Binding', ], [ - 'id' => 96289, - 'title' => null, + 'children' => ['GetUserByDeviceId', 'ListDeviceByUserId', 'UnbindDevice', 'ListDeviceByUserIdAndChanel'], 'type' => 'directory', - 'children' => [ - 'GetUserByDeviceId', - 'ListDeviceByUserId', - 'UnbindDevice', - 'ListDeviceByUserIdAndChanel', - ], + 'title' => 'User-Device Relationship', ], [ - 'id' => 96293, - 'title' => null, + 'children' => ['GetDeviceIdByIdentity', 'ListDeviceIdByIdentities', 'GetDeviceBasicInfo', 'ListDeviceBasicInfo', 'GetDeviceStatusInfo', 'GetDeviceTag', 'DeviceControl', 'GetDeviceSetting', 'GetDeviceStatusDetail', 'SetDeviceSetting'], 'type' => 'directory', - 'children' => [ - 'GetDeviceIdByIdentity', - 'ListDeviceIdByIdentities', - 'GetDeviceBasicInfo', - 'ListDeviceBasicInfo', - 'GetDeviceStatusInfo', - 'GetDeviceTag', - 'DeviceControl', - 'GetDeviceSetting', - 'GetDeviceStatusDetail', - 'SetDeviceSetting', - ], + 'title' => 'Device Information', ], [ - 'id' => 170173, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 199234, - 'title' => null, + 'children' => ['GetJiangSuTelecomData'], 'type' => 'directory', + 'title' => 'Data', + ], + [ 'children' => [ - 'GetJiangSuTelecomData', + 'ScgSearch', 'AddAndRemoveFavoriteContent', 'CreatePlayingList', 'GetAlbum', 'GetContent', 'GetCurrentPlayingItem', 'GetCurrentPlayingList', 'IndexControlPlayingList', 'ListAlbumDetail', 'ListCateContent', 'ListCateInfo', 'ListCommonCateFirstFloor', 'ListCommonCateSecondFloor', 'ListPlayHistory', 'ListRecommendContent', 'PlayAndPauseControl', 'PlayModeControl', 'PreviousAndNextControl', 'ProgressControl', 'SearchContent', + 'CloudPlayer', 'MobileRecommend', ], + 'type' => 'directory', + 'title' => 'Video-on-Demand Content', ], [ - 'id' => 170178, - 'title' => null, + 'children' => ['AddSub', 'DeleteSub', 'ListAlbumIsAdded', 'ListSub', 'ListSubAlbum', 'ListSubscriptionAlbumCategory', 'GetAlbumDetailById'], 'type' => 'directory', - 'children' => [ - 'ScgSearch', - 'AddAndRemoveFavoriteContent', - 'CreatePlayingList', - 'GetAlbum', - 'GetContent', - 'GetCurrentPlayingItem', - 'GetCurrentPlayingList', - 'IndexControlPlayingList', - 'ListAlbumDetail', - 'ListCateContent', - 'ListCateInfo', - 'ListCommonCateFirstFloor', - 'ListCommonCateSecondFloor', - 'ListPlayHistory', - 'ListRecommendContent', - 'PlayAndPauseControl', - 'PlayModeControl', - 'PreviousAndNextControl', - 'ProgressControl', - 'SearchContent', - 'CloudPlayer', - 'MobileRecommend', - ], - ], - [ - 'id' => 170194, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'AddSub', - 'DeleteSub', - 'ListAlbumIsAdded', - 'ListSub', - 'ListSubAlbum', - 'ListSubscriptionAlbumCategory', - 'GetAlbumDetailById', - ], + 'title' => 'Course Subscription', ], [ - 'id' => 170201, - 'title' => null, + 'children' => ['GetUnreadMessageCount', 'ListUserMessage', 'ReadMessage', 'SendMessage'], 'type' => 'directory', - 'children' => [ - 'GetUnreadMessageCount', - 'ListUserMessage', - 'ReadMessage', - 'SendMessage', - ], + 'title' => 'Message', ], [ - 'id' => 170204, - 'title' => null, + 'children' => ['CreateAlarm', 'DeleteAlarms', 'GetAlarm', 'ListAlarms', 'ListMusic', 'QueryMusicType', 'UpdateAlarm'], 'type' => 'directory', - 'children' => [ - 'CreateAlarm', - 'DeleteAlarms', - 'GetAlarm', - 'ListAlarms', - 'ListMusic', - 'QueryMusicType', - 'UpdateAlarm', - ], + 'title' => 'Alarm', ], [ - 'id' => 170174, - 'title' => null, + 'children' => ['CreateScheduleTask', 'DeleteScheduleTask', 'GetScheduleTask'], 'type' => 'directory', - 'children' => [ - 'CreateScheduleTask', - 'DeleteScheduleTask', - 'GetScheduleTask', - ], + 'title' => 'Scheduled Task', ], [ - 'id' => 171175, - 'title' => null, + 'children' => ['GetWeather'], 'type' => 'directory', - 'children' => [ - 'GetWeather', - ], + 'title' => 'Weather', ], ], + 'type' => 'directory', + 'title' => 'Feature API', ], [ - 'id' => 263709, - 'title' => null, + 'children' => ['CreatePlayingListOAuth2', 'ThirdImmediateMsgPush'], 'type' => 'directory', - 'children' => [ - 'CreatePlayingListOAuth2', - 'ThirdImmediateMsgPush', - ], + 'title' => 'Other', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'AuthLoginWithThirdUserInfo' => [ - 'summary' => '通过三方用户信息进行授权登录', - 'path' => '/v1.0/ssp/authLoginWithThirdUserInfo', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddAndRemoveFavoriteContent' => [ + 'summary' => 'Collect or remove from favorites.', + 'path' => '/v1.0/ssp/AddAndRemoveFavoriteContent', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SceneCode', - 'in' => 'formData', - 'schema' => [ - 'title' => '场景码，需提前向天猫精灵申请', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'wechat_ecology_openness', - ], - ], - [ - 'name' => 'ThirdUserType', + 'name' => 'OpenAddAndRemoveFavoriteContentRequest', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '三方用户类型，场景接入申请完成后进行分配', - 'description' => '', - 'type' => 'string', + 'description' => 'Business parameters', + 'type' => 'object', + 'properties' => [ + 'PackageType' => ['description' => 'Content type'."\n" + ."\n" + .'Content: CONTENT; Album: ALBUM; Playlist: COLLECT.', 'type' => 'string', 'required' => true, 'example' => 'CONTENT', 'title' => ''], + 'OpenSourceRawIdPair' => [ + 'description' => 'Object to collect or remove from favorites', + 'type' => 'object', + 'properties' => [ + 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'required' => true, 'example' => '2105818057', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'required' => true, 'example' => 'xiami', 'title' => ''], + 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'FavoriteCmd' => ['description' => 'Operation Type'."\n" + ."\n" + .'ADD for collect; REMOVE for remove from favorites', 'type' => 'string', 'required' => true, 'example' => 'ADD', 'title' => ''], + ], 'required' => true, - 'example' => 'weChatUser', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ThirdUserIdentifier', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '三方用户唯一标识', - 'description' => '', - 'type' => 'string', + 'description' => 'User identification information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID.'."\n" + ."\n" + .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skills 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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], 'required' => true, - 'example' => 'o5qxy6EItZBasv2VZAf-MGwllHL4', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ExtInfo', - 'in' => 'formData', + 'name' => 'DeviceInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '扩展信息', - 'description' => '', + 'description' => 'Device identification information', 'type' => 'object', - 'required' => false, - 'example' => '{}', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID'."\n" + ."\n" + .'`OPEN_ID`: Default device ID identifier. `UNION_ID`: Device ID identifier at the organization dimension. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -255,255 +182,167 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'default' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Result' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LoginStateAccessToken' => [ - 'title' => '登录态访问令牌', - 'description' => '', - 'type' => 'string', - 'example' => 'bd9ccdb121ee950ddead51e943e081fe', - ], - 'ExpiredTimeLong' => [ - 'title' => '登录态访问令牌过期时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1659428051452', - 'default' => '1659333475811', - ], - ], - ], - 'DataObj' => [ - 'title' => '当Code为5140001时，代表登录失败，原因是三方用户未绑定到天猫精灵用户，前端需要根据此错误码走用户手机号授权登录流程，后续流程前端需要将DataObj中SessionId带回服务端。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SessionId' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', - ], - ], - ], + 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Result' => ['description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'Additional information. In common scenarios, this provides a brief description of a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '121212121', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. The value true indicates success, and false indicates failure. When the value is false, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"bd9ccdb121ee950ddead51e943e081fe\\",\\n \\"ExpiredTimeLong\\": 1659428051452\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AuthLoginWithThirdUserInfoResponse>\\n <RequestId>73C67BD9-175A-1324-8202-9FAABBB3E6FA</RequestId>\\n <Code>200</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n <Result>\\n <AccessToken>f6221a258d8cfcb7c82fbf9fff9a164b</AccessToken>\\n <ExpiredTimeLong>1659428051452</ExpiredTimeLong>\\n </Result>\\n <DataObj>\\n <SessionId>dbe2eb4458302b9246c6da17fbc95f4b</SessionId>\\n </DataObj>\\n</AuthLoginWithThirdUserInfoResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"121212121\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Collect or remove from favorites', + 'changeSet' => [], ], - 'EcologyOpennessSendVerificationCode' => [ - 'summary' => '生态开放发送短信验证码', - 'path' => '/v1.0/ssp/ecologyOpennessSendVerificationCode', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddSub' => [ + 'summary' => 'Subscribe to an album.', + 'path' => '/v1.0/ssp/addSub', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SessionId', - 'in' => 'formData', - 'schema' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', - ], - ], - [ - 'name' => 'PhoneNumber', - 'in' => 'formData', + 'name' => 'AddSubscriptionInfoRequest', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '手机号码', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Subscribe to album request ', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'docRequired' => true, 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', 'description' => ''], + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'docRequired' => true, 'example' => '1152893538998276761', 'description' => ''], + 'ScheduleInfo' => [ + 'title' => '', + 'description' => 'Schedule information', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'The specific days of the week for weekly reminders. Valid values are 1 to 7.', + 'type' => 'array', + 'items' => [ + 'description' => 'The specific days of the week for weekly reminders. Valid values are 1 to 7.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '7', + 'minimum' => '1', + 'example' => '1,3,5,7,6', + 'enum' => ['1', '2', '3', '4', '5', '6', '7'], + 'title' => '', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 7, + 'minItems' => 1, + 'example' => '', + ], + 'Hour' => ['title' => '', 'description' => 'The hour of the clock when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '23', 'minimum' => '0', 'example' => '1'], + 'Minute' => ['title' => '', 'description' => 'The minute of the hour when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '59', 'minimum' => '0', 'example' => '23'], + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51999575'], + 'PlayMode' => ['title' => '', 'description' => 'Playback pattern (currently only supports sequence) ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sequence'], + 'DailyStudyCnt' => ['title' => '', 'description' => 'Daily study quantity', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'], + ], 'required' => true, - 'example' => '18612345678', + 'docRequired' => true, + 'example' => '', ], ], [ - 'name' => 'Region', - 'in' => 'formData', - 'schema' => [ - 'title' => '地区编码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '+86', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Device Information', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', + 'EncodeType' => [ 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', + 'required' => false, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', + 'EncodeKey' => [ 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', + 'required' => false, + 'example' => '123', + 'enum' => [], 'description' => '', - 'type' => 'boolean', + 'title' => '', ], - 'Result' => [ - 'title' => '响应结果', + 'IdType' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ExpireIn' => [ - 'title' => '有效期（单位：秒）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '900', - ], - 'RepeatInterval' => [ - 'title' => '下次可重新发送的时间间隔（单位：秒）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - ], + 'title' => '', ], + 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"ExpireIn\\": 900,\\n \\"RepeatInterval\\": 60\\n }\\n}","type":"json"}]', - ], - 'FindUserlistToAuthLoginWithPhoneNumber' => [ - 'summary' => '通过手机号寻找可授权登录的账号列表', - 'path' => '/v1.0/ssp/findUserlistToAuthLoginWithPhoneNumber', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'title' => '地区编码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '+86', - ], - ], - [ - 'name' => 'PhoneNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '手机号码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '18612345678', + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'Code', + 'name' => 'UserInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '短信验证码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', + 'title' => '', + 'description' => 'User Information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'description' => '', + 'title' => '', + ], + 'EncodeKey' => [ + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'enum' => [], + 'description' => '', + 'title' => '', + ], + 'IdType' => [ + 'type' => 'string', + 'required' => false, + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Id' => ['type' => 'string', 'required' => false, 'example' => '123', 'description' => '', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '', ], ], ], @@ -514,127 +353,66 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - ], + 'Code' => ['title' => '', 'description' => 'Status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], 'Result' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Return Result', 'type' => 'object', 'properties' => [ - 'UserListToAuthLogin' => [ - 'title' => '可授权登录的账号列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '可授权登录的账号', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserType' => [ - 'title' => '用户类型'."\n" - .'TAOBAO：淘宝用户'."\n" - .'ALIGENIE：天猫精灵用户', - 'description' => '', - 'type' => 'string', - 'example' => 'ALIGENIE', - ], - 'EncryptedUserIdentifier' => [ - 'title' => '加密过的用户标识', - 'description' => '', - 'type' => 'string', - 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh', - ], - 'Nickname' => [ - 'title' => '用户昵称', - 'description' => '', - 'type' => 'string', - 'example' => 'XXX', - ], - 'Avatar' => [ - 'title' => '用户头像', - 'description' => '', - 'type' => 'string', - 'example' => 'https://xxx', - ], - 'FindingType' => [ - 'title' => '用户发现类型'."\n" - ."\n" - .'淘宝用户固定为：PHONE_NUMBER_BINDING_WITH_TAOBAO：phoneNumber作为淘宝绑定手机号查询到的；'."\n" - ."\n" - .'天猫精灵用户为：'."\n" - .'PHONE_NUMBER_BINDING_WITH_ALIGENIE：phoneNumber作为精灵绑定手机号查询到的；'."\n" - .'PHONE_NUMBER_BINDING_WITH_TAOBAO：phoneNumber作为淘宝绑定手机号查询到的；', - 'description' => '', - 'type' => 'string', - 'example' => 'PHONE_NUMBER_BINDING_WITH_ALIGENIE：phoneNumber', - ], + 'Id' => ['title' => '', 'description' => 'Subscription record ID', 'type' => 'integer', 'format' => 'int64', 'example' => '81'], + 'DeviceId' => ['title' => '', 'description' => 'Device ID', 'type' => 'string', 'example' => '5874DBCCA3038FAA1A70A8060F07F26D'], + 'UserId' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => '1152893538998276761'], + 'ScheduleInfo' => [ + 'title' => '', + 'description' => 'Schedule information ', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'The epoch for trigger ', + 'type' => 'array', + 'items' => ['description' => 'Set the specific days of the week for reminders. The value range is 1 to 7. ', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'example' => '', ], + 'Hour' => ['title' => '', 'description' => 'The hour of the clock when the trigger occurs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'Minute' => ['title' => '', 'description' => 'The minute of the Time when the trigger occurs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], ], + 'example' => '', ], + 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '51999575'], + 'PlayMode' => ['title' => '', 'description' => 'Playback mode', 'type' => 'string', 'example' => 'sequence'], + 'DailyStudyCnt' => ['title' => '', 'description' => 'Daily study quantity', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], + 'example' => '', ], - 'DataObj' => [ - 'title' => 'Code为5140003时代表调用失败，原因是该手机号未找到可授权登录的账号列表，前端可以让用户确认通过手机号生成精灵账号，也可提示用户先基于手机号注册淘宝账号，后续流程前端需要将DataObj中sessionId带回服务端。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SessionId' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', - ], - ], - ], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'B99D27ED-4E12-1414-9FDE-599C57C4B204'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserListToAuthLogin\\": [\\n {\\n \\"UserType\\": \\"ALIGENIE\\",\\n \\"EncryptedUserIdentifier\\": \\"KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh\\",\\n \\"Nickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"https://xxx\\",\\n \\"FindingType\\": \\"PHONE_NUMBER_BINDING_WITH_ALIGENIE：phoneNumber\\"\\n }\\n ]\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","type":"json"}]', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Result\\": {\\n \\"Id\\": 81,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": \\"1152893538998276761\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B99D27ED-4E12-1414-9FDE-599C57C4B204\\"\\n}","type":"json"}]', + 'title' => 'Subscribe to album ', + 'changeSet' => [], ], 'AuthLoginWithAligenieUserInfo' => [ - 'summary' => '通过指定精灵账号进行授权登录', + 'summary' => 'Authorize logon by specifying an Aligenie account. ', 'path' => '/v1.0/ssp/authLoginWithAligenieUserInfo', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], @@ -642,24 +420,12 @@ [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', - ], + 'schema' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ 'name' => 'EncryptedAligenieUserIdentifier', 'in' => 'formData', - 'schema' => [ - 'title' => '加密过的精灵用户标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'UYugfm/3Nb9q24AyES2rYmC5tIglSoDX3Mbna/vrldcjGPtC8VzFwo+CU5c4CHLjrK7ekskG2WVaevM5Zi9f0w==', - ], + 'schema' => ['title' => '', 'description' => 'Encrypted Aligenie User Identifier ', 'type' => 'string', 'required' => true, 'example' => 'UYugfm/3Nb9q24AyES2rYmC5tIglSoDX3Mbna/vrldcjGPtC8VzFwo+CU5c4CHLjrK7ekskG2WVaevM5Zi9f0w=='], ], ], 'responses' => [ @@ -669,80 +435,41 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'default' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ - 'LoginStateAccessToken' => [ - 'title' => '登录态访问令牌', - 'description' => '', - 'type' => 'string', - 'example' => 'd15aa92de679d0d225aa845268be19ee', - ], - 'ExpiredTimeLong' => [ - 'title' => '登录态访问令牌过期时间（长整型）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1659506854230', - 'default' => '1659506854230', - ], + 'LoginStateAccessToken' => ['title' => '', 'description' => 'Login state access token ', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'], + 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the login state access token (long integer) ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230', 'default' => '1659506854230'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]', + 'title' => 'Authorize logon by specifying an Aligenie account ', + 'changeSet' => [], ], 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber' => [ - 'summary' => '通过手机号生成精灵账号进行授权登录', + 'summary' => 'Generate a Genie account by phone number for authorization logon.', 'path' => '/v1.0/ssp/authLoginWithAligenieUserInfoGeneratedByPhoneNumber', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], @@ -750,13 +477,7 @@ [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', - ], + 'schema' => ['title' => '', 'description' => 'Session ID', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], ], 'responses' => [ @@ -766,80 +487,41 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'default' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Response Result', 'type' => 'object', 'properties' => [ - 'LoginStateAccessToken' => [ - 'title' => '登录态访问令牌', - 'description' => '', - 'type' => 'string', - 'example' => 'd15aa92de679d0d225aa845268be19ee', - ], - 'ExpiredTimeLong' => [ - 'title' => '登录态访问令牌过期时间（长整型）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1659506854230', - 'default' => '1659506854230', - ], + 'LoginStateAccessToken' => ['title' => '', 'description' => 'Logon state access token', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'], + 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the logon state access token (long integer)', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230', 'default' => '1659506854230'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]', + 'title' => 'Generate a Genie account by phone number for authorization logon', + 'changeSet' => [], ], 'AuthLoginWithTaobaoUserInfo' => [ - 'summary' => '通过指定淘宝账号进行授权登录', + 'summary' => 'Authorize logon by specifying a Taobao account ', 'path' => '/v1.0/ssp/authLoginWithTaobaoUserInfo', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], @@ -847,24 +529,12 @@ [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', - ], + 'schema' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ 'name' => 'EncryptedTaobaoUserIdentifier', 'in' => 'formData', - 'schema' => [ - 'title' => '加密过的淘宝用户标识', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh', - ], + 'schema' => ['title' => '', 'description' => 'Encrypted Taobao User Identifier ', 'type' => 'string', 'required' => true, 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh'], ], ], 'responses' => [ @@ -874,113 +544,65 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ - 'LoginStateAccessToken' => [ - 'title' => '登录态访问令牌', - 'description' => '', - 'type' => 'string', - 'example' => 'd15aa92de679d0d225aa845268be19ee', - ], - 'ExpiredTimeLong' => [ - 'title' => '登录态访问令牌过期时间（长整型）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1659506854230', - ], + 'LoginStateAccessToken' => ['title' => '', 'description' => 'Login state access token ', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'], + 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the login state access token (long integer) ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]', + 'title' => 'Authorize logon by specifying a Taobao account ', + 'changeSet' => [], ], - 'EcologyOpennessAuthenticate' => [ - 'summary' => '生态开放鉴权', - 'path' => '/v1.0/ssp/ecologyOpennessAuthenticate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AuthLoginWithThirdUserInfo' => [ + 'summary' => 'Authorize logon by using third-party user information. ', + 'path' => '/v1.0/ssp/authLoginWithThirdUserInfo', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'LoginStateAccessToken', + 'name' => 'SceneCode', 'in' => 'formData', - 'schema' => [ - 'title' => '登录态访问令牌', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd15aa*****ee', - ], + 'schema' => ['title' => '', 'description' => 'Scene code, which must be requested from Tmall Genie in advance', 'type' => 'string', 'required' => true, 'example' => 'wechat_ecology_openness'], ], [ - 'name' => 'EncodeType', + 'name' => 'ThirdUserType', 'in' => 'formData', - 'schema' => [ - 'title' => '实体类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], + 'schema' => ['title' => '', 'description' => 'Third-party User Type', 'type' => 'string', 'required' => true, 'example' => 'weChatUser'], ], [ - 'name' => 'EncodeKey', + 'name' => 'ThirdUserIdentifier', 'in' => 'formData', - 'schema' => [ - 'title' => '实体key', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12*****', - ], + 'schema' => ['title' => '', 'description' => 'Third-party User Identifier', 'type' => 'string', 'required' => true, 'example' => 'o5qxy6EItZBasv2VZAf-MGwllHL4'], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'Extension information', 'type' => 'object', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -990,115 +612,106 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73****9-175A-1324-8202-9FAAB*****A', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'default' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ - 'title' => '响应结果', - 'description' => '', + 'title' => '', + 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ - 'UserOpenId' => [ - 'title' => '精灵用户openId', - 'description' => '', - 'type' => 'string', - 'example' => 'o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==', - ], - 'EncodeType' => [ - 'title' => '实体类型', - 'description' => '', - 'type' => 'string', - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '实体key', - 'description' => '', - 'type' => 'string', - 'example' => '12****7', - ], - 'SceneCode' => [ - 'title' => '场景码', - 'description' => '', - 'type' => 'string', - 'example' => '******', - ], - 'ThirdUserType' => [ - 'title' => '三方用户类型', - 'description' => '', - 'type' => 'string', - 'example' => '******', - ], - 'ThirdUserIdentifier' => [ - 'title' => '三方用户标识', - 'description' => '', - 'type' => 'string', - 'example' => '******', - ], + 'LoginStateAccessToken' => ['title' => '', 'description' => 'Logon state access token ', 'type' => 'string', 'example' => 'bd9ccdb121ee950ddead51e943e081fe'], + 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the logon state access token ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659428051452', 'default' => '1659333475811'], ], + 'example' => '', + ], + 'DataObj' => [ + 'title' => '', + 'description' => 'When Code is 5140001, it indicates that logon failed because the third-party user is not attached to a Tmall Genie user. The frontend must initiate the phone number authorization logon flow based on this error code. In subsequent steps, the frontend must return the SessionId in DataObj to the server. ', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"SceneCode\\": \\"******\\",\\n \\"ThirdUserType\\": \\"******\\",\\n \\"ThirdUserIdentifier\\": \\"******\\"\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"bd9ccdb121ee950ddead51e943e081fe\\",\\n \\"ExpiredTimeLong\\": 1659428051452\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","type":"json"}]', + 'title' => 'Authorize logon by third-party user information', + 'changeSet' => [], ], - 'GetAligenieUserInfo' => [ - 'summary' => '获取三方绑定的精灵账号信息', - 'path' => '/v1.0/ssp/getAligenieUserInfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CheckAuthCodeBindForExt' => [ + 'summary' => 'Poll the result of the activation attachment.', + 'path' => '/v1.0/ssp/checkAuthCodeBindForExt', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'LoginStateAccessToken', + 'name' => 'EncodeType', 'in' => 'query', 'schema' => [ - 'title' => '登录态访问凭证', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. Enter PROJECT_ID here. ', 'type' => 'string', 'required' => true, - 'example' => '99ce8a70c23a94f8569e1a525bef6e85', + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + ], + ], + [ + 'name' => 'EncodeKey', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project containing the ProductKey of this product in the Tmall Genie AI platform. ', 'type' => 'string', 'required' => true, 'example' => '123'], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The authCode obtained by specifying a user ID ', 'type' => 'string', 'required' => true, 'example' => 'Aexfgc'], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'List of user identifier information. ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. Enter PROJECT_ID here. ', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the product\'s project here. You can view it in the Tmall Genie AI platform console. ', 'type' => 'string', 'required' => true, 'example' => '123'], + 'IdType' => [ + 'title' => '', + '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 requires prior request for an organization on the Open Platform. ', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'Id' => ['title' => '', 'description' => 'User identifier. Enter the value of userOpenId or userUnionId. ', 'type' => 'string', 'required' => true, 'example' => '123'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1***2'], + ], + 'required' => true, + 'example' => '', ], ], ], @@ -1109,183 +722,184 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - ], + 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The returned error code. The value 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ + 'title' => '', + 'description' => 'Detailed information', 'type' => 'object', 'properties' => [ - 'AligenieNickname' => [ - 'title' => '精灵用户昵称', - 'description' => '', - 'type' => 'string', - 'example' => 'XXX', - ], - 'Avatar' => [ - 'title' => '精灵用户头像地址', - 'description' => '', - 'type' => 'string', - 'example' => 'http://img.alicdn.com/xxx.jpg', + 'UserOpenInfo' => [ + 'title' => '', + 'description' => 'User open information', + 'type' => 'object', + 'properties' => [ + 'IdType' => ['title' => 'USER_ID', 'description' => 'USER_ID', 'type' => 'string', 'example' => 'USER_ID'], + 'Id' => ['title' => '', 'description' => 'External user ID', 'type' => 'string', 'example' => '0963*0158'], + ], + 'example' => '', ], - 'Deletable' => [ - 'title' => '是否可注销', - 'description' => '', - 'type' => 'boolean', + 'DeviceOpenInfo' => [ + 'title' => '', + 'description' => 'Device open information', + 'type' => 'object', + 'properties' => [ + 'IdType' => ['title' => 'DEVICE_ID', 'description' => 'DEVICE_ID', 'type' => 'string', 'example' => 'DEVICE_ID'], + 'Id' => ['title' => '', 'description' => 'External device ID', 'type' => 'string', 'example' => 'A963*0158'], + ], + 'example' => '', ], ], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"AligenieNickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"http://img.alicdn.com/xxx.jpg\\",\\n \\"Deletable\\": true\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenInfo\\": {\\n \\"IdType\\": \\"USER_ID\\",\\n \\"Id\\": \\"0963*0158\\"\\n },\\n \\"DeviceOpenInfo\\": {\\n \\"IdType\\": \\"DEVICE_ID\\",\\n \\"Id\\": \\"A963*0158\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Polling result of activation binding ', + 'changeSet' => [], ], - 'UnbindAligenieUser' => [ - 'summary' => '解除三方和精灵账号的关系', - 'path' => '/v1.0/ssp/unbindAligenieUser', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudPlayer' => [ + 'summary' => 'Cloud Push Song: Create a playlist by providing the device openUuid and the Tmall Genie openUserId.', + 'path' => '/v1.0/ssp/cloud/player', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'LoginStateAccessToken', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '登录态访问凭证', - 'description' => '', - 'type' => 'string', + 'description' => 'Open user information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'description' => 'Encoding type', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', + ], + 'EncodeKey' => ['description' => 'Encoding key', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => [ + 'description' => 'ID Type', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'title' => '', + ], + 'Id' => ['description' => 'Open ID', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID (can be empty)', 'type' => 'string', 'required' => false, 'example' => '为空', 'title' => ''], + ], 'required' => true, - 'example' => '99ce8a70c23a94f8569e1a525bef6e85', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', + 'EncodeType' => [ + 'description' => 'Encoding type', 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', + 'EncodeKey' => [ + 'description' => 'Encoding key', 'type' => 'string', - 'example' => 'OK', + 'required' => true, + 'example' => '123', + 'enum' => [], + 'title' => '', ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', + 'IdType' => [ + 'description' => 'ID Type', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['UNION_ID', 'OPEN_ID'], + 'title' => '', ], + 'Id' => ['description' => 'Open ID', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID (can be empty)', 'type' => 'string', 'required' => false, 'example' => '为空', 'title' => ''], ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QueryUserDeviceListByTmeUserId' => [ - 'summary' => '通过tme用户id获取授权的天猫精灵用户+设备列表', - 'path' => '/v1.0/ssp/queryUserDeviceListByTmeUserId', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AliGenie_Auth_SPI' => [], + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source of cloud-recommended songs', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['KG' => ''], + 'example' => 'KG', + 'title' => '', + ], ], - ], - 'consumes' => [ - 'application/json', - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'TmeUserId', + 'name' => 'SongIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'TME用户id', - 'description' => '', - 'type' => 'string', + 'description' => 'List of song IDs (1–200 songs)', + 'type' => 'array', + 'items' => ['description' => 'Song ID', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], 'required' => true, + 'maxItems' => 200, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Sp', + 'name' => 'CurPlayIndex', + 'in' => 'query', + 'schema' => ['description' => 'Index of the currently playing song. Starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'maximum' => '200', 'minimum' => '1', 'title' => ''], + ], + [ + 'name' => 'PlayMode', 'in' => 'query', 'schema' => [ - 'title' => '"KG"：酷狗'."\n" - .'"KW"：酷我'."\n" - .'"QM"：Q音', - 'description' => '', + 'description' => 'Playback pattern', 'type' => 'string', 'required' => true, + 'enumValueTitles' => ['Shuffle' => '', 'RepeatOne' => '', 'Repeat' => '', 'Normal' => ''], + 'example' => 'Normal', + 'title' => '', ], ], + [ + 'name' => 'SongId', + 'in' => 'query', + 'schema' => ['description' => 'Song ID (used to recompute the index when the index is invalid)', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], ], 'responses' => [ 200 => [ @@ -1294,532 +908,527 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - ], - 'Result' => [ - 'title' => '响应结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Sp' => [ - 'title' => '"KG"：酷狗'."\n" - .'"KW"：酷我'."\n" - .'"QM"：Q音', - 'description' => '', - 'type' => 'string', - ], - 'EncodeType' => [ - 'title' => '实体类型（三方透传即可）', - 'description' => '', - 'type' => 'string', - ], - 'EncodeKey' => [ - 'title' => '实体key（三方透传即可）', - 'description' => '', - 'type' => 'string', - ], - 'AligenieUserInfoList' => [ - 'title' => '天猫精灵用户列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OpenUserId' => [ - 'title' => '用户id', - 'description' => '', - 'type' => 'string', - ], - 'UserNickname' => [ - 'title' => '用户昵称', - 'description' => '', - 'type' => 'string', - ], - 'AuthorizedDeviceList' => [ - 'title' => '用户授权的设备列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OpenDeviceId' => [ - 'title' => '按照天猫精灵开放平台标准加密的设备id', - 'description' => '', - 'type' => 'string', - ], - 'DeviceName' => [ - 'title' => '设备名称', - 'description' => '', - 'type' => 'string', - ], - 'Online' => [ - 'title' => '设备是否在线', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TmeProductId' => [ - 'title' => 'TME产品id', - 'type' => 'string', - ], - 'TmeDeviceId' => [ - 'title' => '透出给TME的设备id', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B7D82DB0-DD59-5756-AC62-871C9D7DBC36'], + 'Code' => ['description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Result' => ['description' => 'Return Result: true indicates validation succeeded; false indicates validation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Sp\\": \\"KG\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"AligenieUserInfoList\\": [\\n {\\n \\"OpenUserId\\": \\"R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==\\",\\n \\"UserNickname\\": \\"a***e\\",\\n \\"AuthorizedDeviceList\\": [\\n {\\n \\"OpenDeviceId\\": \\"fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=\\",\\n \\"DeviceName\\": \\"CC\\",\\n \\"Online\\": true,\\n \\"TmeProductId\\": \\"\\",\\n \\"TmeDeviceId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7D82DB0-DD59-5756-AC62-871C9D7DBC36\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Cloud Push Song', + 'description' => 'After synchronously validating the input parameters, the system asynchronously creates the playlist.', + 'responseParamsDescription' => 'The return value is true or false, indicating whether the playlist creation succeeded.', + 'changeSet' => [], ], - 'InvalidateThirdPartyAppLoginState' => [ - 'summary' => '失效三方应用登录态', - 'path' => '/v1.0/ssp/invalidateThirdPartyAppLoginState', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAlarm' => [ + 'summary' => 'Create an alarm that supports three types: one-time, weekly, and legal working days. ', + 'path' => '/v1.0/ssp/createAlarm', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceInfo', + 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', + 'ScheduleInfo' => [ + 'title' => '', + 'description' => 'Schedule information ', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'Schedule Type / Loop Type: '."\n" + .'ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORY_WORKING_DAY -> Statutory working day ', + 'type' => 'string', + 'required' => true, + 'example' => 'ONCE', + 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], + ], + 'Once' => [ + 'title' => '', + 'description' => 'One-time: This property is active when the loop type is ONCE. ', + 'type' => 'object', + 'properties' => [ + 'Year' => ['title' => '', 'description' => 'Trigger time: Year ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'], + 'Month' => ['title' => '', 'description' => 'Trigger time: Month ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'], + 'Day' => ['title' => '', 'description' => 'Trigger Time: Day ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + 'required' => false, + 'example' => '', + ], + 'Weekly' => [ + 'title' => '', + 'description' => 'Weekly Loop: This property is active when the loop Type is WEEKLY. ', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'Collection of Days of the Week to Trigger ', + 'type' => 'array', + 'items' => ['description' => 'Collection of Days of the Week to Trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week. If triggering every day, include all numbers. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + 'required' => false, + 'example' => '', + ], + 'StatutoryWorkingDay' => [ + 'title' => '', + 'description' => 'Statutory working day: This property is active when the loop Type is STATUTORY_WORKING_DAY.', + 'type' => 'object', + 'properties' => [ + 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', + 'example' => '', ], + 'MusicInfo' => [ + 'title' => '', + 'description' => 'Ringtone information', + 'type' => 'object', + 'properties' => [ + 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'], + 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'MusicName' => ['title' => '', 'description' => 'Ringtone name', 'type' => 'string', 'required' => true, 'example' => 'xx铃声'], + 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'required' => false, 'example' => 'http://xx'], + ], + 'required' => true, + 'example' => '', + ], + 'Volume' => ['title' => '', 'description' => 'Ringtone volume', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'default' => '40'], + 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Invoker', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'User Identifier information', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of User ID: OPEN_ID: default User ID identifier; UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding Type. There are multiple ways to obtain the User Identifier for Maojing, and each way corresponds to a different encoding Type: PACKAGE_NAME: APK package name, used for the Android application Customer link; SKILL_ID: Skill ID, used for the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.*.*.*', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s Skill ID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'ThirdPartyAppId', + 'name' => 'DeviceInfo', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '三方应用标识', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Device identity information ', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of device ID: OPEN_ID: default device ID; UNION_ID: organization-dimension device ID, available only after applying for an organization on the Maojing Skill Application Open Platform. ', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link. ', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the Skill ID of the application; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], 'required' => true, - 'example' => 'com.*.*.*', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'AmpResult', + 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', - ], - 'Code' => [ - 'title' => '响应码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'title' => '调用是否成功标志', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Request result status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'xx为空'], + 'Result' => ['description' => 'Alarm ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], + 'RequestId' => ['description' => 'request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Create Alarm ', + 'responseParamsDescription' => 'The request is successful only when the service returns a status code of 200; otherwise, it indicates failure. ', + 'changeSet' => [], ], - 'CheckAuthCodeBindForExt' => [ - 'summary' => '轮询激活绑定结果', - 'path' => '/v1.0/ssp/checkAuthCodeBindForExt', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreatePlayingList' => [ + 'summary' => 'Create a playlist and play the specified content.', + 'path' => '/v1.0/ssp/CreatePlayingList', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'EncodeType', - 'in' => 'query', + 'name' => 'OpenCreatePlayingListRequest', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', + 'description' => 'Business parameters', + 'type' => 'object', + 'properties' => [ + 'PlayFrom' => ['description' => 'Playback source, the UUID for configuring playback control capabilities.'."\n" + ."\n" + .'Can be empty. Default is "default".', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'ContentType' => ['description' => 'Content type for playback.'."\n" + ."\n" + .'Values: "content" for content, "album" for album, and "collect" for playlist.', 'type' => 'string', 'required' => true, 'example' => 'content', 'title' => ''], + 'ContentList' => [ + 'description' => 'Playback content list.'."\n" + ."\n" + .'If the content type is "content", multiple entries are supported. If it is "album", only the first entry takes effect.', + 'type' => 'array', + 'items' => [ + 'description' => 'Playback object', + 'type' => 'object', + 'properties' => [ + 'RawId' => ['description' => 'Third-party ID.'."\n" + ."\n" + .'If the content type is "content", this is the content ID. If it is "album", this is the album ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'required' => true, 'example' => 'xiami', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Index' => ['description' => 'Playback index.'."\n" + ."\n" + .'Can be empty. Default is 0, indicating playback starts from the beginning.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'NeedAlbumContinued' => ['description' => 'Whether to resume album playback. For example, if the user previously listened up to episode 5 of an album, whether to continue from episode 5. Default is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'PlayMode' => ['description' => 'Playback pattern.'."\n" + ."\n" + .'Repeat: list loop; Shuffle: random; RepeatOne: single track loop; Normal: sequential playback.', 'type' => 'string', 'required' => false, 'example' => 'Repeat', 'title' => ''], + 'ExtendInfo' => ['description' => 'extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], - ], - ], - [ - 'name' => 'EncodeKey', - 'in' => 'query', - 'schema' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', 'required' => true, - 'example' => '123', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AuthCode', + 'name' => 'UserInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '指定用户和渠道获取的authCode', - 'description' => '', - 'type' => 'string', + 'description' => 'User identity information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used as the encoding type for the Android application customer link. '."\n" + .'`SKILL_ID`: Skill ID, used as the encoding type for the cloud-based link.', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', + ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. '."\n" + .'When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => [ + 'description' => 'Type of User ID.'."\n" + ."\n" + .'`OPEN_ID`: Default User ID identity. '."\n" + .'`UNION_ID`: Organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie skill application Open Platform.', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'title' => '', + ], + 'Id' => ['description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], 'required' => true, - 'example' => 'Aexfgc', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserInfo', + 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息列表。', - 'description' => '', + 'description' => 'Device ID information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used as the encoding type for the Android application customer link. '."\n" + .'`SKILL_ID`: Skill ID, used as the encoding type for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], + 'enum' => ['PROJECT_ID'], + 'title' => '', ], 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', + 'description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. '."\n" + .'When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', + 'enum' => [], + 'title' => '', ], 'IdType' => [ - 'title' => '用户Id的类型：'."\n" - .'OPEN_ID：默认的用户ID标识。'."\n" - .'UNION_ID: 组织维度的用户ID标识，需要提前在开放平台申请组织。', - 'description' => '', + 'description' => 'Type of device ID.'."\n" + ."\n" + .'`OPEN_ID`: Default device ID identity. '."\n" + .'`UNION_ID`: Organization-dimension device ID identity. This value is available only after an organization has been requested on the Tmall Genie skill application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '用户标识，填写userOpenId或userUnionId的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1***2', + 'enum' => ['UNION_ID', 'OPEN_ID'], + 'title' => '', ], + 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'OpenServiceResult<OpenPlayingItem>', + 'description' => 'OpenServiceResult<OpenPlayingItem>', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '调用该接口的返回结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '详细信息', - 'description' => '', + 'title' => '', + 'description' => 'Actual return result of the service', 'type' => 'object', 'properties' => [ - 'UserOpenInfo' => [ - 'title' => '用户开放信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'IdType' => [ - 'title' => 'USER_ID', - 'description' => 'USER_ID', - 'type' => 'string', - 'example' => 'USER_ID', - ], - 'Id' => [ - 'title' => '对外的用户id', - 'description' => '', - 'type' => 'string', - 'example' => '0963*0158', - ], - ], - ], - 'DeviceOpenInfo' => [ - 'title' => '设备开放信息', - 'description' => '', + 'RawId' => ['title' => '', 'description' => 'third-party ID', 'type' => 'string', 'example' => '550144364'], + 'Source' => ['title' => '', 'description' => 'Source', 'type' => 'string', 'example' => 'ximalayav2'], + 'AlbumRawId' => ['title' => '', 'description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744'], + 'AlbumName' => ['title' => '', 'description' => 'Third-party album name', 'type' => 'string', 'example' => '晚安妈妈睡前故事'], + 'Liked' => ['title' => '', 'description' => 'is collected', 'type' => 'boolean', 'example' => 'false'], + 'Singer' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '晚安妈妈'], + 'Title' => ['title' => '', 'description' => 'title', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈'], + 'Cover' => [ + 'title' => '', + 'description' => 'thumbnail image object', 'type' => 'object', 'properties' => [ - 'IdType' => [ - 'title' => 'DEVICE_ID', - 'description' => 'DEVICE_ID', - 'type' => 'string', - 'example' => 'DEVICE_ID', - ], - 'Id' => [ - 'title' => '对外的设备id', - 'description' => '', - 'type' => 'string', - 'example' => 'A963*0158', - ], + 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Medium' => ['description' => 'medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Small' => ['description' => 'small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'example' => '', ], + 'PlayMode' => ['title' => '', 'description' => 'Playback pattern (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Repeat'], + 'AudioLength' => ['title' => '', 'description' => 'Length', 'type' => 'integer', 'format' => 'int32', 'example' => '190'], + 'Progress' => ['title' => '', 'description' => 'Playback progress of the song', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'LyricUrl' => ['title' => '', 'description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'], + 'Copyright' => ['title' => '', 'description' => 'The copyright field is upgraded to indicate whether the content is playable: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Type' => ['description' => 'type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], + 'ItemUrl' => ['description' => 'Playback URL', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], + 'DefaultPlayOrder' => ['description' => 'Default playback order of the package: 0 for sequential, 1 for reverse.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Valid' => ['description' => 'Playback availability: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Pos' => ['description' => 'Position of the item in the playlist', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'example' => '', ], - '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 troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the value is false, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenInfo\\": {\\n \\"IdType\\": \\"USER_ID\\",\\n \\"Id\\": \\"0963*0158\\"\\n },\\n \\"DeviceOpenInfo\\": {\\n \\"IdType\\": \\"DEVICE_ID\\",\\n \\"Id\\": \\"A963*0158\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Playlist Creation', + 'changeSet' => [], ], - 'GetCodeEnhance' => [ - 'summary' => '获取authCode', - 'path' => '/v1.0/ssp/getCodeEnhance', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreatePlayingListOAuth2' => [ + 'summary' => 'Playlist creation uses OAuth2 authorization.', + 'path' => '/v1.0/ssp/CreatePlayingListOAuth2', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ - 'AliGenie_Auth_SPI' => [], + 'OAuth 2.0 Bearer Token' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ChannelInfo', - 'in' => 'query', + 'name' => 'OpenCreatePlayingListRequest', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '激活渠道，如微信小程序，三方app等', - 'description' => '', + 'description' => 'Business parameters ', 'type' => 'object', 'properties' => [ - 'Channel' => [ - 'title' => '激活渠道，如WeChat', - 'description' => '', - 'type' => 'string', + 'PlayFrom' => ['description' => 'Playback source, the unique identifier for configuring playback control capabilities. '."\n" + ."\n" + .'Optional. Default value is "default". ', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'ContentType' => ['description' => 'Content type for playback'."\n" + ."\n" + .'Content: content; Album: album; Playlist: collect', 'type' => 'string', 'required' => true, 'example' => 'content', 'title' => ''], + 'ContentList' => [ + 'description' => 'Playback objects ', + 'type' => 'array', + 'items' => [ + 'description' => 'Playback object ', + 'type' => 'object', + 'properties' => [ + 'RawId' => ['description' => 'Third-party ID. '."\n" + ."\n" + .'If the item is content, this is the content ID; if it is an album, this is the album ID. ', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + 'Source' => ['description' => 'Source ', 'type' => 'string', 'required' => true, 'example' => 'xiami', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'WeChat、ThirdApp', - ], - 'ExtInfo' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + 'title' => '', + 'example' => '', ], + 'Index' => ['description' => 'Index of the item to play'."\n" + ."\n" + .'Can be empty. Default is 0, which means playback starts from the beginning.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'NeedAlbumContinued' => ['description' => 'Indicates whether album playback should continue from the last played episode. For example, if the last playback stopped at episode 5, whether to resume from episode 5. Default is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'PlayMode' => ['description' => 'Playback pattern'."\n" + ."\n" + .'Repeat all: Repeat; Shuffle: Shuffle; Repeat one: RepeatOne; Play in order: Normal.', 'type' => 'string', 'required' => false, 'example' => 'Repeat', 'title' => ''], + 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserInfo', + 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息列表。', - 'description' => '', + 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'EncodeType' => ['description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view it in the Tmall Genie AI Platform console. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => [ - 'title' => '设备Id的类型 ：'."\n" - .'OPEN_ID：默认的设备ID标识。'."\n" - .'UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', - 'description' => '', + 'description' => 'The type of device ID: '."\n" + .'OPEN_ID: The default device ID. '."\n" + .'UNION_ID: The organization-level device ID. You must request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '用户标识，填写userOpenId或userUnionId的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'enum' => ['UNION_ID', 'OPEN_ID'], + 'title' => '', ], + 'Id' => ['description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -1830,619 +1439,428 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '调用该接口的返回结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '返回的详细信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'Aexfgc', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'title' => '', + 'description' => 'Actual return result from the service', + 'type' => 'object', + 'properties' => [ + 'RawId' => ['title' => '', 'description' => 'third-party ID', 'type' => 'string', 'example' => '123123'], + 'Source' => ['title' => '', 'description' => 'Source', 'type' => 'string', 'example' => 'qignting'], + 'AlbumRawId' => ['title' => '', 'description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744'], + 'AlbumName' => ['title' => '', 'description' => 'Third-party album name', 'type' => 'string', 'example' => '晚安妈妈睡前故事'], + 'Liked' => ['title' => '', 'description' => 'is collected', 'type' => 'boolean', 'example' => 'false'], + 'Singer' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '晚安妈妈'], + 'Title' => ['title' => '', 'description' => 'title', 'type' => 'string', 'example' => '超能狂少在都市'], + 'Cover' => [ + 'title' => '', + 'description' => 'thumbnail image object', + 'type' => 'object', + 'properties' => [ + 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Medium' => ['description' => 'medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Small' => ['description' => 'small image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'CanResize' => ['description' => 'Indicates whether cropping using OSS rules is allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'example' => '', + ], + 'PlayMode' => ['title' => '', 'description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Repeat'], + 'AudioLength' => ['title' => '', 'description' => 'Length', 'type' => 'integer', 'format' => 'int32', 'example' => '190'], + 'Progress' => ['title' => '', 'description' => 'Song playback progress', 'type' => 'integer', 'format' => 'int32', 'example' => '96.0'], + 'LyricUrl' => ['title' => '', 'description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'], + 'Copyright' => ['title' => '', 'description' => 'The copyright field has been upgraded to indicate whether the content is playable: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Type' => ['description' => 'type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'ItemUrl' => ['description' => 'Playback URL', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], + 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Valid' => ['description' => 'Playback availability status: VALID(10), UNKNOWN(20), NOT_VALID(30).', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Pos' => ['description' => 'Position of this item in the playlist.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', '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' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the value is false, check the Message field.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": \\"Aexfgc\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qignting\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 96,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"program\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 1\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Playlist Creation_OAuth2', + 'changeSet' => [], ], - 'ScanCodeBind' => [ - 'summary' => '扫描二维码激活绑定设备', - 'path' => '/v1.0/ssp/scanCode', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateScheduleTask' => [ + 'summary' => 'Create a scheduled task.', + 'path' => '/v1.0/ssp/CreateScheduleTask', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', + 'name' => 'Payload', 'in' => 'formData', - 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', + 'IdempotentId' => ['title' => '', 'description' => 'Idempotent ID', 'type' => 'string', 'required' => false, 'example' => '1'], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'ScheduleDTO' => [ + 'title' => '', + 'description' => 'Scheduling information', + 'type' => 'object', + 'properties' => [ + 'ScheduleType' => [ + 'title' => '', + 'description' => 'Schedule Type', + 'type' => 'string', + 'required' => true, + 'example' => 'ONCE', + 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_DAY'], + ], + 'Once' => [ + 'title' => '', + 'description' => 'One-time Scan Configuration', + 'type' => 'object', + 'properties' => [ + 'Year' => ['title' => '', 'description' => 'Trigger Year', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'], + 'Month' => ['title' => '', 'description' => 'Trigger Month', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], + 'Day' => ['title' => '', 'description' => 'Trigger day', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '26'], + 'Hour' => ['title' => '', 'description' => 'Trigger Hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12'], + 'Minute' => ['title' => '', 'description' => 'Trigger Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + 'required' => false, + 'example' => '', + ], + 'Weekly' => [ + 'title' => '', + 'description' => 'Loop schedule configuration', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'Trigger days of the week, where 1–7 represent Monday through Sunday, respectively', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'description' => '', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'Hours' => [ + 'title' => '', + 'description' => 'Trigger hour', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'description' => '', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'Minutes' => [ + 'title' => '', + 'description' => 'Trigger minute', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'description' => '', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'StatutoryWorkingDay' => [ + 'title' => '', + 'description' => 'Statutory working day schedule configuration', + 'type' => 'object', + 'properties' => [ + 'Hours' => [ + 'title' => '', + 'description' => 'Trigger hour; Multiple Choice ', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'description' => '', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'Minutes' => [ + 'title' => '', + 'description' => 'Trigger minute; Multiple Choice ', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'description' => '', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'ScheduleStartTime' => ['title' => '', 'description' => 'Schedule Start Time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656318855000'], + 'ScheduleEndTime' => ['title' => '', 'description' => 'Schedule end time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1661589255000'], ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', - 'type' => 'string', 'required' => true, - 'example' => '129****0946', + 'example' => '', ], - 'IdType' => [ - 'title' => '设备Id的类型 ：'."\n" - .'OPEN_ID：默认的设备ID标识。'."\n" - .'UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', + 'ActionDTOs' => [ + 'title' => '', + 'description' => 'Scheduling action parameters', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'customAction' => ['description' => 'Vendor-defined command', 'type' => 'object', 'required' => false, 'example' => '{"k1":"v1","k2":{"key":1}}', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Id' => [ - 'title' => '用户标识，填写userOpenId或userUnionId的值。', - 'description' => '', - 'type' => 'string', 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '111', + 'example' => '', ], + 'AccessKeyId' => ['title' => 'AccessKey ID of the caller', 'type' => 'string', 'description' => '', 'example' => ''], ], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'BindReq', + 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '扫描绑定入参', - 'description' => '', + 'title' => '', + 'description' => 'User Identifier Information ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'authCode', - 'description' => 'authCode', - 'type' => 'string', - 'required' => true, - 'example' => 'ASdfre', - ], - 'ClientId' => [ - 'title' => '产品clientId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RnY8v0W0ZVn58ZrUAOr2RD', - ], - 'ExtInfo' => [ - 'title' => '扩展参数', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"key":"value"}', - ], - 'UserId' => [ - 'title' => '精灵用户id', - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId) ', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], + 'IdType' => ['title' => '', 'description' => 'Type of User ID: '."\n" + .'- OPEN_ID: The default User ID identity. '."\n" + .'- UNION_ID: The User ID identity at the organization dimension. This is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding Type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer links; SKILL_ID: Skill ID, used for cloud-based links. ', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID; Required if IdType is UNION_ID', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Device identity information', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], + 'IdType' => ['title' => '', 'description' => 'Type of device ID: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after applying for an organization in the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer linkage; SKILL_ID: skill ID, used for cloud linkage.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the SkillID of the application. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'AmpResult<Long>', + 'description' => 'AmpResult<Long>', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '结果信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '返回的详细信息。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BizType' => [ - 'title' => '产品分类', - 'description' => '', - 'type' => 'string', - 'example' => 'AILABS', - ], - 'BizGroup' => [ - 'title' => '产品分组', - 'description' => '', - 'type' => 'string', - 'example' => 'X1', - ], - 'UserOpenId' => [ - 'title' => 'DAFE****ce3ej=', - 'description' => 'DAFE****ce3ej=', - 'type' => 'string', - 'example' => '用户opneId', - ], - 'DeviceOpenId' => [ - 'title' => 'A963*0158', - 'description' => 'A963*0158', - 'type' => 'string', - 'example' => '设备OpenId', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '686DF82F-45C4-7DF7-8B67-27B91CFD63A9', - ], + 'Code' => ['description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '调用成功'], + 'Result' => ['description' => 'ID of the successfully created job', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F7E2****B7C94', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"BizType\\": \\"AILABS\\",\\n \\"BizGroup\\": \\"X1\\",\\n \\"UserOpenId\\": \\"用户OpenId\\",\\n \\"DeviceOpenId\\": \\"设备OpenId\\"\\n },\\n \\"RequestId\\": \\"686DF82F-45C4-7DF7-8B67-27B91CFD63A9\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'title' => 'Create a scheduled task', + 'description' => 'Configure a triggering task for Custom instruction data in the ecosystem based on scheduling rules such as one-time, daily, or business days.', + 'responseParamsDescription' => 'Success occurs only when the service returns a status code of 200; otherwise, it indicates failure.', + 'changeSet' => [], ], - 'GetUserByDeviceId' => [ - 'summary' => '查询设备绑定的用户', - 'path' => '/v1.0/ssp/getUserByDeviceId', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteAlarms' => [ + 'summary' => 'Delete alarms. You can delete multiple alarms at the same time.', + 'path' => '/v1.0/ssp/deleteAlarms', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceInfo', - 'in' => 'query', + 'name' => 'Payload', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', + 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Invoker', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AlarmIds' => [ + 'title' => '', + 'description' => 'Alarms to delete', + 'type' => 'array', + 'format' => 'int64', + 'items' => ['description' => 'Set of alarm IDs to delete', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567', 'title' => ''], 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '返回数据体', - 'description' => '', + 'title' => '', + 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of the User ID: '."\n" + .'- OPEN_ID: The default User ID identity. '."\n" + .'- UNION_ID: The User ID identity at the organization dimension. This is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '用户open信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserOpenId' => [ - 'title' => '用户信息对应的openId', - 'description' => '', - 'type' => 'string', - 'example' => '0963*0158', - ], - 'UserUnionIds' => [ - 'title' => '组织id及归一id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织id', - 'description' => '', - 'type' => 'string', - 'example' => '1**2', - ], - 'UserUnionId' => [ - 'title' => '组织id对应的归一id', - 'description' => '', - 'type' => 'string', - 'example' => '1553*B0C3', - ], - ], - ], - ], - ], - 'example' => 'true', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Maojing, and each way corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer ingest endpoint; SKILL_ID refers to the skill ID, which is the encoding type for the cloud ingest endpoint.', 'type' => 'string', - 'example' => '0EC7*726E', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], + 'required' => true, + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.GetUserByDeviceId.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"0963*0158\\",\\n \\"UserUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"UserUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetUserByDeviceIdResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <UserOpenId>0963*0158</UserOpenId>\\n <UserUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <UserUnionId>1553*B0C3</UserUnionId>\\n </UserUnionIds>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetUserByDeviceIdResponse>","errorExample":""}]', - ], - 'ListDeviceByUserId' => [ - 'summary' => '查询用户名下的设备', - 'path' => '/v1.0/ssp/listDeviceByUserId', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'UserInfo', - 'in' => 'query', + 'name' => 'DeviceInfo', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the device ID: OPEN_ID: default device ID; UNION_ID: organization-dimension device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link.', 'type' => 'string', 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the SkillID of the application; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据体', - 'description' => '', + 'title' => 'AmpResult', + 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '返回result', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DeviceOpenId' => [ - 'title' => '设备信息对应的openId', - 'description' => '', - 'type' => 'string', - 'example' => 'A963*0158', - ], - 'DeviceUnionIds' => [ - 'title' => '组织id及归一id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织id', - 'description' => '', - 'type' => 'string', - 'example' => '1**2', - ], - 'DeviceUnionId' => [ - 'title' => '组织id对应的归一id', - 'description' => '', - 'type' => 'string', - 'example' => '1553*B0C3', - ], - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'Code' => ['description' => 'Status code returned by the alarm service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '闹钟id为空'], + 'Result' => ['description' => 'Indicates whether the alarm deletion was executed successfully', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'request ID', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.ListDeviceByUserId.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceByUserIdResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceByUserIdResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"闹钟id为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Batch delete alarms', + 'responseParamsDescription' => 'The request is successful only when the returned status code is 200; otherwise, it has failed.', + 'changeSet' => [], ], - 'UnbindDevice' => [ - 'summary' => '解绑设备', - 'path' => '/v1.0/ssp/unbindDevice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteScheduleTask' => [ + 'summary' => 'Delete a scheduled task.', + 'path' => '/v1.0/ssp/DeleteScheduleTask', + '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' => 'DeviceInfo', + 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', + 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'example' => 'PROJECT_ID', - 'required' => true, - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'type' => 'string', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'example' => '12**45', - 'required' => true, - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'type' => 'string', - ], - 'IdType' => [ - 'description' => '', - 'example' => 'OPEN_ID', - 'required' => true, - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在开放平台申请过组织后才会有', - 'type' => 'string', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'example' => 'DAFE****ce3ej=', - 'required' => true, - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'type' => 'string', - ], - 'OrganizationId' => [ - 'description' => '', - 'example' => '1**2', - 'required' => false, - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'type' => 'string', - ], + 'Id' => ['title' => '', 'description' => 'ID of the job to delete', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'AccessKey ID of the caller', 'type' => 'string', 'description' => '', 'example' => ''], ], 'required' => true, - 'title' => '设备标识信息', - 'type' => 'object', + 'example' => '', ], ], [ @@ -2450,1508 +1868,1136 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', + 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'example' => 'PROJECT_ID', - 'required' => true, - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'type' => 'string', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'example' => '12**45', - 'required' => true, - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'type' => 'string', - ], - 'IdType' => [ - 'description' => '', - 'example' => 'OPEN_ID', - 'required' => true, - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在开放平台申请过组织后才会有', - 'type' => 'string', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'example' => 'HOFF****my7Iw=', - 'required' => true, - 'title' => '用户标识（userOpenId或userUnionId）', - 'type' => 'string', - ], - 'OrganizationId' => [ - 'description' => '', - 'example' => '1**2', - 'required' => false, - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'type' => 'string', - ], + 'Id' => ['title' => '', 'description' => 'User identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], + 'IdType' => ['title' => '', 'description' => 'Type of User ID: OPEN_ID: default User ID identifier; UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the Maojing user identifier, and each way corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer link; SKILL_ID refers to the skill ID, which is the encoding type for the cloud link.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, - 'title' => '用户标识信息', + 'example' => '', + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Device identity information', 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], + 'IdType' => ['title' => '', 'description' => 'Type of the device ID: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after an organization has been registered on the Maojing skill application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: Skill ID, used in the cloud link.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'AmpResult<Boolean>', + 'description' => 'AmpResult<Boolean>', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'success', - 'title' => '返回的错误信息', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'title' => '返回的错误码', - 'type' => 'integer', - ], - 'Result' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否解绑成功', - 'type' => 'boolean', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '0EC7*726E', - 'title' => '请求id', - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'string', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => '调用成功'], + 'Result' => ['title' => '', 'description' => 'Response result', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F7E2****B7C94'], ], - 'title' => '返回数据体', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'title' => 'Delete Scheduled Task', + 'description' => 'Deletes a specified scheduled task by its ID.', + 'responseParamsDescription' => 'The operation is successful only when the service returns status code 200. Otherwise, it indicates failure.', + 'changeSet' => [], + ], + 'DeleteSub' => [ + 'summary' => 'Delete a subscribed album.', + 'path' => '/v1.0/ssp/deleteSub', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Subscription album record ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '81'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'Result' => ['title' => '', 'description' => 'Return Result', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0AA6C15C-FD61-1E32-9881-480CC6F35A70'], + ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.UnbindDevice.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindDeviceResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>true</Result>\\n <RequestId>0EC7*726E</RequestId>\\n</UnbindDeviceResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0AA6C15C-FD61-1E32-9881-480CC6F35A70\\"\\n}","type":"json"}]', + 'title' => 'Delete a subscribed album', + 'changeSet' => [], ], - 'ListDeviceByUserIdAndChanel' => [ - 'summary' => '获取指定渠道的设备列表', - 'path' => '/v1.0/ssp/listDeviceByUserIdAndChanel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeviceControl' => [ + 'summary' => 'Control property values such as device volume.', + 'path' => '/v1.0/ssp/control', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => [], + 'produces' => [], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ChannelInfo', - 'in' => 'query', + 'name' => 'ControlRequest', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '激活渠道，如微信小程序，三方app等', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for volume control ', 'type' => 'object', 'properties' => [ - 'Channel' => [ - 'title' => '激活配网渠道，如WeChat', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'WeChat、ThirdApp', - ], - 'ExtInfo' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'Volume' => ['title' => '', 'description' => 'Target volume value ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Muted' => ['title' => '', 'description' => 'Indicates whether mute is enabled. If this field is set to true, you must also specify the volume value as 0. ', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'UserInfo', + 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息列表。', - 'description' => '', + 'title' => '', + 'description' => 'List of device ID information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', + 'title' => '', + 'description' => 'Encoding Type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'enum' => ['PROJECT_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can View this in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ - 'title' => '用户Id的类型：'."\n" - .'OPEN_ID：默认的用户ID标识。'."\n" - .'UNION_ID: 组织维度的用户ID标识，需要提前在开放平台申请组织。', - 'description' => '', + 'title' => '', + 'description' => 'The type of Device ID: '."\n" + .'OPEN_ID: The default Device ID identity. '."\n" + .'UNION_ID: The organization-dimension Device ID identity. You must request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '用户标识，填写userOpenId或userUnionId的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1***2', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID of the device. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1*****2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '调用该接口的返回结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceOpenId' => [ - 'title' => '设备信息对应的openId。', - 'description' => '', - 'type' => 'string', - 'example' => 'A963*0158', - ], - 'DeviceUnionIds' => [ - 'title' => '设备信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织ID。', - 'description' => '', - 'type' => 'string', - 'example' => '1***2', - ], - 'DeviceUnionId' => [ - 'title' => '设备的UnionId。', - 'description' => '', - 'type' => 'string', - 'example' => '1553*B0C3', - ], - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => 'RE***D', - ], + 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Error code returned. A value of 200 indicates that the call Succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Detailed Result returned.', 'type' => 'boolean', 'example' => ''], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1***2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"RE***D\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": false,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Control property values such as device volume', + 'description' => 'Specify a device to modify property values such as volume.'."\n", + 'changeSet' => [], ], - 'GetDeviceIdByIdentity' => [ - 'summary' => '获取设备信息', - 'path' => '/v1.0/ssp/getDeviceIdByIdentity', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'EcologyOpennessAuthenticate' => [ + 'summary' => 'Use the login-state access token for authentication to obtain the third-party user identifier and the Tmall Genie user\'s openId. ', + 'path' => '/v1.0/ssp/ecologyOpennessAuthenticate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ + 'name' => 'LoginStateAccessToken', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'logon state access token', 'type' => 'string', 'required' => true, 'example' => 'd15aa*****ee'], + ], + [ 'name' => 'EncodeType', - 'in' => 'query', - 'schema' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'entity Type', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'], ], [ 'name' => 'EncodeKey', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'entity key', 'type' => 'string', 'required' => true, 'example' => '12*****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '129****0946', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73****9-175A-1324-8202-9FAAB*****A'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], + 'Result' => [ + 'title' => '', + 'description' => 'Response Result ', + 'type' => 'object', + 'properties' => [ + 'UserOpenId' => ['title' => '', 'description' => 'Tmall Genie user openId ', 'type' => 'string', 'example' => 'o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ=='], + 'EncodeType' => ['title' => '', 'description' => 'entity Type', 'type' => 'string', 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'entity key', 'type' => 'string', 'example' => '12****7'], + 'SceneCode' => ['title' => '', 'description' => 'scenario code', 'type' => 'string', 'example' => '******'], + 'ThirdUserType' => ['title' => '', 'description' => 'Third-party user type ', 'type' => 'string', 'example' => '******'], + 'ThirdUserIdentifier' => ['title' => '', 'description' => 'Third-party user identifier ', 'type' => 'string', 'example' => '******'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"SceneCode\\": \\"******\\",\\n \\"ThirdUserType\\": \\"******\\",\\n \\"ThirdUserIdentifier\\": \\"******\\"\\n }\\n}","type":"json"}]', + 'title' => 'Ecosystem Open Authentication', + 'description' => 'Note: When the login state expires, the integrator must reinitiate the authorization login flow to obtain a new login state (entry service API: AuthLoginWithThirdUserInfo).'."\n" + ."\n" + .'- Invoke the service API with the login-state access credential (LoginStateAccessToken) parameter by using the Java SDK (for SDKs in other languages, consult Tmall Genie developers during integration). '."\n" + .'If the API call throws a TeaException and TeaException.code is InvalidAuthentication, the login state has expired.'."\n" + ."\n" + .'- Invoke the service API by sending an HTTP request with the login-state access credential (LoginStateAccessToken) parameter. '."\n" + .'If the HTTP response status code returned by the API call is 400, the login state has expired. ', + 'changeSet' => [], + ], + 'EcologyOpennessSendVerificationCode' => [ + 'summary' => 'Ecosystem Open API for sending SMS verification codes ', + 'path' => '/v1.0/ssp/ecologyOpennessSendVerificationCode', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IdentityType', - 'in' => 'query', - 'schema' => [ - 'title' => '填写设备认证类型，“MAC”或者“SN”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MAC', - ], + 'AliGenie_Auth_SPI' => [], ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'IdentityId', - 'in' => 'query', - 'schema' => [ - 'title' => '认证标识，填写MAC地址或者SN的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'b4:xx:xx:xx:65:2b', - ], + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'title' => '产品唯一标志符productKey，在天猫精灵AI平台中创建产品时，平台颁发的全局唯一标识。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Mm*****XnZ8', - ], + 'name' => 'PhoneNumber', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Phone number ', 'type' => 'string', 'required' => true, 'example' => '18612345678'], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Region encoding ', 'type' => 'string', 'required' => true, 'example' => '+86'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据体', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ - 'title' => '返回result', - 'description' => '', + 'title' => '', + 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ - 'DeviceOpenId' => [ - 'title' => '设备信息对应的openId', - 'description' => '', - 'type' => 'string', - 'example' => 'A963*0158', - ], - 'DeviceUnionIds' => [ - 'title' => '组织id及归一id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织id', - 'description' => '', - 'type' => 'string', - 'example' => '1**2', - ], - 'DeviceUnionId' => [ - 'title' => '组织id对应的归一id', - 'description' => '', - 'type' => 'string', - 'example' => '1553*B0C3', - ], - ], - ], - ], + 'ExpireIn' => ['title' => '', 'description' => 'Validity Period (unit: seconds) ', 'type' => 'integer', 'format' => 'int32', 'example' => '900'], + 'RepeatInterval' => ['title' => '', 'description' => 'Recency before the next resend is allowed (unit: seconds) ', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], ], - ], - 'RequestId' => [ - 'title' => '请求ID，用于排查问题，如果没有这个参数，可以在responseHeader里进行排查。', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7DA****A0726E', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7DA****A0726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceIdByIdentityResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </Result>\\n <RequestId>0EC7DA****A0726E</RequestId>\\n</GetDeviceIdByIdentityResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"ExpireIn\\": 900,\\n \\"RepeatInterval\\": 60\\n }\\n}","type":"json"}]', + 'title' => 'Ecosystem Open API for sending SMS verification codes ', + 'changeSet' => [], ], - 'ListDeviceIdByIdentities' => [ - 'summary' => '批量获取设备openId', - 'path' => '/v1.0/ssp/listDeviceIdByIdentities', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'FindUserlistToAuthLoginWithPhoneNumber' => [ + 'summary' => 'Find a list of accounts that can be authorized to log on by phone number ', + 'path' => '/v1.0/ssp/findUserlistToAuthLoginWithPhoneNumber', + 'methods' => ['get'], + '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' => 'EncodeType', - 'in' => 'query', - 'schema' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - ], - [ - 'name' => 'EncodeKey', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '125****0946', - ], + 'schema' => ['title' => '', 'description' => 'Session ID', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ - 'name' => 'IdentityType', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '填写设备认证类型，“MAC”或者“SN”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MAC', - ], + 'schema' => ['title' => '', 'description' => 'Region encoding', 'type' => 'string', 'required' => true, 'example' => '+86'], ], [ - 'name' => 'IdentityIds', + 'name' => 'PhoneNumber', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '认证标识，填写MAC地址或者SN的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'b4:xx:xx:xx:65:2b', - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Phone number', 'type' => 'string', 'required' => true, 'example' => '18612345678'], ], [ - 'name' => 'ProductKey', + 'name' => 'Code', 'in' => 'query', - 'schema' => [ - 'title' => '产品唯一标志符productKey，在天猫精灵AI平台中创建产品时，平台颁发的全局唯一标识。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Mm*****XnZ8', - ], + 'schema' => ['title' => '', 'description' => 'Text message verification code', 'type' => 'string', 'required' => true, 'example' => '123456'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据体', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ - 'title' => '返回result', - 'description' => '', + 'title' => '', + 'description' => 'Response Result ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceOpenId' => [ - 'title' => '设备信息对应的openId', - 'description' => '', - 'type' => 'string', - 'example' => 'A963*0158', - ], - 'DeviceUnionIds' => [ - 'title' => '组织id及归一id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OrganizationId' => [ - 'title' => '组织id', - 'description' => '', - 'type' => 'string', - 'example' => '1**2', - ], - 'DeviceUnionId' => [ - 'title' => '组织id对应的归一id', - 'description' => '', - 'type' => 'string', - 'example' => '1553*B0C3', - ], - ], - 'description' => '', + 'properties' => [ + 'UserListToAuthLogin' => [ + 'title' => '', + 'description' => 'List of accounts eligible for authorization login ', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Account eligible for authorization login', + 'type' => 'object', + 'properties' => [ + 'UserType' => ['title' => '', 'description' => 'User Type '."\n" + .'TAOBAO: Taobao user '."\n" + .'ALIGENIE: Tmall Genie user ', 'type' => 'string', 'example' => 'ALIGENIE'], + 'EncryptedUserIdentifier' => ['title' => '', 'description' => 'Encrypted User Identifier ', 'type' => 'string', 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh'], + 'Nickname' => ['title' => '', 'description' => 'Nickname ', 'type' => 'string', 'example' => 'XXX'], + 'Avatar' => ['title' => '', 'description' => 'Profile picture ', 'type' => 'string', 'example' => 'https://xxx'], + 'FindingType' => ['title' => '', 'description' => 'User Search Type '."\n" + ."\n" + .'For Taobao users, the value is fixed as: '."\n" + .'PHONE_NUMBER_BINDING_WITH_TAOBAO: The phoneNumber is queried as the phone number bound to a Taobao account. '."\n" + ."\n" + .'For Tmall Genie users, the value can be: '."\n" + .'PHONE_NUMBER_BINDING_WITH_ALIGENIE: The phoneNumber is queried as the phone number bound to a Tmall Genie device; '."\n" + .'PHONE_NUMBER_BINDING_WITH_TAOBAO: The phoneNumber is queried as the phone number bound to a Taobao account.', 'type' => 'string', 'example' => 'PHONE_NUMBER_BINDING_WITH_ALIGENIE：phoneNumber'], ], + 'example' => '', ], + 'example' => '', ], - 'description' => '', ], + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'DataObj' => [ + 'title' => '', + 'description' => 'When the code is 5140003, it indicates that the invocation failed because no account list eligible for authorization login was found for the given phone number. The frontend can prompt the user to confirm generating a Jingle account via the phone number or suggest registering a Taobao account using the phone number first. In subsequent flows, the frontend must return the sessionId from DataObj to the server. ', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceIdByIdentitiesResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <b4:xx:xx:xx:65:2b>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </b4:xx:xx:xx:65:2b>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceIdByIdentitiesResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"UserListToAuthLogin\\": [\\n {\\n \\"UserType\\": \\"ALIGENIE\\",\\n \\"EncryptedUserIdentifier\\": \\"KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh\\",\\n \\"Nickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"https://xxx\\",\\n \\"FindingType\\": \\"PHONE_NUMBER_BINDING_WITH_ALIGENIE：phoneNumber\\"\\n }\\n ]\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query a list of accounts eligible for authorization login by phone number', + 'changeSet' => [], ], - 'GetDeviceBasicInfo' => [ - 'summary' => '获取设备认证信息', - 'path' => '/v1.0/ssp/getDeviceBasicInfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAlarm' => [ + 'summary' => 'Retrieve the detailed information of a specific alarm clock. ', + 'path' => '/v1.0/ssp/getAlarm', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceInfo', - 'in' => 'query', + 'name' => 'Payload', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', + 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AlarmId' => ['description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567', 'title' => ''], + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'User identifier information', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of User ID: OPEN_ID: default User ID identifier; UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the Maojing User Identifier, and each corresponds to a different encoding type: '."\n" + .'- PACKAGE_NAME: APK package name, used for Android application customer-side flows '."\n" + .'- SKILL_ID: Skill ID, used for cloud-side flows', 'type' => 'string', 'required' => true, - 'example' => '12**45', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s SkillID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Device identity information', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of Device ID: '."\n" + .'- OPEN_ID: default device ID identity '."\n" + .'- UNION_ID: organization-dimension device ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding Type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding Type: PACKAGE_NAME: APK package name, used for the Android application Customer link; SKILL_ID: Skill ID, used for the cloud link.', 'type' => 'string', 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type: when the encoding type is SKILL_ID, the value is the application\'s SkillID; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据体', - 'description' => '', + 'title' => 'AmpResult', + 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'Status code returned by the alarm service ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'id为空'], 'Result' => [ - 'title' => '返回result', - 'description' => '', + 'title' => '', + 'description' => 'Alarm details ', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '设备名称', - 'description' => '', - 'type' => 'string', - 'example' => '我的设备', - ], - 'FirmwareVersion' => [ - 'title' => '固件版本', - 'description' => '', - 'type' => 'string', - 'example' => '2.0.3', - ], - 'Mac' => [ - 'title' => '设备MAC地址', - 'description' => '', - 'type' => 'string', - 'example' => 'b4:xx:xx:xx:65:2b', + 'AlarmId' => ['title' => '', 'description' => 'Alarm ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], + 'ScheduleTypeDesc' => ['title' => '', 'description' => 'Chinese description of the loop type', 'type' => 'string', 'example' => '单次'], + 'TriggerDateDesc' => ['title' => '', 'description' => 'Trigger date description (one-time) ', 'type' => 'string', 'example' => '2022-07-29'], + 'TriggerTimeDesc' => ['title' => '', 'description' => 'Trigger time description ', 'type' => 'string', 'example' => '10:00'], + 'ScheduleInfo' => [ + 'title' => '', + 'description' => 'Schedule Information ', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'Schedule Type / Loop Type: ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORYWORKINGDAY -> Statutory working day ', + 'type' => 'string', + 'example' => 'ONCE', + 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], + ], + 'Once' => [ + 'title' => '', + 'description' => 'One-time: This property is active when the loop type is ONCE. ', + 'type' => 'object', + 'properties' => [ + 'Year' => ['title' => '', 'description' => 'Trigger Time: Year ', 'type' => 'integer', 'format' => 'int32', 'example' => '2022'], + 'Month' => ['title' => '', 'description' => 'Trigger Time: Month ', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'Day' => ['title' => '', 'description' => 'Trigger time: Day', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], + 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', + ], + 'StatutoryWorkingDay' => [ + 'title' => '', + 'description' => 'Statutory working day: This property is active when the loop Type is STATUTORYWORKINGDAY.', + 'type' => 'object', + 'properties' => [ + 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', + ], + 'Weekly' => [ + 'title' => '', + 'description' => 'Weekly loop: This property is active when the loop Type is WEEKLY.', + 'type' => 'object', + 'properties' => [ + 'Hour' => ['title' => '', 'description' => 'Trigger time: Hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: Minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'Collection of days of the week to trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week. If triggered every day, include all numbers.', + 'type' => 'array', + 'items' => ['description' => 'Monday', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'Sn' => [ - 'title' => '设备SN', - 'description' => '', - 'type' => 'string', - 'example' => '1200xxx048', + 'MusicInfo' => [ + 'title' => '', + 'description' => 'Ringtone Information ', + 'type' => 'object', + 'properties' => [ + 'MusicType' => ['title' => '', 'description' => 'Ringtone Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone Category Name ', 'type' => 'string', 'example' => 'xx音乐'], + 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MusicName' => ['title' => '', 'description' => 'Ringtone Name ', 'type' => 'string', 'example' => 'xx铃声'], + 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'example' => 'http://xx'], + ], + 'example' => '', ], + 'Volume' => ['title' => '', 'description' => 'Ringtone volume ', 'type' => 'integer', 'format' => 'int32', 'example' => '40'], + 'Status' => ['title' => '', 'description' => 'status: 0 Normal, 1 deleted, 2 shutdown ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceBasicInfo.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceBasicInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <Name>我的设备</Name>\\n <FirmwareVersion>2.0.3</FirmwareVersion>\\n <Mac>b4:xx:xx:xx:65:2b</Mac>\\n <Sn>1200xxx048</Sn>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceBasicInfoResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"id为空\\",\\n \\"Result\\": {\\n \\"AlarmId\\": 1234567,\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Retrieve Details of a Single Alarm', + 'responseParamsDescription' => 'The operation is successful only when the service returns a status code of 200; otherwise, it indicates failure. ', + 'changeSet' => [], ], - 'ListDeviceBasicInfo' => [ - 'summary' => '批量获取设备基本信息', - 'path' => '/v1.0/ssp/listDeviceBasicInfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAlbum' => [ + 'summary' => 'Retrieve album information by a specific ID. ', + 'path' => '/v1.0/ssp/GetAlbum', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceInfos', + 'name' => 'Id', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Ids' => [ - 'title' => '设备标识列表（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'required' => false, - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'Album ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12343', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'Default Value: song ', 'type' => 'string', 'required' => true, 'example' => 'song', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据体', - 'description' => '', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], + 'Code' => ['description' => 'Code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ - 'title' => '返回result，key为deviceOpenId或deviceUnionId，value为对应的设备信息', - 'description' => '', + 'description' => 'Return Result ', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '设备名称', - 'description' => '', - 'type' => 'string', - 'example' => '我的设备', - ], - 'FirmwareVersion' => [ - 'title' => '固件版本', - 'description' => '', - 'type' => 'string', - 'example' => '2.0.3', - ], - 'Mac' => [ - 'title' => '设备MAC地址', - 'description' => '', - 'type' => 'string', - 'example' => 'b4:xx:xx:xx:65:2b', + 'properties' => [ + 'Alias' => [ + 'description' => 'Alias ', + 'type' => 'array', + 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Audition' => ['description' => 'Is auditionable ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Authors' => [ + 'description' => 'Author information ', + 'type' => 'array', + 'items' => [ + 'description' => 'Author information ', + 'type' => 'object', + 'properties' => [ + 'AuthorTypes' => [ + 'description' => 'Author types', + 'type' => 'array', + 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], + 'Id' => ['description' => 'Author primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13123', 'title' => ''], + 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qignting', 'title' => ''], + 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Sn' => [ - 'title' => '设备SN', - 'description' => '', - 'type' => 'string', - 'example' => '1200xx048', + 'title' => '', + 'example' => '', + ], + 'Category' => ['description' => 'Transform controlType based on the public category it belongs to ', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CommCateId' => ['description' => 'Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], + 'Cover' => [ + 'description' => 'Album cover image', + 'type' => 'object', + 'properties' => [ + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Small' => ['description' => 'Small Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'description' => '', - ], - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], + 'HotScore' => ['description' => 'Popularity Score ', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'Id' => ['description' => 'Album ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1231231', 'title' => ''], + 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qignting', 'title' => ''], + 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'Type' => ['description' => 'Transform to favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether the album is playable. ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Finished' => ['description' => 'Is finished ', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''], + 'TotalEpisode' => ['description' => 'Total number of episodes ', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '23242', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.ListDeviceBasicInfo.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xx048\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceBasicInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DAFE****ce3ej=>\\n <Name>我的设备</Name>\\n <FirmwareVersion>2.0.3</FirmwareVersion>\\n <Mac>b4:xx:xx:xx:65:2b</Mac>\\n <Sn>1200xx048</Sn>\\n </DAFE****ce3ej=>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceBasicInfoResponse>\\n","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 13123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Finished\\": \\"FINISHED\\",\\n \\"TotalEpisode\\": 12,\\n \\"RawId\\": \\"23242\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve album information by a specific ID ', + 'changeSet' => [], ], - 'GetDeviceStatusInfo' => [ - 'summary' => '获取设备状态信息', - 'path' => '/v1.0/ssp/getDeviceStatusInfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAlbumDetailById' => [ + 'summary' => 'Retrieve album information.', + 'path' => '/v1.0/ssp/getAlbumDetailById', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceInfo', + 'name' => 'AlbumId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51999575'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据体', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '返回result', - 'description' => '', + 'title' => '', + 'description' => 'Album content', 'type' => 'object', 'properties' => [ - 'Online' => [ - 'title' => '是否在线，0为不在线，1为在线', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '51999575'], + 'AlbumTitle' => ['title' => '', 'description' => 'Album Title', 'type' => 'string', 'example' => '小科学家探索'], + 'AlbumDescription' => ['title' => '', 'description' => 'Album Description', 'type' => 'string', 'example' => '每次一个百科知识或者故事\\n丰富孩子的视野，拓展眼界和知识面，培养和孩子的探究能力和好奇心\\n\\n'], + 'AlbumCoverUrl' => ['title' => '', 'description' => 'Album thumbnail', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg'], + 'AlbumContentList' => [ + 'title' => '', + 'description' => 'Album content list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Album content ID', 'type' => 'string', 'example' => '468009044'], + 'Title' => ['title' => '', 'description' => 'Album content title', 'type' => 'string', 'example' => '001为什么肚子饿时会咕咕叫'], + 'Duration' => ['title' => '', 'description' => 'Album content duration', 'type' => 'string', 'example' => '3分24秒'], + 'OrderIndex' => ['title' => '', 'description' => 'Album content sorting', 'type' => 'string', 'example' => '1000'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'A0B7CACD-485B-14E2-854F-39EACB09E45B'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceStatusInfo.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Online\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceStatusInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <Online>1</Online>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceStatusInfoResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"AlbumTitle\\": \\"小科学家探索\\",\\n \\"AlbumDescription\\": \\"每次一个百科知识或者故事\\\\\\\\n丰富孩子的视野，拓展眼界和知识面，培养和孩子的探究能力和好奇心\\\\\\\\n\\\\\\\\n\\",\\n \\"AlbumCoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"AlbumContentList\\": [\\n {\\n \\"Id\\": \\"468009044\\",\\n \\"Title\\": \\"001为什么肚子饿时会咕咕叫\\",\\n \\"Duration\\": \\"3分24秒\\",\\n \\"OrderIndex\\": \\"1000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A0B7CACD-485B-14E2-854F-39EACB09E45B\\"\\n}","type":"json"}]', + 'title' => 'Retrieve album information', + 'changeSet' => [], ], - 'GetDeviceTag' => [ - 'summary' => '获取设备标签', - 'path' => '/v1.0/ssp/getDeviceTag', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAligenieUserInfo' => [ + 'summary' => 'Obtain the Aligenie account information bound to a third party by using the logon state credential ', + 'path' => '/v1.0/ssp/getAligenieUserInfo', + 'methods' => ['get'], + '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' => 'DeviceInfo', + 'name' => 'LoginStateAccessToken', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写“PROJECT_ID”', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Logon state access credential ', 'type' => 'string', 'required' => true, 'example' => '99ce8a70c23a94f8569e1a525bef6e85'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据体', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '返回的错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ - 'title' => '返回result', - 'description' => '', 'type' => 'object', 'properties' => [ - 'DeviceTags' => [ - 'title' => '设备标签结果', - 'description' => '', - 'type' => 'object', - 'example' => '{ "antest1": "antest1", "antest": "a" }', - ], + 'AligenieNickname' => ['title' => '', 'description' => 'Aligenie user nickname ', 'type' => 'string', 'example' => 'XXX'], + 'Avatar' => ['title' => '', 'description' => 'URL of the Aligenie user profile picture ', 'type' => 'string', 'example' => 'http://img.alicdn.com/xxx.jpg'], + 'Deletable' => ['title' => '', 'description' => 'Indicates whether the account can be logged off ', 'type' => 'boolean', 'example' => ''], ], - ], - 'RequestId' => [ - 'title' => '请求id', 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'AliGenie.Public.InternalError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceTags\\": {\\n \\"antest1\\": \\"antest1\\",\\n \\"antest\\": \\"a\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceTagResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceTags>\\n <antest1>antest1</antest1>\\n <antest>a</antest>\\n </DeviceTags>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceTagResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"AligenieNickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"http://img.alicdn.com/xxx.jpg\\",\\n \\"Deletable\\": false\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the Aligenie account information bound to a third party ', + 'description' => 'Note: When the logon state expires, the integrator must initiate the authorization logon flow again to obtain a new logon state (entry service API: AuthLoginWithThirdUserInfo).'."\n" + ."\n" + .'- Invoke the service API with the logon state access credential (LoginStateAccessToken) parameter by using the Java software development kit (SDK). For SDKs in other languages, consult the Tmall Genie developer team during integration. '."\n" + .'If the API call throws a TeaException and TeaException.code is InvalidAuthentication, the logon state has expired.'."\n" + ."\n" + .'- Invoke the service API by sending an HTTP request with the logon state access credential (LoginStateAccessToken) parameter. '."\n" + .'If the HTTP response status code returned by the API call is 400, the logon state has expired. ', + 'changeSet' => [], ], - 'DeviceControl' => [ - 'summary' => '设备控制', - 'path' => '/v1.0/ssp/control', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCodeEnhance' => [ + 'summary' => 'Obtain the authCode.', + 'path' => '/v1.0/ssp/getCodeEnhance', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [], - 'produces' => [], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ControlRequest', - 'in' => 'formData', + 'name' => 'ChannelInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '控制音量入参', - 'description' => '', + 'title' => '', + 'description' => 'Activation Channel, such as WeChat mini program or third-party app.', 'type' => 'object', 'properties' => [ - 'Volume' => [ - 'title' => '音量目标值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Muted' => [ - 'title' => '是否静音', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'Channel' => ['title' => '', 'description' => 'Activation Channel, such as WeChat or ThirdApp.', 'type' => 'string', 'required' => true, 'example' => 'WeChat、ThirdApp'], + 'ExtInfo' => ['title' => '', 'description' => 'Extension information.', 'type' => 'string', 'required' => false, 'example' => '{}'], ], - 'required' => false, + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'DeviceInfo', + 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息列表。', - 'description' => '', + 'title' => '', + 'description' => 'List of User Identifier information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', + 'title' => '', + 'description' => 'Encoding Type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'enum' => ['PROJECT_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ - 'title' => '设备Id的类型 ：'."\n" - .'OPEN_ID：默认的设备ID标识。'."\n" - .'UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', - 'description' => '', + 'title' => '', + 'description' => 'Type of User ID: '."\n" + .'OPENID: The default User ID identifier. '."\n" + .'UNIONID: The organization-dimension User ID identifier. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识，填写deviceOpenId或deviceUnionId的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'title' => '设备的组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1*****2', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['title' => '', 'description' => 'User Identifier. Enter the value of userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '调用该接口的返回结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '返回的详细信息。', - 'description' => '', - 'type' => 'boolean', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', - ], + 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Returned error code. A value of 200 indicates that the invocation Succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Detailed returned information.', 'type' => 'string', 'example' => 'Aexfgc'], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": \\"Aexfgc\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain authCode', + 'description' => 'Obtain the corresponding authCode by specifying the user ID.', + 'changeSet' => [], ], - 'GetDeviceSetting' => [ - 'summary' => '获取设备的用户设置', - 'path' => '/v1.0/ssp/getDeviceSetting', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetContent' => [ + 'summary' => 'Retrieve content information by a specific ID ', + 'path' => '/v1.0/ssp/GetContent', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Keys', + 'name' => 'Id', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '设备设置指定的Key集合，'."\n" - .'勿扰模式:nightMode', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123', 'title' => ''], ], [ - 'name' => 'DeviceInfo', + 'name' => 'Type', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息列表。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'IdType' => [ - 'title' => '设备Id的类型'."\n" - .'OPEN_ID：默认的设备ID标识。'."\n" - .'UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识，配置为deviceOpenId或deviceUnionId。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '122', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'Default value: song ', 'type' => 'string', 'required' => true, 'example' => 'song', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '调用该接口的返回结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'Code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Message information ', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request RequestId ', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Result' => [ - 'title' => '返回具体的设备设置信息。', - 'description' => '', + 'description' => 'Return Result ', 'type' => 'object', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'properties' => [ + 'Alias' => [ + 'description' => 'Alias', + 'type' => 'array', + 'items' => ['description' => 'Alias', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Audition' => ['description' => 'Is audition available ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Authors' => [ + 'description' => 'Content authors ', + 'type' => 'array', + 'items' => [ + 'description' => 'Content author ', + 'type' => 'object', + 'properties' => [ + 'AuthorTypes' => [ + 'description' => 'author type', + 'type' => 'array', + 'items' => ['description' => 'author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], + 'Id' => ['description' => 'Author primary key ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], + 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Category' => ['description' => 'Transform controlType based on the associated public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Charge' => ['description' => 'is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CommCateId' => ['description' => 'ID of the corresponding category', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], + 'Cover' => [ + 'description' => 'album thumbnail image', + 'type' => 'object', + 'properties' => [ + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used to crop the image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], + 'HotScore' => ['description' => 'Popularity score', 'type' => 'number', 'format' => 'double', 'example' => '内容描述', 'title' => ''], + 'Id' => ['description' => 'Content ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Title' => ['description' => 'title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'Type' => ['description' => 'Transform to favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether the content is playable.', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Duration' => ['description' => 'duration information', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'title' => ''], + 'AlbumId' => ['description' => 'ID of the corresponding album', 'type' => 'string', 'example' => '1231', 'title' => ''], + 'Lyric' => ['description' => 'Lyric information', 'type' => 'string', 'example' => 'http://1231.lrc', 'title' => ''], + 'Styles' => [ + 'description' => 'Genre ', + 'type' => 'array', + 'items' => ['description' => 'Genre ', 'type' => 'string', 'example' => '1312', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RawId' => ['description' => 'third-party ID of the content', 'type' => 'string', 'example' => '1231231', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 123123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 0,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"1231\\",\\n \\"Lyric\\": \\"http://1231.lrc\\",\\n \\"Styles\\": [\\n \\"1312\\"\\n ],\\n \\"RawId\\": \\"1231231\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve content information by a specific ID ', + 'changeSet' => [], ], - 'GetDeviceStatusDetail' => [ - 'summary' => '获取设备状态详情', - 'path' => '/v1.0/ssp/getDeviceStatusDetail', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCurrentPlayingItem' => [ + 'summary' => 'Obtain the current playback item. ', + 'path' => '/v1.0/ssp/GetCurrentPlayingItem', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Keys', + 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备设置指定的Key集合，'."\n" - .'如播放器:player', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, + 'description' => 'User identification information ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'The encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: The APK package name, which is the encoding type for the Android application customer link. `SKILL_ID`: The skill ID, which is the encoding type for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID.'."\n" + ."\n" + .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'The User Identifier, which can be set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'The organization ID. This field is required if IdType is set to UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -3959,56 +3005,24 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息列表。', - 'description' => '', + 'description' => 'Device identification information ', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'title' => '设备Id的类型 ：'."\n" - .'OPEN_ID：默认的设备ID标识。'."\n" - .'UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'OPEN_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识，填写deviceOpenId或deviceUnionId的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application client link. `SKILL_ID`: Skill ID, used for the cloud-based link. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type '."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID '."\n" + ."\n" + .'`OPEN_ID`: The default device ID identifier. `UNION_ID`: Device ID identifier at the organization dimension. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device identifier, set to either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -4019,197 +3033,113 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '调用该接口的返回结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'Return code of the invocation ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ - 'title' => '返回的详细信息。', - 'description' => '', + 'description' => 'Actual return result of the service ', 'type' => 'object', 'properties' => [ - 'Player' => [ - 'title' => '播放器信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AudioAnchor' => [ - 'title' => '歌手', - 'description' => '', - 'type' => 'string', - 'example' => '刘德华', - ], - 'AudioExt' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'AudioId' => [ - 'title' => '歌曲id', - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'Format' => [ - 'title' => '歌曲类型(mp3)', - 'description' => '', - 'type' => 'string', - 'example' => 'mp3', - ], - 'AudioSource' => [ - 'title' => '歌曲来源(xiami)', - 'description' => '', - 'type' => 'string', - 'example' => 'xiami', - ], - 'AudioLength' => [ - 'title' => ' 歌曲长度，秒', - 'description' => '', - 'type' => 'string', - 'example' => '253', - ], - 'Source' => [ - 'title' => '播放来源(cloud)', - 'description' => '', - 'type' => 'string', - 'example' => 'cloud', - ], - 'AudioUrl' => [ - 'title' => '歌曲url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://xxx', - ], - 'AudioName' => [ - 'title' => '歌曲名称', - 'description' => '', - 'type' => 'string', - ], - 'AudioAlbum' => [ - 'title' => '歌曲专辑', - 'description' => '', - 'type' => 'string', - ], - 'Progress' => [ - 'title' => '播放进度', - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'Timestamp' => [ - 'title' => '上报时间', - 'description' => '', - 'type' => 'string', - ], - 'Status' => [ - 'title' => '播放状态,pause', - 'description' => '', - 'type' => 'string', - 'example' => 'pause', - ], - ], - ], - 'Speaker' => [ - 'title' => '音量信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Volume' => [ - 'title' => '音量当前值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Muted' => [ - 'title' => '是否静音', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - 'Power' => [ - 'title' => '电量信息', - 'description' => '', + 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '550144364', 'title' => ''], + 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], + 'AlbumRawId' => ['description' => 'Third-party album ID ', 'type' => 'string', 'example' => '260744', 'title' => ''], + 'AlbumName' => ['description' => 'Third-party album name ', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], + 'Liked' => ['description' => 'is collected ', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Singer' => ['description' => 'author ', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], + 'Title' => ['description' => 'title ', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], + 'Cover' => [ + 'description' => 'Thumbnail image object', 'type' => 'object', 'properties' => [ - 'Quantity' => [ - 'title' => '电量值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Status' => [ - 'title' => '电源状态', - 'description' => '', - 'type' => 'string', - ], - ], + 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal) ', 'type' => 'string', 'example' => 'Repeat', 'title' => ''], + 'AudioLength' => ['description' => 'Length ', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], + 'Progress' => ['description' => 'Song playback progress ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'LyricUrl' => ['description' => 'Lyrics URL ', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], + 'Copyright' => ['description' => 'The copyright field is upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], + 'ItemUrl' => ['description' => 'Playback URL ', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], + 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential order, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether playback is allowed: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Pos' => ['description' => 'The position of this item in the playlist ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'Additional information. A common scenario is providing a brief description for failed invocations to help the caller identify the issue. ', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the invocation fails, check the Message field for details. ', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Player\\": {\\n \\"AudioAnchor\\": \\"刘德华\\",\\n \\"AudioExt\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AudioId\\": \\"123\\",\\n \\"Format\\": \\"mp3\\",\\n \\"AudioSource\\": \\"xiami\\",\\n \\"AudioLength\\": \\"253\\",\\n \\"Source\\": \\"cloud\\",\\n \\"AudioUrl\\": \\"https://xxx\\",\\n \\"AudioName\\": \\"\\",\\n \\"AudioAlbum\\": \\"\\",\\n \\"Progress\\": \\"30\\",\\n \\"Timestamp\\": \\"\\",\\n \\"Status\\": \\"pause\\"\\n },\\n \\"Speaker\\": {\\n \\"Volume\\": 10,\\n \\"Muted\\": true\\n },\\n \\"Power\\": {\\n \\"Quantity\\": 30,\\n \\"Status\\": \\"\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": \\"false\\",\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain the currently playing item ', + 'changeSet' => [], ], - 'SetDeviceSetting' => [ - 'summary' => '修改设备设置', - 'path' => '/v1.0/ssp/setDeviceSetting', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCurrentPlayingList' => [ + 'summary' => 'Obtain the current playlist.', + 'path' => '/v1.0/ssp/GetCurrentPlayingList', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'OpenQueryPlayListRequest', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '设备设置指定的Key集合，'."\n" - .'勿扰模式:nightMode', - 'description' => '', - 'type' => 'string', + 'description' => 'Business parameters', + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '15', 'title' => ''], + ], 'required' => true, - 'example' => 'nightMode', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Value', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'any', - 'required' => false, - 'example' => '{"enable":true}', + 'description' => 'User identity information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the Tmall Genie User Identifier, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID.'."\n" + ."\n" + .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User Identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -4217,54 +3147,24 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'title' => '编码类型，此处填写PROJECT_ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'title' => '设备Id的类型 ：'."\n" - .'OPEN_ID：默认的设备ID标识。'."\n" - .'UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'title' => '设备标识，填写deviceOpenId或deviceUnionId的值。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填。', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of Device ID.'."\n" + ."\n" + .'`OPEN_ID`: The default Device ID identity. `UNION_ID`: The organization-dimension Device ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -4275,573 +3175,359 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '调用该接口的返回结果。', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '返回的错误码，200表示调用成功。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ - 'title' => '设置执行结果', - 'description' => '', - 'type' => 'boolean', - ], - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '', - 'type' => 'string', - 'example' => '0EC7*726E', + 'description' => 'Actual return result of the service', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RawId' => ['description' => 'Third-party ID ', 'type' => 'string', 'example' => '550144364', 'title' => ''], + 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], + 'AlbumRawId' => ['description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744', 'title' => ''], + 'AlbumName' => ['description' => 'Third-party album name', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], + 'Liked' => ['description' => 'is collected', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Singer' => ['description' => 'author', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], + 'Title' => ['description' => 'title', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], + 'Cover' => [ + 'description' => 'Thumbnail image object ', + 'type' => 'object', + 'properties' => [ + 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Mediam' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'AudioLength' => ['description' => 'Length', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], + 'Progress' => ['description' => 'Playback progress of the song', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'LyricUrl' => ['description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], + 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.) ', 'type' => 'string', 'example' => 'story', 'title' => ''], + 'Copyright' => ['description' => 'The copyright field has been upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ItemUrl' => ['description' => 'Playback URL', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], + 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential, 1 for reverse order', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Valid' => ['description' => 'Whether playable: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Pos' => ['description' => 'Position of this item in the playlist', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'Additional information. A typical scenario is providing a brief description for failed invocations to help the caller identify the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the invocation fails, check the Message field.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Normal\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Retrieve the current playlist', + 'changeSet' => [], ], - 'GetJiangSuTelecomData' => [ - 'summary' => '江苏电信号百', - 'path' => '/v1.0/ssp/GetJiangSuTelecomData', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDeviceBasicInfo' => [ + 'summary' => 'Obtain basic device information by Device ID. ', + 'path' => '/v1.0/ssp/getDeviceBasicInfo', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Date', + 'name' => 'DeviceInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-09', + 'title' => '', + 'description' => 'List of device identity information. ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. Enter **PROJECT_ID** here. ', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which this product belongs. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of device ID: '."\n" + .'- OPEN_ID: The default device ID. '."\n" + .'- UNION_ID: The organization-dimension device ID. You must request an organization in the Open Platform in advance.', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'Return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'Detailed information returned. ', 'type' => 'object', 'properties' => [ - 'OssUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA', - ], + 'Name' => ['title' => '', 'description' => 'Name of the device. ', 'type' => 'string', 'example' => '我的设备'], + 'FirmwareVersion' => ['title' => '', 'description' => 'Firmware version of the device. ', 'type' => 'string', 'example' => '2.0.3'], + 'Mac' => ['title' => '', 'description' => 'MAC address of the device. ', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'], + 'Sn' => ['title' => '', 'description' => 'SN information of the device. ', 'type' => 'string', 'example' => '1200xxx048'], ], + 'example' => '', ], - 'Message' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.GetDeviceBasicInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OssUrl\\": \\"http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain basic device information ', + 'changeSet' => [], ], - 'ScgSearch' => [ - 'summary' => '选品池投放能力', - 'path' => '/v1.0/ssp/scgSearch', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDeviceIdByIdentity' => [ + 'summary' => 'Obtain the Device ID based on the device MAC or SN.', + 'path' => '/v1.0/ssp/getDeviceIdByIdentity', + 'methods' => ['get'], + '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' => 'TopicId', + 'name' => 'EncodeType', 'in' => 'query', - 'schema' => [ - 'title' => '选品池ID 可选：MC201132（民族中国风），MC201136（流行音乐），MC201139（甜蜜爱情），MC201133（民谣），MC201137（放松阅读），MC201138（快乐），PA202029（故事），PA202030（儿歌），PA202028（国学历史），PA202032（百科），PA202031（英文儿歌）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'MC201132', - ], + 'schema' => ['title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'], ], [ - 'name' => 'ScgFilter', + 'name' => 'EncodeKey', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '查询filter', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SortParam' => [ - 'title' => '排序参数', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SortKey' => [ - 'title' => '排序字段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'internal_id', - ], - 'SortText' => [ - 'title' => '排序字段（默认空字符串）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '“”', - ], - 'SortOrder' => [ - 'title' => '排序顺序', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', - ], - ], - 'required' => true, - ], - 'UseOffSet' => [ - 'title' => '是否使用pageParam对象分页，offSetParam和pageParam二选一，默认分页模式为pageParam', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'OffSetParam' => [ - 'title' => '分页类型', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Offset' => [ - 'title' => '跳过的条目数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Limit' => [ - 'title' => '返回的条目数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], - 'PageParam' => [ - 'title' => '分页类型', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'title' => '每页记录条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'PageNum' => [ - 'title' => '页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which this product belongs. You can view it in the Tmall Genie AI platform console. ', 'type' => 'string', 'required' => true, 'example' => '129****0946'], + ], + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Device authentication type. Enter **MAC**, **SN**, or **CTEI**. ', 'type' => 'string', 'required' => true, 'example' => 'MAC'], + ], + [ + 'name' => 'IdentityId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Authentication identifier. Enter the MAC address or the SN value. ', 'type' => 'string', 'required' => true, 'example' => 'b4:xx:xx:xx:65:2b'], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The unique product identifier ProductKey, which is a globally unique identity issued by the platform when the product is created in the Tmall Genie AI platform. This parameter is optional when IdentityType is **CTEI**. ', 'type' => 'string', 'required' => false, 'example' => 'Mm*****XnZ8'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', - 'description' => 'result', + 'title' => '', + 'description' => 'Returns a data list.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'title' => '页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Message' => [ - 'title' => '响应信息', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'PageSize' => [ - 'title' => '每页记录条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Message' => ['title' => '', 'description' => 'The return result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '返回的内容数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Source' => [ - 'title' => '内容来源', - 'description' => '', - 'type' => 'string', - 'example' => 'xiami', - ], - 'Title' => [ - 'title' => '内容标题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'title' => '内容类型', - 'description' => '', - 'type' => 'string', - 'example' => 'music', - ], - 'Cover' => [ - 'title' => '内容封面', - 'description' => '', + 'title' => '', + 'description' => 'Detailed information returned.', + 'type' => 'object', + 'properties' => [ + 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the device. ', 'type' => 'string', 'example' => 'A963*0158'], + 'DeviceUnionIds' => [ + 'title' => '', + 'description' => 'Organization ID and UnionId information corresponding to the device.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information list', 'type' => 'object', 'properties' => [ - 'Img' => [ - 'title' => '封面图片', - 'description' => '', - 'type' => 'string', - 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg', - ], - 'canResize' => [ - 'title' => '是否支持缩放', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Large' => [ - 'title' => '大图', - 'description' => '', - 'type' => 'string', - 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg', - ], - 'Medium' => [ - 'title' => '中图', - 'description' => '', - 'type' => 'string', - 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg', - ], - 'Small' => [ - 'title' => '小图', - 'description' => '', - 'type' => 'string', - 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg', - ], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID.', 'type' => 'string', 'example' => '1**2'], + 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device.', 'type' => 'string', 'example' => '1553*B0C3'], ], - ], - 'Alias' => [ - 'title' => '别名', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'SupportAudition' => [ - 'title' => '是否支持试听'."\n", - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ContentType' => [ - 'title' => '内容类型', - 'description' => '', - 'type' => 'string', - 'example' => 'MUSIC_CONTENT', - ], - 'Singers' => [ - 'title' => '歌手名', - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'AlbumRawId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'example' => '1795716629', - ], - 'Album' => [ - 'title' => '是否为专辑', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AlbumType' => [ - 'title' => '专辑类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'AuthorIds' => [ - 'title' => '作者ID'."\n", - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1795716629', - ], - ], - 'IsAudition' => [ - 'title' => '能否试听', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AuthorNames' => [ - 'title' => '作者姓名', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'NeedCharge' => [ - 'title' => '是否需要收费', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsCharge' => [ - 'title' => '是否收费', - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'Category' => [ - 'title' => '类别', - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'RawId' => [ - 'title' => '三方内容Id', - 'description' => '', - 'type' => 'string', - 'example' => '1795716629', - ], + 'example' => '', ], ], 'example' => '', ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', - ], - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7DA****A0726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"xiami\\",\\n \\"Title\\": \\"那个人\\",\\n \\"Type\\": \\"music\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"canResize\\": false,\\n \\"Large\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Medium\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Small\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\"\\n },\\n \\"Alias\\": [\\n \\"那个人\\"\\n ],\\n \\"SupportAudition\\": false,\\n \\"ContentType\\": \\"MUSIC_CONTENT\\",\\n \\"Singers\\": \\"黎偌天\\",\\n \\"AlbumRawId\\": \\"1795716629\\",\\n \\"Album\\": false,\\n \\"AlbumType\\": 0,\\n \\"AuthorIds\\": [\\n 1795716629\\n ],\\n \\"IsAudition\\": false,\\n \\"AuthorNames\\": [\\n \\"\\\\\\"王一鸣Iris\\\\\\", \\\\\\"黎偌天\\\\\\", \\\\\\"薛晨雨\\\\\\"\\"\\n ],\\n \\"NeedCharge\\": false,\\n \\"IsCharge\\": \\"false\\",\\n \\"Category\\": \\"audio\\",\\n \\"RawId\\": \\"1795716629\\"\\n }\\n ],\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ScgSearchResponse>\\n <PageNum>1</PageNum>\\n <Message>OK</Message>\\n <PageSize>10</PageSize>\\n <Result>\\n <Source>xiami</Source>\\n <Title>那个人</Title>\\n <Type>music</Type>\\n <Cover>\\n <Img>http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg</Img>\\n <canResize>false</canResize>\\n </Cover>\\n <Alias>那个人</Alias>\\n <SupportAudition>false</SupportAudition>\\n <ContentType>MUSIC_CONTENT</ContentType>\\n <Singers>黎偌天</Singers>\\n <AlbumRawId>1795716629</AlbumRawId>\\n <Album>false</Album>\\n <AlbumType>0</AlbumType>\\n <AuthorIds>1795716629</AuthorIds>\\n <IsAudition>false</IsAudition>\\n <AuthorNames>\\"王一鸣Iris\\", \\"黎偌天\\", \\"薛晨雨\\"</AuthorNames>\\n <NeedCharge>false</NeedCharge>\\n <IsCharge>false</IsCharge>\\n <Category>audio</Category>\\n <RawId>1795716629</RawId>\\n </Result>\\n <RequestId>73C67BD9-175A-1324-8202-9FAABBB3E6FA</RequestId>\\n <Code>200</Code>\\n</ScgSearchResponse>","errorExample":""}]', - ], - 'AddAndRemoveFavoriteContent' => [ - 'summary' => '收藏/取消收藏', - 'path' => '/v1.0/ssp/AddAndRemoveFavoriteContent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7DA****A0726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain Device ID ', + 'changeSet' => [], + ], + 'GetDeviceSetting' => [ + 'summary' => 'Obtain the user settings of a device. ', + 'path' => '/v1.0/ssp/getDeviceSetting', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => [], + 'produces' => [], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenAddAndRemoveFavoriteContentRequest', - 'in' => 'formData', + 'name' => 'Keys', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PackageType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CONTENT', - ], - 'OpenSourceRawIdPair' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2105818057', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xiami', - ], - 'ExtendInfo' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'FavoriteCmd' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ADD', - ], - ], + 'title' => '', + 'description' => 'Set of specified keys for device Settings, '."\n" + .'Do Not Disturb mode: nightMode ', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'UserInfo', + 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of device identity information. ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. Set this parameter to PROJECT_ID. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project that contains the ProductKey of this product in the Tmall Genie AI Platform.', 'type' => 'string', 'required' => true, 'example' => '12345'], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'The type of Device ID. '."\n" + .'OPEN_ID: The default device identity. '."\n" + .'UNION_ID: The device identity at the organization dimension. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'Device ID. Configure this parameter as deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '122'], ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API. ', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Returned error code. The value 200 indicates that the call Succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Returns specific device Settings information. ', 'type' => 'object', 'example' => ''], + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain the user settings of a device ', + 'changeSet' => [], + ], + 'GetDeviceStatusDetail' => [ + 'summary' => 'Obtain device status details.', + 'path' => '/v1.0/ssp/getDeviceStatusDetail', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Keys', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'A collection of specified keys for device settings: '."\n" + .'Player: player '."\n" + .'Device volume: speaker '."\n" + .'Battery level: power', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'required' => true, + 'example' => '', ], ], [ @@ -4849,41 +3535,34 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of device identification information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the product’s project here. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID: '."\n" + .'OPEN_ID: The default device ID. '."\n" + .'UNION_ID: An organization-level device ID. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'OPEN_ID'], ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, + 'example' => '', ], ], ], @@ -4894,1237 +3573,738 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Returned error code. 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '121212121', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', + 'title' => '', + 'description' => 'Returned detailed information.', + 'type' => 'object', + 'properties' => [ + 'Player' => [ + 'title' => '', + 'description' => 'Player information', + 'type' => 'object', + 'properties' => [ + 'AudioAnchor' => ['title' => '', 'description' => 'Artist ', 'type' => 'string', 'example' => '刘德华'], + 'AudioExt' => ['title' => '', 'description' => 'Extension Information ', 'type' => 'string', 'example' => '""'], + 'AudioId' => ['title' => '', 'description' => 'Audio ID ', 'type' => 'string', 'example' => '123'], + 'Format' => ['title' => '', 'description' => 'Song Type (mp3) ', 'type' => 'string', 'example' => 'mp3'], + 'AudioSource' => ['title' => '', 'description' => 'Song Source (xiami) ', 'type' => 'string', 'example' => 'xiami'], + 'AudioLength' => ['title' => '', 'description' => 'Song length, in seconds', 'type' => 'string', 'example' => '253'], + 'Source' => ['title' => '', 'description' => 'Playback Source (cloud) ', 'type' => 'string', 'example' => 'cloud'], + 'AudioUrl' => ['title' => '', 'description' => 'Song URL', 'type' => 'string', 'example' => 'https://xxx'], + 'AudioName' => ['title' => '', 'description' => 'Song Name', 'type' => 'string', 'example' => ''], + 'AudioAlbum' => ['title' => '', 'description' => 'Song Album ', 'type' => 'string', 'example' => ''], + 'Progress' => ['title' => '', 'description' => 'Playback progress', 'type' => 'string', 'example' => '30'], + 'Timestamp' => ['title' => '', 'description' => 'Reporting Time ', 'type' => 'string', 'example' => ''], + 'Status' => ['title' => '', 'description' => 'Playback status, pause', 'type' => 'string', 'example' => 'pause'], + ], + 'example' => '', + ], + 'Speaker' => [ + 'title' => '', + 'description' => 'Volume information ', + 'type' => 'object', + 'properties' => [ + 'Volume' => ['title' => '', 'description' => 'Current volume value ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Muted' => ['title' => '', 'description' => 'Is muted', 'type' => 'boolean', 'example' => ''], + ], + 'example' => '', + ], + 'Power' => [ + 'title' => '', + 'description' => 'Battery information ', + 'type' => 'object', + 'properties' => [ + 'Quantity' => ['title' => '', 'description' => 'Battery value ', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Status' => ['title' => '', 'description' => 'Power status ', 'type' => 'string', 'example' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"121212121\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAndRemoveFavoriteContentResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>121212121</RequestId>\\n <Success>true</Success>\\n</AddAndRemoveFavoriteContentResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Player\\": {\\n \\"AudioAnchor\\": \\"刘德华\\",\\n \\"AudioExt\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AudioId\\": \\"123\\",\\n \\"Format\\": \\"mp3\\",\\n \\"AudioSource\\": \\"xiami\\",\\n \\"AudioLength\\": \\"253\\",\\n \\"Source\\": \\"cloud\\",\\n \\"AudioUrl\\": \\"https://xxx\\",\\n \\"AudioName\\": \\"\\",\\n \\"AudioAlbum\\": \\"\\",\\n \\"Progress\\": \\"30\\",\\n \\"Timestamp\\": \\"\\",\\n \\"Status\\": \\"pause\\"\\n },\\n \\"Speaker\\": {\\n \\"Volume\\": 10,\\n \\"Muted\\": false\\n },\\n \\"Power\\": {\\n \\"Quantity\\": 30,\\n \\"Status\\": \\"\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Get device status details', + 'changeSet' => [], ], - 'CreatePlayingList' => [ - 'summary' => '播放列表创建', - 'path' => '/v1.0/ssp/CreatePlayingList', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDeviceStatusInfo' => [ + 'summary' => 'Obtain the online status of a device based on its openID. ', + 'path' => '/v1.0/ssp/getDeviceStatusInfo', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenCreatePlayingListRequest', - 'in' => 'formData', + 'name' => 'DeviceInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of device identity information. ', 'type' => 'object', 'properties' => [ - 'PlayFrom' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'ContentType' => [ - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. Set this parameter to **PROJECT_ID**. ', 'type' => 'string', 'required' => true, - 'example' => 'content', - ], - 'ContentList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xiami', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'Index' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'NeedAlbumContinued' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], - 'PlayMode' => [ - 'description' => '', + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'IdType' => [ + 'title' => '', + 'description' => 'The Type of the Device ID: '."\n" + .'- OPEN_ID: The default device ID identity. '."\n" + .'- UNION_ID: The organization-dimension device ID identity. You must request an organization in the Open Platform in advance.', 'type' => 'string', - 'required' => false, - 'example' => 'Repeat', - ], - 'ExtendInfo' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['title' => '', 'description' => 'Device identifier. Specify the value of deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID of the device. This parameter is required if IdType is set to UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], - [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', + 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => [ + 'title' => '', + 'description' => 'Detailed information returned. ', + 'type' => 'object', + 'properties' => [ + 'Online' => ['title' => '', 'description' => 'Indicates whether the device is online. A value of 0 means offline, and 1 means online. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'example' => '', ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], - 'required' => true, + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.GetDeviceStatusInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Online\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain device status ', + 'changeSet' => [], + ], + 'GetDeviceTag' => [ + 'summary' => 'Obtain the tag information of a device.', + 'path' => '/v1.0/ssp/getDeviceTag', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of device identity information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. Enter **PROJECT_ID** here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - 'enum' => [], + 'enum' => ['PROJECT_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project in the Tmall Genie AI platform where the product\'s ProductKey resides.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'The type of Device ID:'."\n" + .' - OPEN_ID: The default device identity.'."\n" + .'- UNION_ID: The device identity at the organization dimension, which requires a prior request for an organization on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'UNION_ID', - 'OPEN_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['title' => '', 'description' => 'Device identifier. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenServiceResult<OpenPlayingItem>', - 'description' => 'OpenServiceResult<OpenPlayingItem>', + 'title' => '', + 'description' => 'Returns a data list.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'The return result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', + 'title' => '', + 'description' => 'Detailed information returned.', 'type' => 'object', 'properties' => [ - 'RawId' => [ - 'title' => '三方id', - 'description' => '', - 'type' => 'string', - 'example' => '550144364', - ], - 'Source' => [ - 'title' => '来源', - 'description' => '', - 'type' => 'string', - 'example' => 'ximalayav2', - ], - 'AlbumRawId' => [ - 'title' => '三方专辑id', - 'description' => '', - 'type' => 'string', - 'example' => '260744', - ], - 'AlbumName' => [ - 'title' => '三方专辑id', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Liked' => [ - 'title' => '是否收藏', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Singer' => [ - 'title' => '作者', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Title' => [ - 'title' => '标题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Cover' => [ - 'title' => '封面图片对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'PlayMode' => [ - 'title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', - 'description' => '', - 'type' => 'string', - 'example' => 'Repeat', - ], - 'AudioLength' => [ - 'title' => '长度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '190', - ], - 'Progress' => [ - 'title' => '歌曲播放进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'LyricUrl' => [ - 'title' => '歌词url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', - ], - 'Copyright' => [ - 'title' => '版权字段升级为是否可播：0 可播, 1/2 不可播', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'story', - ], - 'ItemUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', - ], - 'DefaultPlayOrder' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Pos' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'DeviceTags' => ['title' => '', 'description' => 'Tag information of the device.', 'type' => 'object', 'example' => '{ "antest1": "antest1", "antest": "a" }'], ], + 'example' => '', ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <LyricUrl>https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc</LyricUrl>\\n <Copyright>0</Copyright>\\n <Type>story</Type>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</CreatePlayingListResponse>","errorExample":""}]', - ], - 'GetAlbum' => [ - 'summary' => '根据id获取专辑信息', - 'path' => '/v1.0/ssp/GetAlbum', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceTags\\": {\\n \\"antest1\\": \\"antest1\\",\\n \\"antest\\": \\"a\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain device tags', + 'changeSet' => [], + ], + 'GetJiangSuTelecomData' => [ + 'summary' => 'Derived requirements from Jiangsu Telecom\'s self-developed desktop launcher project. HaoBai expects to collect statistics on the activation rate, active user rate, and top user usage patterns after the project is published, and to generate daily and weekly reports. Daily reports are synchronized automatically via API, while weekly reports are synchronized offline.', + 'path' => '/v1.0/ssp/GetJiangSuTelecomData', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => ['description' => 'Date in the format yyyy-MM-dd. This refers to the data timestamp when the data becomes available, not the date when the data was generated. Data is always produced on a T+1 basis.', 'type' => 'string', 'required' => false, 'example' => '2024-11-09', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Status code. Returns 200 for normal responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Result' => [ + 'description' => 'Actual return result of the service', + 'type' => 'object', + 'properties' => [ + 'OssUrl' => ['description' => 'OSS object URL, valid for 10 minutes', 'type' => 'string', 'example' => 'http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Message' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949', 'title' => ''], + ], + 'example' => '', + ], + ], ], - 'produces' => [ - 'application/json', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OssUrl\\": \\"http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949\\"\\n}","type":"json"}]', + 'title' => 'Retrieve data from Jiangsu Telecom HaoBai', + 'changeSet' => [], + ], + 'GetScheduleTask' => [ + 'summary' => 'Obtain scheduled task information.', + 'path' => '/v1.0/ssp/GetScheduleTask', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'Input parameters for the service request', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'ID of the job to query', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'], + 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'AccessKey of the caller', 'type' => 'string', 'description' => '', 'example' => ''], + ], 'required' => true, - 'example' => '12343', + 'example' => '', ], ], [ - 'name' => 'Type', - 'in' => 'query', + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'User identifier information', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], + 'IdType' => ['title' => '', 'description' => 'Type of the User ID: OPENID—the default User ID identity; UNIONID—the organization-dimension User ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME indicates the APK package name, used in the Android application customer flow; SKILL_ID indicates the skill ID, used in the cloud-based flow.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILLID, the value is the application\'s SkillID. When the encoding type is PACKAGENAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], 'required' => true, - 'example' => 'song', + 'example' => '', + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Device ID information ', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], + 'IdType' => ['title' => '', 'description' => 'Device ID type: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform. ', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link. ', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s SkillID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'AmpResult<ScheduleOpenResponse>', + 'description' => 'AmpResult<ScheduleOpenResponse>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => '调用成功'], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F7E21065-6C21-1158-A2F9-AEFE5CAB7C94'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'Service response parameters', 'type' => 'object', 'properties' => [ - 'Alias' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Audition' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'ScheduleId' => ['title' => '', 'description' => 'Job ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], + 'ScheduleType' => [ + 'title' => '', + 'description' => 'Schedule Type', + 'type' => 'string', + 'example' => 'ONCE', + 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_DAY'], ], - 'Authors' => [ - 'description' => '', + 'Cron' => ['title' => '', 'description' => 'Trigger Cron Expression ', 'type' => 'string', 'example' => '0 10 20 30 6 ? 2022'], + 'ScheduleStartTime' => ['description' => 'Validity Period - Start Time', 'type' => 'string', 'example' => '1656577473000', 'title' => ''], + 'ScheduleEndTime' => ['description' => 'Validity Period - End Time', 'type' => 'string', 'example' => '1659169473000', 'title' => ''], + 'ActionTopicList' => [ + 'description' => 'Trigger behavior', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'AuthorTypes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANCHOR', - ], - ], - 'Gender' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MALE', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13123', - ], - 'Online' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qignting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Charge' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CommCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80012017', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', + 'CustomAction' => ['description' => 'Vendor-defined command', 'type' => 'object', 'example' => '{"k1":"v1","k2":{"key":1}}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotScore' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1231231', - ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALBUM', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qignting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Finished' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FINISHED', - ], - 'TotalEpisode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23242', - ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 13123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Finished\\": \\"FINISHED\\",\\n \\"TotalEpisode\\": 12,\\n \\"RawId\\": \\"23242\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAlbumResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>13123</Id>\\n <Online>false</Online>\\n <Source>qignting</Source>\\n <Title>超能狂少在都市</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>1231231</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qignting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <Finished>FINISHED</Finished>\\n <TotalEpisode>12</TotalEpisode>\\n <RawId>23242</RawId>\\n </Result>\\n</GetAlbumResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"RequestId\\": \\"F7E21065-6C21-1158-A2F9-AEFE5CAB7C94\\",\\n \\"Result\\": {\\n \\"ScheduleId\\": 1234567,\\n \\"ScheduleType\\": \\"ONCE\\",\\n \\"Cron\\": \\"0 10 20 30 6 ? 2022\\",\\n \\"ScheduleStartTime\\": \\"1656577473000\\",\\n \\"ScheduleEndTime\\": \\"1659169473000\\",\\n \\"ActionTopicList\\": [\\n {\\n \\"CustomAction\\": {\\n \\"k1\\": \\"v1\\",\\n \\"k2\\": {\\n \\"key\\": 1\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve scheduled task information ', + 'description' => 'Query the details of a specified scheduled task by its ID.', + 'responseParamsDescription' => 'The request is successful only when the service returns a status code of 200; otherwise, it indicates failure.', + 'changeSet' => [], ], - 'GetContent' => [ - 'summary' => '按照特定的id获取内容信息', - 'path' => '/v1.0/ssp/GetContent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetUnreadMessageCount' => [ + 'summary' => 'Query the number of unread messages for a user.', + 'path' => '/v1.0/ssp/getUnreadMessageCount', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'UserInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123123', + 'description' => 'User Identifier information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier from Maojing, and each method corresponds to a different encoding type: PACKAGENAME for the APK package name used in the Android application client link, and SKILLID for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the application\'s Skill ID. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], + 'IdType' => ['description' => 'Type of User ID: OPENID is the default user ID identity; UNIONID is the organization-dimension user ID identity, which is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Service Return Result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => 'Id of the request', 'description' => 'Error message', 'type' => 'string', 'example' => '用户信息不存在'], + 'Code' => ['description' => 'Status code returned by the service', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Result' => ['description' => 'Number of unread messages', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"用户信息不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": 10\\n}","type":"json"}]', + 'title' => 'Query the Number of Unread Messages', + 'changeSet' => [], + ], + 'GetUserByDeviceId' => [ + 'summary' => 'Obtain the User ID attached to a device by the device\'s openID. ', + 'path' => '/v1.0/ssp/getUserByDeviceId', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Type', + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'DeviceInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'List of device identity information. ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. Set this parameter to **PROJECT_ID**. ', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Set this parameter to the Project ID of the product’s ProductKey in the Tmall Genie AI platform. ', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of the device ID: '."\n" + .'- OPEN_ID: The default device ID. '."\n" + .'- UNION_ID: The organization-dimension device ID. You must request an organization on the Open Platform in advance. ', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + ], + 'Id' => ['title' => '', 'description' => 'Device identifier, configured as either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is set to UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], + ], 'required' => true, - 'example' => 'song', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], + 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'The list of user information returned. ', 'type' => 'object', 'properties' => [ - 'Alias' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Audition' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Authors' => [ - 'description' => '', + 'UserOpenId' => ['title' => '', 'description' => 'The openID corresponding to the user information. ', 'type' => 'string', 'example' => '0963*0158'], + 'UserUnionIds' => [ + 'title' => '', + 'description' => 'The list of organization IDs and UnionIDs for the user. ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of information ', 'type' => 'object', 'properties' => [ - 'AuthorTypes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANCHOR', - ], - ], - 'Gender' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MALE', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - 'Online' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Charge' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CommCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80012017', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', + 'OrganizationId' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'example' => '1**2'], + 'UserUnionId' => ['title' => '', 'description' => 'The user\'s UnionID. ', 'type' => 'string', 'example' => '1553*B0C3'], ], + 'title' => '', + 'example' => '', ], - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotScore' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', 'example' => '', ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALBUM', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '180', - ], - 'AlbumId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1231', - ], - 'Lyric' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://1231.lrc', - ], - 'Styles' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1312', - ], - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1231231', - ], ], + 'example' => 'true', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 123123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 0,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"1231\\",\\n \\"Lyric\\": \\"http://1231.lrc\\",\\n \\"Styles\\": [\\n \\"1312\\"\\n ],\\n \\"RawId\\": \\"1231231\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>123123</Id>\\n <Online>false</Online>\\n <Source>qingting</Source>\\n <Title>播音呆瓜小贼</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <Duration>180</Duration>\\n <AlbumId>1231</AlbumId>\\n <Lyric>http://1231.lrc</Lyric>\\n <Styles>1312</Styles>\\n <RawId>1231231</RawId>\\n </Result>\\n</GetContentResponse>","errorExample":""}]', - ], - 'GetCurrentPlayingItem' => [ - 'summary' => '获取当前播放项', - 'path' => '/v1.0/ssp/GetCurrentPlayingItem', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.GetUserByDeviceId.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"0963*0158\\",\\n \\"UserUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"UserUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain the User ID attached to a device ', + 'changeSet' => [], + ], + 'GetWeather' => [ + 'summary' => 'Query the weather.', + 'path' => '/v1.0/ssp/GetWeather', + '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' => [], 'parameters' => [ [ + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Input parameters for the service request', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Caller AccessKey', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + 'required' => false, + 'docRequired' => false, + 'example' => '', + ], + ], + [ 'name' => 'UserInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], + 'IdType' => ['title' => '', 'description' => 'Type of user ID: OPEN_ID: default user ID identifier; UNION_ID: organization-dimension user ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer links; SKILL_ID: skill ID, used for cloud-based links.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Device ID information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], + 'IdType' => ['title' => '', 'description' => 'Type of the device ID: OPEN_ID is the default device ID identity; UNION_ID is the organization-dimension device ID identity, which is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID of Maojing, and each way corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer link; SKILL_ID refers to the skill ID, which is the encoding type for the cloud link.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This field is required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'AmpResult<WeatherResponse>', + 'description' => 'AmpResult<WeatherResponse>', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '调用成功'], + 'Code' => ['title' => 'HttpCode', 'description' => 'HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'model data', 'type' => 'object', 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '550144364', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ximalayav2', - ], - 'AlbumRawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '260744', - ], - 'AlbumName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Liked' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'Singer' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Cover' => [ - 'description' => '', + 'CurrentMeteorology' => [ + 'title' => '', + 'description' => 'Current weather', 'type' => 'object', 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', + 'Weather' => [ + 'title' => '', + 'description' => 'Daytime weather', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '', 'description' => 'Weather code: for example, "000,100"', 'type' => 'string', 'example' => '000'], + 'Name' => ['title' => '', 'description' => 'Weather name description: "Sunny (000), Multicloud (100), Overcast (101), Rain (200), Light rain (201), Light to moderate rain (202), Moderate rain (203), Moderate to heavy rain (204), Heavy rain (205), Heavy to storm rain (206), Storm rain (207), Heavy storm rain (209), Severe storm rain (211), Showers (212), Thunderstorms (213), Freezing rain (214), Snow (300), Sleet (301), Snow showers (302), Light snow (303), Light to moderate snow (304), Moderate snow (305), Heavy snow (307), Blizzard (309), Fog (400), Dust (501), Sand blowing (502), Sandstorm (503), Severe sandstorm (504), Mostly sunny (000), Partly cloudy (100), Light showers (212), Lightning (213), Ice pellets (214), Thunderstorms with hail (215), Light snow showers (302), Freezing fog (400), Haze (500), Dust whirls (502), Localized showers (212), Thunderstorm (213), Ice needles (214), Hail (215), Intense showers (212)"', 'type' => 'string', 'example' => '晴'], + ], + 'example' => '', ], - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'Temperature' => [ + 'title' => '', + 'description' => 'Temperature', + 'type' => 'object', + 'properties' => [ + 'Current' => ['title' => '', 'description' => 'Current temperature value', 'type' => 'string', 'example' => '36'], + 'CurrentDesc' => ['title' => '', 'description' => 'Description of the current temperature value', 'type' => 'string', 'example' => '36度'], + 'High' => ['title' => '', 'description' => 'Maximum temperature value', 'type' => 'string', 'example' => '37'], + 'HighDesc' => ['title' => '', 'description' => 'Description of the maximum temperature value', 'type' => 'string', 'example' => '37度'], + 'Low' => ['title' => '', 'description' => 'Lowest temperature', 'type' => 'string', 'example' => '28'], + 'LowDesc' => ['title' => '', 'description' => 'Description of the lowest temperature', 'type' => 'string', 'example' => '28度'], + 'Logical' => ['title' => '', 'description' => 'Temperature with logic, as follows:', 'type' => 'string', 'example' => '41'], + ], + 'example' => '', ], ], - ], - 'PlayMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Repeat', - ], - 'AudioLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '190', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'LyricUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', - ], - 'Copyright' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'story', - ], - 'ItemUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', - ], - 'DefaultPlayOrder' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Pos' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'example' => '', ], ], + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F7E2****B7C94', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": \\"false\\",\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCurrentPlayingItemResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Copyright>0</Copyright>\\n <Type>story</Type>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</GetCurrentPlayingItemResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"调用成功\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"CurrentMeteorology\\": {\\n \\"Weather\\": {\\n \\"Code\\": \\"000\\",\\n \\"Name\\": \\"晴\\"\\n },\\n \\"Temperature\\": {\\n \\"Current\\": \\"36\\",\\n \\"CurrentDesc\\": \\"36度\\",\\n \\"High\\": \\"37\\",\\n \\"HighDesc\\": \\"37度\\",\\n \\"Low\\": \\"28\\",\\n \\"LowDesc\\": \\"28度\\",\\n \\"Logical\\": \\"41\\"\\n }\\n }\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + 'title' => 'Query weather', + 'description' => 'Query the weather data for the location of the device based on the Device Information obtained from system parameters.', + 'responseParamsDescription' => 'The request is successful only when the status code returned by the service is 200; otherwise, it indicates failure.', + 'changeSet' => [], ], - 'GetCurrentPlayingList' => [ - 'summary' => '获取当前播放列表', - 'path' => '/v1.0/ssp/GetCurrentPlayingList', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'IndexControlPlayingList' => [ + 'summary' => 'Click a playlist to start playback. ', + 'path' => '/v1.0/ssp/IndexControlPlayingList', + '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' => [], 'parameters' => [ [ - 'name' => 'OpenQueryPlayListRequest', + 'name' => 'OpenIndexControlRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '15', - ], + 'Index' => ['description' => 'The index to be played back', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + 'NeedContentContinued' => ['description' => 'Whether content playback should continue. Default is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -6132,41 +4312,24 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of User ID'."\n" + ."\n" + .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity, which is available only after an organization has been requested on the Tmall Genie Skills Application 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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -6174,41 +4337,24 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID'."\n" + ."\n" + .'`OPEN_ID`: The default device ID identity. `UNION_ID`: Device ID identity at the organization dimension. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -6219,529 +4365,376 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'Return code of the invocation ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '550144364', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ximalayav2', - ], - 'AlbumRawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '260744', - ], - 'AlbumName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Liked' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Singer' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'PlayMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Normal', - ], - 'AudioLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '190', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'LyricUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'story', - ], - 'Copyright' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ItemUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', - ], - 'DefaultPlayOrder' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Pos' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'description' => 'Actual return result from the service ', + 'type' => 'object', + 'properties' => [ + 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '550144364', 'title' => ''], + 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], + 'AlbumRawId' => ['description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744', 'title' => ''], + 'AlbumName' => ['description' => 'Third-party album Name', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], + 'Liked' => ['description' => 'Indicates whether the item is collected ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Singer' => ['description' => 'Author ', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], + 'Title' => ['description' => 'Title ', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], + 'Cover' => [ + 'description' => 'Thumbnail image object', + 'type' => 'object', + 'properties' => [ + 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', + 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal) ', 'type' => 'string', 'example' => 'Repeat', 'title' => ''], + 'AudioLength' => ['description' => 'Length ', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], + 'Progress' => ['description' => 'Playback progress of the song ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'LyricUrl' => ['description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], + 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], + 'Copyright' => ['description' => 'The copyright field is upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ItemUrl' => ['description' => 'Playback URL ', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], + 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential order, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether playback is allowed: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Pos' => ['description' => 'The position of this item in the playlist', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. If the invocation fails, check the Message field for details. ', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Normal\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCurrentPlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Normal</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</GetCurrentPlayingListResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Click to play from playlist', + 'changeSet' => [], ], - 'IndexControlPlayingList' => [ - 'summary' => '播放列表点击播放', - 'path' => '/v1.0/ssp/IndexControlPlayingList', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InvalidateThirdPartyAppLoginState' => [ + 'summary' => 'When a user operation (not initiated from the device side) causes the login session of a third-party application on the device to become invalid (for example, the user logs on to the same account from a new device, invalidating the session on the old device, or the user changes their password, which invalidates the session on the old device), the third party must invoke this API to notify Tmall Genie. ', + 'path' => '/v1.0/ssp/invalidateThirdPartyAppLoginState', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Device identification information ', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='], + 'IdType' => ['title' => '', 'description' => 'The type of Device ID. OPEN_ID: the default device identity. UNION_ID: the device identity at the organization dimension, which is available only after an organization has been requested on the Maojing Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'], + 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the Tmall Genie device ID, and each method corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, used in the Android application customer flow; SKILL_ID refers to the skill ID, used in the cloud-based flow. ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the Skill ID of the application. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => 'com.*.*.*'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123'], + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'ThirdPartyAppId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Third-party application identity', 'type' => 'string', 'required' => true, 'example' => 'com.*.*.*'], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'success'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], ], - 'operationType' => 'readAndWrite', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Invalidate Third-Party Application Login Session ', + 'description' => '> Modify message notification template '."\n" + .'> - You need to query the templateId first, then modify other parameters based on the templateId. ', + 'changeSet' => [], + ], + 'ListAlarms' => [ + 'summary' => 'Perform a paged query to retrieve the alarm clock list of a specific User on a device. ', + 'path' => '/v1.0/ssp/listAlarm', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenIndexControlRequest', + 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'Index' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'NeedContentContinued' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ExtendInfo' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - ], + 'CurrentPage' => ['title' => '', 'description' => 'Current page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page: maximum value is 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'], + 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID: '."\n" + .'- OPEN_ID: The default User ID identity. '."\n" + .'- UNION_ID: The User ID identity at the organization dimension. This is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer link; SKILL_ID refers to the skill ID, which is the encoding type for the cloud link.', 'type' => 'string', 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ + 'title' => '', + 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Device ID type: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link.', 'type' => 'string', 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'AmpResult', + 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'status code returned by the alarm service ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => '设备账号未关联'], 'Result' => [ - 'description' => '', + 'description' => 'collection of alarm list results ', 'type' => 'object', 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '550144364', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ximalayav2', - ], - 'AlbumRawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '260744', - ], - 'AlbumName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Liked' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Singer' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'TotalCount' => ['title' => '', 'description' => 'total number of entries ', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageCount' => ['title' => '', 'description' => 'total number of pages ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageSize' => ['title' => '', 'description' => 'number of entries per page: maximum is 100; values exceeding 100 are treated as 100 ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'CurrentPage' => ['title' => '', 'description' => 'current page ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Model' => [ + 'title' => '', + 'description' => 'alarm list ', + 'type' => 'array', + 'items' => [ + 'description' => 'alarm details ', + 'type' => 'object', + 'properties' => [ + 'AlarmId' => ['title' => '', 'description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], + 'ScheduleTypeDesc' => ['title' => '', 'description' => 'Chinese description of loop type', 'type' => 'string', 'example' => '单次'], + 'TriggerDateDesc' => ['title' => '', 'description' => 'Trigger date description (one-time)', 'type' => 'string', 'example' => '2022-07-29'], + 'TriggerTimeDesc' => ['title' => '', 'description' => 'Trigger time description', 'type' => 'string', 'example' => '10:00'], + 'ScheduleInfo' => [ + 'title' => '', + 'description' => 'Schedule information ', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'Schedule Type / Loop Type: ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORYWORKINGDAY -> Statutory working day ', + 'type' => 'string', + 'example' => 'ONCE', + 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], + ], + 'Once' => [ + 'title' => '', + 'description' => 'One-time: This property is active when the loop type is ONCE. ', + 'type' => 'object', + 'properties' => [ + 'Year' => ['title' => '', 'description' => 'Trigger Time: Year ', 'type' => 'integer', 'format' => 'int32', 'example' => '2022'], + 'Month' => ['title' => '', 'description' => 'Trigger Time: Month ', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'Day' => ['title' => '', 'description' => 'Trigger time: day', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], + 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', + ], + 'Weekly' => [ + 'title' => '', + 'description' => 'Weekly loop: This property is active when the loop Type is WEEKLY.', + 'type' => 'object', + 'properties' => [ + 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'Collection of days of the week to trigger', + 'type' => 'array', + 'items' => ['description' => 'Collection of days of the week to trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week (1 for Monday, 2 for Tuesday, etc.). If the schedule applies to every day, include all values.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + 'StatutoryWorkingDay' => [ + 'title' => '', + 'description' => 'Statutory working day: This property is active when the loop Type is STATUTORYWORKINGDAY.', + 'type' => 'object', + 'properties' => [ + 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'MusicInfo' => [ + 'title' => '', + 'description' => 'Music information', + 'type' => 'object', + 'properties' => [ + 'MusicType' => ['title' => '', 'description' => 'Ringtone Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone Category Name ', 'type' => 'string', 'example' => 'xx音乐'], + 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MusicName' => ['title' => '', 'description' => 'Ringtone Name ', 'type' => 'string', 'example' => 'xx铃声'], + 'MusicUrl' => ['title' => '', 'description' => 'Music URL ', 'type' => 'string', 'example' => 'http://xx'], + ], + 'example' => '', + ], + 'Volume' => ['title' => '', 'description' => 'Ringtone volume, default 40', 'type' => 'integer', 'format' => 'int32', 'example' => '40'], + 'Status' => ['title' => '', 'description' => 'Status: 0 Normal, 1 Deleted, 2 Shutdown', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], + 'title' => '', + 'example' => '', ], - ], - 'PlayMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Repeat', - ], - 'AudioLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '190', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'LyricUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'story', - ], - 'Copyright' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ItemUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', - ], - 'DefaultPlayOrder' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Pos' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<IndexControlPlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</IndexControlPlayingListResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"AlarmId\\": 1234567,\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Query alarm list', + 'responseParamsDescription' => '1. The request is considered successful only if the returned status code is 200; otherwise, it is failed. '."\n" + .'2. The paging parameters in the response do not match the actual number of items in the list; this is for demonstration purposes only. ', + 'changeSet' => [], ], 'ListAlbumDetail' => [ - 'summary' => '获取音乐音频专辑里面的内容列表', + 'summary' => 'Obtain the content list within a music audio album. ', 'path' => '/v1.0/ssp/ListAlbumDetail', - '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'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '121321', - ], + 'schema' => ['description' => 'album ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '121321', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'number of records per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -6749,258 +4742,237 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'], + 'Code' => ['description' => 'Code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Message information ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ - 'CurrentPageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'CurrentPageNum' => ['description' => 'Current page number ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OpenDataItemList' => [ - 'description' => '', + 'description' => 'Data information ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Data information ', 'type' => 'object', 'properties' => [ 'Alias' => [ - 'description' => '', + 'description' => 'Alias', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Audition' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'items' => ['description' => 'alias', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Audition' => ['description' => 'Indicates whether the content is available for audition ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ - 'description' => '', + 'description' => 'Author of the content ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Content author ', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ - 'description' => '', + 'description' => 'Author type ', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANCHOR', - ], - ], - 'Gender' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MALE', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12314', - ], - 'Online' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], + 'title' => '', 'example' => '', ], + 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], + 'Id' => ['description' => 'Primary key ID of the author ', 'type' => 'integer', 'format' => 'int64', 'example' => '12314', 'title' => ''], + 'Online' => ['description' => 'Whether the author is online ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Charge' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CommCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80012017', - ], + 'Category' => ['description' => 'Transform controlType based on the associated public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CommCateId' => ['description' => 'category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ - 'description' => '', + 'description' => 'Content thumbnail ', 'type' => 'object', 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '180', - ], - 'HotScore' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1231231', - ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALBUM', - ], - 'OrderIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], + 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], + 'Duration' => ['description' => 'Duration', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'title' => ''], + 'HotScore' => ['description' => 'popularity score', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'Id' => ['description' => 'content ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1231231', 'title' => ''], + 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], + 'OrderIndex' => ['description' => 'OrderIndex sequence', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Styles' => [ - 'description' => '', + 'description' => 'style', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13131', - ], - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'style', 'type' => 'string', 'example' => '13131', 'title' => ''], + 'title' => '', 'example' => '', ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12323423', - ], + 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'Type' => ['description' => 'Transform favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether the content is playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'RawId' => ['description' => 'Third-party ID ', 'type' => 'string', 'example' => '12323423', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21421', + 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalSize' => ['description' => 'total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '21421', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"CurrentPageNum\\": 1,\\n \\"OpenDataItemList\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 12314,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"Duration\\": 180,\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"OrderIndex\\": 1,\\n \\"Source\\": \\"qingting\\",\\n \\"Styles\\": [\\n \\"13131\\"\\n ],\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"12323423\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 21421\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the content list in a music audio album', + 'changeSet' => [], + ], + 'ListAlbumIsAdded' => [ + 'summary' => 'Whether the album is subscribed.', + 'path' => '/v1.0/ssp/listAlbumIsAdded', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AlbumIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Album ID list', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51999575'], + 'required' => true, + 'docRequired' => true, + 'minItems' => 1, + 'example' => '', + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'Device Information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'User information', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BCC85E69-5DA6-197E-A8C1-8A1B19CF781B'], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'Result' => [ + 'title' => '', + 'description' => 'Result', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '51999575'], + 'IsAdded' => ['title' => '', 'description' => 'Whether it is subscribed', 'type' => 'string', 'example' => 'false'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"CurrentPageNum\\": 1,\\n \\"OpenDataItemList\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 12314,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"Duration\\": 180,\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"OrderIndex\\": 1,\\n \\"Source\\": \\"qingting\\",\\n \\"Styles\\": [\\n \\"13131\\"\\n ],\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"12323423\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 21421\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAlbumDetailResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <CurrentPageNum>1</CurrentPageNum>\\n <OpenDataItemList>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>12314</Id>\\n <Online>false</Online>\\n <Source>qingting</Source>\\n <Title>播音呆瓜小贼</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <Duration>180</Duration>\\n <HotScore>10</HotScore>\\n <Id>1231231</Id>\\n <ItemType>ALBUM</ItemType>\\n <OrderIndex>1</OrderIndex>\\n <Source>qingting</Source>\\n <Styles>13131</Styles>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <RawId>12323423</RawId>\\n </OpenDataItemList>\\n <PageSize>10</PageSize>\\n <TotalSize>21421</TotalSize>\\n </Result>\\n</ListAlbumDetailResponse>","errorExample":""}]', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCC85E69-5DA6-197E-A8C1-8A1B19CF781B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"IsAdded\\": \\"false\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Whether the album is subscribed', + 'changeSet' => [], ], 'ListCateContent' => [ - 'summary' => '根据特定的类目,按照指定的排序顺序获取该类目下的内容.', + 'summary' => 'Obtain the content under a specific category according to the specified sorting order. ', 'path' => '/v1.0/ssp/ListCateContent', - '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'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ @@ -7009,54 +4981,26 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Parameters', 'type' => 'object', 'properties' => [ - 'CateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '80010', - ], - 'IsAlbum' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'SortBy' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hot_score', - ], + 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '80010', 'title' => ''], + 'IsAlbum' => ['description' => 'Indicates whether to query albums', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + 'SortBy' => ['description' => 'Sorting field', 'type' => 'string', 'required' => false, 'example' => 'hot_score', 'title' => ''], 'SortOrder' => [ - 'description' => '', + 'description' => 'Sorting order', 'type' => 'string', 'required' => true, 'example' => 'DESC', - 'enum' => [ - 'ASC', - 'DESC', - ], - ], - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', + 'enum' => ['ASC', 'DESC'], + 'title' => '', ], + 'PageNum' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -7064,41 +5008,27 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is SKILL_ID, the value is the Skill ID of the application. '."\n" + .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'PACKAGE_NAME: APK package name, used for the Android application customer link. '."\n" + .'SKILL_ID: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], + 'IdType' => ['description' => 'Type of User ID.'."\n" + ."\n" + .'OPEN_ID: The default User ID identifier. '."\n" + .'UNION_ID: The organization-dimension User ID identifier. This value is available only after an organization has been registered on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -7106,41 +5036,27 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Device identifier information', 'type' => 'object', 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" + ."\n" + .'When the encoding type is SKILL_ID, the value is the application\'s Skill ID. '."\n" + .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'PACKAGE_NAME: APK package name, used for the Android application customer link.'."\n" + .'SKILL_ID: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'Device identifier, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej=', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID'."\n" + ."\n" + .'OPEN_ID: Default device ID identifier. '."\n" + .'UNION_ID: Organization-level device ID identifier. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -7151,287 +5067,131 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sucess', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'], + 'Code' => ['description' => 'code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'message information ', 'type' => 'string', 'example' => 'sucess', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ - 'TotalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12002', - ], - 'CurrentPageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalSize' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '12002', 'title' => ''], + 'CurrentPageNum' => ['description' => 'Current page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'OpenDataItemList' => [ - 'description' => '', + 'description' => 'Data information ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Data information ', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26152778', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'id' => ['description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '26152778', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Authors' => [ - 'description' => '', + 'description' => 'author information', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'author information', 'type' => 'object', 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123123', - ], - 'Gender' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MALE', - ], + 'RawId' => ['description' => 'third-party author ID', 'type' => 'string', 'example' => '123123', 'title' => ''], + 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'AuthorTypes' => [ - 'description' => '', + 'description' => 'Author type', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANCHOR', - ], - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', + 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Cover' => [ - 'description' => '', + 'description' => 'profile picture', 'type' => 'object', 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Medium' => ['description' => 'medium image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Small' => ['description' => 'small image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'CanResize' => ['description' => 'Indicates whether the image can be cropped using OSS rules. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'Online' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Id' => ['description' => 'Primary key ID of the author information ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Online' => ['description' => 'Whether it is online', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALBUM', - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'HotScore' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], + 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], + 'Category' => ['description' => 'Transform controlType based on the assigned public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Type' => ['description' => 'Transform favoriteType based on the associated public category.', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'HotScore' => ['description' => 'Popularity score', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether the content is playable.', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Cover' => [ - 'description' => '', + 'description' => 'Album thumbnail image', 'type' => 'object', 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/20170207175.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020675.jpg', - ], - 'canResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg', 'title' => ''], + 'Mediam' => ['description' => 'Medium image (Deprecated)', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/20170207175.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020675.jpg', 'title' => ''], + 'canResize' => ['description' => 'Indicates whether cropping can be performed using OSS rules.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'CommCateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '80012017', - ], + 'CommCateId' => ['description' => 'Category ID', 'type' => 'string', 'example' => '80012017', 'title' => ''], 'Alias' => [ - 'description' => '', + 'description' => 'Alias', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Charge' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Audition' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'Alias', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'title' => '', 'example' => '', ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '206775', - ], + 'Charge' => ['description' => 'Whether it is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Audition' => ['description' => 'Is audition available', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '作者：月不醉 简介：啥，假冒你男友？退役兵王回归都市后做了一名小保安，机缘巧合下却被冷艳女总拉去客串男友，从此之后，他与冷艳老总开始纠缠不清···拳打恶一代，脚踩高富帅，哥哥我专治各种不服。面对各类的阴谋阳谋，面对各种黑恶势力，且看哥如何称霸都市，踏上巅峰！', 'title' => ''], + 'RawId' => ['description' => 'Third-party ID of the album', 'type' => 'string', 'example' => '206775', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"sucess\\",\\n \\"Result\\": {\\n \\"TotalSize\\": 12002,\\n \\"CurrentPageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"OpenDataItemList\\": [\\n {\\n \\"id\\": 26152778,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Authors\\": [\\n {\\n \\"RawId\\": \\"123123\\",\\n \\"Gender\\": \\"MALE\\",\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Source\\": \\"qingting\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Mediam\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Category\\": \\"audio\\",\\n \\"Type\\": \\"program\\",\\n \\"HotScore\\": 0,\\n \\"Valid\\": \\"VALID\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/20170207175.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020675.jpg\\",\\n \\"canResize\\": false\\n },\\n \\"CommCateId\\": \\"80012017\\",\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Charge\\": false,\\n \\"Audition\\": true,\\n \\"Description\\": \\"作者：月不醉 简介：啥，假冒你男友？退役兵王回归都市后做了一名小保安，机缘巧合下却被冷艳女总拉去客串男友，从此之后，他与冷艳老总开始纠缠不清···拳打恶一代，脚踩高富帅，哥哥我专治各种不服。面对各类的阴谋阳谋，面对各种黑恶势力，且看哥如何称霸都市，踏上巅峰！\\",\\n \\"RawId\\": \\"206775\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCateContentResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Message>sucess</Message>\\n <Result>\\n <TotalSize>12002</TotalSize>\\n <CurrentPageNum>1</CurrentPageNum>\\n <PageSize>10</PageSize>\\n <OpenDataItemList>\\n <id>26152778</id>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Authors>\\n <RawId>123123</RawId>\\n <Gender>MALE</Gender>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Source>qingting</Source>\\n <Cover>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Mediam>https://a.jpg</Mediam>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>true</Online>\\n </Authors>\\n <ItemType>ALBUM</ItemType>\\n <Category>audio</Category>\\n <Type>program</Type>\\n <HotScore>0</HotScore>\\n <Valid>VALID</Valid>\\n <Cover>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718275.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718275.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/20170207175.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020675.jpg</Small>\\n <canResize>false</canResize>\\n </Cover>\\n <CommCateId>80012017</CommCateId>\\n <Alias>超能狂少在都市</Alias>\\n <Charge>false</Charge>\\n <Audition>true</Audition>\\n <Description>作者：月不醉 简介：啥，假冒你男友？退役兵王回归都市后做了一名小保安，机缘巧合下却被冷艳女总拉去客串男友，从此之后，他与冷艳老总开始纠缠不清···拳打恶一代，脚踩高富帅，哥哥我专治各种不服。面对各类的阴谋阳谋，面对各种黑恶势力，且看哥如何称霸都市，踏上巅峰！</Description>\\n <RawId>206775</RawId>\\n </OpenDataItemList>\\n </Result>\\n</ListCateContentResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"sucess\\",\\n \\"Result\\": {\\n \\"TotalSize\\": 12002,\\n \\"CurrentPageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"OpenDataItemList\\": [\\n {\\n \\"id\\": 26152778,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Authors\\": [\\n {\\n \\"RawId\\": \\"123123\\",\\n \\"Gender\\": \\"MALE\\",\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Source\\": \\"qingting\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Mediam\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Category\\": \\"audio\\",\\n \\"Type\\": \\"program\\",\\n \\"HotScore\\": 0,\\n \\"Valid\\": \\"VALID\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/20170207175.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020675.jpg\\",\\n \\"canResize\\": false\\n },\\n \\"CommCateId\\": \\"80012017\\",\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Charge\\": false,\\n \\"Audition\\": true,\\n \\"Description\\": \\"作者：月不醉 简介：啥，假冒你男友？退役兵王回归都市后做了一名小保安，机缘巧合下却被冷艳女总拉去客串男友，从此之后，他与冷艳老总开始纠缠不清···拳打恶一代，脚踩高富帅，哥哥我专治各种不服。面对各类的阴谋阳谋，面对各种黑恶势力，且看哥如何称霸都市，踏上巅峰！\\",\\n \\"RawId\\": \\"206775\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve content under a specific category sorted in the specified order.', + 'changeSet' => [], ], 'ListCateInfo' => [ - 'summary' => '获取音乐音频类目列表', + 'summary' => 'Obtain category information.', 'path' => '/v1.0/ssp/ListCateInfo', - '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' => 'read', 'deprecated' => false, 'systemTags' => [], @@ -7439,13 +5199,7 @@ [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'song', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Default value is song (the extension field currently only supports song)', 'type' => 'string', 'required' => true, 'example' => 'song'], ], ], 'responses' => [ @@ -7455,88 +5209,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Returned parameters', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80064', - ], - 'CateName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ParentCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80064', 'title' => ''], + 'CateName' => ['description' => 'Category name', 'type' => 'string', 'example' => '时尚生活', 'title' => ''], + 'ParentCateId' => ['description' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80064,\\n \\"CateName\\": \\"时尚生活\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListCateInfoResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <CateId>80064</CateId>\\n <CateName>时尚生活</CateName>\\n <ParentCateId>0</ParentCateId>\\n </Result>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n</ListCateInfoResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80064,\\n \\"CateName\\": \\"时尚生活\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","type":"json"}]', + 'title' => 'Obtain the music audio category list', + 'changeSet' => [], ], 'ListCommonCateFirstFloor' => [ - 'summary' => '获取音乐/音频的一级类目列表', + 'summary' => 'Obtain the top-level category list for music or audio.', 'path' => '/v1.0/ssp/ListCommonCateFirstFloor', - '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'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'song', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Default value: song (extension field currently only supports song)', 'type' => 'string', 'required' => true, 'example' => 'song'], ], ], 'responses' => [ @@ -7545,88 +5265,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], + 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80012', - ], - 'CateName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ParentCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80012', 'title' => ''], + 'CateName' => ['description' => 'Category name', 'type' => 'string', 'example' => '有声内容', 'title' => ''], + 'ParentCateId' => ['description' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80012,\\n \\"CateName\\": \\"有声内容\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListCommonCateFirstFloorResponse>\\n <Code>200</Code>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Result>\\n <CateId>80012</CateId>\\n <CateName>有声内容</CateName>\\n <ParentCateId>0</ParentCateId>\\n </Result>\\n <Message>success</Message>\\n</ListCommonCateFirstFloorResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80012,\\n \\"CateName\\": \\"有声内容\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Obtain the top-level category list for music or audio', + 'changeSet' => [], ], 'ListCommonCateSecondFloor' => [ - 'summary' => '获取指定一级类目下面的二级类目列表', + 'summary' => 'Retrieve the list of level-2 categories under a specified level-1 category.', 'path' => '/v1.0/ssp/ListCommonCateSecondFloor', - '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'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ParentCateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '80010', - ], + 'schema' => ['description' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '80010', 'title' => ''], ], ], 'responses' => [ @@ -7634,1099 +5322,307 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], + 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80018009', - ], - 'CateName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ParentCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80018', - ], + 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80018009', 'title' => ''], + 'CateName' => ['description' => 'Category Name', 'type' => 'string', 'example' => '儿童笑话', 'title' => ''], + 'ParentCateId' => ['description' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80018', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80018009,\\n \\"CateName\\": \\"儿童笑话\\",\\n \\"ParentCateId\\": 80018\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListCommonCateSecondFloorResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Result>\\n <CateId>80018009</CateId>\\n <CateName>儿童笑话</CateName>\\n <ParentCateId>80018</ParentCateId>\\n </Result>\\n <Message>success</Message>\\n</ListCommonCateSecondFloorResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80018009,\\n \\"CateName\\": \\"儿童笑话\\",\\n \\"ParentCateId\\": 80018\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Retrieve the list of level-2 categories under a specified level-1 category', + 'changeSet' => [], ], - 'ListPlayHistory' => [ - 'summary' => '获取用户的播放历史', - 'path' => '/v1.0/ssp/ListPlayHistory', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDeviceBasicInfo' => [ + 'summary' => 'Batch retrieve basic device information based on a list of device openIDs. ', + 'path' => '/v1.0/ssp/listDeviceBasicInfo', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Request', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'music', - ], - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1**2', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'DeviceInfo', + 'name' => 'DeviceInfos', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of device identity information.', 'type' => 'object', 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. Enter **PROJECT_ID** here.', 'type' => 'string', 'required' => true, - 'example' => 'DAFE****ce3ej=', + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can view this in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Type of device ID:'."\n" + .'- OPEN_ID: Default device ID identity.'."\n" + .'- UNION_ID: Organization-dimension device ID identity. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1**2', + 'Ids' => [ + 'title' => '', + 'description' => 'List of device identity information.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Device identifier. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'required' => false, + 'example' => '', ], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID of the device. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', + 'title' => '', + 'description' => 'Detailed information returned. ', + 'type' => 'object', + 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'Alias' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Audition' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Authors' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AuthorTypes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANCHOR', - ], - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - ], - ], - 'Gender' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MALE', - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123123', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Online' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Charge' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CommCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80012017', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - ], - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotScore' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALBUM', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], + 'Name' => ['title' => '', 'description' => 'The name of the device. ', 'type' => 'string', 'example' => '我的设备'], + 'FirmwareVersion' => ['title' => '', 'description' => 'The firmware version of the device. ', 'type' => 'string', 'example' => '2.0.3'], + 'Mac' => ['title' => '', 'description' => 'The MAC address of the device. ', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'], + 'Sn' => ['title' => '', 'description' => 'The SN information of the device. ', 'type' => 'string', 'example' => '1200xx048'], ], + 'description' => 'List of device information returned. ', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Type\\": \\"program\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Valid\\": \\"VALID\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPlayHistoryResponse>\\n <requestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</requestId>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>123123</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>false</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Type>program</Type>\\n <Title>超能狂少在都市</Title>\\n <Valid>VALID</Valid>\\n </Result>\\n</ListPlayHistoryResponse>","errorExample":""}]', - ], - 'ListRecommendContent' => [ - 'summary' => '获取每日推荐的音乐或者音频', - 'path' => '/v1.0/ssp/ListRecommendContent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.ListDeviceBasicInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xx048\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Batch query basic device information', + 'changeSet' => [], + ], + 'ListDeviceByUserId' => [ + 'summary' => 'Obtain the list of attached Device IDs based on the user\'s openID. ', + 'path' => '/v1.0/ssp/listDeviceByUserId', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Request', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'song', - ], - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => true, - ], - ], - [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of User Identifier information.', 'type' => 'object', 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. Enter **PROJECT_ID** here.', 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can view this in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID:'."\n" + .' - OPEN_ID: The default User ID identifier.'."\n" + .' - UNION_ID: A User ID identifier in the organization dimension. You must request an organization in the Open Platform beforehand.', 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier. Enter the value of userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], + 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The returned error code, where 200 indicates that the invocation succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'Detailed information returned. ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of information entries ', 'type' => 'object', 'properties' => [ - 'Alias' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Audition' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Authors' => [ - 'description' => '', + 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the Device Information.', 'type' => 'string', 'example' => 'A963*0158'], + 'DeviceUnionIds' => [ + 'title' => '', + 'description' => 'Organization ID and UnionId information corresponding to the device. ', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of information entries ', 'type' => 'object', 'properties' => [ - 'AuthorTypes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANCHOR', - ], - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - ], - ], - 'Gender' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MALE', - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12311', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Online' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Charge' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CommCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80012017', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', + 'OrganizationId' => ['title' => '', 'description' => 'The organization ID. ', 'type' => 'string', 'example' => '1**2'], + 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device. ', 'type' => 'string', 'example' => '1553*B0C3'], ], + 'title' => '', + 'example' => '', ], - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', 'example' => '', ], - 'HotScore' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALBUM', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123123', - ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"12311\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"123123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRecommendContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>12311</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>false</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <RawId>123123</RawId>\\n </Result>\\n</ListRecommendContentResponse>","errorExample":""}]', - ], - 'PlayAndPauseControl' => [ - 'summary' => '播放暂停控制', - 'path' => '/v1.0/ssp/PlayAndPauseControl', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'OpenPlayAndPauseControlParam', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OpenPlayAndPauseCommand' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Play', - 'enum' => [ - 'Play', - 'Pause', - ], - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => true, - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.ListDeviceByUserId.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - ], - ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PlayAndPauseControlResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PlayAndPauseControlResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Obtain the list of devices attached to a user', + 'changeSet' => [], ], - 'PlayModeControl' => [ - 'summary' => '播放模式切换', - 'path' => '/v1.0/ssp/PlayModeControl', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDeviceByUserIdAndChanel' => [ + 'summary' => 'Obtain the device list for a specified channel.', + 'path' => '/v1.0/ssp/listDeviceByUserIdAndChanel', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenPlayModeControlRequest', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OpenPlayMode' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Normal', - 'enum' => [ - 'Repeat', - 'Shuffle', - 'RepeatOne', - 'Normal', - ], - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'UserInfo', + 'name' => 'ChannelInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Activation channel, such as WeChat mini program or third-party app.', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Channel' => ['title' => '', 'description' => 'Activation provisioning channel, such as WeChat or ThirdApp.', 'type' => 'string', 'required' => true, 'example' => 'WeChat、ThirdApp'], + 'ExtInfo' => ['title' => '', 'description' => 'Extension information.', 'type' => 'string', 'required' => false, 'example' => '{}'], ], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'DeviceInfo', + 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'List of User Identifier information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Encoding Type; enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type; enter the Project ID of the project to which the product belongs. You can view this in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'The Type of the User ID: '."\n" + .'OPEN_ID: The default User ID identity. '."\n" + .'UNION_ID: The User ID identity at the organization dimension, which requires you to request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier; enter the value of userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID; required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1***2'], ], 'required' => true, + 'example' => '', ], ], ], @@ -8737,548 +5633,325 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The returned error code. The value 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OpenPlayMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Normal', - 'enum' => [ - 'Repeat', - 'Shuffle', - 'RepeatOne', - 'Normal', + 'title' => '', + 'description' => 'List of information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the Device Information.', 'type' => 'string', 'example' => 'A963*0158'], + 'DeviceUnionIds' => [ + 'title' => '', + 'description' => 'List of information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID.', 'type' => 'string', 'example' => '1***2'], + 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device.', 'type' => 'string', 'example' => '1553*B0C3'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'RE***D'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OpenPlayMode\\": \\"Normal\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PlayModeControlResponse>\\n <Code>200</Code>\\n <Result>\\n <openPlayMode>Normal</openPlayMode>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PlayModeControlResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1***2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"RE***D\\"\\n}","type":"json"}]', + 'title' => 'Obtain the device list for a specified Channel', + 'changeSet' => [], ], - 'PreviousAndNextControl' => [ - 'summary' => '上下首控制', - 'path' => '/v1.0/ssp/PreviousAndNextControl', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDeviceIdByIdentities' => [ + 'summary' => 'Batch retrieve Device IDs by device MAC/SN.', + 'path' => '/v1.0/ssp/listDeviceIdByIdentities', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenControlPlayingListRequest', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Cmd' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'NEXT', - ], - 'IsFromDevice' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ExtendInfo' => [ - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], + 'name' => 'EncodeType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'], ], [ - 'name' => 'UserInfo', + 'name' => 'EncodeKey', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which this product belongs. You can view it in the Tmall Genie AI platform console. ', 'type' => 'string', 'required' => true, 'example' => '125****0946'], ], [ - 'name' => 'DeviceInfo', + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Device authentication type. Enter **MAC** or **SN**. ', 'type' => 'string', 'required' => true, 'example' => 'MAC'], + ], + [ + 'name' => 'IdentityIds', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - '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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => true, + 'description' => 'List of device authentication identifiers. ', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Authentication identifier. Enter the MAC address or SN value. ', 'type' => 'string', 'required' => true, 'example' => 'b4:xx:xx:xx:65:2b'], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The unique product identifier ProductKey, which is a globally unique identity issued by the platform when creating a product in the Tmall Genie AI platform. ', 'type' => 'string', 'required' => true, 'example' => 'Mm*****XnZ8'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Returns a data list.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'The return result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The returned error code. A value of 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'A list of detailed returned information.', 'type' => 'object', - 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '550144364', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ximalayav2', - ], - 'AlbumRawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '260744', - ], - 'AlbumName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Liked' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Singer' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', - ], - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the device. ', 'type' => 'string', 'example' => 'A963*0158'], + 'DeviceUnionIds' => [ + 'title' => '', + 'description' => 'The organization ID and UnionId information corresponding to the device.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OrganizationId' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'example' => '1**2'], + 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device.', 'type' => 'string', 'example' => '1553*B0C3'], + ], + 'description' => 'Information list', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], - 'PlayMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Repeat', - ], - 'AudioLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '190', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'LyricUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'story', - ], - 'Copyright' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ItemUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', - ], - 'DefaultPlayOrder' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Pos' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'description' => 'Information list', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PreviousAndNextControlResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PreviousAndNextControlResponse>","errorExample":""}]', - ], - 'ProgressControl' => [ - 'summary' => '进度控制', - 'path' => '/v1.0/ssp/ProgressControl', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Batch retrieve Device IDs ', + 'changeSet' => [], + ], + 'ListMusic' => [ + 'summary' => 'Query the list of ringtones under a specified music category.', + 'path' => '/v1.0/ssp/listMusic', + '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' => 'OpenProgressControlRequest', + 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12', - ], - 'ExtendInfo' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - ], + 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID, returned by the queryMusicType API', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name, returned by the queryMusicType API', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'], + 'MusicId' => ['title' => '', 'description' => 'Ringtone ID, an extension field; currently not required', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'MusicName' => ['title' => '', 'description' => 'Ringtone name, an extension field; currently not required to be passed.', 'type' => 'string', 'required' => false, 'example' => 'xx铃声'], + 'CurrentPage' => ['title' => '', 'description' => 'Current page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page: maximum value is 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Type of user ID: OPEN_ID: default user ID identifier; UNION_ID: organization-dimension user ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer links; SKILL_ID: skill ID, used for cloud-based links', 'type' => 'string', 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID, required if IdType is UNION_ID', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'query', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Device ID information ', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Type of the device ID: OPEN_ID indicates the default device ID; UNION_ID indicates the organization-dimension device ID, which is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, used in the Android application customer link; SKILL_ID refers to the skill ID, used in the cloud link. ', 'type' => 'string', 'required' => true, - 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type: when the encoding type is SKILL_ID, the value is the application\'s SkillID; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'AmpResult', + 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'Status code returned by the alarm service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '音乐类型名称为空'], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10002398812', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', + 'description' => 'collection of ringtone query results', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'Total number of entries', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageCount' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page: maximum value is 100; values exceeding 100 are treated as 100', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'CurrentPage' => ['title' => '', 'description' => 'Current page', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Model' => [ + 'title' => '', + 'description' => 'List of ringtones', + 'type' => 'array', + 'items' => [ + 'description' => 'Ringtone information', + 'type' => 'object', + 'properties' => [ + 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name ', 'type' => 'string', 'example' => 'xx'], + 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MusicName' => ['title' => '', 'description' => 'Ringtone name ', 'type' => 'string', 'example' => 'xx'], + 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'example' => 'http://xx'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ProgressControlResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</ProgressControlResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"音乐类型名称为空\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Query paginated ringtone list ', + 'responseParamsDescription' => 'The request is successful only if the returned status code is 200; otherwise, it has failed.', + 'changeSet' => [], ], - 'SearchContent' => [ - 'summary' => '按照特定的搜索条件搜索', - 'path' => '/v1.0/ssp/SearchContent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPlayHistory' => [ + 'summary' => 'Obtain the history playback API.', + 'path' => '/v1.0/ssp/ListPlayHistory', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ @@ -9287,49 +5960,16 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Parameters ', 'type' => 'object', 'properties' => [ - 'Query' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Cate' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'music', - ], - 'SubCate' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'singer', - ], - 'QueryAlbum' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'Type' => ['description' => 'Type of content: music, program (audiobook), story, children_song, or radio ', 'type' => 'string', 'required' => false, 'example' => 'music', 'title' => ''], + 'PageNum' => ['description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -9337,41 +5977,27 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'User identification information ', 'type' => 'object', 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is SKILL_ID, the value is the Skill ID of the application.'."\n" + .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'The encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'PACKAGE_NAME: The APK package name. This is the encoding type for the Android application customer link.'."\n" + .'SKILL_ID: The skill ID. This is the encoding type for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'The User Identifier, which can be set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID.'."\n" + ."\n" + .'OPEN_ID: The default User ID identity.'."\n" + .'UNION_ID: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'The organization ID. This field is required when IdType is set to UNION_ID.', 'type' => 'string', 'required' => true, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -9379,41 +6005,27 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Device identification information ', 'type' => 'object', 'properties' => [ - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type '."\n" + ."\n" + .'When the encoding type is SKILL_ID, this value is the application\'s Skill ID. '."\n" + .'When the encoding type is PACKAGE_NAME, this value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + ."\n" + .'PACKAGE_NAME: APK package name, used for Android application client-side identification. '."\n" + .'SKILL_ID: Skill ID, used for cloud-based identification. ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej=', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID '."\n" + ."\n" + .'OPEN_ID: Default device ID identity. '."\n" + .'UNION_ID: Organization-dimension device ID identity. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID. ', 'type' => 'string', 'required' => true, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -9422,573 +6034,166 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'], + 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'Alias' => [ - 'description' => '', + 'description' => 'Alias ', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'Audition' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Audition' => ['description' => 'Is audition available', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ - 'description' => '', + 'description' => 'Authors of the content', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Content author', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ - 'description' => '', + 'description' => 'Author types', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANCHOR', - ], + 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], + 'title' => '', + 'example' => '', ], 'Cover' => [ - 'description' => '', + 'description' => 'Profile picture', 'type' => 'object', 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://a.jpg', - ], + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], ], - ], - 'Gender' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MALE', - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123123', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Online' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], + 'RawId' => ['description' => 'Third-party author ID', 'type' => 'string', 'example' => '123123', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Id' => ['description' => 'Author primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Category' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Charge' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'fasle', - ], - 'CommCateId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80012017', - ], + 'Category' => ['description' => "\n" + .'Transform controlType based on the category', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CommCateId' => ['description' => 'Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ - 'description' => '', + 'description' => 'Album cover image', 'type' => 'object', 'properties' => [ - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - ], - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'HotScore' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13597709', - ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALBUM', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qingting', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '180', - ], - 'AlbumId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13123', - ], - 'Lyric' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://a1231.lrc', - ], - 'OrderIndex' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Styles' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1231', - ], - ], + 'Description' => ['description' => 'Content description', 'type' => 'string', 'example' => '内容描述', 'title' => ''], + 'HotScore' => ['description' => 'Hot Score ', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'Id' => ['description' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Type' => ['description' => 'Convert to favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether the content is playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": true,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"13123\\",\\n \\"Lyric\\": \\"http://a1231.lrc\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Styles\\": [\\n \\"1231\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>123123</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>true</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Valid>VALID</Valid>\\n <Duration>180</Duration>\\n </Result>\\n</SearchContentResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Type\\": \\"program\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Valid\\": \\"VALID\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get Playback History API ', + 'changeSet' => [], ], - 'CloudPlayer' => [ - 'summary' => '云播放器：对外', - 'path' => '/v1.0/ssp/cloud/player', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRecommendContent' => [ + 'summary' => 'Obtain daily recommended music or audio.', + 'path' => '/v1.0/ssp/ListRecommendContent', + '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' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1234', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'query', + 'name' => 'Request', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Parameters', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - 'enum' => [], - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'UNION_ID', - 'OPEN_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1234', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'Type' => ['description' => 'Default value: song (currently, the extension field supports only song)', 'type' => 'string', 'required' => false, 'example' => 'song', 'title' => ''], + 'Count' => ['description' => 'Quantity of recommendations', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'KG' => '', - ], - 'example' => 'KG', - ], - ], - [ - 'name' => 'SongIdList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - 'required' => true, - 'maxItems' => 200, - 'minItems' => 1, - ], - ], - [ - 'name' => 'CurPlayIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'maximum' => '200', - 'minimum' => '1', - ], - ], - [ - 'name' => 'PlayMode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Shuffle' => '', - 'RepeatOne' => '', - 'Repeat' => '', - 'Normal' => '', - ], - 'example' => 'Normal', - ], - ], - [ - 'name' => 'SongId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'B7D82DB0-DD59-5756-AC62-871C9D7DBC36', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7D82DB0-DD59-5756-AC62-871C9D7DBC36\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true\\n}","type":"json"}]', - ], - 'MobileRecommend' => [ - 'summary' => '移动轻纳管', - 'path' => '/v1.0/ssp/mobile/recommend/music', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - ], - 'parameters' => [ - [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'User identification information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1414895629783187053', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is SKILL_ID, the value is the Skill ID of the application. '."\n" + .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'PACKAGE_NAME: APK package name, used for the Android application client path.'."\n" + .'SKILL_ID: Skill ID, used for the cloud-based path.', 'type' => 'string', 'required' => false, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw=', 'title' => ''], + 'IdType' => ['description' => 'Type of User ID.'."\n" + ."\n" + .'OPEN_ID: The default User ID identifier. '."\n" + .'UNION_ID: The organization-dimension User ID identifier. This value is available only after an organization has been requested on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -9996,798 +6201,152 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1414895629783187053', - 'enum' => [], - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'UNION_ID', - 'OPEN_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" + ."\n" + .'When the encoding type is SKILL_ID, the value is the application\'s Skill ID.'."\n" + .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'PACKAGE_NAME: APK package name, used for the Android application client path.'."\n" + .'SKILL_ID: Skill ID, used for the cloud-based path.', 'type' => 'string', 'required' => false, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej=', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID'."\n" + ."\n" + .'OPEN_ID: Default device ID identity.'."\n" + .'UNION_ID: Organization-dimension device ID identity. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, - ], - ], - [ - 'name' => 'BotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'STYLE' => '', - 'DAILY_REC' => '', - 'HOT' => '', - ], - 'example' => 'DAILY_REC', - ], - ], - [ - 'name' => 'Style', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '钢琴' => '', - '抖音' => '', - '欢快' => '', - '轻音乐' => '', - '流行' => '', - 'DJ' => 'DJ', - ], + 'title' => '', 'example' => '', ], ], - [ - 'name' => 'Count', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6', - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '5C5809B4-F465-52E0-9A8B-61396F9E593B', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request RequestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Return Result', 'type' => 'object', 'properties' => [ - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'KG', - ], - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '550144364', - ], - 'Cover' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg', + 'Alias' => [ + 'description' => 'Alias ', + 'type' => 'array', + 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Audition' => ['description' => 'Is audition available', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ - 'description' => '', + 'description' => 'Content author', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Content author', + 'type' => 'object', + 'properties' => [ + 'AuthorTypes' => [ + 'description' => 'Author types ', + 'type' => 'array', + 'items' => ['description' => 'Author type ', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Cover' => [ + 'description' => 'Profile picture', + 'type' => 'object', + 'properties' => [ + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used to crop the image ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], + 'RawId' => ['description' => 'Third-party author ID', 'type' => 'string', 'example' => '12311', 'title' => ''], + 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Id' => ['description' => 'Author primary key ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Online' => ['description' => 'Whether the author is online ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5809B4-F465-52E0-9A8B-61396F9E593B\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"KG\\",\\n \\"RawId\\": \\"550144364\\",\\n \\"Cover\\": \\"http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg\\",\\n \\"Authors\\": [\\n \\"[\\\\\\"周杰伦\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"稻香\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'AddSub' => [ - 'summary' => '新增订阅', - 'path' => '/v1.0/ssp/addSub', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'AddSubscriptionInfoRequest', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '订阅专辑request', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DeviceId' => [ - 'title' => '设备ID', - 'type' => 'string', - 'docRequired' => true, - 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', - ], - 'UserId' => [ - 'title' => '用户ID', - 'type' => 'string', - 'docRequired' => true, - 'example' => '1152893538998276761', - ], - 'ScheduleInfo' => [ - 'title' => '定时信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'title' => '设置按周提醒的具体日期，取值范围为：1~7', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '7', - 'minimum' => '1', - 'example' => '1,3,5,7,6', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - ], - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 7, - 'minItems' => 1, - ], - 'Hour' => [ - 'title' => '提醒触发的时间时钟数，0~23', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '23', - 'minimum' => '0', - 'example' => '1', - ], - 'Minute' => [ - 'title' => '提醒触发的分钟，0~59', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '59', - 'minimum' => '0', - 'example' => '23', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - 'AlbumId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '51999575', - ], - 'PlayMode' => [ - 'title' => '播放模式（目前只支持sequence）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'sequence', - ], - 'DailyStudyCnt' => [ - 'title' => '每天学习数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], - ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '设备信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'enum' => [], - ], - 'IdType' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'type' => 'string', - 'required' => false, - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'enum' => [], - ], - 'IdType' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Result' => [ - 'title' => '结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '订阅专辑记录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'DeviceId' => [ - 'title' => '设备ID', - 'description' => '', - 'type' => 'string', - 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', - ], - 'UserId' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'string', - 'example' => '1152893538998276761', - ], - 'ScheduleInfo' => [ - 'title' => '定时信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'title' => '提醒触发的周期', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - 'Hour' => [ - 'title' => '提醒触发的小时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Minute' => [ - 'title' => '提醒触发的分钟', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], + 'Category' => ['description' => 'Transform controlType based on the assigned public category', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Charge' => ['description' => 'Whether the content is charged ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CommCateId' => ['description' => 'Corresponding category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], + 'Cover' => [ + 'description' => 'Album cover image ', + 'type' => 'object', + 'properties' => [ + 'CanResize' => ['description' => 'Whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - 'AlbumId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'example' => '51999575', - ], - 'PlayMode' => [ - 'title' => '播放模式', - 'description' => '', - 'type' => 'string', - 'example' => 'sequence', - ], - 'DailyStudyCnt' => [ - 'title' => '每天学习数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'B99D27ED-4E12-1414-9FDE-599C57C4B204', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Result\\": {\\n \\"Id\\": 81,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": \\"1152893538998276761\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B99D27ED-4E12-1414-9FDE-599C57C4B204\\"\\n}","type":"json"}]', - ], - 'DeleteSub' => [ - 'summary' => '删除订阅', - 'path' => '/v1.0/ssp/deleteSub', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'SubId', - 'in' => 'query', - 'schema' => [ - 'title' => '订阅专辑记录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '81', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Result' => [ - 'title' => '返回结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '0AA6C15C-FD61-1E32-9881-480CC6F35A70', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0AA6C15C-FD61-1E32-9881-480CC6F35A70\\"\\n}","type":"json"}]', - ], - 'ListAlbumIsAdded' => [ - 'summary' => '专辑是否被订阅', - 'path' => '/v1.0/ssp/listAlbumIsAdded', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'AlbumIdList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '专辑idList', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '51999575', - ], - 'required' => true, - 'docRequired' => true, - 'minItems' => 1, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '设备信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => false, - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => false, - ], - 'IdType' => [ - 'type' => 'string', - 'required' => false, - ], - 'Id' => [ - 'type' => 'string', - 'required' => false, - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, + 'Description' => ['description' => 'Content description', 'type' => 'string', 'example' => '内容描述', 'title' => ''], + 'HotScore' => ['description' => "\n" + .'Hot Score', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'Id' => ['description' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'ItemType' => ['description' => "\n" + .'Type of content, such as music, audio, radio, jokes, etc. ', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], + 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Title' => ['description' => 'Title ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'Type' => ['description' => 'Transformed favoriteType based on the associated public category ', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'Valid' => ['description' => 'Whether playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'RawId' => ['description' => 'Third-party ID ', 'type' => 'string', 'example' => '123123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'UserInfo', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户信息', 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => false, - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => false, - ], - 'IdType' => [ - 'type' => 'string', - 'required' => false, - ], - 'Id' => [ - 'type' => 'string', - 'required' => false, - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => true, - 'docRequired' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'BCC85E69-5DA6-197E-A8C1-8A1B19CF781B', - ], - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Result' => [ - 'title' => '结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AlbumId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'example' => '51999575', - ], - 'IsAdded' => [ - 'title' => '是否被订阅', - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'IdempotentParameterMismatch', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCC85E69-5DA6-197E-A8C1-8A1B19CF781B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"IsAdded\\": \\"false\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"12311\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"123123\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain daily recommended music or audio', + 'changeSet' => [], ], 'ListSub' => [ - 'summary' => '订阅列表', + 'summary' => 'The user has subscribed to the list.', 'path' => '/v1.0/ssp/listSub', - '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' => 'read', 'deprecated' => false, 'systemTags' => [], @@ -10797,31 +6356,16 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '分页参数', - 'description' => '', + 'title' => '', + 'description' => 'Pagination Parameters', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - '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', - ], + 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], 'required' => true, 'docRequired' => true, + 'example' => '', ], ], [ @@ -10829,44 +6373,33 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备信息', - 'description' => '', + 'title' => '', + 'description' => 'Device Information ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'enum' => ['PROJECT_ID'], + 'description' => '', + 'title' => '', ], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], 'IdType' => [ 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'description' => '', + 'title' => '', ], + 'Id' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, + 'example' => '', ], ], [ @@ -10874,44 +6407,33 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户信息', - 'description' => '', + 'title' => '', + 'description' => 'User information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'enum' => ['PROJECT_ID'], + 'description' => '', + 'title' => '', ], + 'EncodeKey' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], 'IdType' => [ 'type' => 'string', 'required' => true, 'example' => 'UNION_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'description' => '', + 'title' => '', ], + 'Id' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, + 'example' => '', ], ], ], @@ -10922,183 +6444,87 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'Result' => [ - 'title' => '结果', - 'description' => '', + 'title' => '', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '共计多少数据', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'TotalPageCount' => [ - 'title' => '共计多少页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'HasNext' => [ - 'title' => '是否有下一页', - 'description' => '', - 'type' => 'boolean', - 'default' => 'false', - ], + 'TotalCount' => ['title' => '', 'description' => 'Total number of data entries ', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'TotalPageCount' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'HasNext' => ['title' => '', 'description' => 'Is there a next page ', 'type' => 'boolean', 'default' => 'false', 'example' => ''], 'DataList' => [ - 'title' => '订阅列表', - 'description' => '', + 'title' => '', + 'description' => 'Subscription list', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '订阅记录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DeviceId' => [ - 'title' => '设备ID', - 'description' => '', - 'type' => 'string', - 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', - ], - 'UserId' => [ - 'title' => '用户ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1152893538998276761', - ], + 'Id' => ['title' => '', 'description' => 'Subscription record ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DeviceId' => ['title' => '', 'description' => 'Device ID', 'type' => 'string', 'example' => '5874DBCCA3038FAA1A70A8060F07F26D'], + 'UserId' => ['title' => '', 'description' => 'User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1152893538998276761'], 'ScheduleInfo' => [ - 'title' => '定时信息', - 'description' => '', + 'title' => '', + 'description' => 'Schedule information ', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ - 'title' => '触发周期', - 'description' => '', + 'title' => '', + 'description' => 'Trigger epoch ', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'items' => ['title' => '', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'maxItems' => 7, 'minItems' => 1, + 'example' => '', ], - 'Hour' => [ - 'title' => '触发小时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Minute' => [ - 'title' => '触发分钟', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], + 'Hour' => ['title' => '', 'description' => 'Trigger hour ', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'Minute' => ['title' => '', 'description' => 'Trigger minute ', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], ], + 'example' => '', ], - 'AlbumId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'example' => '51999575', - ], - 'PlayMode' => [ - 'title' => '播放模式', - 'description' => '', - 'type' => 'string', - 'example' => 'sequence', - ], - 'DailyStudyCnt' => [ - 'title' => '每天学习数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CoverUrl' => [ - 'title' => '专辑封面', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg', - ], - 'Title' => [ - 'title' => '专辑标题', - 'description' => '', - 'type' => 'string', - 'example' => '小科学家探索', - ], + 'AlbumId' => ['title' => '', 'description' => 'Album ID ', 'type' => 'string', 'example' => '51999575'], + 'PlayMode' => ['title' => '', 'description' => 'Playback mode', 'type' => 'string', 'example' => 'sequence'], + 'DailyStudyCnt' => ['title' => '', 'description' => 'Daily study quantity ', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'CoverUrl' => ['title' => '', 'description' => 'Album thumbnail ', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg'], + 'Title' => ['title' => '', 'description' => 'Album title ', 'type' => 'string', 'example' => '小科学家探索'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '0D0C09C2-ADC1-198B-964D-24F4FAD967DB', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0D0C09C2-ADC1-198B-964D-24F4FAD967DB'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": true,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": 1152893538998276700,\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2,\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"Title\\": \\"小科学家探索\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0D0C09C2-ADC1-198B-964D-24F4FAD967DB\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": false,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": 1152893538998276700,\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2,\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"Title\\": \\"小科学家探索\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0D0C09C2-ADC1-198B-964D-24F4FAD967DB\\"\\n}","type":"json"}]', + 'title' => 'User subscribed list ', + 'changeSet' => [], ], 'ListSubAlbum' => [ - 'summary' => '订阅专辑元数据列表', + 'summary' => 'Album List.', 'path' => '/v1.0/ssp/listSubAlbum', - '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' => 'read', 'deprecated' => false, 'systemTags' => [], @@ -11112,71 +6538,27 @@ 'description' => 'request', 'type' => 'object', 'properties' => [ - 'CategoryId' => [ - 'title' => '分类ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '80011', - ], - 'AlbumId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4476001', - ], - 'Title' => [ - 'title' => '专辑标题', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '睡前故事', - ], + 'CategoryId' => ['title' => '', 'description' => 'Category ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '80011'], + 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'required' => false, 'example' => '4476001'], + 'Title' => ['title' => '', 'description' => 'Album title', 'type' => 'string', 'required' => false, 'example' => '睡前故事'], 'Page' => [ - 'title' => '分页参数', - 'description' => '', + 'title' => '', + 'description' => 'Pagination Parameters', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - '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', - ], + 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], 'required' => true, 'docRequired' => true, + 'example' => '', ], - 'DeviceId' => [ - 'title' => '设备ID', - 'type' => 'string', - 'docRequired' => true, - 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', - ], - 'UserId' => [ - 'title' => '用户ID', - 'type' => 'string', - 'docRequired' => true, - 'example' => '1152893538998276761', - ], + 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'docRequired' => true, 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', 'description' => ''], + 'UserId' => ['title' => 'User ID', 'type' => 'string', 'docRequired' => true, 'example' => '1152893538998276761', 'description' => ''], ], 'required' => true, 'docRequired' => true, + 'example' => '', ], ], [ @@ -11184,33 +6566,19 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备信息', - 'description' => '', + 'title' => '', + 'description' => 'Device Information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => false, - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => false, - ], - 'IdType' => [ - 'type' => 'string', - 'required' => false, - ], - 'Id' => [ - 'type' => 'string', - 'required' => false, - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], + 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, + 'example' => '', ], ], [ @@ -11218,33 +6586,19 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户信息', - 'description' => '', + 'title' => '', + 'description' => 'User information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'type' => 'string', - 'required' => false, - ], - 'EncodeKey' => [ - 'type' => 'string', - 'required' => false, - ], - 'IdType' => [ - 'type' => 'string', - 'required' => false, - ], - 'Id' => [ - 'type' => 'string', - 'required' => false, - ], - 'OrganizationId' => [ - 'type' => 'string', - 'required' => false, - ], + 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, + 'example' => '', ], ], ], @@ -11255,184 +6609,86 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '结果', - 'description' => '', + 'title' => '', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '共计多少条', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'TotalPageCount' => [ - 'title' => '共计多少页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'HasNext' => [ - 'title' => '是否有下一页', - 'description' => '', - 'type' => 'boolean', - ], + 'TotalCount' => ['title' => '', 'description' => 'total number of entries', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'TotalPageCount' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'HasNext' => ['title' => '', 'description' => 'Indicates whether there is a next page.', 'type' => 'boolean', 'example' => ''], 'DataList' => [ - 'title' => '专辑List', - 'description' => '', + 'title' => '', + 'description' => 'Album List', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '记录ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CategoryId' => [ - 'title' => '专辑分类ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80011', - ], - 'AlbumId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'example' => '4476001', - ], - 'Title' => [ - 'title' => '专辑标题', - 'description' => '', - 'type' => 'string', - 'example' => '睡前故事', - ], - 'CoverUrl' => [ - 'title' => '专辑封面', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg', - ], + 'Id' => ['title' => '', 'description' => 'Record ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CategoryId' => ['title' => '', 'description' => 'Album category ID', 'type' => 'integer', 'format' => 'int32', 'example' => '80011'], + 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '4476001'], + 'Title' => ['title' => '', 'description' => 'Album title', 'type' => 'string', 'example' => '睡前故事'], + 'CoverUrl' => ['title' => '', 'description' => 'Album thumbnail', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg'], 'ScheduleInfo' => [ - 'title' => '定时信息', - 'description' => '', + 'title' => '', + 'description' => 'Schedule information', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ - 'title' => '触发周期', - 'description' => '', + 'title' => '', + 'description' => 'trigger epoch', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'Hour' => [ - 'title' => '触发小时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Minute' => [ - 'title' => '触发分钟', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'ScheduleId' => [ - 'title' => '定时任务ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], + 'example' => '', ], + 'Hour' => ['title' => '', 'description' => 'trigger hour', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'Minute' => ['title' => '', 'description' => 'trigger minute', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], + 'ScheduleId' => ['title' => '', 'description' => 'scheduled task ID', 'type' => 'integer', 'format' => 'int64', 'example' => ''], ], + 'example' => '', ], - 'TotalEpisode' => [ - 'title' => '共多少集', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'Sequence' => [ - 'title' => '排序', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'IsAdded' => [ - 'title' => '是否已订阅', - 'description' => '', - 'type' => 'boolean', - ], + 'TotalEpisode' => ['title' => '', 'description' => 'Total number of episodes', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], + 'Sequence' => ['title' => '', 'description' => 'Sorting', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'IsAdded' => ['title' => '', 'description' => 'Is subscribed', 'type' => 'boolean', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CB13B8D7-37FB-1B3E-8EB9-65BB413267E1', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'CB13B8D7-37FB-1B3E-8EB9-65BB413267E1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": true,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"CategoryId\\": 80011,\\n \\"AlbumId\\": \\"4476001\\",\\n \\"Title\\": \\"睡前故事\\",\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23,\\n \\"ScheduleId\\": 0\\n },\\n \\"TotalEpisode\\": 23,\\n \\"Sequence\\": 1,\\n \\"IsAdded\\": true\\n }\\n ]\\n },\\n \\"RequestId\\": \\"CB13B8D7-37FB-1B3E-8EB9-65BB413267E1\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": false,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"CategoryId\\": 80011,\\n \\"AlbumId\\": \\"4476001\\",\\n \\"Title\\": \\"睡前故事\\",\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23,\\n \\"ScheduleId\\": 0\\n },\\n \\"TotalEpisode\\": 23,\\n \\"Sequence\\": 1,\\n \\"IsAdded\\": false\\n }\\n ]\\n },\\n \\"RequestId\\": \\"CB13B8D7-37FB-1B3E-8EB9-65BB413267E1\\"\\n}","type":"json"}]', + 'title' => 'Album List', + 'changeSet' => [], ], 'ListSubscriptionAlbumCategory' => [ - 'summary' => '内容订阅元数据分类', + 'summary' => 'Album categorization.', 'path' => '/v1.0/ssp/listSubscriptionAlbumCategory', - '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' => [], @@ -11440,13 +6696,7 @@ [ 'name' => 'CategoryName', 'in' => 'query', - 'schema' => [ - 'title' => '分类名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '儿歌', - ], + 'schema' => ['title' => '', 'description' => 'Category name', 'type' => 'string', 'required' => false, 'example' => '儿歌'], ], ], 'responses' => [ @@ -11454,96 +6704,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'title' => '分类List', - 'description' => '', + 'title' => '', + 'description' => 'List of categories', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CategoryId' => [ - 'title' => '分类ID', - 'description' => '', - 'type' => 'string', - 'example' => '80011', - ], - 'CategoryName' => [ - 'title' => '分类名称', - 'description' => '', - 'type' => 'string', - 'example' => '儿童', - ], + 'CategoryId' => ['title' => '', 'description' => 'Category ID', 'type' => 'string', 'example' => '80011'], + 'CategoryName' => ['title' => '', 'description' => 'Category name', 'type' => 'string', 'example' => '儿童'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '60E7A523-9766-1D07-87A2-6E587420C59B', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '60E7A523-9766-1D07-87A2-6E587420C59B'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'IdempotentParameterMismatch', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CategoryId\\": \\"80011\\",\\n \\"CategoryName\\": \\"儿童\\"\\n }\\n ],\\n \\"RequestId\\": \\"60E7A523-9766-1D07-87A2-6E587420C59B\\"\\n}","type":"json"}]', + 'title' => 'Album categorization', + 'changeSet' => [], ], - 'GetAlbumDetailById' => [ - 'summary' => '获取专辑数据', - 'path' => '/v1.0/ssp/getAlbumDetailById', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListUserMessage' => [ + 'summary' => 'Query the list of user message records based on the query conditions, including the start time and the number of entries to return.', + 'path' => '/v1.0/ssp/listUserMessage', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AlbumId', + 'name' => 'BeforeTime', + 'in' => 'query', + 'schema' => ['description' => 'After a specific point in time ', 'type' => 'string', 'required' => false, 'example' => '2022-07-27 14:06:55.984', 'title' => ''], + ], + [ + 'name' => 'limit', 'in' => 'query', + 'schema' => ['description' => 'Number of records to query ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', + 'description' => 'User identifier information ', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: - PACKAGENAME: APK package name, used for Android application client links - SKILLID: Skill ID, used for cloud-based links ', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', + ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the application\'s Skill ID. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => [ + 'description' => 'Type of user ID: - OPENID: Default user ID identifier - UNIONID: Organization-level user ID identifier, available only after an organization has been registered on the Maojing skill application Open Platform ', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'title' => '', + ], + 'Id' => ['description' => 'User identifier (userOpenId or userUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID ', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], + ], 'required' => true, - 'docRequired' => true, - 'example' => '51999575', + 'title' => '', + 'example' => '', ], ], ], @@ -11551,554 +6800,303 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Service Return Result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => '附加信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'title' => '状态码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['title' => 'Id of the request', 'description' => 'error message', 'type' => 'string', 'example' => '外部userId映射关系不存在'], + 'Code' => ['description' => 'Status code returned by the service. SUCCESS indicates success; otherwise, it indicates failure.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Result' => [ - 'title' => '专辑内容', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AlbumId' => [ - 'title' => '专辑ID', - 'description' => '', - 'type' => 'string', - 'example' => '51999575', - ], - 'AlbumTitle' => [ - 'title' => '专辑标题', - 'description' => '', - 'type' => 'string', - 'example' => '小科学家探索', - ], - 'AlbumDescription' => [ - 'title' => '专辑描述', - 'description' => '', - 'type' => 'string', - 'example' => '每次一个百科知识或者故事\\n丰富孩子的视野，拓展眼界和知识面，培养和孩子的探究能力和好奇心\\n\\n', - ], - 'AlbumCoverUrl' => [ - 'title' => '专辑封面', - 'description' => '', - 'type' => 'string', - 'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg', - ], - 'AlbumContentList' => [ - 'title' => '专辑内容List', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '专辑内容ID', - 'description' => '', - 'type' => 'string', - 'example' => '468009044', - ], - 'Title' => [ - 'title' => '专辑内容标题', - 'description' => '', - 'type' => 'string', - 'example' => '001为什么肚子饿时会咕咕叫', - ], - 'Duration' => [ - 'title' => '专辑内容时长', - 'description' => '', - 'type' => 'string', - 'example' => '3分24秒', - ], - 'OrderIndex' => [ - 'title' => '专辑内容排序', - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'A0B7CACD-485B-14E2-854F-39EACB09E45B', + 'description' => 'List of user message query results', + 'type' => 'array', + 'items' => [ + 'description' => 'Message details', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Message ID', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'GmtCreate' => ['description' => 'Time when the message was sent', 'type' => 'string', 'example' => '2022-07-27 14:06:27.000', 'title' => ''], + 'Status' => ['description' => 'Message status: 0 indicates unread, and 1 indicates read.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Source' => ['description' => 'Message source: app or box', 'type' => 'string', 'example' => 'app', 'title' => ''], + 'Type' => ['description' => 'Currently only audio is supported.', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Content' => ['description' => 'Message text', 'type' => 'string', 'example' => '哈哈哈', 'title' => ''], + 'Url' => ['description' => 'Audio message link ', 'type' => 'string', 'example' => 'http://xx', 'title' => ''], + 'SourceUuid' => ['description' => 'Source Device ID', 'type' => 'string', 'example' => 'AF188**065EE4B**DD68CE**951D84D4', 'title' => ''], + 'DeviceName' => ['description' => 'Device name ', 'type' => 'string', 'example' => '卧室的小芳', 'title' => ''], + 'Pic' => ['description' => 'Device Image', 'type' => 'string', 'example' => 'http://xx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'IdempotentParameterMismatch', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"AlbumTitle\\": \\"小科学家探索\\",\\n \\"AlbumDescription\\": \\"每次一个百科知识或者故事\\\\\\\\n丰富孩子的视野，拓展眼界和知识面，培养和孩子的探究能力和好奇心\\\\\\\\n\\\\\\\\n\\",\\n \\"AlbumCoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"AlbumContentList\\": [\\n {\\n \\"Id\\": \\"468009044\\",\\n \\"Title\\": \\"001为什么肚子饿时会咕咕叫\\",\\n \\"Duration\\": \\"3分24秒\\",\\n \\"OrderIndex\\": \\"1000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A0B7CACD-485B-14E2-854F-39EACB09E45B\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"123456\\",\\n \\"GmtCreate\\": \\"2022-07-27 14:06:27.000\\",\\n \\"Status\\": 0,\\n \\"Source\\": \\"app\\",\\n \\"Type\\": \\"audio\\",\\n \\"Content\\": \\"哈哈哈\\",\\n \\"Url\\": \\"http://xx\\",\\n \\"SourceUuid\\": \\"AF188**065EE4B**DD68CE**951D84D4\\",\\n \\"DeviceName\\": \\"卧室的小芳\\",\\n \\"Pic\\": \\"http://xx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of user message records ', + 'changeSet' => [], ], - 'GetUnreadMessageCount' => [ - 'summary' => '查询未读留言数量', - 'path' => '/v1.0/ssp/getUnreadMessageCount', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'MobileRecommend' => [ + 'summary' => 'Shift the project to obtain recommended songs, including daily recommendations, popular songs, and genre-based playlists.', + 'path' => '/v1.0/ssp/mobile/recommend/music', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'User information – userId', 'type' => 'object', 'properties' => [ 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - ], - 'EncodeKey' => [ - 'description' => '', + 'description' => 'Encoding type', 'type' => 'string', 'required' => true, - 'example' => '12**45', + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', ], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding Type. Enter the Project ID of the project to which this product belongs.', 'type' => 'string', 'required' => true, 'example' => '1414895629783187053', 'title' => ''], 'IdType' => [ - 'description' => '', + 'description' => 'ID Type', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'title' => '', ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'Id' => ['description' => 'ID value', 'type' => 'string', 'required' => true, 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. This parameter is Required when IdType is set to UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '暂无', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Device identification information.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'Id of the request', - 'description' => '', + 'EncodeType' => [ + 'description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', - 'example' => '', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', ], - 'Code' => [ - 'description' => '', + 'EncodeKey' => [ + 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs.', 'type' => 'string', - 'example' => 'SUCCESS', + 'required' => true, + 'example' => '1414895629783187053', + 'enum' => [], + 'title' => '', ], - 'Result' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'IdType' => [ + 'description' => 'Type of the device ID.'."\n" + ."\n" + .'OPEN_ID: Default device ID.'."\n" + .'UNION_ID: Organization-level device ID. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['UNION_ID', 'OPEN_ID'], + 'title' => '', ], + 'Id' => ['description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. This parameter is required when **IdType** is set to **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '暂无', 'title' => ''], ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"用户信息不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": 10\\n}","errorExample":""},{"type":"xml","example":"<GetUnreadMessageCountResponse>\\n <Message>用户信息不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>10</Result>\\n</GetUnreadMessageCountResponse>","errorExample":""}]', - ], - 'ListUserMessage' => [ - 'summary' => '获取留言列表', - 'path' => '/v1.0/ssp/listUserMessage', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AliGenie_Auth_SPI' => [], + 'name' => 'BotId', + 'in' => 'query', + 'schema' => ['description' => 'Bot ID.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'BeforeTime', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Request Type: Obtain daily recommendations, hot songs, or genre-based playlists.', 'type' => 'string', 'required' => false, - 'example' => '2022-07-27 14:06:55.984', + 'enumValueTitles' => ['STYLE' => '', 'DAILY_REC' => '', 'HOT' => ''], + 'example' => 'DAILY_REC', + 'title' => '', ], ], [ - 'name' => 'limit', + 'name' => 'Style', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Required when the request type is STYLE.', + 'type' => 'string', 'required' => false, - 'example' => '10', + 'enumValueTitles' => ['钢琴' => '', '抖音' => '', '欢快' => '', '轻音乐' => '', '流行' => '', 'DJ' => 'DJ'], + 'example' => '轻音乐', + 'title' => '', ], ], [ - 'name' => 'UserInfo', + 'name' => 'Count', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'Quantity of recommended Result', 'type' => 'string', 'required' => false, 'example' => '6', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5C5809B4-F465-52E0-9A8B-61396F9E593B'], + 'Code' => ['description' => 'Return code of the invocation', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'If an error occurs, the error message will be output.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'Request result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Actual return result from the service', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-07-27 14:06:27.000', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'app', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'audio', - ], - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xx', - ], - 'SourceUuid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AF188**065EE4B**DD68CE**951D84D4', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', + 'Source' => ['description' => 'Source of the content', 'type' => 'string', 'example' => 'KG', 'title' => ''], + 'RawId' => ['description' => 'Third-party ID of the content', 'type' => 'string', 'example' => '550144364', 'title' => ''], + 'Cover' => ['description' => 'Album thumbnail image', 'type' => 'string', 'example' => 'http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg', 'title' => ''], + 'Authors' => [ + 'description' => 'Author information', + 'type' => 'array', + 'items' => ['description' => 'Author information', 'type' => 'string', 'example' => '["周杰伦"]', 'title' => ''], + 'title' => '', 'example' => '', ], - 'Pic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xx', - ], + 'Title' => ['description' => 'Content title', 'type' => 'string', 'example' => '稻香', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"123456\\",\\n \\"GmtCreate\\": \\"2022-07-27 14:06:27.000\\",\\n \\"Status\\": 0,\\n \\"Source\\": \\"app\\",\\n \\"Type\\": \\"audio\\",\\n \\"Content\\": \\"哈哈哈\\",\\n \\"Url\\": \\"http://xx\\",\\n \\"SourceUuid\\": \\"AF188**065EE4B**DD68CE**951D84D4\\",\\n \\"DeviceName\\": \\"卧室的小芳\\",\\n \\"Pic\\": \\"http://xx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListUserMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>\\n <Id>123456</Id>\\n <GmtCreate>2022-07-27 14:06:27.000</GmtCreate>\\n <Status>0</Status>\\n <Source>app</Source>\\n <Type>audio</Type>\\n <Content>哈哈哈</Content>\\n <Url>http://xx</Url>\\n <SourceUuid>AF188**065EE4B**DD68CE**951D84D4</SourceUuid>\\n <DeviceName>卧室的小芳</DeviceName>\\n <Pic>http://xx</Pic>\\n </Result>\\n</ListUserMessageResponse>","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5809B4-F465-52E0-9A8B-61396F9E593B\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"KG\\",\\n \\"RawId\\": \\"550144364\\",\\n \\"Cover\\": \\"http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg\\",\\n \\"Authors\\": [\\n \\"[\\\\\\"周杰伦\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"稻香\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Shift Lightweight Managed Recommendation API', + 'description' => 'Different scenarios (such as daily recommendations and popular songs) can be distinguished by the Type parameter.', + 'changeSet' => [], ], - 'ReadMessage' => [ - 'summary' => '读取留言', - 'path' => '/v1.0/ssp/readMessage', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PlayAndPauseControl' => [ + 'summary' => 'Playback and pause control.', + 'path' => '/v1.0/ssp/PlayAndPauseControl', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UserInfo', - 'in' => 'query', + 'name' => 'OpenPlayAndPauseControlParam', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'description' => '', + 'OpenPlayAndPauseCommand' => [ + 'description' => 'Playback: Play; Pause: Pause.', 'type' => 'string', 'required' => true, - 'example' => '123L', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'example' => 'Play', + 'enum' => ['Play', 'Pause'], + 'title' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MessageId', + 'name' => 'UserInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'User identity information', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier from Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer flow. `SKILL_ID`: Skill ID, used for the cloud-based flow.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID.'."\n" + ."\n" + .'`OPEN_ID`: The default user ID identity. `UNION_ID`: The organization-dimension user ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<ReadMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>true</Result>\\n</ReadMessageResponse>","errorExample":""}]', - ], - 'SendMessage' => [ - 'summary' => '发送留言', - 'path' => '/v1.0/ssp/sendMessage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'Url', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xx', + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserInfo', + 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ + 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - 'enum' => [ - 'PROJECT_ID', - ], - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123L', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123L', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device identity for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'If the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. If the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of Device ID.'."\n" + ."\n" + .'`OPEN_ID`: The default device ID identity. `UNION_ID`: The organization-dimension device ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device ID, which can be set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. This parameter is required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -12106,1056 +7104,410 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Result' => ['description' => 'Actual return result from the service', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'Additional information. In typical scenarios, this provides a brief description of a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. The value true means success, and false means failure. If the invocation fails, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SendMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>true</Result>\\n</SendMessageResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Playback and pause control', + 'changeSet' => [], ], - 'CreateAlarm' => [ - 'summary' => '创建闹钟', - 'path' => '/v1.0/ssp/createAlarm', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PlayModeControl' => [ + 'summary' => 'Switch playback mode.', + 'path' => '/v1.0/ssp/PlayModeControl', + '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' => [], 'parameters' => [ [ - 'name' => 'Payload', + 'name' => 'OpenPlayModeControlRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ - 'ScheduleInfo' => [ - 'title' => '调度信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '调度类型/循环类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ONCE', - 'enum' => [ - 'ONCE', - 'WEEKLY', - 'STATUTORY_WORKING_DAY', - ], - ], - 'Once' => [ - 'title' => '单次', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'title' => '触发时间：年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2022', - ], - 'Month' => [ - 'title' => '触发时间：月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8', - ], - 'Day' => [ - 'title' => '触发时间：日', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'Weekly' => [ - 'title' => '周循环', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'title' => '周几触发集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'StatutoryWorkingDay' => [ - 'title' => '法定工作日', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], - 'MusicInfo' => [ - 'title' => '音乐信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MusicType' => [ - 'title' => '音乐类别id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'MusicTypeName' => [ - 'title' => '音乐类别名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'MusicId' => [ - 'title' => '音乐id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'MusicName' => [ - 'title' => '音乐名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'MusicUrl' => [ - 'title' => '音乐url', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xx', - ], - ], - 'required' => true, - ], - 'Volume' => [ - 'title' => '音乐信息', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - 'default' => '40', - ], - 'RequestId' => [ - 'type' => 'string', - 'required' => true, - ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ + 'OpenPlayMode' => [ + 'description' => 'Playback mode'."\n" + ."\n" + .'List loop: Repeat; Shuffle: Shuffle; Single track loop: RepeatOne; NAT mode: Normal;', 'type' => 'string', 'required' => true, + 'example' => 'Normal', + 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'], + 'title' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer ingest endpoint. `SKILL_ID`: Skill ID, used for the cloud-side ingest endpoint.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of User ID'."\n" + ."\n" + .'`OPEN_ID`: The default User ID identity. `UNION_ID`: Organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application 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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for Android application customer journeys. `SKILL_ID`: Skill ID, used for cloud-based journeys.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID'."\n" + ."\n" + .'`OPEN_ID`: Default device ID identity. `UNION_ID`: Organization-dimension device ID identity, available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', + 'description' => 'Actual return result of the service', + 'type' => 'object', + 'properties' => [ + 'OpenPlayMode' => [ + 'description' => 'Playback mode'."\n" + ."\n" + .'List loop: Repeat; Shuffle: Shuffle; Single-track loop: RepeatOne; NAT mode: Normal;', + 'type' => 'string', + 'example' => 'Normal', + 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'], + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the value is false, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlarmResponse>\\n <Code>200</Code>\\n <Message>xx为空</Message>\\n <Result>1234567</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</CreateAlarmResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OpenPlayMode\\": \\"Normal\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Switch playback mode', + 'changeSet' => [], ], - 'DeleteAlarms' => [ - 'summary' => '闹钟批量删除', - 'path' => '/v1.0/ssp/deleteAlarms', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'PreviousAndNextControl' => [ + 'summary' => 'Control the next or previous track in the created playlist. ', + 'path' => '/v1.0/ssp/PreviousAndNextControl', + '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' => [], 'parameters' => [ [ - 'name' => 'Payload', + 'name' => 'OpenControlPlayingListRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'description' => 'Business parameters ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - 'required' => true, - ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AlarmIds' => [ - 'title' => '待删除闹钟', - 'description' => '', - 'type' => 'array', - 'format' => 'int64', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234567', - ], - 'required' => true, - ], + 'Cmd' => ['description' => 'Next track: NEXT; Previous track: PREVIOUS ', 'type' => 'string', 'required' => true, 'example' => 'NEXT', 'title' => ''], + 'IsFromDevice' => ['description' => 'Whether initiated by the device. Default is false. ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'ExtendInfo' => ['type' => 'object', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'description' => 'User identity information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identity from Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for Android application client-side flows. `SKILL_ID`: Skill ID, used for cloud-side flows.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID.'."\n" + ."\n" + .'`OPEN_ID`: The default user identity. `UNION_ID`: The organization-dimension user identity, which is available only after an organization has been requested on the Tmall Genie Skill Application 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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'description' => 'Device ID information ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for Android application customer journeys. `SKILL_ID`: Skill ID, used for cloud-based journeys. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of Device ID.'."\n" + ."\n" + .'`OPEN_ID`: The default device identity. `UNION_ID`: The organization-dimension device identity, which is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult', - 'description' => 'AmpResult', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'Code' => ['description' => 'Return code of the invocation ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', + 'description' => 'Actual return result from the service ', + 'type' => 'object', + 'properties' => [ + 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '550144364', 'title' => ''], + 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], + 'AlbumRawId' => ['description' => 'Third-party album ID ', 'type' => 'string', 'example' => '260744', 'title' => ''], + 'AlbumName' => ['description' => 'Third-party album name ', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], + 'Liked' => ['description' => 'is collected ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Singer' => ['description' => 'author ', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], + 'Title' => ['description' => 'title ', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], + 'Cover' => [ + 'description' => 'Thumbnail image object', + 'type' => 'object', + 'properties' => [ + 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal) ', 'type' => 'string', 'example' => 'Repeat', 'title' => ''], + 'AudioLength' => ['description' => 'Length ', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], + 'Progress' => ['description' => 'Song playback progress ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'LyricUrl' => ['description' => 'Lyrics URL ', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], + 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], + 'Copyright' => ['description' => 'The copyright field is upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ItemUrl' => ['description' => 'Playback URL ', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], + 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether playback is allowed: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Pos' => ['description' => 'The position of this item in the playlist ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. A value of true means success, and false means failure. When the value is false, check the Message field for details. ', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"闹钟id为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlarmsResponse>\\n <Code>200</Code>\\n <Message>闹钟id为空</Message>\\n <Result>true</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</DeleteAlarmsResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Next/Previous Track Control ', + 'changeSet' => [], ], - 'GetAlarm' => [ - 'summary' => '获取单个闹钟', - 'path' => '/v1.0/ssp/getAlarm', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ProgressControl' => [ + 'summary' => 'Progress control.', + 'path' => '/v1.0/ssp/ProgressControl', + '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' => [], 'parameters' => [ [ - 'name' => 'Payload', + 'name' => 'OpenProgressControlRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - 'required' => true, - ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AlarmId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567', - ], + 'Progress' => ['description' => 'Song progress, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', 'title' => ''], + 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'description' => 'User identity information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the Tmall Genie user identity, and each way corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application client path. `SKILL_ID`: Skill ID, used for the cloud-based path.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of User ID.'."\n" + ."\n" + .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity, which is available only after an organization has been requested on the Tmall Genie Skills Application 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+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer flow. `SKILL_ID`: Skill ID, used for the cloud-based flow.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => ['description' => 'The type of Device ID.'."\n" + ."\n" + .'`OPEN_ID`: The default device identity. `UNION_ID`: The organization-dimension device identity, which is available only after an organization has been requested on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'Id' => ['description' => 'Device ID. Set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult', - 'description' => 'AmpResult', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Result' => [ - 'title' => '模型数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AlarmId' => [ - 'title' => '闹钟id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'ScheduleTypeDesc' => [ - 'title' => '循环类型描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TriggerDateDesc' => [ - 'title' => '触发日期描述（单次）', - 'description' => '', - 'type' => 'string', - 'example' => '2022-07-29', - ], - 'TriggerTimeDesc' => [ - 'title' => '触发时间描述', - 'description' => '', - 'type' => 'string', - 'example' => '10:00', - ], - 'ScheduleInfo' => [ - 'title' => '调度信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '循环类型', - 'description' => '', - 'type' => 'string', - 'example' => 'ONCE', - 'enum' => [ - 'ONCE', - 'WEEKLY', - 'STATUTORY_WORKING_DAY', - ], - ], - 'Once' => [ - 'title' => '单次', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'title' => '触发时间：年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2022', - ], - 'Month' => [ - 'title' => '触发时间：月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Day' => [ - 'title' => '触发时间：日', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '29', - ], - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'StatutoryWorkingDay' => [ - 'title' => '法定工作日', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'Weekly' => [ - 'title' => '周循环', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分'."\n", - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DaysOfWeek' => [ - 'title' => '周几触发集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - 'MusicInfo' => [ - 'title' => '音乐信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MusicType' => [ - 'title' => '音乐类别id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MusicTypeName' => [ - 'title' => '音乐类别名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'MusicId' => [ - 'title' => '音乐id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MusicName' => [ - 'title' => '音乐名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'MusicUrl' => [ - 'title' => '音乐url', - 'description' => '', - 'type' => 'string', - 'example' => 'http://xx', - ], - ], - ], - 'Volume' => [ - 'title' => '音量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'Status' => [ - 'title' => '状态 0 正常 1 删除 2 关闭', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', - ], + 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Result' => ['description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'Additional information. In typical scenarios, this provides a brief description of a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the invocation fails, pay attention to the Message field.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"id为空\\",\\n \\"Result\\": {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 123454321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAlarmResponse>\\n <Code>200</Code>\\n <Message>id为空</Message>\\n <Result>\\n <AlarmId>1234567</AlarmId>\\n <UserId>123454321</UserId>\\n <Uuid>AF18***065EE4BD***68CEFD9***84D4</Uuid>\\n <ScheduleTypeDesc>单次</ScheduleTypeDesc>\\n <TriggerDateDesc>2022-07-29</TriggerDateDesc>\\n <TriggerTimeDesc>10:00</TriggerTimeDesc>\\n <ScheduleInfo>\\n <Type>ONCE</Type>\\n <Once>\\n <Year>2022</Year>\\n <Month>7</Month>\\n <Day>29</Day>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </Once>\\n <StatutoryWorkingDay>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </StatutoryWorkingDay>\\n <Weekly>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n <DaysOfWeek>1</DaysOfWeek>\\n </Weekly>\\n </ScheduleInfo>\\n <MusicInfo>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx音乐</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx铃声</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </MusicInfo>\\n <Volume>40</Volume>\\n <Status>0</Status>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</GetAlarmResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Progress control', + 'changeSet' => [], ], - 'ListAlarms' => [ - 'summary' => '查询闹钟列表', - 'path' => '/v1.0/ssp/listAlarm', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'QueryMusicType' => [ + 'summary' => 'Obtain the collection of alarm music types supported by the device.', + 'path' => '/v1.0/ssp/queryMusicType', + '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' => [ @@ -13164,47 +7516,17 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'title' => '每页条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], - 'RequestId' => [ - 'type' => 'string', - 'required' => true, - ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - 'required' => true, - ], + 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Invoker', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], [ @@ -13212,55 +7534,32 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of User ID: OPEN_ID: default User ID identity; UNION_ID: organization-dimension User ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the Maojing user identifier, and each way corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer journeys; SKILL_ID: skill ID, used for cloud-based journeys.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], [ @@ -13268,2865 +7567,1399 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], + 'Id' => ['title' => '', 'description' => 'device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Type of the device ID: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after requesting an organization in the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Maojing, and each way corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for the Android application customer link; SKILL_ID: skill ID, used for the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', + 'Code' => ['description' => 'Status code returned by the alarm service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '设备账号未关联'], + 'Result' => [ + 'description' => 'List of ringtone types', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a ringtone type', + 'type' => 'object', + 'properties' => [ + 'MusicType' => ['title' => '', 'description' => 'Ringtone type ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MusicTypeName' => ['title' => 'musicTypeName', 'description' => 'Name of the ringtone category', 'type' => 'string', 'example' => 'xx'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], + 'RequestId' => ['description' => 'request ID', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\"\\n }\\n ],\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Obtain the list of alarm music types', + 'responseParamsDescription' => 'The operation is successful only when the status code returned by the service is 200; otherwise, it indicates failure.', + 'changeSet' => [], + ], + 'QueryUserDeviceListByTmeUserId' => [ + 'summary' => 'Obtain the list of authorized Tmall Genie users and their devices by using the TME user ID, for use by KuGou Cloud Push Song service ', + 'path' => '/v1.0/ssp/queryUserDeviceListByTmeUserId', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json', 'application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'], + 'parameters' => [ + [ + 'name' => 'TmeUserId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'TME User ID', 'type' => 'string', 'required' => true, 'example' => 'FDEEDE337BAA780793D72F7F20BEF2F5'], + ], + [ + 'name' => 'Sp', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => '"KG": KuGou '."\n" + .'"KW": Kuwo '."\n" + .'"QM": QQ Music', 'type' => 'string', 'required' => true, 'example' => 'KG'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00'], + 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'success'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageCount' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageSize' => [ - 'title' => '每页条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CurrentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Model' => [ - 'title' => '闹钟列表', - 'description' => '', + 'Sp' => ['title' => '', 'description' => '"KG": KuGou '."\n" + .'"KW": Kuwo '."\n" + .'"QM": QQ Music', 'type' => 'string', 'example' => 'KG'], + 'EncodeType' => ['title' => '', 'description' => 'entity Type (pass-through by third party)', 'type' => 'string', 'example' => 'PROJECT_ID'], + 'EncodeKey' => ['title' => '', 'description' => 'entity key (pass-through by third party)', 'type' => 'string', 'example' => '12****7'], + 'AligenieUserInfoList' => [ + 'title' => '', + 'description' => 'Tmall Genie User List ', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'AlarmId' => [ - 'title' => '闹钟id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'ScheduleTypeDesc' => [ - 'title' => '循环类型描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TriggerDateDesc' => [ - 'title' => '触发日期描述（单次）', - 'description' => '', - 'type' => 'string', - 'example' => '2022-07-29', - ], - 'TriggerTimeDesc' => [ - 'title' => '触发时间描述', - 'description' => '', - 'type' => 'string', - 'example' => '10:00', - ], - 'ScheduleInfo' => [ - 'title' => '调度信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '循环类型', - 'description' => '', - 'type' => 'string', - 'example' => 'ONCE', - 'enum' => [ - 'ONCE', - 'WEEKLY', - 'STATUTORY_WORKING_DAY', - ], - ], - 'Once' => [ - 'title' => '单次', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'title' => '触发时间：年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2022', - ], - 'Month' => [ - 'title' => '触发时间：月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Day' => [ - 'title' => '触发时间：日', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '29', - ], - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'Weekly' => [ - 'title' => '周循环', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DaysOfWeek' => [ - 'title' => '周几触发集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'StatutoryWorkingDay' => [ - 'title' => '法定工作日', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - ], - 'MusicInfo' => [ - 'title' => '音乐信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MusicType' => [ - 'title' => '音乐类别id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MusicTypeName' => [ - 'title' => '音乐类别名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'MusicId' => [ - 'title' => '音乐id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MusicName' => [ - 'title' => '音乐名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'MusicUrl' => [ - 'title' => '音乐url', - 'description' => '', - 'type' => 'string', - 'example' => 'http://xx', + 'OpenUserId' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg=='], + 'UserNickname' => ['title' => '', 'description' => 'User nickname ', 'type' => 'string', 'example' => 'a***e'], + 'AuthorizedDeviceList' => [ + 'title' => '', + 'description' => 'User Authorization device List ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OpenDeviceId' => ['title' => '', 'description' => 'Device ID ', 'type' => 'string', 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM='], + 'DeviceName' => ['title' => '', 'description' => 'device name', 'type' => 'string', 'example' => 'CC'], + 'Online' => ['title' => '', 'description' => 'Indicates whether the device is online ', 'type' => 'boolean', 'example' => 'true'], + 'TmeProductId' => ['description' => 'TME product ID ', 'title' => 'TME product ID ', 'type' => 'string', 'example' => ''], + 'TmeDeviceId' => ['description' => 'Device ID exposed to TME ', 'title' => 'Device ID exposed to TME ', 'type' => 'string', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Volume' => [ - 'title' => '音量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'Status' => [ - 'title' => '状态 0 正常 1 删除 2 关闭', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 1234321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<ListAlarmsResponse>\\n <Code>200</Code>\\n <Message>设备账号未关联</Message>\\n <Result>\\n <TotalCount>100</TotalCount>\\n <PageCount>10</PageCount>\\n <PageSize>10</PageSize>\\n <CurrentPage>1</CurrentPage>\\n <Model>\\n <AlarmId>1234567</AlarmId>\\n <UserId>1234321</UserId>\\n <Uuid>AF18***065EE4BD***68CEFD9***84D4</Uuid>\\n <ScheduleTypeDesc>单次</ScheduleTypeDesc>\\n <TriggerDateDesc>2022-07-29</TriggerDateDesc>\\n <TriggerTimeDesc>10:00</TriggerTimeDesc>\\n <ScheduleInfo>\\n <Type>ONCE</Type>\\n <Once>\\n <Year>2022</Year>\\n <Month>7</Month>\\n <Day>29</Day>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </Once>\\n <Weekly>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n <DaysOfWeek>1</DaysOfWeek>\\n </Weekly>\\n <StatutoryWorkingDay>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </StatutoryWorkingDay>\\n </ScheduleInfo>\\n <MusicInfo>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx音乐</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx铃声</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </MusicInfo>\\n <Volume>40</Volume>\\n <Status>0</Status>\\n </Model>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</ListAlarmsResponse>","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Sp\\": \\"KG\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"AligenieUserInfoList\\": [\\n {\\n \\"OpenUserId\\": \\"R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==\\",\\n \\"UserNickname\\": \\"a***e\\",\\n \\"AuthorizedDeviceList\\": [\\n {\\n \\"OpenDeviceId\\": \\"fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=\\",\\n \\"DeviceName\\": \\"CC\\",\\n \\"Online\\": true,\\n \\"TmeProductId\\": \\"\\",\\n \\"TmeDeviceId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain authorized Tmall Genie users and device list by TME user ID', + 'changeSet' => [], ], - 'ListMusic' => [ - 'summary' => '基于音乐类型查询铃声列表（分页）', - 'path' => '/v1.0/ssp/listMusic', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ReadMessage' => [ + 'summary' => 'Set a message to read status.', + 'path' => '/v1.0/ssp/readMessage', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'formData', + 'name' => 'UserInfo', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'description' => 'User information', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - 'required' => true, - ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ + 'EncodeType' => [ + 'description' => 'Encoding type. There are multiple ways to obtain the User Identifier in Maojing, and each method corresponds to a different encoding type: PACKAGENAME for the APK package name used in Android client application links, and SKILLID for the skill ID used in cloud-based links.', 'type' => 'string', 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', ], - 'MusicType' => [ - 'title' => '音乐类别id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'MusicTypeName' => [ - 'title' => '音乐类别名称', - 'description' => '', + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the Skill ID of the application. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'IdType' => [ + 'description' => 'Type of User ID: OPENID is the default User ID identity. UNIONID is the organization-dimension User ID identity, which is available only after an organization has been registered on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, - 'example' => '', - ], - 'MusicId' => [ - 'title' => '音乐id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'MusicName' => [ - 'title' => '音乐名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'CurrentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'title' => '每页条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '10', + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'title' => '', ], + 'Id' => ['description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => '123L', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => ['description' => 'Message ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Return Result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => 'Id of the request', 'description' => 'error message', 'type' => 'string', 'example' => '外部userId映射关系不存在'], + 'Code' => ['description' => 'Status code returned by the service. Only "SUCCESS" indicates success; all other values indicate failure.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Result' => ['description' => 'Succeeded in marking as read', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Mark a Message as Read', + 'changeSet' => [], + ], + 'ScanCodeBind' => [ + 'summary' => 'A screen-equipped device completes activation and attachment between the user and the device by scanning a QR code.', + 'path' => '/v1.0/ssp/scanCode', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ 'name' => 'UserInfo', 'in' => 'formData', + 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'User identity information ', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. Enter PROJECT_ID here. ', 'type' => 'string', 'required' => true, - 'example' => 'HOFF****my7Iw=', + 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view this in the Tmall Genie AI Platform console. ', 'type' => 'string', 'required' => true, 'example' => '129****0946'], 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'title' => '', + 'description' => 'Device ID type: '."\n" + .'OPEN_ID: Default Device ID identifier. '."\n" + .'UNION_ID: Organization-dimension Device ID identifier. You must request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['title' => '', 'description' => 'User Identifier. Enter the value of userOpenId or userUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '111'], ], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'DeviceInfo', + 'name' => 'BindReq', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for QR code scanning binding', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'Code' => ['title' => 'authCode', 'description' => 'authCode', 'type' => 'string', 'required' => true, 'example' => 'ASdfre'], + 'ClientId' => ['title' => '', 'description' => 'Product client ID ', 'type' => 'string', 'required' => true, 'example' => 'RnY8v0W0ZVn58ZrUAOr2RD'], + 'ExtInfo' => ['title' => '', 'description' => 'Extension parameter', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}'], + 'UserId' => ['title' => 'Genie User ID ', 'type' => 'string', 'required' => true, 'example' => '123456', 'description' => ''], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult', - 'description' => 'AmpResult', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'Message' => ['title' => '', 'description' => 'Result message', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'The returned error code. A value of 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'Detailed information returned.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageCount' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageSize' => [ - 'title' => '每页条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CurrentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Model' => [ - 'title' => '铃声列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MusicType' => [ - 'title' => '音乐类别id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MusicTypeName' => [ - 'title' => '音乐类别名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], - 'MusicId' => [ - 'title' => '音乐id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MusicName' => [ - 'title' => '音乐名称', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', - ], - 'MusicUrl' => [ - 'title' => '音乐url', - 'description' => '', - 'type' => 'string', - 'example' => 'http://xx', - ], - ], - ], - ], + 'BizType' => ['title' => '', 'description' => 'Product categorization', 'type' => 'string', 'example' => 'AILABS'], + 'BizGroup' => ['title' => '', 'description' => 'Product group', 'type' => 'string', 'example' => 'X1'], + 'UserOpenId' => ['title' => 'DAFE****ce3ej=', 'description' => 'DAFE****ce3ej=', 'type' => 'string', 'example' => '用户OpenId'], + 'DeviceOpenId' => ['title' => 'A963*0158', 'description' => 'A963*0158', 'type' => 'string', 'example' => '设备OpenId'], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '686DF82F-45C4-7DF7-8B67-27B91CFD63A9'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"音乐类型名称为空\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<ListMusicResponse>\\n <Code>200</Code>\\n <Message>音乐类型名称为空</Message>\\n <Result>\\n <TotalCount>100</TotalCount>\\n <PageCount>10</PageCount>\\n <PageSize>10</PageSize>\\n <CurrentPage>1</CurrentPage>\\n <Model>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </Model>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</ListMusicResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"BizType\\": \\"AILABS\\",\\n \\"BizGroup\\": \\"X1\\",\\n \\"UserOpenId\\": \\"用户OpenId\\",\\n \\"DeviceOpenId\\": \\"设备OpenId\\"\\n },\\n \\"RequestId\\": \\"686DF82F-45C4-7DF7-8B67-27B91CFD63A9\\"\\n}","type":"json"}]', + 'title' => 'Activate and attach by scanning a QR code', + 'description' => 'Perform activation and attachment by scanning the QR code related to activation and attachment displayed on the device.', + 'changeSet' => [], ], - 'QueryMusicType' => [ - 'summary' => '获取闹钟音乐类型列表', - 'path' => '/v1.0/ssp/queryMusicType', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ScgSearch' => [ + 'summary' => 'Query the content of a selection pool by its ID.', + 'path' => '/v1.0/ssp/scgSearch', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - 'required' => true, - ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - 'required' => true, - ], - ], - 'required' => false, - ], + 'name' => 'TopicId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Selection pool ID. Optional values: MC201132 (Ethnic Chinese Style), MC201136 (Pop Music), MC201139 (Sweet Love), MC201133 (Folk), MC201137 (Relaxing Reading), MC201138 (Happiness), PA202029 (Stories), PA202030 (Children\'s Songs), PA202028 (Chinese Classics and History), PA202032 (Encyclopedia), PA202031 (English Children\'s Songs)', 'type' => 'string', 'required' => true, 'example' => 'MC201132'], ], [ - 'name' => 'UserInfo', - 'in' => 'formData', + 'name' => 'ScgFilter', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'title' => '', + 'description' => 'Query filter', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', + 'SortParam' => [ + 'title' => '', + 'description' => 'Sorting parameters', + 'type' => 'object', + 'properties' => [ + 'SortKey' => ['title' => '', 'description' => 'Sorting field', 'type' => 'string', 'required' => false, 'example' => 'internal_id'], + 'SortText' => ['title' => '', 'description' => 'Sorting field (default: empty string)', 'type' => 'string', 'required' => false, 'example' => '“”'], + 'SortOrder' => ['title' => '', 'description' => 'Sorting order', 'type' => 'string', 'required' => false, 'example' => 'ASC'], ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', + 'example' => '', ], - 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', + 'UseOffSet' => ['title' => '', 'description' => 'Whether to use the pageParam object for paging. Choose either offSetParam or pageParam. The default paging mode is pageParam.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'OffSetParam' => [ + 'title' => '', + 'description' => 'Paging type', + 'type' => 'object', + 'properties' => [ + 'Offset' => ['title' => '', 'description' => 'Number of skipped items', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Limit' => ['title' => '', 'description' => 'Number of returned items', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], + 'required' => false, + 'example' => '', ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', + 'PageParam' => [ + 'title' => '', + 'description' => 'Paging type', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', 'required' => false, - 'example' => '1**2', + 'example' => '', ], ], 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'AmpResult', - 'description' => 'AmpResult', + 'title' => 'result', + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => 'OK'], + 'PageSize' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Result' => [ - 'description' => '', + 'title' => '', + 'description' => 'Detailed returned information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Returned content data', 'type' => 'object', 'properties' => [ - 'MusicType' => [ - 'title' => '铃声类型id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'Source' => ['title' => '', 'description' => 'Content source', 'type' => 'string', 'example' => 'xiami'], + 'Title' => ['title' => '', 'description' => 'Content title ', 'type' => 'string', 'example' => '那个人'], + 'Type' => ['title' => '', 'description' => 'Content type ', 'type' => 'string', 'example' => 'music'], + 'Cover' => [ + 'title' => '', + 'description' => 'Thumbnail ', + 'type' => 'object', + 'properties' => [ + 'Img' => ['title' => '', 'description' => 'Thumbnail image (Img, Large, Medium, and Small may not appear simultaneously; only one of them may be present) ', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], + 'canResize' => ['title' => '', 'description' => 'Whether scaling is supported ', 'type' => 'boolean', 'example' => 'false'], + 'Large' => ['title' => '', 'description' => 'Large graph ', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], + 'Medium' => ['title' => '', 'description' => 'Medium image', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], + 'Small' => ['title' => '', 'description' => 'Small image ', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], + ], + 'example' => '', ], - 'MusicTypeName' => [ - 'title' => 'musicTypeName', - 'description' => '', - 'type' => 'string', - 'example' => 'xx', + 'Alias' => [ + 'title' => '', + 'description' => 'Alias ', + 'type' => 'array', + 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '那个人', 'title' => ''], + 'example' => '', + ], + 'SupportAudition' => ['title' => '', 'description' => 'Whether audition is supported ', 'type' => 'boolean', 'example' => 'false'], + 'ContentType' => ['title' => '', 'description' => 'Content type ', 'type' => 'string', 'example' => 'MUSIC_CONTENT'], + 'Singers' => ['title' => '', 'description' => 'Singer name ', 'type' => 'string', 'example' => '黎偌天'], + 'AlbumRawId' => ['title' => '', 'description' => 'Album ID ', 'type' => 'string', 'example' => '1795716629'], + 'Album' => ['title' => '', 'description' => 'Whether it is an album ', 'type' => 'boolean', 'example' => 'false'], + 'AlbumType' => ['title' => '', 'description' => 'Album type ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'AuthorIds' => [ + 'title' => '', + 'description' => 'Author ID ', + 'type' => 'array', + 'items' => ['description' => 'Author ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1795716629', 'title' => ''], + 'example' => '', + ], + 'IsAudition' => ['title' => '', 'description' => 'Whether audition is available', 'type' => 'boolean', 'example' => 'false'], + 'AuthorNames' => [ + 'title' => '', + 'description' => 'Author names ', + 'type' => 'array', + 'items' => ['description' => 'Author name ', 'type' => 'string', 'example' => '"王一鸣Iris", "黎偌天", "薛晨雨"', 'title' => ''], + 'example' => '', ], + 'NeedCharge' => ['title' => '', 'description' => 'Whether charging is required ', 'type' => 'boolean', 'example' => 'false'], + 'IsCharge' => ['title' => '', 'description' => 'Is charged', 'type' => 'string', 'example' => 'false'], + 'Category' => ['title' => '', 'description' => 'Category', 'type' => 'string', 'example' => 'audio'], + 'RawId' => ['title' => '', 'description' => 'Third-party content ID ', 'type' => 'string', 'example' => '1795716629'], ], + 'title' => '', + 'example' => '', ], + 'example' => '{"sourceId":0,"copyright":0,"releaseTime":1196438400000,"hotScore":0.9546929544543479,"tppExtendInfo":"{\\"userEvent\\":\\"前台投放\\",\\"scgTopicName\\":\\"inside民族中国风曲风音乐库\\",\\"scgTopicId\\":\\"MC201132\\"}","source":"xiami","title":"题帕三绝","type":"music","x1Pv30d":10307,"valid":10,"cover":{"img":"http://img.xiami.net/qianxun/07d8ec1a38a5462c3afbfac41413b8af/47244c25fcf3a8f67442d02e3127d023-500x432.jpg","canResize":false},"duration":0,"rawId":"1771626071","albumType":0,"alias":["题帕三绝"],"id":268033175,"supportAudition":false,"contentType":"MUSIC_CONTENT","authorIds":[],"singers":"陈力","albumRawId":"1771626071","album":false,"x1PvTotal":14676,"commCateId":80021001,"finished":0,"isAudition":false,"appIds":[],"authorNames":["陈力","王立平","曹雪芹"],"needCharge":false,"isCharge":false,"category":"audio"}', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\"\\n }\\n ],\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMusicTypeResponse>\\n <Code>200</Code>\\n <Message>设备账号未关联</Message>\\n <Result>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx</MusicTypeName>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</QueryMusicTypeResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"xiami\\",\\n \\"Title\\": \\"那个人\\",\\n \\"Type\\": \\"music\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"canResize\\": false,\\n \\"Large\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Medium\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Small\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\"\\n },\\n \\"Alias\\": [\\n \\"那个人\\"\\n ],\\n \\"SupportAudition\\": false,\\n \\"ContentType\\": \\"MUSIC_CONTENT\\",\\n \\"Singers\\": \\"黎偌天\\",\\n \\"AlbumRawId\\": \\"1795716629\\",\\n \\"Album\\": false,\\n \\"AlbumType\\": 0,\\n \\"AuthorIds\\": [\\n 1795716629\\n ],\\n \\"IsAudition\\": false,\\n \\"AuthorNames\\": [\\n \\"\\\\\\"王一鸣Iris\\\\\\", \\\\\\"黎偌天\\\\\\", \\\\\\"薛晨雨\\\\\\"\\"\\n ],\\n \\"NeedCharge\\": false,\\n \\"IsCharge\\": \\"false\\",\\n \\"Category\\": \\"audio\\",\\n \\"RawId\\": \\"1795716629\\"\\n }\\n ],\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => 'Query content in a selection pool by selection pool ID', + 'changeSet' => [], ], - 'UpdateAlarm' => [ - 'summary' => '更新闹钟', - 'path' => '/v1.0/ssp/updateAlarm', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'SearchContent' => [ + 'summary' => 'Search according to specific search criteria. ', + 'path' => '/v1.0/ssp/SearchContent', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', + 'name' => 'Request', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'description' => 'Request Parameters ', 'type' => 'object', 'properties' => [ - 'ScheduleInfo' => [ - 'title' => '调度信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '调度类型/循环类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'WEEKLY', - 'enum' => [ - 'ONCE', - 'WEEKLY', - 'STATUTORY_WORKING_DAY', - ], - ], - 'Once' => [ - 'title' => '单次', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'title' => '触发时间：年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2022', - ], - 'Month' => [ - 'title' => '触发时间：月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8', - ], - 'Day' => [ - 'title' => '触发时间：日', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'Weekly' => [ - 'title' => '周循环', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'title' => '周几触发集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'StatutoryWorkingDay' => [ - 'title' => '法定工作日', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Hour' => [ - 'title' => '触发时间：时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Minute' => [ - 'title' => '触发时间：分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], - 'MusicInfo' => [ - 'title' => '音乐信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MusicType' => [ - 'title' => '音乐类别id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12', - ], - 'MusicTypeName' => [ - 'title' => '音乐类别名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'MusicId' => [ - 'title' => '音乐id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - 'MusicName' => [ - 'title' => '音乐名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'MusicUrl' => [ - 'title' => '音乐url', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://music-url.mp3', - ], - ], - 'required' => true, - ], - 'AlarmId' => [ - 'title' => '闹钟id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567', - ], - 'Volume' => [ - 'title' => '音量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - 'default' => '40', - ], - 'RequestId' => [ - 'type' => 'string', - 'required' => true, - ], - 'UserId' => [ - 'type' => 'string', - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方', - 'type' => 'string', - 'required' => true, - ], - 'DeviceId' => [ - 'type' => 'string', - 'required' => true, - ], + 'Query' => ['description' => 'Query keyword ', 'type' => 'string', 'required' => false, 'example' => '周杰伦', 'title' => ''], + 'Cate' => ['description' => 'The search scope: music or audio. '."\n" + .'Input parameter enumeration: music | program ', 'type' => 'string', 'required' => false, 'example' => 'music', 'title' => ''], + 'SubCate' => ['description' => 'When `cate` is `music`, `subCate` can be omitted. '."\n" + .'If `subCate` is provided, it can be one of the following: '."\n" + .'`song` (Song), `singer` (Artist), `album` (Album). '."\n" + ."\n" + .'When `cate` is `program`, `subCate` can be omitted. '."\n" + .'If `subCate` is provided, it can be one of the following: '."\n" + .'`album` (Album), `audio` (Program Audio), `radio` (Radio Station).'."\n", 'type' => 'string', 'required' => false, 'example' => 'singer', 'title' => ''], + 'QueryAlbum' => ['description' => 'Whether to query albums ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'PageNum' => ['description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'UserInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', + 'description' => 'User identification information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" + ."\n" + .'When the encoding type is SKILL_ID, the value is the Skill ID of the application. '."\n" + .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. '."\n" + .'`SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'User identifier, set to either `userOpenId` or `userUnionId`.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], + 'IdType' => ['description' => 'The Type of the User ID.'."\n" + ."\n" + .'OPEN_ID: The default User ID identity. '."\n" + .'UNION_ID: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skills Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when `IdType` is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'DeviceInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'OPEN_ID', - 'enum' => [ - 'OPEN_ID', - 'UNION_ID', - ], - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PACKAGE_NAME', - 'enum' => [ - 'PACKAGE_NAME', - 'SKILL_ID', - ], - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. '."\n" + ."\n" + .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. '."\n" + .'When the encoding type is `PACKAGE_NAME`, the value is the `packageName` of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], + 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" + ."\n" + .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. '."\n" + .'`SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], + 'Id' => ['description' => 'Device ID, set to either `deviceOpenId` or `deviceUnionId`.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej=', 'title' => ''], + 'IdType' => ['description' => 'Type of device ID. '."\n" + ."\n" + .'`OPEN_ID`: Default device ID identity. '."\n" + .'`UNION_ID`: Organization-dimension device ID identity. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID. Required when `IdType` is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult', - 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'], + 'Code' => ['description' => 'code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'message information ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43***28C-A810-5***-8747-EC226A086881', + 'description' => 'return information ', + 'type' => 'array', + 'items' => [ + 'description' => 'return information ', + 'type' => 'object', + 'properties' => [ + 'Alias' => [ + 'description' => 'Alias ', + 'type' => 'array', + 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Audition' => ['description' => 'Is audition available ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Authors' => [ + 'description' => 'Authors of the content ', + 'type' => 'array', + 'items' => [ + 'description' => 'Author information ', + 'type' => 'object', + 'properties' => [ + 'AuthorTypes' => [ + 'description' => 'Author type', + 'type' => 'array', + 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Cover' => [ + 'description' => 'Profile picture ', + 'type' => 'object', + 'properties' => [ + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], + 'RawId' => ['description' => 'Third-party author ID ', 'type' => 'string', 'example' => '123123', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Id' => ['description' => 'Author primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], + 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Category' => ['description' => 'Transform controlType based on the associated public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], + 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'fasle', 'title' => ''], + 'CommCateId' => ['description' => 'The corresponding category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], + 'Cover' => [ + 'description' => 'Album thumbnail image ', + 'type' => 'object', + 'properties' => [ + 'CanResize' => ['description' => 'Indicates whether OSS rules can be used to crop the image ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], + 'HotScore' => ['description' => 'Popularity score ', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'Id' => ['description' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], + 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], + 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], + 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], + 'Type' => ['description' => 'Transform favoriteType based on the associated public category ', 'type' => 'string', 'example' => 'program', 'title' => ''], + 'Valid' => ['description' => 'Indicates whether the item is playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], + 'Duration' => ['description' => 'Duration information', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'title' => ''], + 'AlbumId' => ['description' => 'The corresponding album ID ', 'type' => 'string', 'example' => '13123', 'title' => ''], + 'Lyric' => ['description' => 'Lyric information ', 'type' => 'string', 'example' => 'http://a1231.lrc', 'title' => ''], + 'OrderIndex' => ['description' => 'Content sorting value', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Styles' => [ + 'description' => 'Music styles ', + 'type' => 'array', + 'items' => ['description' => 'Music style ', 'type' => 'string', 'example' => '1231', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlarmResponse>\\n <Code>200</Code>\\n <Message>xx为空</Message>\\n <Result>true</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</UpdateAlarmResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": true,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"13123\\",\\n \\"Lyric\\": \\"http://a1231.lrc\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Styles\\": [\\n \\"1231\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Search by specific search criteria ', + 'changeSet' => [], ], - 'CreateScheduleTask' => [ - 'summary' => '创建定时任务', - 'path' => '/v1.0/ssp/CreateScheduleTask', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SendMessage' => [ + 'summary' => 'Send a message.', + 'path' => '/v1.0/ssp/sendMessage', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'IdempotentId' => [ - 'title' => '幂等id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - ], - 'UserId' => [ - 'title' => '用户id', - 'type' => 'string', - ], - 'RequestId' => [ - 'title' => '请求id', - 'type' => 'string', - ], - 'ScheduleDTO' => [ - 'title' => '调度信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ScheduleType' => [ - 'title' => '调度类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ONCE', - 'enum' => [ - 'ONCE', - 'WEEKLY', - 'STATUTORY_DAY', - ], - ], - 'Once' => [ - 'title' => '单次调度配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Year' => [ - 'title' => '触发年', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2022', - ], - 'Month' => [ - 'title' => '触发月', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], - 'Day' => [ - 'title' => '触发日', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '26', - ], - 'Hour' => [ - 'title' => '触发时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], - 'Minute' => [ - 'title' => '触发分', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - 'Weekly' => [ - 'title' => '循环调度配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DaysOfWeek' => [ - 'title' => '触发星期，1-7分别代表周一到周日', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], - 'required' => false, - ], - 'Hours' => [ - 'title' => '触发时', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], - 'required' => false, - ], - 'Minutes' => [ - 'title' => '触发分', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'StatutoryWorkingDay' => [ - 'title' => '法定工作日调度配置', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Hours' => [ - 'title' => '触发时，可多选', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], - 'required' => false, - ], - 'Minutes' => [ - 'title' => '触发分，可多选', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'ScheduleStartTime' => [ - 'title' => '调度开始时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1656318855000', - ], - 'ScheduleEndTime' => [ - 'title' => '调度结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1661589255000', - ], - ], - 'required' => true, - ], - 'ActionDTOs' => [ - 'title' => '调度行动参数', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'customAction' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{"k1":"v1","k2":{"key":1}}', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'AccessKeyId' => [ - 'title' => '调用方ak', - 'type' => 'string', - ], - ], - 'required' => true, - ], + 'name' => 'Url', + 'in' => 'query', + 'schema' => ['description' => 'Message URL', 'type' => 'string', 'required' => false, 'example' => 'http://xx', 'title' => ''], ], [ 'name' => 'UserInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Maojing, and each method corresponds to a different encoding type: - PACKAGENAME: APK package name, used for Android application customer links - SKILLID: Skill ID, used for cloud-based links', 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], + 'title' => '', ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'DeviceInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], + 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the application\'s Skill ID. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123L', 'title' => ''], 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', + 'description' => 'Type of User ID: - OPENID: default User ID identity - UNIONID: organization-dimension User ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], + 'title' => '', ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], + 'Id' => ['description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => '123L', 'title' => ''], + 'OrganizationId' => ['description' => 'Organization ID; required when IdType is UNION_ID', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult<Long>', - 'description' => 'AmpResult<Long>', + 'title' => 'Schema of Response', + 'description' => 'Return Result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Result' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F7E2****B7C94', - ], + 'Message' => ['title' => 'Id of the request', 'description' => 'Error message; if present, the send operation failed', 'type' => 'string', 'example' => '外部userId映射关系不存在'], + 'Code' => ['description' => 'Status code returned by the service; "SUCCESS" indicates success, otherwise it indicates failure', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Result' => ['description' => 'Message sending result', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <Result>1234567</Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</CreateScheduleTaskResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Send Message', + 'changeSet' => [], ], - 'DeleteScheduleTask' => [ - 'summary' => '删除定时任务', - 'path' => '/v1.0/ssp/DeleteScheduleTask', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'SetDeviceSetting' => [ + 'summary' => 'Modify the user settings of a device.', + 'path' => '/v1.0/ssp/setDeviceSetting', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', + 'name' => 'Key', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '待删除的调度id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567', - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - ], - 'RequestId' => [ - 'title' => '请求id', - 'type' => 'string', - ], - 'UserId' => [ - 'title' => '用户id', - 'type' => 'string', - ], - 'AccessKeyId' => [ - 'title' => '调用方ak', - 'type' => 'string', - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'The collection of keys specified for device settings: '."\n" + .'Do Not Disturb mode: nightMode', 'type' => 'string', 'required' => true, 'example' => 'nightMode'], ], [ - 'name' => 'UserInfo', + 'name' => 'Value', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Attribute Value', 'type' => 'any', 'required' => false, 'example' => '{"enable":true}'], ], [ 'name' => 'DeviceInfo', - 'in' => 'formData', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', + 'description' => 'List of user identifier information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', + 'title' => '', + 'description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'PROJECT_ID', + 'enum' => ['PROJECT_ID'], ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can view it in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], + 'IdType' => [ + 'title' => '', + 'description' => 'The type of Device ID: '."\n" + .'OPEN_ID: The default device identity. '."\n" + .'UNION_ID: The organization-dimension device identity. You must request an organization in advance on the Open Platform.', 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult<Boolean>', - 'description' => 'AmpResult<Boolean>', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Result' => [ - 'title' => '删除结果', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'F7E2****B7C94', - ], + 'Message' => ['title' => '', 'description' => 'Return result of invoking this API.', 'type' => 'string', 'example' => 'success'], + 'Code' => ['title' => '', 'description' => 'Error code returned. A value of 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['title' => '', 'description' => 'Execution result of the settings.', 'type' => 'boolean', 'example' => ''], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <Result>true</Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</DeleteScheduleTaskResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": false,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Modify the user settings of a device', + 'changeSet' => [], ], - 'GetScheduleTask' => [ - 'summary' => '查询定时任务', - 'path' => '/v1.0/ssp/GetScheduleTask', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'ThirdImmediateMsgPush' => [ + 'summary' => 'Third-party real-time information data change event push ', + 'path' => '/v1.0/ssp/thirdImmediateMsgPush', + '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', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Payload', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '待查询的调度id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567', - ], - 'RequestId' => [ - 'title' => '请求id', - 'type' => 'string', - 'required' => false, - ], - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => false, - ], - 'UserId' => [ - 'title' => '用户id', - 'type' => 'string', - 'required' => false, - ], - 'AccessKeyId' => [ - 'title' => '调用方ak', - 'type' => 'string', - ], - ], - 'required' => true, - ], + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => 'user ID ', 'title' => 'user ID ', 'type' => 'string', 'example' => 'userId', 'required' => false], ], [ - 'name' => 'UserInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => ['description' => 'Order ID', 'title' => 'Order ID', 'type' => 'string', 'example' => 'orderId', 'required' => false], ], [ - 'name' => 'DeviceInfo', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], - 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12**45', - ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1**2', - ], - ], - 'required' => true, - ], + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'Request source', 'title' => 'Request source', 'type' => 'string', 'example' => 'source', 'required' => false], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => 'Business type (FLIGHT: flight, TRAIN: train)', 'title' => 'Business type (FLIGHT: flight, TRAIN: train)', 'type' => 'string', 'example' => 'FLIGHT', 'required' => false], + ], + [ + 'name' => 'TrafficChangeType', + 'in' => 'query', + 'schema' => ['description' => 'change type (TRAIN_ISSUED, FLIGHT_CHANGED) ', 'title' => 'change type (TRAIN_ISSUED, FLIGHT_CHANGED) ', 'type' => 'string', 'example' => 'TRAIN_ISSUED', 'required' => false], + ], + [ + 'name' => 'TrafficChangeTypeDesc', + 'in' => 'query', + 'schema' => ['description' => 'change type description (ticket issued, rebooked) ', 'title' => 'change type description (ticket issued, rebooked) ', 'type' => 'string', 'example' => '已出票', 'required' => false], + ], + [ + 'name' => 'ChangeDetail', + 'in' => 'query', + 'schema' => ['description' => 'Change details (JSON-formatted change data)', 'title' => 'Change details (JSON-formatted change data)', 'type' => 'string', 'example' => '{}', 'required' => false], + ], + [ + 'name' => 'TrafficJourneyIds', + 'in' => 'query', + 'schema' => ['description' => 'Journey IDs to change', 'title' => 'Journey IDs to change', 'type' => 'string', 'example' => 'trafficJourneyIds', 'required' => false], + ], + [ + 'name' => 'TrafficSubOrderIds', + 'in' => 'query', + 'schema' => ['description' => 'sub-order ID of the changed train request ', 'title' => 'sub-order ID of the changed train request ', 'type' => 'string', 'example' => 'trafficSubOrderIds', 'required' => false], + ], + [ + 'name' => 'PsgIds', + 'in' => 'query', + 'schema' => ['description' => 'Passenger IDs to change', 'title' => 'Passenger IDs to change', 'type' => 'string', 'example' => 'psgIds', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult<ScheduleOpenResponse>', - 'description' => 'AmpResult<ScheduleOpenResponse>', + 'description' => '', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'F7E21065-6C21-1158-A2F9-AEFE5CAB7C94', - ], - 'Result' => [ - 'title' => '服务响应出参', - 'description' => '', + 'Success' => ['description' => 'whether the invocation succeeded ', 'title' => 'whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], + 'ErrorCode' => ['description' => 'error code ', 'title' => 'error code ', 'type' => 'string', 'example' => '500000000'], + 'ErrorMsg' => ['description' => 'error message ', 'title' => 'error message ', 'type' => 'string', 'example' => '服务器内部异常'], + 'Model' => [ + 'description' => 'push result ', + 'title' => 'push result ', 'type' => 'object', 'properties' => [ - 'ScheduleId' => [ - 'title' => '调度id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'ScheduleType' => [ - 'title' => '调度类型', - 'description' => '', - 'type' => 'string', - 'example' => 'ONCE', - 'enum' => [ - 'ONCE', - 'WEEKLY', - 'STATUTORY_DAY', - ], - ], - 'Cron' => [ - 'title' => '触发cron表达式', - 'description' => '', - 'type' => 'string', - 'example' => '0 10 20 30 6 ? 2022', - ], - 'ScheduleStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1656577473000', - ], - 'ScheduleEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1659169473000', - ], - 'ActionTopicList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CustomAction' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{"k1":"v1","k2":{"key":1}}', - ], - ], - ], - ], + 'RequestId' => ['description' => 'request ID ', 'title' => 'request ID ', 'type' => 'string', 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B'], + 'Success' => ['description' => 'whether the push succeeded ', 'title' => 'whether the push succeeded ', 'type' => 'boolean', 'example' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"RequestId\\": \\"F7E21065-6C21-1158-A2F9-AEFE5CAB7C94\\",\\n \\"Result\\": {\\n \\"ScheduleId\\": 1234567,\\n \\"ScheduleType\\": \\"ONCE\\",\\n \\"Cron\\": \\"0 10 20 30 6 ? 2022\\",\\n \\"ScheduleStartTime\\": \\"1656577473000\\",\\n \\"ScheduleEndTime\\": \\"1659169473000\\",\\n \\"ActionTopicList\\": [\\n {\\n \\"CustomAction\\": {\\n \\"k1\\": \\"v1\\",\\n \\"k2\\": {\\n \\"key\\": 1\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <RequestId>F7E21065-6C21-1158-A2F9-AEFE5CAB7C94</RequestId>\\n <Result>\\n <Uuid>362*****8C1</Uuid>\\n <ScheduleId>1234567</ScheduleId>\\n <ScheduleType>ONCE</ScheduleType>\\n <Cron>0 10 20 30 6 ? 2022</Cron>\\n <ScheduleStartTime>1656577473000</ScheduleStartTime>\\n <ScheduleEndTime>1659169473000</ScheduleEndTime>\\n <ActionTopicList/>\\n </Result>\\n</GetScheduleTaskResponse>","errorExample":""}]', - ], - 'GetWeather' => [ - 'summary' => '查询天气', - 'path' => '/v1.0/ssp/GetWeather', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Third-party real-time information data change event push ', + 'changeSet' => [ + ['createdAt' => '2025-09-01T09:51:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-01T02:40:36.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-09-01T02:40:31.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-09-01T02:36:01.000Z', 'description' => 'OpenAPI offline'], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": false,\\n \\"ErrorCode\\": \\"500000000\\",\\n \\"ErrorMsg\\": \\"服务器内部异常\\",\\n \\"Model\\": {\\n \\"RequestId\\": \\"2DF6FEFE-3301-16DD-ABCC-968A9524920B\\",\\n \\"Success\\": false\\n }\\n}","type":"json"}]', + ], + 'UnbindAligenieUser' => [ + 'summary' => 'Detach the relationship between a third-party account and a Tmall Genie account by using a logon credential.'."\n", + 'path' => '/v1.0/ssp/unbindAligenieUser', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Payload', + 'name' => 'LoginStateAccessToken', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'Logon credential', 'type' => 'string', 'required' => true, 'example' => '99ce8a70c23a94f8569e1a525bef6e85'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '服务请求入参', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DeviceId' => [ - 'title' => '设备id', - 'type' => 'string', - 'required' => false, - ], - 'UserId' => [ - 'title' => '用户id', - 'type' => 'string', - 'required' => false, - ], - 'RequestId' => [ - 'title' => '请求id', - 'type' => 'string', - 'required' => false, - ], - 'AccessKeyId' => [ - 'title' => '调用方ak', - 'type' => 'string', - 'required' => false, - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], + 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded', 'type' => 'boolean', 'example' => ''], ], - 'required' => false, - 'docRequired' => false, + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Detach the relationship between a third-party account and a Tmall Genie account', + 'description' => 'Note: When the logon credential expires, the integrator must initiate the authorization logon flow again to obtain a new logon credential (entry service API: AuthLoginWithThirdUserInfo).'."\n" + ."\n" + .'- Invoke the service API with the logon credential (LoginStateAccessToken) parameter via the Java software development kit (SDK). For SDKs in other languages, consult Tmall Genie developers during integration. '."\n" + .'If the API call throws a TeaException and TeaException.code is "InvalidAuthentication", the logon credential has expired.'."\n" + ."\n" + .'- Invoke the service API by sending an HTTP request with the logon credential (LoginStateAccessToken) parameter. '."\n" + .'If the HTTP response status code returned by the API call is 400, the logon credential has expired.'."\n", + 'changeSet' => [], + ], + 'UnbindDevice' => [ + 'summary' => 'Detach the binding relationship based on the user\'s open information and the device\'s open information. ', + 'path' => '/v1.0/ssp/unbindDevice', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'UserInfo', + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '用户标识信息', - 'description' => '', - 'type' => 'object', + 'description' => 'List of device identity information. ', 'properties' => [ - 'Id' => [ - 'title' => '用户标识（userOpenId或userUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HOFF****my7Iw=', - ], - 'IdType' => [ - 'title' => '用户Id的类型-OPEN_ID：默认的用户ID标识-UNION_ID:组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, + 'description' => 'Encoding type. Set this parameter to **PROJECT_ID**. ', 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', + 'required' => true, + 'title' => '', 'type' => 'string', - 'required' => false, - 'example' => '12**45', + 'enum' => ['PROJECT_ID'], ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type, which is the Project ID of the project where the product resides. You can view it in the Tmall Genie AI platform console. ', 'example' => '12**45', 'required' => true, 'title' => '', 'type' => 'string'], + 'IdType' => [ + 'description' => 'The type of Device ID. '."\n" + .'- OPEN_ID: The default device ID identity. '."\n" + .'- UNION_ID: The organization-dimension device ID identity. You must request an organization in advance on the Open Platform. '."\n", + 'example' => 'OPEN_ID', + 'required' => true, + 'title' => '', 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['description' => 'Device identifier. Enter the value of deviceOpenId or deviceUnionId. ', 'example' => 'DAFE****ce3ej=', 'required' => true, 'title' => '', 'type' => 'string'], + 'OrganizationId' => ['description' => 'Organization ID. This parameter is required if IdType is set to UNION_ID. ', 'example' => '1**2', 'required' => false, 'title' => '', 'type' => 'string'], ], 'required' => true, + 'title' => '', + 'type' => 'object', + 'example' => '', ], ], [ - 'name' => 'DeviceInfo', + 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '设备标识信息', - 'description' => '', - 'type' => 'object', + 'description' => 'List of user identifier information. '."\n", 'properties' => [ - 'Id' => [ - 'title' => '设备标识（deviceOpenId或deviceUnionId）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DAFE****ce3ej=', - ], - 'IdType' => [ - 'title' => '设备Id的类型-OPEN_ID：默认的设备ID标识-UNION_ID:组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OPEN_ID', - ], 'EncodeType' => [ - 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型-PACKAGE_NAME：apk包名，Android应用客户链路的编码类型-SKILL_ID：技能ID，云端链路的编码类型', - 'description' => '', - 'type' => 'string', - 'required' => false, + 'description' => 'Encoding type. Enter **PROJECT_ID** here. '."\n", 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的SkillID；编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', - 'description' => '', + 'required' => true, + 'title' => '', 'type' => 'string', - 'required' => false, - 'example' => '12**45', + 'enum' => ['PROJECT_ID'], ], - 'OrganizationId' => [ - 'title' => '组织ID，如果IdType为UNION_ID时必填', - 'description' => '', + 'EncodeKey' => ['description' => 'The value corresponding to the encoding type, which is the Project ID of the project where this product resides. You can view it in the Tmall Genie AI Platform console. '."\n", 'example' => '12**45', 'required' => true, 'title' => '', 'type' => 'string'], + 'IdType' => [ + 'description' => 'The type of User ID: '."\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. '."\n", + 'example' => 'OPEN_ID', + 'required' => true, + 'title' => '', 'type' => 'string', - 'required' => false, - 'example' => '1**2', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], + 'Id' => ['description' => 'User identifier. Enter the value of userOpenId or userUnionId. '."\n", 'example' => 'HOFF****my7Iw=', 'required' => true, 'title' => '', 'type' => 'string'], + 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID. '."\n", 'example' => '1**2', 'required' => false, 'title' => '', 'type' => 'string'], ], 'required' => true, + 'title' => '', + 'type' => 'object', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AmpResult<WeatherResponse>', - 'description' => 'AmpResult<WeatherResponse>', - 'type' => 'object', + 'description' => 'Returns a data list. ', 'properties' => [ - 'Message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Code' => [ - 'title' => 'HttpCode', - 'description' => 'HttpCode', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '模型数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CurrentMeteorology' => [ - 'title' => '当前天气', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Weather' => [ - 'title' => '白天天气', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '天气编号: 形如："000,100"', - 'description' => '', - 'type' => 'string', - 'example' => '000', - ], - 'Name' => [ - 'title' => '天气名称描述: "晴(000),多云(100)"', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Temperature' => [ - 'title' => '温度', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Current' => [ - 'title' => '当前温度气温值', - 'description' => '', - 'type' => 'string', - 'example' => '36', - ], - 'CurrentDesc' => [ - 'title' => '当前温度气温值描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'High' => [ - 'title' => '气温最高值', - 'description' => '', - 'type' => 'string', - 'example' => '37', - ], - 'HighDesc' => [ - 'title' => '气温最高值描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Low' => [ - 'title' => '气温最低值', - 'description' => '', - 'type' => 'string', - 'example' => '28', - ], - 'LowDesc' => [ - 'title' => '气温最低值描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Logical' => [ - 'title' => '带有逻辑的温度,逻辑如下:', - 'description' => '', - 'type' => 'string', - 'example' => '41', - ], - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F7E2****B7C94', - ], + 'Message' => ['description' => 'The return result of invoking this API. ', 'example' => 'success', 'title' => '', 'type' => 'string'], + 'Code' => ['description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'example' => '200', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Result' => ['description' => 'Indicates whether the device was detached successfully. ', 'example' => 'true', 'title' => '', 'type' => 'boolean'], + 'RequestId' => ['description' => 'The request ID. ', 'example' => '0EC7*726E', 'title' => '', 'type' => 'string'], ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"调用成功\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"CurrentMeteorology\\": {\\n \\"Weather\\": {\\n \\"Code\\": \\"000\\",\\n \\"Name\\": \\"晴\\"\\n },\\n \\"Temperature\\": {\\n \\"Current\\": \\"36\\",\\n \\"CurrentDesc\\": \\"36度\\",\\n \\"High\\": \\"37\\",\\n \\"HighDesc\\": \\"37度\\",\\n \\"Low\\": \\"28\\",\\n \\"LowDesc\\": \\"28度\\",\\n \\"Logical\\": \\"41\\"\\n }\\n }\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<GetWeatherResponse>\\n <Message>调用成功</Message>\\n <Code>200</Code>\\n <Result>\\n <CurrentMeteorology>\\n <Weather>\\n <Code>000</Code>\\n <Name>晴</Name>\\n </Weather>\\n <Temperature>\\n <Current>36</Current>\\n <CurrentDesc>36度</CurrentDesc>\\n <High>37</High>\\n <HighDesc>37度</HighDesc>\\n <Low>28</Low>\\n <LowDesc>28度</LowDesc>\\n <Logical>41</Logical>\\n </Temperature>\\n </CurrentMeteorology>\\n </Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</GetWeatherResponse>","errorExample":""}]', - ], - 'CreatePlayingListOAuth2' => [ - 'summary' => '播放列表创建走OAuth2授权', - 'path' => '/v1.0/ssp/CreatePlayingListOAuth2', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'AliGenie.UnbindDevice.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + 'title' => 'Detach Device ', + 'changeSet' => [], + ], + 'UpdateAlarm' => [ + 'summary' => 'Update an alarm, including its trigger time, loop type, and music. ', + 'path' => '/v1.0/ssp/updateAlarm', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ - 'OAuth 2.0 Bearer Token' => [], + 'AliGenie_Auth_SPI' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenCreatePlayingListRequest', + 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ - 'PlayFrom' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'ContentType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'content', - ], - 'ContentList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RawId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', + 'ScheduleInfo' => [ + 'title' => '', + 'description' => 'Schedule information ', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'Schedule Type / Loop Type: '."\n" + .'ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORY_WORKING_DAY -> Statutory working day ', + 'type' => 'string', + 'required' => true, + 'example' => 'WEEKLY', + 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], + ], + 'Once' => [ + 'title' => '', + 'description' => 'One-time: This property is active when the loop type is ONCE. ', + 'type' => 'object', + 'properties' => [ + 'Year' => ['title' => '', 'description' => 'Trigger time: Year ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'], + 'Month' => ['title' => '', 'description' => 'Trigger time: Month ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'], + 'Day' => ['title' => '', 'description' => 'Trigger time: day', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xiami', + 'required' => false, + 'example' => '', + ], + 'Weekly' => [ + 'title' => '', + 'description' => 'Weekly loop: This property is active when the loop Type is WEEKLY.', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'title' => '', + 'description' => 'Collection of days of the week to trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week (1 for Monday, 2 for Tuesday, etc.). To trigger every day, include all values from 1 to 7.', + 'type' => 'array', + 'items' => ['description' => 'Monday', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], + 'required' => false, + 'example' => '', + ], + 'StatutoryWorkingDay' => [ + 'title' => '', + 'description' => 'Statutory Working Day: This property is active when the loop Type is STATUTORY_WORKING_DAY. ', + 'type' => 'object', + 'properties' => [ + 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + 'required' => false, + 'example' => '', ], - 'required' => true, ], 'required' => true, + 'example' => '', ], - 'Index' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'NeedAlbumContinued' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'PlayMode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Repeat', - ], - 'ExtendInfo' => [ - 'description' => '', + 'MusicInfo' => [ + 'title' => '', + 'description' => 'Ringtone information', 'type' => 'object', - 'required' => false, + 'properties' => [ + 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12'], + 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'], + 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + 'MusicName' => ['title' => '', 'description' => 'Ringtone name', 'type' => 'string', 'required' => true, 'example' => 'xx铃声'], + 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'required' => false, 'example' => 'http://music-url.mp3'], + ], + 'required' => true, + 'example' => '', ], + 'AlarmId' => ['title' => '', 'description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'], + 'Volume' => ['title' => '', 'description' => 'Ringtone volume', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'default' => '40'], + 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, + 'example' => '', ], ], [ - 'name' => 'DeviceInfo', - 'in' => 'query', + 'name' => 'UserInfo', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'User Identifier Information ', 'type' => 'object', 'properties' => [ - 'EncodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PROJECT_ID', - ], - 'EncodeKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ - 'description' => '', + 'title' => '', + 'description' => 'Type of the User ID: - OPEN_ID: default User ID identifier - UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', - 'enum' => [ - 'UNION_ID', - 'OPEN_ID', - ], + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Id' => [ - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding Type: There are multiple ways to obtain the User Identifier for Maojing, and each method corresponds to a different encoding Type: '."\n" + .'- PACKAGE_NAME: APK package name, used for the Android application Customer link '."\n" + .'- SKILL_ID: Skill ID, used for the cloud link ', 'type' => 'string', 'required' => true, - 'example' => '123', - ], - 'OrganizationId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s Skill ID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'device identity information ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '调用返回码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'title' => '服务的实际返回结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RawId' => [ - 'title' => '三方id', - 'description' => '', - 'type' => 'string', - 'example' => '123123', - ], - 'Source' => [ - 'title' => '来源', - 'description' => '', - 'type' => 'string', - 'example' => 'qignting', - ], - 'AlbumRawId' => [ - 'title' => '三方专辑id', - 'description' => '', - 'type' => 'string', - 'example' => '260744', - ], - 'AlbumName' => [ - 'title' => '三方专辑名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Liked' => [ - 'title' => '是否收藏', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Singer' => [ - 'title' => '作者', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Title' => [ - 'title' => '标题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Cover' => [ - 'title' => '封面图片对象', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Img' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Large' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Mediam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Medium' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'Small' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', - ], - 'CanResize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'PlayMode' => [ - 'title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', - 'description' => '', - 'type' => 'string', - 'example' => 'Repeat', - ], - 'AudioLength' => [ - 'title' => '长度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '190', - ], - 'Progress' => [ - 'title' => '歌曲播放进度', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '96.0', - ], - 'LyricUrl' => [ - 'title' => '歌词url', - 'description' => '', - 'type' => 'string', - 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', - ], - 'Copyright' => [ - 'title' => '版权字段升级为是否可播：0 可播, 1/2 不可播', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'program', - ], - 'ItemUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', - ], - 'DefaultPlayOrder' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Valid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VALID', - ], - 'Pos' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'Message' => [ - 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', + 'Id' => ['title' => '', 'description' => 'device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], + 'IdType' => [ + 'title' => '', + 'description' => 'Type of device ID: OPEN_ID: default device ID; UNION_ID: organization-dimension device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform. ', 'type' => 'string', - 'example' => '10002398812', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => ['OPEN_ID', 'UNION_ID'], ], - 'Success' => [ - 'description' => '', + 'EncodeType' => [ + 'title' => '', + 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link. ', 'type' => 'string', - 'example' => 'true', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], + 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the Skill ID of the application. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], + 'OrganizationId' => ['title' => '', 'description' => 'organization ID; required if IdType is UNION_ID ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qignting\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 96,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"program\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 1\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'ThirdImmediateMsgPush' => [ - 'summary' => '三方即时信息数据变更事件推送', - 'path' => '/v1.0/ssp/thirdImmediateMsgPush', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AliGenie_Auth_SPI' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'title' => '用户id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'userId', - ], - ], - [ - 'name' => 'OrderId', - 'in' => 'query', - 'schema' => [ - 'title' => '订单id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'orderId', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'title' => '请求来源', - 'type' => 'string', - 'example' => 'source', - ], - ], - [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'title' => '业务类型（FLIGHT：航班、TRAIN：火车）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FLIGHT', - ], - ], - [ - 'name' => 'TrafficChangeType', - 'in' => 'query', - 'schema' => [ - 'title' => '变动类型（TRAIN_ISSUED、FLIGHT_CHANGED）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficChangeType', - ], - ], - [ - 'name' => 'TrafficChangeTypeDesc', - 'in' => 'query', - 'schema' => [ - 'title' => '变动类型描述（已出票、已改签）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficChangeTypeDesc', - ], - ], - [ - 'name' => 'ChangeDetail', - 'in' => 'query', - 'schema' => [ - 'title' => '变动信息明细（变动数据json）', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'changeDetail', - ], - ], - [ - 'name' => 'TrafficJourneyIds', - 'in' => 'query', - 'schema' => [ - 'title' => '变更的行程id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficJourneyIds', - ], - ], - [ - 'name' => 'TrafficSubOrderIds', - 'in' => 'query', - 'schema' => [ - 'title' => '变更的火车申请单子订单id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trafficSubOrderIds', - ], - ], - [ - 'name' => 'PsgIds', - 'in' => 'query', - 'schema' => [ - 'title' => '变更的乘客id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'psgIds', + 'required' => true, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '', - 'description' => '', + 'title' => 'AmpResult', + 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '调用是否成功', - 'description' => '', - 'type' => 'boolean', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '500000000', - ], - 'ErrorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => '服务器内部异常', - ], - 'Model' => [ - 'title' => '推送结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B', - ], - 'Success' => [ - 'title' => '是否推送成功', - 'description' => '', - 'type' => 'boolean', - ], - ], - ], + 'Code' => ['description' => 'Status code returned by the alarm service ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'xx为空'], + 'Result' => ['description' => 'Indicates whether the update succeeded ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"500000000\\",\\n \\"ErrorMsg\\": \\"服务器内部异常\\",\\n \\"Model\\": {\\n \\"RequestId\\": \\"2DF6FEFE-3301-16DD-ABCC-968A9524920B\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', + 'title' => 'Update Alarm ', + 'responseParamsDescription' => 'The operation is successful only if the status code returned by the service is 200; otherwise, it indicates failure. ', + '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' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ThirdImmediateMsgPush'], + ], + 'createdAt' => '2025-09-01T09:51:37.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'openapi.aligenie.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ThirdImmediateMsgPush'], + ['description' => 'OpenAPI offline', 'api' => 'ThirdImmediateMsgPush'], + ], + 'createdAt' => '2025-09-01T02:40:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ThirdImmediateMsgPush'], + ], + 'createdAt' => '2025-09-01T02:36:01.000Z', + 'description' => '', ], ], ]; |