'1.0', 'info' => [ 'style' => 'AliGenie', 'product' => 'AliGenie', 'version' => 'oauth2_1.0', ], 'directories' => [ [ 'id' => 196076, 'title' => '资源API', 'type' => 'directory', 'children' => [ 'GetSmartHomeSceneList', 'ExecuteSmartHomeScene', 'GetUserBasicInfo', 'GetUserPhone', 'GetSceneList', 'ExecuteScene', 'QueryDeviceList', 'PushDeviceNotification', 'CreatePlayingList', ], ], [ 'id' => 196077, 'title' => '授权API', 'type' => 'directory', 'children' => [ 'OAuth2TokenEndpoint', 'OAuth2RevocationEndpoint', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GetSmartHomeSceneList' => [ 'summary' => '获取全屋App中用户配置的包含三方设备的场景控制列表。', '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' => '请求Id', 'type' => 'string', 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'."\n", ], 'FamilySceneList' => [ 'description' => '家庭维度场景列表', 'type' => 'array', 'items' => [ 'description' => '家庭场景对象', 'type' => 'object', 'properties' => [ 'familyId' => [ 'description' => '家庭Id', 'type' => 'string', 'example' => '2iS1AH5eo8qrw1PYBL/Ulq==', ], 'familyName' => [ 'description' => '家庭名称', 'type' => 'string', 'example' => '我的家', ], 'sceneList' => [ 'description' => '场景列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SceneId' => [ 'description' => '场景Id', '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"}]', 'title' => '获取场景列表（全屋）', ], 'ExecuteSmartHomeScene' => [ 'summary' => '执行全屋App中用户配置的包含三方设备的场景。', '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' => '家庭Id', 'type' => 'string', 'required' => true, 'example' => '2iS1AH5eo8qrw1PYBL/Ulq==', ], ], [ 'name' => 'SceneId', 'in' => 'formData', 'schema' => [ 'description' => '场景Id', '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' => '请求Id', 'type' => 'string', 'example' => '435CF567-12DC-5761-AFA8-650774502E2D', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"435CF567-12DC-5761-AFA8-650774502E2D\\"\\n}","type":"json"}]', 'title' => '执行场景（全屋）', 'responseParamsDescription' => '需要关注的异常'."\n" ."\n" .'异常 1:'."\n" .'- Code：scene_not_exist'."\n" .'- Message：The scene does not exist.'."\n" .'- 描述：场景不存在，可能已被删除。'."\n" ."\n" .'异常 2:'."\n" .'- Code：scene_not_include_third_party_device'."\n" .'- Message：The scene does not include third-party devices.'."\n" .'- 描述：场景中不包含三方设备，可能用户进行了修改，将三方设备从场景中删除了。', ], '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' => '用户openId', 'type' => 'string', 'example' => '3hPPBd9YuhfJQCzZ/07AAWdoO3K8zCb/KAqW96zPHXPiFkzjB/JfcWuuFHQQDaGZ4wVbNMV6wYuj075p/rhVLg==', ], 'UnionIds' => [ 'title' => '用户unionId列表', 'description' => '用户unionId列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OrganizationId' => [ 'title' => '组织id', 'description' => '组织id', 'type' => 'string', ], 'UnionId' => [ 'title' => 'unionId', 'description' => 'unionId', 'type' => 'string', ], ], ], ], 'Nickname' => [ 'title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'example' => 'xxxxxx', ], 'AvatarUrl' => [ 'title' => '用户头像地址', 'description' => '用户头像地址', 'type' => 'string', 'example' => 'https://xxxxxx', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', '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"}]', 'title' => '获取用户基本信息', ], '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"}]', 'title' => '获取用户手机号', ], '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' => '场景Id', 'type' => 'string', 'example' => '840960b85c3c48e0bd7260c1718295fd', ], 'SceneName' => [ 'title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'example' => '回家场景', ], ], ], ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', '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"}]', 'title' => '获取场景列表', ], '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' => '场景Id', 'type' => 'string', 'required' => false, 'example' => 'a84a55aa410e460a9ac753570c76fecc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]', 'title' => '执行场景', 'responseParamsDescription' => '需要特殊处理的异常'."\n" ."\n" .'异常1:'."\n" .'- Code：scene_not_exist'."\n" .'- Message：The scene does not exist.'."\n" .'- 描述：场景不存在，可能已被删除'."\n" .'- 备注：出现该异常时，请主动解除与该场景的关联关系，且不再执行该场景。'."\n" ."\n" .'异常2:'."\n" .'- Code：scene_disable'."\n" .'- Message：The scene is disabled.'."\n" .'- 描述：场景已被禁用'."\n" .'- 备注：出现该异常时，请主动解除与该场景的关联关系，且不再执行该场景。'."\n" ."\n" .'异常3:'."\n" .'- Code：scene_not_within_effective_time'."\n" .'- Message：The current time is not within the effective time of the scene.'."\n" .'- 描述：当前时间不在场景允许的生效时间段内，场景不执行。'."\n" .'- 备注：出现该异常时，可考虑提示用户场景执行失败以及原因。', ], 'QueryDeviceList' => [ 'summary' => '提供给三方客户端查询用户已授权（三方需要提前申请授权的PK列表）的设备列表。', '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' => '实体key', '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信息列表', 'description' => '设备UnionId信息列表', 'type' => 'array', 'items' => [ 'title' => '设备UnionId信息', 'description' => '设备UnionId信息', 'type' => 'object', 'properties' => [ 'OrganizationId' => [ 'title' => '组织ID', 'description' => '组织ID', 'type' => 'string', 'example' => '123456', ], 'UnionId' => [ 'title' => 'UnionId', 'description' => 'UnionId', 'type' => 'string', 'example' => 'cJwXrIut3zIgcKyCiS7aKMAiEiE', ], ], ], ], 'DeviceName' => [ 'title' => '设备名称', 'description' => '设备名称', 'type' => 'string', 'example' => 'CC10电池版', ], 'DeviceIconUrl' => [ 'title' => '设备图片地址', 'description' => '设备图片地址', 'type' => 'string', 'example' => 'https://XXXXXX', ], 'Online' => [ 'title' => '在线状态，1:在线，0离线', 'description' => '在线状态，1:在线，0离线', 'type' => 'string', 'example' => '1', ], ], ], ], 'RequestId' => [ 'title' => '请求id', 'description' => '请求id', '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"}]', 'title' => '查询设备列表', ], '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' => '推送的目标类型，获取到对应设备的类型 '."\n" .'DEVICE_UNION_ID：设备unionId'."\n" .'DEVICE_OPEN_ID：设备openId', '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' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', 'type' => 'string', 'required' => true, 'example' => '2iU81*****G9elJ', ], 'PlaceHolder' => [ 'title' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', 'description' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '{"nick":"小甜甜"}', 'description' => '占位符信息，例如：模板【你好，{nick}！】，此处可以是：{"nick":"小甜甜"}。此外，在占位符参数里我们还可以对填写的应用调起链接增加参数，以支持跳转到指定地址的功能，如：`{"nick":"小甜甜","_URL_SUFFIX_":"xxx"}`。消息弹窗内的跳转地址就是：应用调起链接+`${_URL_SUFFIX_}`，此功能只对配置了调起链接的应用有效', ], ], 'EncodeType' => [ 'title' => '实体类型', 'description' => '实体类型', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', ], 'EncodeKey' => [ 'title' => '实体key', 'description' => '实体key', 'type' => 'string', 'required' => true, 'example' => '1923792******8R7392', ], 'OrganizationId' => [ 'title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', 'description' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', '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' => '猫精应用id，【开发者平台-技能应用】创建应用后得到的应用id', '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' => '请求ID', 'type' => 'string', 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]', 'title' => '推送设备通知', ], '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' => '播放来源,配置播控能力的唯一标识'."\n" ."\n" .'可空，默认为default', 'type' => 'string', 'required' => false, 'example' => 'default', ], 'ContentType' => [ 'title' => '播放内容类型'."\n" ."\n" .'内容：content；专辑：album；歌单：collect', 'description' => '播放内容类型'."\n" ."\n" .'内容：content；专辑：album；歌单：collect', 'type' => 'string', 'required' => true, 'example' => 'content', 'enum' => [ 'content', 'album', 'collect', ], ], 'ContentList' => [ 'title' => '播放内容列表'."\n" ."\n" .'若是内容，支持多个；若是专辑，只有第一个有效。'."\n", 'description' => '播放内容列表'."\n" ."\n" .'若是内容，支持多个；若是专辑，只有第一个有效。'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RawId' => [ 'title' => '三方id'."\n" ."\n" .'如果是内容则是内容id；如果是专辑则是专辑id'."\n", 'description' => '三方id'."\n" ."\n" .'如果是内容则是内容id；如果是专辑则是专辑id'."\n", 'type' => 'string', 'required' => true, 'example' => '12345', ], 'Source' => [ 'title' => '来源'."\n", 'description' => '来源'."\n", 'type' => 'string', 'required' => true, 'example' => 'ximalayaH5', ], ], 'required' => true, ], 'required' => true, ], 'Index' => [ 'title' => '播放的index'."\n" ."\n" .'可空。默认为0，表示从头播放', 'description' => '播放的index'."\n" ."\n" .'可空。默认为0，表示从头播放', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'NeedAlbumContinued' => [ 'title' => '专辑是否续播，比如上次专辑听到第五集，是否继续从第五集开始。默认为true', 'description' => '专辑是否续播，比如上次专辑听到第五集，是否继续从第五集开始。默认为true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], 'PlayMode' => [ 'title' => '播放模式'."\n" ."\n" .'列表循环：Repeat；随机：Shuffle；单曲循环：RepeatOne；顺序播放：Normal。', 'description' => '播放模式'."\n" ."\n" .'列表循环：Repeat；随机：Shuffle；单曲循环：RepeatOne；顺序播放：Normal。', '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' => '编码类型，此处填写UC_CLIENT_ID。', 'type' => 'string', 'required' => true, 'example' => 'UC_CLIENT_ID', 'enum' => [ 'UC_CLIENT_ID', ], ], 'EncodeKey' => [ 'title' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值，此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123', ], 'IdType' => [ 'title' => '设备Id的类型 ： OPEN_ID：默认的设备ID标识。 UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', 'description' => '设备Id的类型 ： OPEN_ID：默认的设备ID标识。 UNION_ID: 组织维度的设备ID标识，需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => [ 'OPEN_ID', 'UNION_ID', ], ], 'Id' => [ 'title' => '设备标识，填写deviceOpenId或deviceUnionId的值。', 'description' => '设备标识，填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123', ], 'OrganizationId' => [ 'title' => '组织ID，如果IdType为UNION_ID时必填。', 'description' => '组织ID，如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '10002398812', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10002398812\\"\\n}","type":"json"}]', 'title' => '创建播放列表', ], 'OAuth2TokenEndpoint' => [ 'summary' => 'OAuth2令牌端点，目前支持以下两种操作：'."\n" .'1. 通过code获取access_token。'."\n" .'2. 通过refresh_token刷新access_token。', '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' => '授权类型，必填。'."\n" .'authorization_code: 用授权码来获取访问令牌'."\n" .'refresh_token: 刷新访问令牌', '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' => 'access_token 授予的访问权限范围，表示为以空格分隔、区分大小写的字符串列表。', 'type' => 'string', 'example' => 'aligenie:user:basic:read aligenie:iot:scene:read', ], 'TokenType' => [ 'title' => '返回的令牌的类型。此时，此字段的值始终设置为 Bearer。', 'description' => '返回的令牌的类型。此时，此字段的值始终设置为 Bearer。', 'type' => 'string', 'example' => 'Bearer', ], 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', '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"}]', 'title' => 'OAuth2令牌端点', ], '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' => '要撤销的令牌，可以是访问令牌或刷新令牌。'."\n" .'如果传递的是access_token，则仅会撤销access_token，refresh_token依然可以刷新获取新的访问令牌。'."\n" .'如果传递的是refresh_token，则会同时撤销access_token和对应的refresh_token。', 'type' => 'string', 'required' => false, 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0', ], ], [ 'name' => 'TokenTypeHint', 'in' => 'formData', 'schema' => [ 'title' => '令牌类型的提示，可以是access_token或refresh_token，用于帮助授权服务器理解要撤销的是哪种类型的令牌。', 'description' => '令牌类型的提示，可以是access_token或refresh_token，用于帮助授权服务器理解要撤销的是哪种类型的令牌。', '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"}]', 'title' => 'OAuth2令牌撤销端点', ], ], 'endpoints' => [ [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'openapi.aligenie.com', ], ], ];