diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/aligenie | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/aligenie')
| -rw-r--r-- | data/en_us/aligenie/aiso_1.0/api-docs.php | 129 | ||||
| -rw-r--r-- | data/en_us/aligenie/iap_1.0/api-docs.php | 4179 | ||||
| -rw-r--r-- | data/en_us/aligenie/ip_1.0/api-docs.php | 16375 | ||||
| -rw-r--r-- | data/en_us/aligenie/oauth2_1.0/api-docs.php | 1130 | ||||
| -rw-r--r-- | data/en_us/aligenie/ssp_1.0/api-docs.php | 16132 |
5 files changed, 37945 insertions, 0 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 new file mode 100644 index 0000000..dd7f054 --- /dev/null +++ b/data/en_us/aligenie/aiso_1.0/api-docs.php @@ -0,0 +1,129 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'AliGenie', + 'product' => 'AliGenie', + 'version' => 'aiso_1.0', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'AppAuth', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AppAuth' => [ + 'path' => '/v1.0/aiso/AppAuth', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AccessKey', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ak', + 'type' => 'string', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用id', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<AuthTokenDTO>', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + 'Message' => [ + 'type' => 'string', + ], + 'ExtendInfo' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + ], + 'endpoints' => [ + [ + '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 new file mode 100644 index 0000000..d0f2c45 --- /dev/null +++ b/data/en_us/aligenie/iap_1.0/api-docs.php @@ -0,0 +1,4179 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'AliGenie', + 'product' => 'AliGenie', + 'version' => 'iap_1.0', + ], + 'directories' => [ + [ + 'id' => 167271, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetBusAppConfig', + 'AppUseTimeReport', + 'PullCashier', + 'VideoAppReport', + 'GetAccountForApp', + ], + ], + [ + 'id' => 95708, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetPhoneNumber', + ], + ], + [ + 'id' => 95710, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateReminder', + 'GetReminder', + 'ListReminders', + 'UpdateReminder', + 'DeleteReminder', + ], + ], + [ + 'id' => 95716, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'WakeUpApp', + ], + ], + [ + 'id' => 95719, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PushNotifications', + 'SendNotifications', + ], + ], + [ + 'id' => 263437, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CheckThirdRightSendPlan', + 'CallBackThirdRightSendPlan', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'ThirdImmediateMsgPush', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetBusAppConfig' => [ + 'summary' => '获取应用配置', + 'path' => '/v1.0/iap/app/config/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '业务参数', + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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' => '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', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + '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' => '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + '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"}]', + ], + 'AppUseTimeReport' => [ + 'summary' => '应用使用时长上报', + 'path' => '/v1.0/iap/vip/use/time/report', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + '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' => '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' => 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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '500', + 'errorMessage' => '内部服务错误_xxx', + ], + ], + ], + '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":""}]', + ], + 'PullCashier' => [ + 'summary' => '拉取收银台', + 'path' => '/v1.0/iap/pull/cashier/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + ], + 'DeviceId' => [ + 'type' => 'string', + 'required' => false, + ], + 'originUuid' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '731D5F********DC3B', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'title' => '错误吗', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RetValue' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'VideoAppReport' => [ + 'summary' => '视频类应用会员信息上报', + 'path' => '/v1.0/iap/vip/use/video/report', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + [ + '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' => 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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetAccountForApp' => [ + 'summary' => '获取会员信息', + 'path' => '/v1.0/iap/vip/account/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RetValue' => [ + 'title' => '用户信息', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '500', + 'errorMessage' => '内部服务错误_xx', + ], + [ + 'errorCode' => '10000', + 'errorMessage' => '猫精用户已更换手机号，请重登', + ], + ], + ], + '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":""}]', + ], + 'GetPhoneNumber' => [ + 'summary' => '用户手机号获取', + 'path' => '/v1.0/iap/profile/phoneNumber', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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' => 'query', + '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' => '返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'phoneNumber' => [ + 'title' => '用户手机号', + 'description' => '', + 'type' => 'string', + 'example' => '137****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', + 'errorMessage' => 'The user information does not exist.', + ], + [ + 'errorCode' => 'AliGenie.GetPhoneNumber.BizError', + 'errorMessage' => 'The user has no phoneNumber.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"phoneNumber\\": \\"137****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPhoneNumberResponse>\\n <phoneNumber>137****</phoneNumber>\\n</GetPhoneNumberResponse>","errorExample":""}]', + ], + 'CreateReminder' => [ + 'summary' => '创建提醒', + 'path' => '/v1.0/iap/reminder/create', + 'methods' => [ + 'post', + ], + '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' => [ + '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', + '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' => '', + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetReminder' => [ + 'summary' => '查询提醒', + 'path' => '/v1.0/iap/reminder/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + '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', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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' => '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', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + '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' => '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + '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' => '提醒信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RemindResponses' => [ + 'title' => '提醒信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '周三', + ], + 'RecurrenceRule' => [ + 'title' => '调度信息', + 'description' => '', + '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', + ], + 'DaysOfMonth' => [ + 'title' => '月的第几天 可用作月循环', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'DaysOfWeek' => [ + 'title' => '周循环字段，取值范围：1-7', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListReminders' => [ + 'summary' => '查询提醒列表', + 'path' => '/v1.0/iap/reminder/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + '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', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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' => 'query', + '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' => '', + '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' => '提醒信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RemindResponses' => [ + 'title' => '提醒信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '周三', + ], + 'RecurrenceRule' => [ + 'title' => '调度信息', + 'description' => '', + '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', + ], + 'DaysOfMonth' => [ + 'title' => '月的第几天 可用作月循环', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'DaysOfWeek' => [ + 'title' => '周循环字段，取值范围：1-7', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'DeleteReminder' => [ + 'summary' => '删除提醒', + 'path' => '/v1.0/iap/reminder/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + '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', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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' => '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', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + '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' => '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', + ], + ], + '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' => '参数错误。', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<WakeUpAppResponse/>","errorExample":""}]', + ], + 'PushNotifications' => [ + 'summary' => '猫精系统消息推送', + 'path' => '/v1.0/iap/notifications', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'NotificationUnicastRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '消息推送入参对象。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SendTarget' => [ + 'title' => '消息推送的目标信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TargetType' => [ + 'title' => '推送的目标类型，获取到对应设备或用户标识时的类型 - DEVICE_UNION_ID：设备unionId - DEVICE_OPEN_ID：设备openId - USER_UNION_ID：用户unionId - USER_OPEN_ID：用户openId', + 'description' => '', + '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=', + ], + ], + 'required' => true, + ], + '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' => '', + ], + 'example' => '{"nick":"张三"}', + ], + '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包名', + ], + 'OrganizationId' => [ + 'title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TenantInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '身份信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubjectId' => [ + 'title' => '猫精应用id，【开发者平台-技能应用】创建应用后得到的应用id', + 'type' => 'string', + 'example' => '20*****01', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<PushNotificationsResponse/>","errorExample":""}]', + ], + 'SendNotifications' => [ + 'summary' => '消息推送服务（普通版）', + 'path' => '/v1.0/iap/general/notifications', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'NotificationUnicastRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '消息推送入参对象。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SendTarget' => [ + 'title' => '消息推送的目标信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => [ + 'title' => '设备id', + 'type' => 'string', + 'required' => true, + ], + ], + 'required' => true, + ], + 'MessageTemplateId' => [ + 'title' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2iU81*****G9elJ', + ], + 'PlaceHolder' => [ + 'title' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => '', + ], + 'example' => '{"nick":"张三"}', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TenantInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '身份信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubjectId' => [ + 'title' => '猫精应用标识', + 'type' => 'string', + 'required' => true, + 'example' => '20********01', + ], + ], + 'required' => false, + ], + ], + [ + '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 => [], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<SendNotificationsResponse/>","errorExample":""}]', + ], + 'CheckThirdRightSendPlan' => [ + 'summary' => '商业化移动屏三方app领卡校验', + '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' => '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' => 'ExtendInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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' => '{}', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'CallBackThirdRightSendPlan' => [ + 'summary' => '三方领取回调接口', + 'path' => '/v1.0/iap/business/CallBackThirdRightSendPlan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + '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', + 'schema' => [ + 'title' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'ErrorMsg', + 'in' => 'query', + 'schema' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '领取异常', + ], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetValue\\": true,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetCode\\": \\"400\\",\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]', + ], + 'ThirdImmediateMsgPush' => [ + 'summary' => '三方即时信息数据变更事件推送', + 'path' => '/v1.0/iap/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' => '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 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'openapi.aligenie.com', + ], + ], +]; diff --git a/data/en_us/aligenie/ip_1.0/api-docs.php b/data/en_us/aligenie/ip_1.0/api-docs.php new file mode 100644 index 0000000..2729b8d --- /dev/null +++ b/data/en_us/aligenie/ip_1.0/api-docs.php @@ -0,0 +1,16375 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'AliGenie', + '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', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetRelationProductList' => [ + 'summary' => '关联产品列表查看', + 'path' => '/v1.0/ip/getRelationProductList', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<ProductInfo>>', + 'description' => 'Result<List<ProductInfo>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'CreateHotel' => [ + 'summary' => '创建酒店项目', + 'path' => '/v1.0/ip/createHotel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => [ + 'title' => '淘宝开放id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAEV***E3d3Z2ETwh', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '开放平台appKey', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '333566791', + ], + ], + [ + 'name' => 'HotelName', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '备注', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'HotelAddress', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店地址', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'HotelEmail', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店联系邮箱', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + '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', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '酒店关联产品列表', + 'description' => '酒店关联产品列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'UpdateHotel' => [ + 'summary' => '修改酒店项目', + 'path' => '/v1.0/ip/updateHotel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + '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', + ], + ], + [ + 'name' => 'HotelName', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '备注', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'HotelAddress', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店地址', + 'description' => '', + 'type' => 'string', + 'required' => false, + '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', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '关联产品列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request. ', + 'type' => 'string', + 'example' => '46C53AEB-B19C-5C42-B32E-A726979C126F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'RemoveHotel' => [ + 'summary' => '删除酒店项目', + 'path' => '/v1.0/ip/removeHotel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => [ + 'title' => '淘宝开放id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAEVK***UE3d3Z2ETwh', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'appkey', + 'type' => 'string', + 'required' => true, + 'example' => '30193305', + ], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'ListHotelInfo' => [ + 'summary' => '获取酒店列表', + 'path' => '/v1.0/ip/listHotelInfo', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelInfoResponse>>', + 'description' => 'Result<List<HotelInfoResponse>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'ListHotels' => [ + 'summary' => '酒店列表(待审批/已拒绝/已通过)', + 'path' => '/v1.0/ip/listHotels', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '审批状态（0：待审批、1：通过、2：拒绝）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'HotelRequest', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HotelId' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelListResp>', + 'description' => 'Result<HotelListResp>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'AuditHotel' => [ + 'summary' => '审批酒店', + 'path' => '/v1.0/ip/auditHotel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AuditHotelReq', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '审批request', + 'description' => '', + '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', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + ], + 'ListHotelRooms' => [ + 'summary' => '获取酒店的所有房间', + 'path' => '/v1.0/ip/listHotelRooms', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', + ], + ], + [ + 'name' => 'HotelAdminRoom', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RoomNo' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelRoomResp>>', + 'description' => 'Result<List<HotelRoomResp>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + '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":""}]', + ], + 'BatchAddHotelRoom' => [ + 'summary' => '批量创建房间', + 'path' => '/v1.0/ip/batchAddHotelRoom', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', + ], + ], + [ + 'name' => 'RoomNoList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'title' => '房间号List', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '房间号List', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["101","102"]', + ], + 'required' => true, + 'docRequired' => true, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]', + ], + 'BatchDeleteHotelRoom' => [ + 'summary' => '批量删除房间', + 'path' => '/v1.0/ip/batchDeleteHotelRoom', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f', + ], + ], + [ + 'name' => 'RoomNoList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'title' => '房间号List', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '房间号List', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["1211","1212"]', + ], + 'required' => true, + 'docRequired' => true, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + ], + 'CheckoutWithAK' => [ + 'summary' => '酒店退房，清楚例如闹钟等定时信息', + 'path' => '/v1.0/ip/checkoutWithAK', + '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', + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'title' => '房间号', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1211', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + ], + 'QueryHotelRoomDetail' => [ + 'summary' => '查询房间详细信息', + 'path' => '/v1.0/ip/queryHotelRoomDetail', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Mac', + 'in' => 'formData', + 'schema' => [ + 'title' => '设备mac地址'."\n" + .'注：在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '38:c8:**:**:f5:22', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '设备uuid，可在App中查看'."\n" + .'注：在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '588***96j5WU', + ], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店id'."\n" + .'注：传入设备mac/sn/uuid 可不传酒店id 若都未传 则 酒店id必传', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '520a0c0***5eb', + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'title' => '房间号'."\n" + .'注：传入设备mac/sn/uuid 可不传房间号 若都未传 则 房间号必传', + 'description' => '', + '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<HotelRoomDetail>', + 'description' => 'Result<HotelRoomDetail>', + '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', + ], + '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', + ], + ], + ], + ], + ], + '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\\": {\\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"}]', + ], + 'ListSceneCategory' => [ + 'summary' => '酒店场景分类', + 'path' => '/v1.0/ip/listSceneCategory', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '场景分类类型（物品GOODS/服务SERVICE/维修REPAIR）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'REPAIR', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<String>>', + 'description' => 'Result<List<String>>', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[ "电器类", "家具类", "卫生间类" ]', + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'RequestId', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n \\"[ \\\\\\"电器类\\\\\\", \\\\\\"家具类\\\\\\", \\\\\\"卫生间类\\\\\\" ]\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'ListDialogueTemplate' => [ + 'summary' => '酒店场景对话模板', + 'path' => '/v1.0/ip/listDialogueTemplate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<DialogueTemplate>>', + 'description' => 'Result<List<DialogueTemplate>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'InsertHotelSceneBookItem' => [ + 'summary' => '酒店场景预订新增', + 'path' => '/v1.0/ip/insertHotelSceneBookItem', + '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' => [ + 'title' => 'hotelID', + 'description' => 'hotelID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', + ], + ], + [ + 'name' => 'AddHotelSceneItemReq', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'addHotelSceneItemReq', + 'description' => 'addHotelSceneItemReq', + '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', + ], + 'Icon' => [ + 'title' => 'icon', + 'description' => 'icon', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => 'RequestId', + 'type' => 'string', + 'example' => '36FB***80C2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"36FB***80C2\\"\\n}","type":"json"}]', + ], + 'DeleteHotelSceneBookItem' => [ + 'summary' => '酒店场景预订删除', + 'path' => '/v1.0/ip/deleteHotelSceneBookItem', + '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' => [ + 'title' => 'hotelID', + 'description' => 'hotelID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '80d84ea8ed9e422fbad52715c8fc56f1', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店场景预订itemID'."\n" + .' 删除条件 id与名称必传一个', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '11823', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '名称 删除条件 id与名称必传一个', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'UpdateHotelSceneBookItem' => [ + 'summary' => '酒店场景预订编辑', + 'path' => '/v1.0/ip/updateHotelSceneBookItem', + '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' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'ListHotelSceneBookItems' => [ + 'summary' => '酒店场景预订列表（餐饮/SPA休闲/打车）', + 'path' => '/v1.0/ip/listHotelSceneBookItems', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => 'Type', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelSceneListResp>', + 'description' => 'Result<HotelSceneListResp>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'ListHotelSceneItems' => [ + 'summary' => '酒店场景列表（物品/服务/维修）', + 'path' => '/v1.0/ip/listHotelSceneItems', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => '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' => '棉签', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelSceneListResp>', + 'description' => 'Result<HotelSceneListResp>', + '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' => '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'UpdateHotelSceneItem' => [ + 'summary' => '酒店场景修改（开启/关闭/编辑）', + 'path' => '/v1.0/ip/updateHotelSceneItem', + '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' => [ + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '0D0C***67DB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]', + ], + 'GetHotelSceneItemDetail' => [ + 'summary' => '酒店场景详情', + 'path' => '/v1.0/ip/getHotelSceneItemDetail', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => 'ItemId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店场景itemID'."\n" + .'id与物品名称必传其中一个', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10336', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '物品名称'."\n" + .'id与物品名称必传其中一个', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelSceneDetailResp>', + 'description' => 'Result<HotelSceneDetailResp>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'InvokeRobotPush' => [ + 'summary' => '机器人服务，消息推送', + 'path' => '/v1.0/ip/invokeRobotPush', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + 'in' => 'formData', + 'schema' => [ + 'title' => '推送类型，PUT：放东西、GET：拿东西', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'GET', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + ], + 'ImportHotelConfig' => [ + 'summary' => '批量导入酒店配置', + 'path' => '/v1.0/ip/importHotelConfig', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a7***83', + ], + ], + [ + 'name' => 'ImportHotelConfig', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '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"}]', + ], + 'ImportRoomControlDevices' => [ + 'summary' => '批量导入设备（同时补充房型）', + 'path' => '/v1.0/ip/importRoomControlDevices', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + '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', + '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, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'EnableInfraredDeviceImport', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否支持红外 true 支持红外设备 false 不支持红外设备', + 'type' => 'string', + ], + ], + [ + 'name' => 'EnableMeshDeviceImport', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否支持mesh true/null 支持 走清理逻辑false 不支持 但是会保留Mesh设备 请求参数里面有 Mesh 数据报错', + 'type' => 'string', + ], + ], + ], + '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' => '10', + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'xxxx', + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'fdsfregtre', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 10,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"xxxx\\"\\n },\\n \\"RequestId\\": \\"fdsfregtre\\"\\n}","type":"json"}]', + ], + 'ImportRoomGenieScenes' => [ + 'summary' => '导入房间内精灵场景', + 'path' => '/v1.0/ip/importRoomGenieScenes', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a7a3***013', + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1211', + ], + ], + [ + 'name' => 'SceneList', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + ], + 'PageGetHotelRoomDevices' => [ + 'summary' => '分页查询酒店房间主控设备', + 'path' => '/v1.0/ip/pageGetHotelRoomDevices', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult<List<HotelDeviceInfo>>', + 'description' => 'PageResult<List<HotelDeviceInfo>>', + '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' => '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'QueryRoomControlDevices' => [ + 'summary' => '查询酒店房间客控设备', + 'path' => '/v1.0/ip/queryRoomControlDevices', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<ListHotelMessageTemplate>>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'fdsgfdscvre', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + '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"}]', + ], + 'GetHotelRoomDevice' => [ + 'summary' => '获取酒店房间猫精设备信息', + 'path' => '/v1.0/ip/getHotelRoomDevice', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<ListHotelMessageTemplate>>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + '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', + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vrehvuifdsgrts', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + '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"}]', + ], + 'ControlRoomDevice' => [ + 'summary' => '控制房间内设备', + 'path' => '/v1.0/ip/controlRoomDevice', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + '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', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'Properties', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => true, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => '{"powerstate":"1"}', + 'required' => true, + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<ControlResponse>', + 'description' => 'Result<ControlResponse>', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7***726E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'PushVoiceBoxCommands' => [ + 'summary' => '推送音箱指令', + 'path' => '/v1.0/ip/pushVoiceBoxCommands', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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, + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'title' => '房间号', + 'description' => '', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Commands', + 'in' => 'formData', + '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, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Code' => [ + 'title' => '调用返回码 pop返回使用', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'boolean', + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + ], + ], + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"null\\"\\n}","type":"json"}]', + ], + 'SyncDeviceStatusWithAk' => [ + 'summary' => '同步客控设备状态到主控设备', + 'path' => '/v1.0/ip/syncDeviceStatusWithAk', + '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' => 'af7***536', + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'title' => '房间号', + 'description' => '', + 'type' => 'string', + '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', + 'schema' => [ + 'title' => '设备的品类英文名称，选填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Number', + 'in' => 'formData', + 'schema' => [ + 'title' => '设备序号', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'bedLight', + ], + ], + [ + 'name' => 'Location', + 'in' => 'formData', + 'schema' => [ + 'title' => '位置', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'room', + ], + ], + [ + 'name' => 'LocationCnName', + 'in' => 'formData', + 'schema' => [ + 'title' => '位置中文名称，选填', + 'description' => '', + 'type' => 'string', + 'required' => false, + '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>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","type":"json"}]', + ], + 'CreateRcuScene' => [ + 'summary' => '酒店rcu自定义场景创建', + 'path' => '/v1.0/ip/createRcuScene', + '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' => '520a0c0***5eb', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '场景编码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yoga', + ], + ], + [ + 'name' => 'SceneRelationExtDTO', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '酒店RCU自定义场景', + 'description' => '', + '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, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '844BA5CE-E30A-53CB-8A11-DE1F344C846D', + ], + ], + ], + ], + ], + '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\\": \\"844BA5CE-E30A-53CB-8A11-DE1F344C846D\\"\\n}","type":"json"}]', + ], + 'DeleteRcuScene' => [ + 'summary' => '删除酒店自定义rcu场景', + 'path' => '/v1.0/ip/deleteRcuScene', + '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' => 'a7a3***013', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '场景编码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yoga', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '4F61A7B7-409C-525D-AFDB-238A4E88925A', + ], + ], + ], + ], + ], + '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\\": \\"4F61A7B7-409C-525D-AFDB-238A4E88925A\\"\\n}","type":"json"}]', + ], + 'UpdateRcuScene' => [ + 'summary' => '修改酒店自定义rcu场景', + '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' => '520a0c0***5eb', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '场景编码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'yoga', + ], + ], + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '3A680F3A-6672-5A47-AB28-12BBCD80C679', + ], + ], + ], + ], + ], + '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\\": \\"3A680F3A-6672-5A47-AB28-12BBCD80C679\\"\\n}","type":"json"}]', + ], + 'ExecuteScene' => [ + 'summary' => '控制房间场景', + 'path' => '/v1.0/ip/executeScene', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + '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', + 'schema' => [ + 'title' => '场景名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'title' => '调用返回码 pop返回使用', + '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' => '191C79AD-F9F9-531E-B8C1-73DF6433B920', + ], + ], + ], + ], + ], + '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 \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]', + ], + 'QuerySceneList' => [ + 'summary' => '查询酒店场景列表', + 'path' => '/v1.0/ip/querySceneList', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'af7***536', + ], + ], + [ + 'name' => 'SceneTypes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '场景集合传递（公共：common；自定义：custom）', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'common', + ], + 'required' => false, + ], + ], + [ + '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', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '房型id', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '999', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelSceneWrapperResp>>', + 'description' => 'Result<List<HotelSceneWrapperResp>>', + '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（不可关联）的原因', + 'description' => '', + 'type' => 'string', + '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' => '', + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', + ], + ], + ], + ], + ], + '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 \\"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"}]', + ], + 'QueryRoomStatus' => [ + 'summary' => '查询房态信息', + 'path' => '/v1.0/ip/queryRoomStatus', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7', + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'title' => '房间号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1211', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<OpenRoomStatusDetailResponse>', + 'description' => 'Result<OpenRoomStatusDetailResponse>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'title' => '调用返回码 pop返回使用', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + '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' => '', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B', + ], + ], + ], + ], + ], + '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 \\"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"}]', + ], + 'QueryRoomControlDevicesAndStatus' => [ + 'summary' => '查询房间被控设备包含设备状态', + 'path' => '/v1.0/ip/queryRoomControlDevicesAndStatus', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + '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", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<LocationDevices>>', + 'description' => 'Result<List<LocationDevices>>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'title' => '调用返回码 pop返回使用', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '73C67***6FA'."\n", + ], + ], + ], + ], + ], + '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 \\"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"}]', + ], + 'ListAllProvinces' => [ + 'summary' => '查询省份', + 'path' => '/v1.0/ip/listAllProvinces', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<String>>', + 'description' => 'Result<List<String>>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '00534880-4397-5134-B212-1030B7A37C27', + ], + ], + ], + ], + ], + '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\\": [\\n \\"浙江省\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"00534880-4397-5134-B212-1030B7A37C27\\"\\n}","type":"json"}]', + ], + 'ListCitiesByProvince' => [ + 'summary' => '查询城市', + 'path' => '/v1.0/ip/listCitiesByProvince', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Province', + 'in' => 'formData', + 'schema' => [ + 'title' => '省份', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<String>>', + 'description' => 'Result<List<String>>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00', + ], + ], + ], + ], + ], + '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\\": [\\n \\"北京市\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]', + ], + 'ListSTBServiceProviders' => [ + 'summary' => '查询服务提供商', + 'path' => '/v1.0/ip/listSTBServiceProviders', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Province', + 'in' => 'formData', + 'schema' => [ + 'title' => '省份', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'City', + 'in' => 'formData', + 'schema' => [ + 'title' => '城市', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => '', + 'example' => '', + ], + 'description' => '', + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1036C376-7A37-5A73-BE8B-C6DB40107EC1', + ], + ], + ], + ], + ], + '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\\": {\\n \\"key\\": [\\n \\"\\\\\\"Z\\\\\\":[\\\\\\"浙江华数\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1036C376-7A37-5A73-BE8B-C6DB40107EC1\\"\\n}","type":"json"}]', + ], + 'ListInfraredDeviceBrands' => [ + 'summary' => '查询红外品牌列表', + 'path' => '/v1.0/ip/listInfraredDeviceBrands', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Category', + 'in' => 'formData', + 'schema' => [ + 'title' => '设备名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'ServiceProvider', + 'in' => 'formData', + 'schema' => [ + 'title' => '服务提供商（品类为机顶盒时必传）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => '', + 'example' => '"A":["Addsion", "Ambassador"]', + ], + 'description' => '', + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00', + ], + ], + ], + ], + ], + '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\\": {\\n \\"key\\": [\\n \\"\\\\\\"A\\\\\\":[\\\\\\"Addsion\\\\\\", \\\\\\"Ambassador\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]', + ], + 'ListInfraredRemoteControllers' => [ + 'summary' => '查询红外码库列表', + 'path' => '/v1.0/ip/listInfraredRemoteControllers', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'af7***536', + ], + ], + [ + 'name' => 'Province', + 'in' => 'formData', + 'schema' => [ + 'title' => '省份'."\n" + .'品类为机顶盒时必传', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'City', + 'in' => 'formData', + 'schema' => [ + 'title' => '城市'."\n" + .'品类为机顶盒时必传', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Category', + 'in' => 'formData', + 'schema' => [ + 'title' => '品类', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Brand', + 'in' => 'formData', + 'schema' => [ + 'title' => '品牌'."\n" + .'品类非机顶盒必填，为机顶盒同时供应商为IPTV时必传', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ServiceProvider', + 'in' => 'formData', + 'schema' => [ + 'title' => '服务提供商'."\n" + .'品类为机顶盒时必传', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<InfraredControlCodeResp>>', + 'description' => 'Result<List<InfraredControlCodeResp>>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + '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', + ], + 'Version' => [ + 'title' => '版本信息', + 'description' => '', + 'type' => 'string', + 'example' => '4', + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0C90A059-3653-5356-A78E-8A6BDA606155', + ], + ], + ], + ], + ], + '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\\": [\\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"}]', + ], + 'ListCustomQA' => [ + 'summary' => '查询自定义问答列表', + 'path' => '/v1.0/ip/listCustomQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + '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' => '***', + ], + ], + [ + 'name' => 'Page', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult<List<QAInfoResponse>>', + 'description' => 'PageResult<List<QAInfoResponse>>', + '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", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'AddCustomQA' => [ + 'summary' => '新增自定义问答', + 'path' => '/v1.0/ip/addCustomQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a7a3***013', + ], + ], + [ + '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', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'required' => false, + ], + ], + ], + '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' => '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"}]', + ], + 'AddCustomQAV2' => [ + 'summary' => '添加问答V2', + 'path' => '/v1.0/ip/addQAV2', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => '', + ], + ], + [ + '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', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<QAInfoResponse>', + 'description' => 'Result<QAInfoResponse>', + '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', + ], + ], + ], + ], + ], + '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 \\"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"}]', + ], + 'UpdateCustomQA' => [ + 'summary' => '修改自定义问答', + 'path' => '/v1.0/ip/updateCustomQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + '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', + ], + ], + [ + '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', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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\\": \\"73C6***BB3E6FA\\"\\n}","type":"json"}]', + ], + 'DeleteCustomQA' => [ + 'summary' => '删除自定义问答', + 'path' => '/v1.0/ip/deleteCustomQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CustomQAIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '11', + ], + 'required' => false, + ], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a7a3***013', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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\\": \\"73C6***E6FA\\"\\n}","type":"json"}]', + ], + 'GetBasicInfoQA' => [ + 'summary' => '获取基础信息问答', + 'path' => '/v1.0/ip/getBasicInfoQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Result<IntentionQATemplateResponse>', + 'description' => 'Result<IntentionQATemplateResponse>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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\\": {\\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"}]', + ], + 'UpdateBasicInfoQA' => [ + 'summary' => '修改基础信息问答', + 'path' => '/v1.0/ip/updateBasicInfoQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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'."\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', + 'in' => 'formData', + 'schema' => [ + 'title' => '停车费用，免费停车/收费停车', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'enum' => [ + '免费停车', + '收费停车', + ], + ], + ], + ], + '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' => '0EC7***726E'."\n", + ], + ], + ], + ], + ], + '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\\"\\n}","type":"json"}]', + ], + 'ListServiceQA' => [ + 'summary' => '查询服务设施问答列表', + 'path' => '/v1.0/ip/listServiceQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => 'Active', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否激活', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + [ + 'name' => 'Page', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult<List<IntentionQAResponse>>', + 'description' => 'PageResult<List<IntentionQAResponse>>', + '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' => '12', + ], + ], + ], + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServiceQAId' => [ + 'title' => '通用问答信息', + 'description' => '', + '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' => '', + ], + ], + ], + ], + '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 \\"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"}]', + ], + 'UpdateServiceQA' => [ + 'summary' => '修改服务设施问答', + 'path' => '/v1.0/ip/updateServiceQA', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + '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' => '73C67***6FA'."\n", + ], + ], + ], + ], + ], + '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\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]', + ], + 'AddCartoon' => [ + 'summary' => '添加动画', + 'path' => '/v1.0/ip/addCartoon', + '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' => [ + 'title' => '酒店id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '520a0***eb', + ], + ], + [ + 'name' => 'StartVideoUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => '开机动画url', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://***.mp4', + ], + ], + [ + 'name' => 'StartVideoMd5', + 'in' => 'formData', + 'schema' => [ + 'title' => '开机动画md5', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '40c804***697', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '0EC7*726E'."\n", + ], + ], + ], + ], + ], + '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\\"\\n}","type":"json"}]', + ], + 'GetCartoon' => [ + 'summary' => '查询动画', + 'path' => '/v1.0/ip/getCartoon', + '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' => '520a0c0***5eb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelCartoonResponse>', + 'description' => 'Result<HotelCartoonResponse>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StartVideoUrl' => [ + 'title' => '开机启动视频', + 'description' => '', + 'type' => 'string', + 'example' => '40c8***97', + ], + 'StartVideoMd5' => [ + 'title' => '开机视频md5', + 'description' => '', + 'type' => 'string', + 'example' => 'https://ai***.mp4', + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'DeleteCartoon' => [ + 'summary' => '删除动画', + 'path' => '/v1.0/ip/deleteCartoon', + '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' => false, + 'example' => 'a7***83'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '0EC7*726E'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]', + ], + 'GetHotelScreenSaverStyle' => [ + 'summary' => '获取屏保列表', + 'path' => '/v1.0/ip/getHotelScreenSaverStyle', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'af7***536'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelScreenSaverStyle>>', + 'description' => 'Result<List<HotelScreenSaverStyle>>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + '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', + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '73C67**6FA'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'AddOrUpdateHotelSetting' => [ + 'summary' => '新增或者编辑定制配置', + 'path' => '/v1.0/ip/addOrUpdateHotelSetting', + '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' => 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', + 'style' => 'json', + 'schema' => [ + 'title' => '屏保', + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'HotelDeviceModeList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '模式', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'sleep', + ], + 'required' => false, + ], + ], + [ + 'name' => 'NightMode', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '夜间模式', + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '0EC7*726E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'GetHotelSetting' => [ + 'summary' => '查询定制配置', + 'path' => '/v1.0/ip/getHotelSetting', + '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' => false, + 'example' => 'af7***536'."\n", + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Result<HotelSettingInfo>', + 'description' => 'Result<HotelSettingInfo>', + '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' => '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', + ], + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F7E2****B7C94', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'DeleteHotelSetting' => [ + 'summary' => '删除定制配置', + 'path' => '/v1.0/ip/deleteHotelSetting', + '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' => false, + 'example' => 'af7***536', + ], + ], + [ + 'name' => 'SettingType', + 'in' => 'formData', + 'schema' => [ + 'title' => '设置类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NOTICE' => '', + 'NIGHT_MODE' => '', + 'SCREENSAVER' => '', + 'SCENE' => '', + 'HOMEPAGE_PIC' => '', + ], + 'example' => 'SCREENSAVER', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '73C67****BB3E6FA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67****BB3E6FA\\"\\n}","type":"json"}]', + ], + 'AddOrUpdateWelcomeText' => [ + 'summary' => '添加/更新欢迎语信息', + 'path' => '/v1.0/ip/addOrUpdateWelcomeText', + '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' => [ + 'title' => '酒店id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'af7***536', + ], + ], + [ + 'name' => 'WelcomeText', + 'in' => 'formData', + 'schema' => [ + 'title' => '欢迎语文本，建议150字以内', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'MusicUrl', + 'in' => 'formData', + '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', + 'required' => true, + 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + ], + ], + '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' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'GetWelcomeTextAndMusic' => [ + 'summary' => '查询欢迎语信息', + 'path' => '/v1.0/ip/getWelcomeTextAndMusic', + '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' => 'a7a3***013', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<WelcomeResp>', + 'description' => 'Result<WelcomeResp>', + 'type' => 'object', + 'properties' => [ + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HotelId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'a7***83', + ], + 'Text' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MusicUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav', + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + ], + ], + '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' => [], + '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"}]', + ], + 'ResetWelcomeTextAndMusic' => [ + 'summary' => '重置欢迎语信息', + 'path' => '/v1.0/ip/resetWelcomeTextAndMusic', + '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' => [ + 'title' => '酒店id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'af7***536', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => ' ', + ], + ], + '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' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" \\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'PushWelcomeTextAndMusic' => [ + 'summary' => '推送欢迎语', + 'path' => '/v1.0/ip/pushWelcomeTextAndMusic', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'af7***536', + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'title' => '房间号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1211', + ], + ], + [ + 'name' => 'RoomName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'TemplateVariable', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '参数映射表，例如欢迎语文本中的表达式：${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'hotelName', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + 'example' => ' ', + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F7E2****B7C94', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" *\\"\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + ], + 'PushWelcome' => [ + 'summary' => '直接推送欢迎语', + 'path' => '/v1.0/ip/pushWelcome', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + 'in' => 'formData', + 'schema' => [ + 'title' => '欢迎语推送 房间号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1211', + ], + ], + [ + 'name' => 'RoomName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '0EC7*726E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'AddMessageTemplate' => [ + 'summary' => '添加消息模板', + 'path' => '/v1.0/ip/addMessageTemplate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => [ + 'title' => '消息模板名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '测试模板', + ], + ], + [ + 'name' => 'TemplateDetail', + 'in' => 'formData', + 'schema' => [ + 'title' => '消息模板内容', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '这是${hotel}的一个测试模板', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + ], + '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' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<ListHotelMessageTemplate>>', + 'description' => 'Result<List<ListHotelMessageTemplate>>', + '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' => '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', + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + '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"}]', + ], + 'DeleteMessageTemplate' => [ + 'summary' => '删除消息通知模板', + 'path' => '/v1.0/ip/deleteMessageTemplate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '消息模板id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '234', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => 'F7E2****B7C94', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', + ], + 'UpdateMessageTemplate' => [ + 'summary' => '更新消息通知模板', + 'path' => '/v1.0/ip/updateMessageTemplate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板主键id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123123', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TemplateDetail', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板详情', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'title' => '返回的请求id', + 'description' => '', + 'type' => 'string', + 'example' => '43***881', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + ], + 'PushHotelMessage' => [ + 'summary' => '推送酒店消息', + 'path' => '/v1.0/ip/pushHotelMessage', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PushHotelMessageReq', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'pushHotelMessageReq', + 'description' => 'pushHotelMessageReq', + '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测试酒店"}', + ], + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + ], + 'ListTickets' => [ + 'summary' => '查询工单列表', + 'path' => '/v1.0/ip/listTickets', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => 'Page', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-08 09:39:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09-14 14:23:00', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'waiting' => '', + 'handled' => '', + 'delayed' => '', + ], + 'example' => 'waiting', + ], + ], + [ + 'name' => 'RoomNo', + 'in' => 'formData', + 'schema' => [ + 'title' => '房间号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1211', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '""' => '', + '酒店服务' => '', + '酒店维修' => '', + ], + 'example' => '""', + ], + ], + [ + 'name' => 'IsNeedCallback', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否需要回电', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'IsNeedCharges', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否需要收费', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SortField', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序字段', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gmtCalled', + ], + ], + [ + 'name' => 'IsDesc', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否为降序', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult<List<LogInfoResponse>>', + 'description' => 'PageResult<List<LogInfoResponse>>', + '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' => '5', + ], + ], + ], + 'StatusCode' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + 'Dialogs' => [ + 'title' => '单轮对话', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Question' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Answer' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'RoomNo' => [ + 'title' => '房间号', + 'description' => '', + 'type' => 'string', + 'example' => '101', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '', + 'type' => 'string', + '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' => '***', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'waiting' => '', + 'handled' => '', + 'delayed' => '', + ], + 'example' => 'waiting', + ], + 'Operations' => [ + 'title' => '操作', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + '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', + ], + ], + ], + ], + '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 \\"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"}]', + ], + 'UpdateTicket' => [ + 'summary' => '修改工单', + 'path' => '/v1.0/ip/updateTicket', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '520a0c0***5eb', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '状态', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'waiting' => '', + 'handled' => '', + 'delayed' => '', + ], + 'example' => 'waiting', + ], + ], + [ + 'name' => 'GroupKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '分组键', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2023***93975', + ], + ], + ], + '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' => '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' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PvkB***TA==', + ], + ], + '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' => '', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '""', + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '43***881', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"xxx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]', + ], + 'ListHotelAlarm' => [ + 'summary' => '查询酒店闹钟', + 'path' => '/v1.0/ip/getHotelAlarmList', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'a7a3***013', + ], + ], + [ + 'name' => 'Rooms', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '101', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelAlarmDetailResponse>>', + 'description' => 'Result<List<HotelAlarmDetailResponse>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'CreateHotelAlarm' => [ + 'summary' => '批量创建闹钟', + 'path' => '/v1.0/ip/createHotelAlarm', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + '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', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', + 'description' => 'ONCE, WEEKLY', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + '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' => '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, + ], + ], + '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', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelAlarmResponse>>', + 'description' => 'Result<List<HotelAlarmResponse>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'UpdateHotelAlarm' => [ + 'summary' => '修改酒店闹钟', + 'path' => '/v1.0/ip/updateHotelAlarm', + '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' => 'a7a381a668bc485980bed3876a75e013', + ], + ], + [ + 'name' => 'Alarms', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RoomNo' => [ + 'description' => '', + '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==', + ], + ], + 'required' => false, + ], + '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, + ], + ], + ], + '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' => 'success', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '""', + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'ChildAccountAuth' => [ + 'summary' => '子账号授权', + 'path' => '/v1.0/ip/childAccountAuth', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Account', + 'in' => 'formData', + 'schema' => [ + 'title' => '淘宝账号名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'lee', + ], + ], + [ + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => [ + 'title' => '淘宝开放id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAEV***E3d3Z2ETwh', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '开放平台appKey', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '30471753', + ], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a7***83', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Extentions' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '', + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3DB51A10-327C-58D3-91DF-3A5A471C51E7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'RemoveChildAccountAuth' => [ + 'summary' => '删除子账号授权', + 'path' => '/v1.0/ip/removeChildAccountAuth', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TbOpenId', + 'in' => 'formData', + 'schema' => [ + 'title' => '授权人（平台登录用户）淘宝开放id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAEV***E3d3Z2ETwh', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => [ + 'title' => 'top开放平台appKey', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '30**53', + ], + ], + [ + 'name' => 'ChildAccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '被授权账号的淘宝账号名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'tbxxxx', + ], + ], + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'af7***536', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + 'description' => 'Result<Boolean>', + '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, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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"}]', + ], + 'QueryDeviceStatus' => [ + 'summary' => '查询酒店设备状态/模式状态查询', + 'path' => '/v1.0/ip/queryDeviceStatus', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LocationDevices' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'UserId' => [ + 'type' => 'string', + 'required' => true, + ], + 'Properties' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'mode', + 'description' => '', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'value', + 'description' => '', + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'fdsgrefds', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"key\\": \\"value\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"fdsgrefds\\"\\n}","type":"json"}]', + ], + 'ListHotelControlDevice' => [ + 'summary' => '酒店设备列表', + 'path' => '/v1.0/ip/listHotelControlDevice', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '调用返回码，除约定的SUCCESS_CODE外，其余由服务提供者自定义', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => null, + ], + 'DeviceControl' => [ + 'summary' => '设备控制', + 'path' => '/v1.0/ip/deviceControl', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + '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' => '业务参数', + ], + ], + [ + 'name' => 'UserInfo', + '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' => '用户标识信息', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结果对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '调用返回码，200表示成功', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + 'title' => '业务执行结果状态，200为执行成功', + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '43***28C-A810-5***-8747-EC226A086881', + 'title' => '请求id', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + ], + '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":""}]', + ], + 'ListHotelSceneItem' => [ + 'summary' => '服务项目', + 'path' => '/v1.0/ip/listHotelSceneItem', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult<ListItemResponse>', + 'description' => 'PageResult<ListItemResponse>', + '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', + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + '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"}]', + ], + 'ListHotelServiceCategory' => [ + 'summary' => '服务分类列表', + 'path' => '/v1.0/ip/listHotelServiceCategory', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<SceneServiceCategory>>', + 'description' => 'Result<List<SceneServiceCategory>>', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '状态码', + 'description' => '', + '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' => '生活及洗漱用品', + ], + 'Icon' => [ + 'title' => '服务分类icon', + 'description' => '', + 'type' => 'string', + 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png', + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '5373C821-65D2-1764-B9F9-951914937FF5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + '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"}]', + ], + 'GetHotelOrderDetail' => [ + 'summary' => '获取酒店订单详情', + 'path' => '/v1.0/ip/getHotelOrderDetail', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '订单详情payload', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OrderNo' => [ + 'title' => '订单号', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '20220714150702000168270112410630', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelOrderDetail>>', + 'description' => 'Result<List<HotelOrderDetail>>', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '服务的实际返回结果', + 'description' => '', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + 'Message' => [ + 'title' => '附加信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '6F579407-13C4-1708-AFA2-B657BE5FE8F5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + '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"}]', + ], + 'ListHotelOrder' => [ + 'summary' => '酒店订单列表', + 'path' => '/v1.0/ip/listHotelOrder', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult<List<HotelOrderListResp>>', + 'description' => 'PageResult<List<HotelOrderListResp>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + '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"}]', + ], + 'SubmitHotelOrder' => [ + 'summary' => '提交酒店订单', + 'path' => '/v1.0/ip/submitHotelOrder', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Boolean>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + '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"}]', + ], + 'GetHotelNotice' => [ + 'summary' => '获取酒店通知', + 'path' => '/v1.0/ip/getHotelNotice', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<String>', + 'description' => 'Result<String>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"test notice...\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]', + ], + 'GetHotelNoticeV2' => [ + 'summary' => '获取酒店通知', + 'path' => '/v1.0/ip/getHotelNoticeV2', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户信息', + 'description' => '', + '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', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelNotice>', + 'description' => 'Result<HotelNotice>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'GetHotelHomeBackImageAndModes' => [ + 'summary' => '获取首页背景图和场景模式', + 'path' => '/v1.0/ip/getHotelHomeBackImageAndModes', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户信息', + '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' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HomePageBackImageAndModes>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => ' AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetHotelSampleUtterances' => [ + 'summary' => '获取推荐语料', + 'path' => '/v1.0/ip/getHotelSampleUtterances', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetHotelScreenSaver' => [ + 'summary' => '获取酒店屏保', + 'path' => '/v1.0/ip/getHotelScreenSaver', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelScreenSaver>', + 'description' => 'Result<HotelScreenSaver>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + ], + '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"}]', + ], + 'RoomCheckOut' => [ + 'summary' => '退房', + 'path' => '/v1.0/ip/roomCheckOut', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>', + 'description' => '', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"dsvrevd\\"\\n}","type":"json"}]', + ], + 'GetHotelContacts' => [ + 'summary' => '获取酒店联系人', + 'path' => '/v1.0/ip/getHotelContacts', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'UserInfo', + 'in' => 'query', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<List<HotelCallContact>>', + 'description' => 'Result<List<HotelCallContact>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'GetHotelContactByNumber' => [ + 'summary' => '根据号码获取酒店联系人', + 'path' => '/v1.0/ip/getHotelContactByNumber', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Number', + 'in' => 'formData', + 'schema' => [ + 'title' => '号码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '101', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户信息', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelCallContact>', + 'description' => 'Result<HotelCallContact>', + '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', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'GetHotelContactByGenieDevice' => [ + 'summary' => '获取当前设备的通话信息', + 'path' => '/v1.0/ip/getHotelContactByGenieDevice', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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' => 'DeviceInfo', + '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', + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<HotelCallContact>', + 'description' => 'Result<HotelCallContact>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'AddOrUpdateScreenSaver' => [ + 'summary' => '新增或者编辑带屏屏保', + 'path' => '/v1.0/ip/addOrUpdateScreenSaver', + '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' => 'a7a3***013', + ], + ], + [ + 'name' => 'HotelScreenSaver', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '屏保', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ScreenSaverStyle' => [ + 'title' => '屏保样式code', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'common-weather', + ], + 'ScreenSaverPicUrl' => [ + 'title' => '屏保图片', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.png', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '4EED***9661', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4EED***9661\\"\\n}","type":"json"}]', + ], + 'AddOrUpdateDisPlayModes' => [ + 'summary' => '新增或者编辑带屏展示模式', + 'path' => '/v1.0/ip/addOrUpdateDisPlayModes', + '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', + ], + ], + [ + 'name' => 'HotelDeviceModeList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '带屏设备展示的模式code列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'dndMode', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '0EC7*726E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'GetUnionId' => [ + 'summary' => '获取组织下unionId列表', + 'path' => '/v1.0/ip/getUnionId', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EncodeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '编码类型，从天猫精灵开放平台中获取', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOTEL', + ], + ], + [ + 'name' => 'EncodeKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '编码Key，从天猫精灵开放平台中获取', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '125****0946', + ], + ], + [ + 'name' => 'IdType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'open id类型，可为用户id或设备id；'."\n" + .'USER_ID: 用户id'."\n" + .'DEVICE_ID: 设备id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DEVICE_ID', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => 'id类型对应的open id值', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '62a319****abdc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Result<List<UnionInfo>>', + 'description' => 'Result<List<UnionInfo>>', + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The request parameter is invalid', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + '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"}]', + ], + 'HotelQrBind' => [ + 'summary' => '酒店带屏设备扫码绑定', + 'path' => '/v1.0/ip/hotelQrBind', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'HotelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '酒店ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'a7***83', + ], + ], + [ + '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', + 'in' => 'formData', + 'schema' => [ + 'title' => '带屏设备绑定二维码中的clientId参数', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxxxxx', + ], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'schema' => [ + 'title' => '额外信息jsonString', + 'description' => '', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Result<UserAndDeviceInfo>', + 'description' => 'Result<UserAndDeviceInfo>', + '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', + ], + ], + ], + ], + ], + '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\\": {\\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"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'openapi.aligenie.com', + ], + ], +]; diff --git a/data/en_us/aligenie/oauth2_1.0/api-docs.php b/data/en_us/aligenie/oauth2_1.0/api-docs.php new file mode 100644 index 0000000..c03e466 --- /dev/null +++ b/data/en_us/aligenie/oauth2_1.0/api-docs.php @@ -0,0 +1,1130 @@ +<?php return [ + 'version' => '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', + ], + ], + [ + 'id' => 196077, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'OAuth2TokenEndpoint', + 'OAuth2RevocationEndpoint', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetSmartHomeSceneList' => [ + 'summary' => '获取场景列表（全屋）', + 'path' => '/v1.0/oauth2/iot/smart_home/scene/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'."\n", + ], + 'FamilySceneList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'FamilyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2iS1AH5eo8qrw1PYBL/Ulq==', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Y1lCALepjYmTEouxsTrkjB==', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '435CF567-12DC-5761-AFA8-650774502E2D', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + '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', + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SceneList' => [ + 'title' => '场景列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '场景对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '场景Id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'a84a55aa410e460a9ac753570c76fecc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'title' => '实体类型', + 'description' => '', + 'type' => 'string', + 'example' => 'PROJECT_ID', + ], + 'EncodeKey' => [ + 'title' => '实体key', + 'description' => '', + 'type' => 'string', + 'example' => '125****0946', + ], + 'DeviceList' => [ + 'title' => '设备列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceOpenId' => [ + 'title' => '设备唯一标识', + 'description' => '', + 'type' => 'string', + 'example' => 'jMR2********ojVJXk=', + ], + 'DeviceUnionIds' => [ + 'title' => '设备UnionId信息列表', + 'type' => 'array', + 'items' => [ + 'title' => '设备UnionId信息', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '消息推送入参对象。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SendTarget' => [ + 'title' => '消息推送的目标信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TargetType' => [ + 'title' => '推送的目标类型，获取到对应设备的类型 '."\n" + .'DEVICE_UNION_ID：设备unionId'."\n" + .'DEVICE_OPEN_ID：设备openId', + 'description' => '', + '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=', + ], + ], + 'required' => true, + ], + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TenantInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '身份信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubjectId' => [ + 'title' => '猫精应用id，【开发者平台-技能应用】创建应用后得到的应用id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12797******304102', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'OpenCreatePlayingListRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '业务参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PlayFrom' => [ + 'title' => '播放来源,配置播控能力的唯一标识'."\n" + ."\n" + .'可空，默认为default', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'ContentType' => [ + 'title' => '播放内容类型'."\n" + ."\n" + .'内容：content；专辑：album；歌单：collect', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'content', + 'enum' => [ + 'content', + 'album', + 'collect', + ], + ], + 'ContentList' => [ + 'title' => '播放内容列表'."\n" + ."\n" + .'若是内容，支持多个；若是专辑，只有第一个有效。'."\n", + 'description' => '', + 'type' => 'array', + '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', + ], + ], + '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', + ], + 'PlayMode' => [ + 'title' => '播放模式'."\n" + ."\n" + .'列表循环：Repeat；随机：Shuffle；单曲循环：RepeatOne；顺序播放：Normal。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'enum' => [ + 'Repeat', + 'Shuffle', + 'RepeatOne', + 'Normal', + ], + ], + 'ExtendInfo' => [ + 'title' => '扩展信息', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + 'RequestId' => [ + 'title' => '系统RequestId，调用方不需要传 系统自动填写', + 'type' => 'string', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'title' => '编码类型，此处填写UC_CLIENT_ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'UC_CLIENT_ID', + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10002398812\\"\\n}","type":"json"}]', + ], + 'OAuth2TokenEndpoint' => [ + 'summary' => 'OAuth2令牌端点', + 'path' => '/v1.0/oauth2/token', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'GrantType', + 'in' => 'formData', + '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', + ], + ], + [ + 'name' => 'RedirectUri', + 'in' => 'formData', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + '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', + ], + ], + [ + 'name' => 'TokenTypeHint', + 'in' => 'formData', + 'schema' => [ + 'title' => '令牌类型的提示，可以是access_token或refresh_token，用于帮助授权服务器理解要撤销的是哪种类型的令牌。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'refresh_token', + ], + ], + ], + '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' => '4070039E-5822-1F32-9295-1D2883E48BA5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4070039E-5822-1F32-9295-1D2883E48BA5\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + '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 new file mode 100644 index 0000000..b8a7c44 --- /dev/null +++ b/data/en_us/aligenie/ssp_1.0/api-docs.php @@ -0,0 +1,16132 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'AliGenie', + 'product' => 'AliGenie', + 'version' => 'ssp_1.0', + ], + 'directories' => [ + [ + 'id' => 171020, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AuthLoginWithThirdUserInfo', + 'EcologyOpennessSendVerificationCode', + 'FindUserlistToAuthLoginWithPhoneNumber', + 'AuthLoginWithAligenieUserInfo', + 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber', + 'AuthLoginWithTaobaoUserInfo', + 'EcologyOpennessAuthenticate', + 'GetAligenieUserInfo', + 'UnbindAligenieUser', + 'QueryUserDeviceListByTmeUserId', + 'InvalidateThirdPartyAppLoginState', + ], + ], + [ + 'id' => 170170, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CheckAuthCodeBindForExt', + 'GetCodeEnhance', + 'ScanCodeBind', + ], + ], + [ + 'id' => 96289, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetUserByDeviceId', + 'ListDeviceByUserId', + 'UnbindDevice', + 'ListDeviceByUserIdAndChanel', + ], + ], + [ + 'id' => 96293, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetDeviceIdByIdentity', + 'ListDeviceIdByIdentities', + 'GetDeviceBasicInfo', + 'ListDeviceBasicInfo', + 'GetDeviceStatusInfo', + 'GetDeviceTag', + 'DeviceControl', + 'GetDeviceSetting', + 'GetDeviceStatusDetail', + 'SetDeviceSetting', + ], + ], + [ + 'id' => 170173, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 199234, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetJiangSuTelecomData', + ], + ], + [ + 'id' => 170178, + 'title' => null, + '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', + ], + ], + [ + 'id' => 170201, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetUnreadMessageCount', + 'ListUserMessage', + 'ReadMessage', + 'SendMessage', + ], + ], + [ + 'id' => 170204, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAlarm', + 'DeleteAlarms', + 'GetAlarm', + 'ListAlarms', + 'ListMusic', + 'QueryMusicType', + 'UpdateAlarm', + ], + ], + [ + 'id' => 170174, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateScheduleTask', + 'DeleteScheduleTask', + 'GetScheduleTask', + ], + ], + [ + 'id' => 171175, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetWeather', + ], + ], + ], + ], + [ + 'id' => 263709, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreatePlayingListOAuth2', + 'ThirdImmediateMsgPush', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AuthLoginWithThirdUserInfo' => [ + 'summary' => '通过三方用户信息进行授权登录', + 'path' => '/v1.0/ssp/authLoginWithThirdUserInfo', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + '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', + 'in' => 'formData', + 'schema' => [ + 'title' => '三方用户类型，场景接入申请完成后进行分配', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'weChatUser', + ], + ], + [ + 'name' => 'ThirdUserIdentifier', + 'in' => 'formData', + 'schema' => [ + 'title' => '三方用户唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'o5qxy6EItZBasv2VZAf-MGwllHL4', + ], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '扩展信息', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'EcologyOpennessSendVerificationCode' => [ + 'summary' => '生态开放发送短信验证码', + 'path' => '/v1.0/ssp/ecologyOpennessSendVerificationCode', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '会话id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '手机号码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '18612345678', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'title' => '地区编码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '+86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Result' => [ + 'title' => '响应结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ExpireIn' => [ + 'title' => '有效期（单位：秒）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900', + ], + 'RepeatInterval' => [ + 'title' => '下次可重新发送的时间间隔（单位：秒）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'title' => '短信验证码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Result' => [ + 'title' => '响应结果', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + 'DataObj' => [ + 'title' => 'Code为5140003时代表调用失败，原因是该手机号未找到可授权登录的账号列表，前端可以让用户确认通过手机号生成精灵账号，也可提示用户先基于手机号注册淘宝账号，后续流程前端需要将DataObj中sessionId带回服务端。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'title' => '会话id', + 'description' => '', + 'type' => 'string', + 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'AuthLoginWithAligenieUserInfo' => [ + 'summary' => '通过指定精灵账号进行授权登录', + 'path' => '/v1.0/ssp/authLoginWithAligenieUserInfo', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '会话id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', + ], + ], + [ + 'name' => 'EncryptedAligenieUserIdentifier', + 'in' => 'formData', + 'schema' => [ + 'title' => '加密过的精灵用户标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'UYugfm/3Nb9q24AyES2rYmC5tIglSoDX3Mbna/vrldcjGPtC8VzFwo+CU5c4CHLjrK7ekskG2WVaevM5Zi9f0w==', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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' => 'd15aa92de679d0d225aa845268be19ee', + ], + 'ExpiredTimeLong' => [ + 'title' => '登录态访问令牌过期时间（长整型）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659506854230', + 'default' => '1659506854230', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber' => [ + 'summary' => '通过手机号生成精灵账号进行授权登录', + 'path' => '/v1.0/ssp/authLoginWithAligenieUserInfoGeneratedByPhoneNumber', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '会话id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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' => 'd15aa92de679d0d225aa845268be19ee', + ], + 'ExpiredTimeLong' => [ + 'title' => '登录态访问令牌过期时间（长整型）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659506854230', + 'default' => '1659506854230', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'AuthLoginWithTaobaoUserInfo' => [ + 'summary' => '通过指定淘宝账号进行授权登录', + 'path' => '/v1.0/ssp/authLoginWithTaobaoUserInfo', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '会话id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b', + ], + ], + [ + 'name' => 'EncryptedTaobaoUserIdentifier', + 'in' => 'formData', + 'schema' => [ + 'title' => '加密过的淘宝用户标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Result' => [ + 'title' => '响应结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LoginStateAccessToken' => [ + 'title' => '登录态访问令牌', + 'description' => '', + 'type' => 'string', + 'example' => 'd15aa92de679d0d225aa845268be19ee', + ], + 'ExpiredTimeLong' => [ + 'title' => '登录态访问令牌过期时间（长整型）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659506854230', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'EcologyOpennessAuthenticate' => [ + 'summary' => '生态开放鉴权', + 'path' => '/v1.0/ssp/ecologyOpennessAuthenticate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'LoginStateAccessToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '登录态访问令牌', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'd15aa*****ee', + ], + ], + [ + 'name' => 'EncodeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '实体类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + ], + ], + [ + 'name' => 'EncodeKey', + 'in' => 'formData', + 'schema' => [ + 'title' => '实体key', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Result' => [ + 'title' => '响应结果', + 'description' => '', + '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' => '******', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetAligenieUserInfo' => [ + 'summary' => '获取三方绑定的精灵账号信息', + 'path' => '/v1.0/ssp/getAligenieUserInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'LoginStateAccessToken', + 'in' => 'query', + 'schema' => [ + 'title' => '登录态访问凭证', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '99ce8a70c23a94f8569e1a525bef6e85', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'AligenieNickname' => [ + 'title' => '精灵用户昵称', + 'description' => '', + 'type' => 'string', + 'example' => 'XXX', + ], + 'Avatar' => [ + 'title' => '精灵用户头像地址', + 'description' => '', + 'type' => 'string', + 'example' => 'http://img.alicdn.com/xxx.jpg', + ], + 'Deletable' => [ + 'title' => '是否可注销', + 'description' => '', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'UnbindAligenieUser' => [ + 'summary' => '解除三方和精灵账号的关系', + 'path' => '/v1.0/ssp/unbindAligenieUser', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'LoginStateAccessToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '登录态访问凭证', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '99ce8a70c23a94f8569e1a525bef6e85', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + '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' => 'TME用户id', + 'description' => '', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Sp', + 'in' => 'query', + 'schema' => [ + 'title' => '"KG"：酷狗'."\n" + .'"KW"：酷我'."\n" + .'"QM"：Q音', + 'description' => '', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'InvalidateThirdPartyAppLoginState' => [ + 'summary' => '失效三方应用登录态', + 'path' => '/v1.0/ssp/invalidateThirdPartyAppLoginState', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + ], + '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', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ThirdPartyAppId', + 'in' => 'formData', + 'schema' => [ + 'title' => '三方应用标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'com.*.*.*', + ], + ], + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '响应信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'title' => '调用是否成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'CheckAuthCodeBindForExt' => [ + 'summary' => '轮询激活绑定结果', + 'path' => '/v1.0/ssp/checkAuthCodeBindForExt', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EncodeType', + 'in' => 'query', + 'schema' => [ + 'title' => '编码类型，此处填写PROJECT_ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => [ + 'PROJECT_ID', + ], + ], + ], + [ + 'name' => 'EncodeKey', + 'in' => 'query', + 'schema' => [ + 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'title' => '指定用户和渠道获取的authCode', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Aexfgc', + ], + ], + [ + 'name' => 'UserInfo', + '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' => '编码类型对应的值，此处填写该产品所在项目的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' => '用户标识，填写userOpenId或userUnionId的值。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + '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' => [ + 'Message' => [ + 'title' => '调用该接口的返回结果。', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '返回的错误码，200表示调用成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '详细信息', + 'description' => '', + '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' => '', + 'type' => 'object', + 'properties' => [ + 'IdType' => [ + 'title' => 'DEVICE_ID', + 'description' => 'DEVICE_ID', + 'type' => 'string', + 'example' => 'DEVICE_ID', + ], + 'Id' => [ + 'title' => '对外的设备id', + 'description' => '', + 'type' => 'string', + 'example' => 'A963*0158', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetCodeEnhance' => [ + 'summary' => '获取authCode', + 'path' => '/v1.0/ssp/getCodeEnhance', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ChannelInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '激活渠道，如微信小程序，三方app等', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Channel' => [ + 'title' => '激活渠道，如WeChat', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'WeChat、ThirdApp', + ], + 'ExtInfo' => [ + 'title' => '扩展信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + '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' => '编码类型对应的值，此处填写该产品所在项目的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' => '用户标识，填写userOpenId或userUnionId的值。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => true, + ], + ], + ], + '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' => 'string', + 'example' => 'Aexfgc', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": \\"Aexfgc\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'ScanCodeBind' => [ + 'summary' => '扫描二维码激活绑定设备', + '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' => '', + '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' => '129****0946', + ], + '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' => '用户标识，填写userOpenId或userUnionId的值。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '111', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'BindReq', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '扫描绑定入参', + 'description' => '', + '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', + ], + ], + 'required' => true, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetUserByDeviceId' => [ + 'summary' => '查询设备绑定的用户', + 'path' => '/v1.0/ssp/getUserByDeviceId', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DeviceInfo', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '返回的错误信息', + 'description' => '', + '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', + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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', + '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' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'UnbindDevice' => [ + 'summary' => '解绑设备', + 'path' => '/v1.0/ssp/unbindDevice', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => true, + 'title' => '设备标识信息', + 'type' => 'object', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => true, + 'title' => '用户标识信息', + 'type' => 'object', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'title' => '返回数据体', + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.UnbindDevice.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\\": 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":""}]', + ], + 'ListDeviceByUserIdAndChanel' => [ + 'summary' => '获取指定渠道的设备列表', + 'path' => '/v1.0/ssp/listDeviceByUserIdAndChanel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ChannelInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '激活渠道，如微信小程序，三方app等', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Channel' => [ + 'title' => '激活配网渠道，如WeChat', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'WeChat、ThirdApp', + ], + 'ExtInfo' => [ + 'title' => '扩展信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + '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' => '编码类型对应的值，此处填写该产品所在项目的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' => '用户标识，填写userOpenId或userUnionId的值。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetDeviceIdByIdentity' => [ + 'summary' => '获取设备信息', + 'path' => '/v1.0/ssp/getDeviceIdByIdentity', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '129****0946', + ], + ], + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'title' => '填写设备认证类型，“MAC”或者“SN”', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MAC', + ], + ], + [ + 'name' => 'IdentityId', + 'in' => 'query', + 'schema' => [ + 'title' => '认证标识，填写MAC地址或者SN的值。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'b4:xx:xx:xx:65:2b', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'title' => '产品唯一标志符productKey，在天猫精灵AI平台中创建产品时，平台颁发的全局唯一标识。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Mm*****XnZ8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '返回的错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '返回的错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '返回result', + '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，用于排查问题，如果没有这个参数，可以在responseHeader里进行排查。', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7DA****A0726E', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListDeviceIdByIdentities' => [ + 'summary' => '批量获取设备openId', + 'path' => '/v1.0/ssp/listDeviceIdByIdentities', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EncodeType', + 'in' => 'query', + 'schema' => [ + 'title' => '编码类型，此处填写“PROJECT_ID”', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + ], + ], + [ + 'name' => 'EncodeKey', + 'in' => 'query', + 'schema' => [ + 'title' => '编码类型对应的值，此处填写天猫精灵AI平台中，该产品ProductKey所在项目的Project ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '125****0946', + ], + ], + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'title' => '填写设备认证类型，“MAC”或者“SN”', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MAC', + ], + ], + [ + 'name' => 'IdentityIds', + '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, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'title' => '产品唯一标志符productKey，在天猫精灵AI平台中创建产品时，平台颁发的全局唯一标识。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Mm*****XnZ8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '返回的错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '返回的错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '返回result', + 'description' => '', + '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' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetDeviceBasicInfo' => [ + 'summary' => '获取设备认证信息', + 'path' => '/v1.0/ssp/getDeviceBasicInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DeviceInfo', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '返回的错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '返回的错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '返回result', + 'description' => '', + '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', + ], + 'Sn' => [ + 'title' => '设备SN', + 'description' => '', + 'type' => 'string', + 'example' => '1200xxx048', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListDeviceBasicInfo' => [ + 'summary' => '批量获取设备基本信息', + 'path' => '/v1.0/ssp/listDeviceBasicInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DeviceInfos', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '返回的错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '返回的错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '返回result，key为deviceOpenId或deviceUnionId，value为对应的设备信息', + 'description' => '', + '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', + ], + 'Sn' => [ + 'title' => '设备SN', + 'description' => '', + 'type' => 'string', + 'example' => '1200xx048', + ], + ], + 'description' => '', + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetDeviceStatusInfo' => [ + 'summary' => '获取设备状态信息', + 'path' => '/v1.0/ssp/getDeviceStatusInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DeviceInfo', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '返回的错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '返回的错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '返回result', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Online' => [ + 'title' => '是否在线，0为不在线，1为在线', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetDeviceStatusInfo.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 \\"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":""}]', + ], + 'GetDeviceTag' => [ + 'summary' => '获取设备标签', + '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' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '返回的错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '返回的错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '返回result', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DeviceTags' => [ + 'title' => '设备标签结果', + 'description' => '', + 'type' => 'object', + 'example' => '{ "antest1": "antest1", "antest": "a" }', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'DeviceControl' => [ + 'summary' => '设备控制', + 'path' => '/v1.0/ssp/control', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ControlRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '控制音量入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Volume' => [ + 'title' => '音量目标值', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Muted' => [ + 'title' => '是否静音', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeviceInfo', + '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' => '编码类型对应的值，此处填写该产品所在项目的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, + 'example' => '1*****2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'GetDeviceSetting' => [ + 'summary' => '获取设备的用户设置', + 'path' => '/v1.0/ssp/getDeviceSetting', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Keys', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备设置指定的Key集合，'."\n" + .'勿扰模式:nightMode', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + '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, + ], + ], + ], + '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' => 'object', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetDeviceStatusDetail' => [ + 'summary' => '获取设备状态详情', + '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' => '设备设置指定的Key集合，'."\n" + .'如播放器:player', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + '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' => '编码类型对应的值，此处填写该产品所在项目的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', + ], + ], + 'required' => true, + ], + ], + ], + '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' => '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' => '', + 'type' => 'object', + 'properties' => [ + 'Quantity' => [ + 'title' => '电量值', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Status' => [ + 'title' => '电源状态', + 'description' => '', + 'type' => 'string', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '0EC7*726E', + ], + ], + ], + ], + ], + '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"}]', + ], + 'SetDeviceSetting' => [ + 'summary' => '修改设备设置', + 'path' => '/v1.0/ssp/setDeviceSetting', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'formData', + 'schema' => [ + 'title' => '设备设置指定的Key集合，'."\n" + .'勿扰模式:nightMode', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'nightMode', + ], + ], + [ + 'name' => 'Value', + 'in' => 'formData', + 'schema' => [ + 'title' => '属性值', + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => '{"enable":true}', + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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, + ], + ], + 'required' => true, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', + ], + 'GetJiangSuTelecomData' => [ + 'summary' => '江苏电信号百', + 'path' => '/v1.0/ssp/GetJiangSuTelecomData', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-09', + ], + ], + ], + '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' => '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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"}]', + ], + 'ScgSearch' => [ + 'summary' => '选品池投放能力', + 'path' => '/v1.0/ssp/scgSearch', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TopicId', + 'in' => 'query', + 'schema' => [ + 'title' => '选品池ID 可选：MC201132（民族中国风），MC201136（流行音乐），MC201139（甜蜜爱情），MC201133（民谣），MC201137（放松阅读），MC201138（快乐），PA202029（故事），PA202030（儿歌），PA202028（国学历史），PA202032（百科），PA202031（英文儿歌）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MC201132', + ], + ], + [ + 'name' => 'ScgFilter', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + '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', + ], + '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' => '', + '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', + ], + ], + ], + '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', + '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' => '', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'OpenAddAndRemoveFavoriteContentRequest', + 'in' => 'formData', + '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', + ], + ], + '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, + ], + ], + ], + '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' => '121212121', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'CreatePlayingList' => [ + 'summary' => '播放列表创建', + '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' => 'OpenCreatePlayingListRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + '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', + ], + 'PlayMode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Repeat', + ], + 'ExtendInfo' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + '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' => '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', + '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' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenServiceResult<OpenPlayingItem>', + 'description' => 'OpenServiceResult<OpenPlayingItem>', + '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' => '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', + ], + ], + ], + 'Message' => [ + 'title' => '附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12343', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'song', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'description' => '', + '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', + ], + ], + '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', + ], + ], + ], + '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', + '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', + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetContent' => [ + 'summary' => '按照特定的id获取内容信息', + 'path' => '/v1.0/ssp/GetContent', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123123', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'song', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'Result' => [ + 'description' => '', + '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', + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + '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, + ], + ], + ], + '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' => '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' => '', + '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' => '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', + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetCurrentPlayingList' => [ + 'summary' => '获取当前播放列表', + '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' => 'OpenQueryPlayListRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '15', + ], + ], + '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, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'IndexControlPlayingList' => [ + 'summary' => '播放列表点击播放', + 'path' => '/v1.0/ssp/IndexControlPlayingList', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'OpenIndexControlRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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, + ], + ], + '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' => [ + '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, + ], + ], + ], + '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' => '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' => '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', + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListAlbumDetail' => [ + 'summary' => '获取音乐音频专辑里面的内容列表', + 'path' => '/v1.0/ssp/ListAlbumDetail', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '121321', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CurrentPageNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'OpenDataItemList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + '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', + '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', + ], + ], + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + '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', + ], + 'Styles' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13131', + ], + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'program', + ], + 'Valid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VALID', + ], + 'RawId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12323423', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21421', + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListCateContent' => [ + 'summary' => '根据特定的类目,按照指定的排序顺序获取该类目下的内容.', + 'path' => '/v1.0/ssp/ListCateContent', + 'methods' => [ + 'post', + ], + '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' => [ + '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', + ], + 'SortOrder' => [ + 'description' => '', + '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', + ], + ], + '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' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + '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' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + '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' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sucess', + ], + 'Result' => [ + 'description' => '', + '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', + ], + 'OpenDataItemList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26152778', + ], + 'Source' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'qingting', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Authors' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RawId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123123', + ], + 'Gender' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MALE', + ], + 'AuthorTypes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ANCHOR', + ], + ], + 'Source' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'qingting', + ], + 'Cover' => [ + 'description' => '', + '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', + ], + ], + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13597709', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Online' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + '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', + ], + 'Cover' => [ + '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/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', + ], + ], + ], + 'CommCateId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '80012017', + ], + 'Alias' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'Charge' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Audition' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RawId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '206775', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListCateInfo' => [ + 'summary' => '获取音乐音频类目列表', + 'path' => '/v1.0/ssp/ListCateInfo', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'song', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListCommonCateFirstFloor' => [ + 'summary' => '获取音乐/音频的一级类目列表', + 'path' => '/v1.0/ssp/ListCommonCateFirstFloor', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', + ], + 'Result' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListCommonCateSecondFloor' => [ + 'summary' => '获取指定一级类目下面的二级类目列表', + 'path' => '/v1.0/ssp/ListCommonCateSecondFloor', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ParentCateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80010', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListPlayHistory' => [ + 'summary' => '获取用户的播放历史', + 'path' => '/v1.0/ssp/ListPlayHistory', + 'methods' => [ + 'post', + ], + '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', + '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' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => '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' => '', + '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' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'PlayModeControl' => [ + 'summary' => '播放模式切换', + 'path' => '/v1.0/ssp/PlayModeControl', + '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', + '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, + ], + ], + ], + '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' => 'object', + 'properties' => [ + 'OpenPlayMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Normal', + 'enum' => [ + 'Repeat', + 'Shuffle', + 'RepeatOne', + 'Normal', + ], + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'PreviousAndNextControl' => [ + 'summary' => '上下首控制', + 'path' => '/v1.0/ssp/PreviousAndNextControl', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + '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' => '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, + ], + ], + ], + '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' => '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' => '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', + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'OpenProgressControlRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Progress' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + 'ExtendInfo' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + ], + ], + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'SearchContent' => [ + 'summary' => '按照特定的搜索条件搜索', + 'path' => '/v1.0/ssp/SearchContent', + 'methods' => [ + 'post', + ], + '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' => [ + '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', + ], + ], + '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' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + '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' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => 'true', + ], + ], + ], + ], + 'Category' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'audio', + ], + 'Charge' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'fasle', + ], + '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', + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'CloudPlayer' => [ + 'summary' => '云播放器：对外', + 'path' => '/v1.0/ssp/cloud/player', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + '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', + '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', + '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' => '', + ], + ], + 'required' => true, + ], + ], + [ + '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' => '', + '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' => '', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + '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' => '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' => '', + ], + ], + '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', + ], + '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', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + 'Authors' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + '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', + ], + ], + ], + '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, + ], + ], + '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', + ], + ], + ], + '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"}]', + ], + 'ListSub' => [ + 'summary' => '订阅列表', + 'path' => '/v1.0/ssp/listSub', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '分页参数', + 'description' => '', + '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', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => [ + 'PROJECT_ID', + ], + ], + 'EncodeKey' => [ + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + '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, + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'type' => 'string', + 'required' => true, + 'example' => 'PROJECT_ID', + 'enum' => [ + 'PROJECT_ID', + ], + ], + 'EncodeKey' => [ + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + '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, + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + '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' => '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', + ], + 'DataList' => [ + 'title' => '订阅列表', + 'description' => '', + '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', + ], + 'ScheduleInfo' => [ + 'title' => '定时信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'title' => '触发周期', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'maxItems' => 7, + 'minItems' => 1, + ], + 'Hour' => [ + 'title' => '触发小时', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Minute' => [ + 'title' => '触发分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + ], + ], + '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' => '小科学家探索', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '0D0C09C2-ADC1-198B-964D-24F4FAD967DB', + ], + ], + ], + ], + ], + '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\\": {\\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"}]', + ], + 'ListSubAlbum' => [ + 'summary' => '订阅专辑元数据列表', + 'path' => '/v1.0/ssp/listSubAlbum', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'QuerySubscriptionAlbumRequest', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'request', + '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' => '睡前故事', + ], + 'Page' => [ + 'title' => '分页参数', + 'description' => '', + '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', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + 'DeviceId' => [ + 'title' => '设备ID', + 'type' => 'string', + 'docRequired' => true, + 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', + ], + 'UserId' => [ + 'title' => '用户ID', + 'type' => 'string', + 'docRequired' => true, + 'example' => '1152893538998276761', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + '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, + ], + ], + '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' => [ + 'Message' => [ + 'title' => '附加信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '结果', + 'description' => '', + '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', + ], + 'DataList' => [ + 'title' => '专辑List', + 'description' => '', + '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', + ], + 'ScheduleInfo' => [ + 'title' => '定时信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DaysOfWeek' => [ + 'title' => '触发周期', + 'description' => '', + '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', + ], + ], + ], + 'TotalEpisode' => [ + 'title' => '共多少集', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Sequence' => [ + 'title' => '排序', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'IsAdded' => [ + 'title' => '是否已订阅', + 'description' => '', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => 'CB13B8D7-37FB-1B3E-8EB9-65BB413267E1', + ], + ], + ], + ], + ], + '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 \\"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"}]', + ], + 'ListSubscriptionAlbumCategory' => [ + 'summary' => '内容订阅元数据分类', + 'path' => '/v1.0/ssp/listSubscriptionAlbumCategory', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CategoryName', + 'in' => 'query', + 'schema' => [ + 'title' => '分类名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '儿歌', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '附加信息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'title' => '分类List', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'title' => '分类ID', + 'description' => '', + 'type' => 'string', + 'example' => '80011', + ], + 'CategoryName' => [ + 'title' => '分类名称', + 'description' => '', + 'type' => 'string', + 'example' => '儿童', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '', + 'type' => 'string', + 'example' => '60E7A523-9766-1D07-87A2-6E587420C59B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'IdempotentParameterMismatch', + ], + ], + ], + '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"}]', + ], + 'GetAlbumDetailById' => [ + 'summary' => '获取专辑数据', + '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' => 'AlbumId', + 'in' => 'query', + 'schema' => [ + 'title' => '专辑ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '51999575', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetUnreadMessageCount' => [ + 'summary' => '查询未读留言数量', + 'path' => '/v1.0/ssp/getUnreadMessageCount', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EncodeType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + ], + 'EncodeKey' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'IdType' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Result' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'BeforeTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-27 14:06:55.984', + ], + ], + [ + 'name' => 'limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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' => 'HOFF****my7Iw=', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + 'example' => '', + ], + 'Pic' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://xx', + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ReadMessage' => [ + 'summary' => '读取留言', + 'path' => '/v1.0/ssp/readMessage', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'deprecated' => false, + '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' => '123L', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'CreateAlarm' => [ + 'summary' => '创建闹钟', + 'path' => '/v1.0/ssp/createAlarm', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => [ + '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' => [ + 'type' => 'string', + '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' => 'AmpResult', + 'description' => '', + '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' => '43***28C-A810-5***-8747-EC226A086881', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'DeleteAlarms' => [ + 'summary' => '闹钟批量删除', + 'path' => '/v1.0/ssp/deleteAlarms', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => [ + '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, + ], + ], + '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时，其值为应用的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=', + ], + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult', + 'description' => 'AmpResult', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '43***28C-A810-5***-8747-EC226A086881', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetAlarm' => [ + 'summary' => '获取单个闹钟', + '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' => '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, + ], + 'AlarmId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234567', + ], + ], + '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时，其值为应用的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=', + ], + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult', + 'description' => 'AmpResult', + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListAlarms' => [ + 'summary' => '查询闹钟列表', + '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' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + '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, + ], + ], + '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时，其值为应用的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=', + ], + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult', + 'description' => 'AmpResult', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Result' => [ + 'description' => '', + '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' => [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'ListMusic' => [ + 'summary' => '基于音乐类型查询铃声列表（分页）', + 'path' => '/v1.0/ssp/listMusic', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => [ + 'RequestId' => [ + 'type' => 'string', + 'required' => true, + ], + 'UserId' => [ + 'type' => 'string', + 'required' => true, + ], + 'AccessKeyId' => [ + 'title' => '调用方', + 'type' => 'string', + 'required' => true, + ], + 'DeviceId' => [ + 'type' => 'string', + 'required' => true, + ], + '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' => 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', + ], + ], + '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时，其值为应用的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=', + ], + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult', + 'description' => 'AmpResult', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Result' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '43***28C-A810-5***-8747-EC226A086881', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'QueryMusicType' => [ + 'summary' => '获取闹钟音乐类型列表', + 'path' => '/v1.0/ssp/queryMusicType', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => [ + 'RequestId' => [ + 'type' => 'string', + 'required' => true, + ], + 'UserId' => [ + 'type' => 'string', + 'required' => true, + ], + 'AccessKeyId' => [ + 'title' => '调用方', + 'type' => 'string', + 'required' => true, + ], + 'DeviceId' => [ + 'type' => 'string', + 'required' => true, + ], + ], + 'required' => false, + ], + ], + [ + '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时，其值为应用的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=', + ], + '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', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'AmpResult', + 'description' => 'AmpResult', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Result' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MusicType' => [ + 'title' => '铃声类型id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MusicTypeName' => [ + 'title' => 'musicTypeName', + 'description' => '', + 'type' => 'string', + 'example' => 'xx', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '43***28C-A810-5***-8747-EC226A086881', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'UpdateAlarm' => [ + 'summary' => '更新闹钟', + 'path' => '/v1.0/ssp/updateAlarm', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => [ + '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, + ], + ], + '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' => 'AmpResult', + 'description' => 'AmpResult', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Result' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '43***28C-A810-5***-8747-EC226A086881', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'CreateScheduleTask' => [ + 'summary' => '创建定时任务', + 'path' => '/v1.0/ssp/CreateScheduleTask', + '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' => '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult<Long>', + 'description' => 'AmpResult<Long>', + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'DeleteScheduleTask' => [ + 'summary' => '删除定时任务', + 'path' => '/v1.0/ssp/DeleteScheduleTask', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + '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' => [ + '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, + ], + ], + [ + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult<Boolean>', + 'description' => 'AmpResult<Boolean>', + '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', + ], + ], + ], + ], + ], + '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":""}]', + ], + 'GetScheduleTask' => [ + 'summary' => '查询定时任务', + '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' => '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' => '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult<ScheduleOpenResponse>', + 'description' => 'AmpResult<ScheduleOpenResponse>', + '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' => '', + '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}}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + '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, + ], + ], + 'required' => false, + 'docRequired' => 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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AmpResult<WeatherResponse>', + 'description' => 'AmpResult<WeatherResponse>', + 'type' => 'object', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'OAuth 2.0 Bearer Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'OpenCreatePlayingListRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + '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', + ], + 'PlayMode' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Repeat', + ], + 'ExtendInfo' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + ], + ], + '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', + 'enum' => [ + 'UNION_ID', + 'OPEN_ID', + ], + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + 'OrganizationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + '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' => '', + 'type' => 'string', + 'example' => '10002398812', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'openapi.aligenie.com', + ], + ], +]; |