'1.0', 'info' => ['style' => 'ROA', 'product' => 'AliGenie', 'version' => 'ssp_1.0'], 'directories' => [ [ 'children' => ['AuthLoginWithThirdUserInfo', 'EcologyOpennessSendVerificationCode', 'FindUserlistToAuthLoginWithPhoneNumber', 'AuthLoginWithAligenieUserInfo', 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber', 'AuthLoginWithTaobaoUserInfo', 'EcologyOpennessAuthenticate', 'GetAligenieUserInfo', 'UnbindAligenieUser', 'QueryUserDeviceListByTmeUserId', 'InvalidateThirdPartyAppLoginState'], 'type' => 'directory', 'title' => 'Account Binding and User Authorization', ], [ 'children' => ['CheckAuthCodeBindForExt', 'GetCodeEnhance', 'ScanCodeBind'], 'type' => 'directory', 'title' => 'Activate Binding', ], [ 'children' => ['GetUserByDeviceId', 'ListDeviceByUserId', 'UnbindDevice', 'ListDeviceByUserIdAndChanel'], 'type' => 'directory', 'title' => 'User-Device Relationship', ], [ 'children' => ['GetDeviceIdByIdentity', 'ListDeviceIdByIdentities', 'GetDeviceBasicInfo', 'ListDeviceBasicInfo', 'GetDeviceStatusInfo', 'GetDeviceTag', 'DeviceControl', 'GetDeviceSetting', 'GetDeviceStatusDetail', 'SetDeviceSetting'], 'type' => 'directory', 'title' => 'Device Information', ], [ 'children' => [ [ 'children' => ['GetJiangSuTelecomData'], 'type' => 'directory', 'title' => 'Data', ], [ 'children' => [ 'ScgSearch', 'AddAndRemoveFavoriteContent', 'CreatePlayingList', 'GetAlbum', 'GetContent', 'GetCurrentPlayingItem', 'GetCurrentPlayingList', 'IndexControlPlayingList', 'ListAlbumDetail', 'ListCateContent', 'ListCateInfo', 'ListCommonCateFirstFloor', 'ListCommonCateSecondFloor', 'ListPlayHistory', 'ListRecommendContent', 'PlayAndPauseControl', 'PlayModeControl', 'PreviousAndNextControl', 'ProgressControl', 'SearchContent', 'CloudPlayer', 'MobileRecommend', ], 'type' => 'directory', 'title' => 'Video-on-Demand Content', ], [ 'children' => ['AddSub', 'DeleteSub', 'ListAlbumIsAdded', 'ListSub', 'ListSubAlbum', 'ListSubscriptionAlbumCategory', 'GetAlbumDetailById'], 'type' => 'directory', 'title' => 'Course Subscription', ], [ 'children' => ['GetUnreadMessageCount', 'ListUserMessage', 'ReadMessage', 'SendMessage'], 'type' => 'directory', 'title' => 'Message', ], [ 'children' => ['CreateAlarm', 'DeleteAlarms', 'GetAlarm', 'ListAlarms', 'ListMusic', 'QueryMusicType', 'UpdateAlarm'], 'type' => 'directory', 'title' => 'Alarm', ], [ 'children' => ['CreateScheduleTask', 'DeleteScheduleTask', 'GetScheduleTask'], 'type' => 'directory', 'title' => 'Scheduled Task', ], [ 'children' => ['GetWeather'], 'type' => 'directory', 'title' => 'Weather', ], ], 'type' => 'directory', 'title' => 'Feature API', ], [ 'children' => ['CreatePlayingListOAuth2', 'ThirdImmediateMsgPush'], 'type' => 'directory', 'title' => 'Other', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddAndRemoveFavoriteContent' => [ 'summary' => 'Collect or remove from favorites.', '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' => 'Business parameters', 'type' => 'object', 'properties' => [ 'PackageType' => ['description' => 'Content type'."\n" ."\n" .'Content: CONTENT; Album: ALBUM; Playlist: COLLECT.', 'type' => 'string', 'required' => true, 'example' => 'CONTENT', 'title' => ''], 'OpenSourceRawIdPair' => [ 'description' => 'Object to collect or remove from favorites', 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'required' => true, 'example' => '2105818057', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'required' => true, 'example' => 'xiami', 'title' => ''], 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], 'FavoriteCmd' => ['description' => 'Operation Type'."\n" ."\n" .'ADD for collect; REMOVE for remove from favorites', 'type' => 'string', 'required' => true, 'example' => 'ADD', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identification information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of User ID.'."\n" ."\n" .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skills Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'Type of device ID'."\n" ."\n" .'`OPEN_ID`: Default device ID identifier. `UNION_ID`: Device ID identifier at the organization dimension. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => ['description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Message' => ['description' => 'Additional information. In common scenarios, this provides a brief description of a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '121212121', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. The value true indicates success, and false indicates failure. When the value is false, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"121212121\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Collect or remove from favorites', 'changeSet' => [], ], 'AddSub' => [ 'summary' => 'Subscribe to an album.', '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' => '', 'description' => 'Subscribe to album request ', 'type' => 'object', 'properties' => [ 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'docRequired' => true, 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', 'description' => ''], 'UserId' => ['title' => 'User ID', 'type' => 'string', 'docRequired' => true, 'example' => '1152893538998276761', 'description' => ''], 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule information', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ 'title' => '', 'description' => 'The specific days of the week for weekly reminders. Valid values are 1 to 7.', 'type' => 'array', 'items' => [ 'description' => 'The specific days of the week for weekly reminders. Valid values are 1 to 7.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '7', 'minimum' => '1', 'example' => '1,3,5,7,6', 'enum' => ['1', '2', '3', '4', '5', '6', '7'], 'title' => '', ], 'required' => true, 'docRequired' => true, 'maxItems' => 7, 'minItems' => 1, 'example' => '', ], 'Hour' => ['title' => '', 'description' => 'The hour of the clock when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '23', 'minimum' => '0', 'example' => '1'], 'Minute' => ['title' => '', 'description' => 'The minute of the hour when the reminder is triggered.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '59', 'minimum' => '0', 'example' => '23'], ], 'required' => true, 'docRequired' => true, 'example' => '', ], 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51999575'], 'PlayMode' => ['title' => '', 'description' => 'Playback pattern (currently only supports sequence) ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sequence'], 'DailyStudyCnt' => ['title' => '', 'description' => 'Daily study quantity', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device Information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'description' => '', 'title' => '', ], 'EncodeKey' => [ 'type' => 'string', 'required' => false, 'example' => '123', 'enum' => [], 'description' => '', 'title' => '', ], 'IdType' => [ 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'description' => '', 'title' => '', ], 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User Information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'description' => '', 'title' => '', ], 'EncodeKey' => [ 'type' => 'string', 'required' => false, 'example' => '123', 'enum' => [], 'description' => '', 'title' => '', ], 'IdType' => [ 'type' => 'string', 'required' => false, 'enum' => ['OPEN_ID', 'UNION_ID'], 'description' => '', 'title' => '', 'example' => '', ], 'Id' => ['type' => 'string', 'required' => false, 'example' => '123', 'description' => '', 'title' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], 'Result' => [ 'title' => '', 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Subscription record ID', 'type' => 'integer', 'format' => 'int64', 'example' => '81'], 'DeviceId' => ['title' => '', 'description' => 'Device ID', 'type' => 'string', 'example' => '5874DBCCA3038FAA1A70A8060F07F26D'], 'UserId' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => '1152893538998276761'], 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule information ', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ 'title' => '', 'description' => 'The epoch for trigger ', 'type' => 'array', 'items' => ['description' => 'Set the specific days of the week for reminders. The value range is 1 to 7. ', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'example' => '', ], 'Hour' => ['title' => '', 'description' => 'The hour of the clock when the trigger occurs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], 'Minute' => ['title' => '', 'description' => 'The minute of the Time when the trigger occurs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], ], 'example' => '', ], 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '51999575'], 'PlayMode' => ['title' => '', 'description' => 'Playback mode', 'type' => 'string', 'example' => 'sequence'], 'DailyStudyCnt' => ['title' => '', 'description' => 'Daily study quantity', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], 'example' => '', ], 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'B99D27ED-4E12-1414-9FDE-599C57C4B204'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Result\\": {\\n \\"Id\\": 81,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": \\"1152893538998276761\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B99D27ED-4E12-1414-9FDE-599C57C4B204\\"\\n}","type":"json"}]', 'title' => 'Subscribe to album ', 'changeSet' => [], ], 'AuthLoginWithAligenieUserInfo' => [ 'summary' => 'Authorize logon by specifying an Aligenie account. ', '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' => '', 'description' => 'Session ID ', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ 'name' => 'EncryptedAligenieUserIdentifier', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Encrypted Aligenie User Identifier ', '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' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ 'title' => '', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'LoginStateAccessToken' => ['title' => '', 'description' => 'Login state access token ', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'], 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the login state access token (long integer) ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230', 'default' => '1659506854230'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]', 'title' => 'Authorize logon by specifying an Aligenie account ', 'changeSet' => [], ], 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber' => [ 'summary' => 'Generate a Genie account by phone number for authorization logon.', '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' => '', 'description' => 'Session ID', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ 'title' => '', 'description' => 'Response Result', 'type' => 'object', 'properties' => [ 'LoginStateAccessToken' => ['title' => '', 'description' => 'Logon state access token', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'], 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the logon state access token (long integer)', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230', 'default' => '1659506854230'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]', 'title' => 'Generate a Genie account by phone number for authorization logon', 'changeSet' => [], ], 'AuthLoginWithTaobaoUserInfo' => [ 'summary' => 'Authorize logon by specifying a Taobao account ', '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' => '', 'description' => 'Session ID ', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ 'name' => 'EncryptedTaobaoUserIdentifier', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Encrypted Taobao User Identifier ', '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' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ 'title' => '', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'LoginStateAccessToken' => ['title' => '', 'description' => 'Login state access token ', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'], 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the login state access token (long integer) ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]', 'title' => 'Authorize logon by specifying a Taobao account ', 'changeSet' => [], ], 'AuthLoginWithThirdUserInfo' => [ 'summary' => 'Authorize logon by using third-party user information. ', 'path' => '/v1.0/ssp/authLoginWithThirdUserInfo', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/x-www-form-urlencoded'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Scene code, which must be requested from Tmall Genie in advance', 'type' => 'string', 'required' => true, 'example' => 'wechat_ecology_openness'], ], [ 'name' => 'ThirdUserType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Third-party User Type', 'type' => 'string', 'required' => true, 'example' => 'weChatUser'], ], [ 'name' => 'ThirdUserIdentifier', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Third-party User Identifier', 'type' => 'string', 'required' => true, 'example' => 'o5qxy6EItZBasv2VZAf-MGwllHL4'], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => ['title' => '', 'description' => 'Extension information', 'type' => 'object', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ 'title' => '', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'LoginStateAccessToken' => ['title' => '', 'description' => 'Logon state access token ', 'type' => 'string', 'example' => 'bd9ccdb121ee950ddead51e943e081fe'], 'ExpiredTimeLong' => ['title' => '', 'description' => 'Expiration time of the logon state access token ', 'type' => 'integer', 'format' => 'int64', 'example' => '1659428051452', 'default' => '1659333475811'], ], 'example' => '', ], 'DataObj' => [ 'title' => '', 'description' => 'When Code is 5140001, it indicates that logon failed because the third-party user is not attached to a Tmall Genie user. The frontend must initiate the phone number authorization logon flow based on this error code. In subsequent steps, the frontend must return the SessionId in DataObj to the server. ', 'type' => 'object', 'properties' => [ 'SessionId' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"bd9ccdb121ee950ddead51e943e081fe\\",\\n \\"ExpiredTimeLong\\": 1659428051452\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","type":"json"}]', 'title' => 'Authorize logon by third-party user information', 'changeSet' => [], ], 'CheckAuthCodeBindForExt' => [ 'summary' => 'Poll the result of the activation attachment.', 'path' => '/v1.0/ssp/checkAuthCodeBindForExt', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'EncodeType', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'Encoding type. Enter PROJECT_ID here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], ], [ 'name' => 'EncodeKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project containing the ProductKey of this product in the Tmall Genie AI platform. ', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ 'name' => 'AuthCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The authCode obtained by specifying a user ID ', 'type' => 'string', 'required' => true, 'example' => 'Aexfgc'], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of user identifier information. ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter PROJECT_ID here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the product\'s project here. You can view it in the Tmall Genie AI platform console. ', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ 'title' => '', 'description' => 'The type of User ID: '."\n" .'OPEN_ID: The default User ID identity. '."\n" .'UNION_ID: The User ID identity at the organization dimension, which requires prior request for an organization on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'User identifier. Enter the value of userOpenId or userUnionId. ', 'type' => 'string', 'required' => true, 'example' => '123'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1***2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The returned error code. The value 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information', 'type' => 'object', 'properties' => [ 'UserOpenInfo' => [ 'title' => '', 'description' => 'User open information', 'type' => 'object', 'properties' => [ 'IdType' => ['title' => 'USER_ID', 'description' => 'USER_ID', 'type' => 'string', 'example' => 'USER_ID'], 'Id' => ['title' => '', 'description' => 'External user ID', 'type' => 'string', 'example' => '0963*0158'], ], 'example' => '', ], 'DeviceOpenInfo' => [ 'title' => '', 'description' => 'Device open information', 'type' => 'object', 'properties' => [ 'IdType' => ['title' => 'DEVICE_ID', 'description' => 'DEVICE_ID', 'type' => 'string', 'example' => 'DEVICE_ID'], 'Id' => ['title' => '', 'description' => 'External device ID', 'type' => 'string', 'example' => 'A963*0158'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenInfo\\": {\\n \\"IdType\\": \\"USER_ID\\",\\n \\"Id\\": \\"0963*0158\\"\\n },\\n \\"DeviceOpenInfo\\": {\\n \\"IdType\\": \\"DEVICE_ID\\",\\n \\"Id\\": \\"A963*0158\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Polling result of activation binding ', 'changeSet' => [], ], 'CloudPlayer' => [ 'summary' => 'Cloud Push Song: Create a playlist by providing the device openUuid and the Tmall Genie openUserId.', 'path' => '/v1.0/ssp/cloud/player', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Open user information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => ['description' => 'Encoding key', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => [ 'description' => 'ID Type', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'title' => '', ], 'Id' => ['description' => 'Open ID', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID (can be empty)', 'type' => 'string', 'required' => false, 'example' => '为空', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => [ 'description' => 'Encoding key', 'type' => 'string', 'required' => true, 'example' => '123', 'enum' => [], 'title' => '', ], 'IdType' => [ 'description' => 'ID Type', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['UNION_ID', 'OPEN_ID'], 'title' => '', ], 'Id' => ['description' => 'Open ID', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID (can be empty)', 'type' => 'string', 'required' => false, 'example' => '为空', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => 'Source of cloud-recommended songs', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['KG' => ''], 'example' => 'KG', 'title' => '', ], ], [ 'name' => 'SongIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of song IDs (1–200 songs)', 'type' => 'array', 'items' => ['description' => 'Song ID', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], 'required' => true, 'maxItems' => 200, 'minItems' => 1, 'title' => '', 'example' => '', ], ], [ 'name' => 'CurPlayIndex', 'in' => 'query', 'schema' => ['description' => 'Index of the currently playing song. Starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'maximum' => '200', 'minimum' => '1', 'title' => ''], ], [ 'name' => 'PlayMode', 'in' => 'query', 'schema' => [ 'description' => 'Playback pattern', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['Shuffle' => '', 'RepeatOne' => '', 'Repeat' => '', 'Normal' => ''], 'example' => 'Normal', 'title' => '', ], ], [ 'name' => 'SongId', 'in' => 'query', 'schema' => ['description' => 'Song ID (used to recompute the index when the index is invalid)', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ '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' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => ['description' => 'Return Result: true indicates validation succeeded; false indicates validation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7D82DB0-DD59-5756-AC62-871C9D7DBC36\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true\\n}","type":"json"}]', 'title' => 'Cloud Push Song', 'description' => 'After synchronously validating the input parameters, the system asynchronously creates the playlist.', 'responseParamsDescription' => 'The return value is true or false, indicating whether the playlist creation succeeded.', 'changeSet' => [], ], 'CreateAlarm' => [ 'summary' => 'Create an alarm that supports three types: one-time, weekly, and legal working days. ', 'path' => '/v1.0/ssp/createAlarm', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule information ', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '', 'description' => 'Schedule Type / Loop Type: '."\n" .'ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORY_WORKING_DAY -> Statutory working day ', 'type' => 'string', 'required' => true, 'example' => 'ONCE', 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], ], 'Once' => [ 'title' => '', 'description' => 'One-time: This property is active when the loop type is ONCE. ', 'type' => 'object', 'properties' => [ 'Year' => ['title' => '', 'description' => 'Trigger time: Year ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'], 'Month' => ['title' => '', 'description' => 'Trigger time: Month ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'], 'Day' => ['title' => '', 'description' => 'Trigger Time: Day ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], 'required' => false, 'example' => '', ], 'Weekly' => [ 'title' => '', 'description' => 'Weekly Loop: This property is active when the loop Type is WEEKLY. ', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ 'title' => '', 'description' => 'Collection of Days of the Week to Trigger ', 'type' => 'array', 'items' => ['description' => 'Collection of Days of the Week to Trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week. If triggering every day, include all numbers. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'required' => false, 'example' => '', ], 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], 'required' => false, 'example' => '', ], 'StatutoryWorkingDay' => [ 'title' => '', 'description' => 'Statutory working day: This property is active when the loop Type is STATUTORY_WORKING_DAY.', 'type' => 'object', 'properties' => [ 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], 'required' => false, 'example' => '', ], ], 'required' => true, 'example' => '', ], 'MusicInfo' => [ 'title' => '', 'description' => 'Ringtone information', 'type' => 'object', 'properties' => [ 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'], 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], 'MusicName' => ['title' => '', 'description' => 'Ringtone name', 'type' => 'string', 'required' => true, 'example' => 'xx铃声'], 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'required' => false, 'example' => 'http://xx'], ], 'required' => true, 'example' => '', ], 'Volume' => ['title' => '', 'description' => 'Ringtone volume', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'default' => '40'], 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Invoker', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ 'title' => '', 'description' => 'Type of User ID: OPEN_ID: default User ID identifier; UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding Type. There are multiple ways to obtain the User Identifier for Maojing, and each way corresponds to a different encoding Type: PACKAGE_NAME: APK package name, used for the Android application Customer link; SKILL_ID: Skill ID, used for the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s Skill ID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identity information ', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ 'title' => '', 'description' => 'Type of device ID: OPEN_ID: default device ID; UNION_ID: organization-dimension device ID, available only after applying for an organization on the Maojing Skill Application Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link. ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the Skill ID of the application; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Request result status code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'xx为空'], 'Result' => ['description' => 'Alarm ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], 'RequestId' => ['description' => 'request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', 'title' => 'Create Alarm ', 'responseParamsDescription' => 'The request is successful only when the service returns a status code of 200; otherwise, it indicates failure. ', 'changeSet' => [], ], 'CreatePlayingList' => [ 'summary' => 'Create a playlist and play the specified content.', 'path' => '/v1.0/ssp/CreatePlayingList', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OpenCreatePlayingListRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ 'PlayFrom' => ['description' => 'Playback source, the UUID for configuring playback control capabilities.'."\n" ."\n" .'Can be empty. Default is "default".', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'ContentType' => ['description' => 'Content type for playback.'."\n" ."\n" .'Values: "content" for content, "album" for album, and "collect" for playlist.', 'type' => 'string', 'required' => true, 'example' => 'content', 'title' => ''], 'ContentList' => [ 'description' => 'Playback content list.'."\n" ."\n" .'If the content type is "content", multiple entries are supported. If it is "album", only the first entry takes effect.', 'type' => 'array', 'items' => [ 'description' => 'Playback object', 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'Third-party ID.'."\n" ."\n" .'If the content type is "content", this is the content ID. If it is "album", this is the album ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'required' => true, 'example' => 'xiami', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], 'Index' => ['description' => 'Playback index.'."\n" ."\n" .'Can be empty. Default is 0, indicating playback starts from the beginning.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'NeedAlbumContinued' => ['description' => 'Whether to resume album playback. For example, if the user previously listened up to episode 5 of an album, whether to continue from episode 5. Default is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'PlayMode' => ['description' => 'Playback pattern.'."\n" ."\n" .'Repeat: list loop; Shuffle: random; RepeatOne: single track loop; Normal: sequential playback.', 'type' => 'string', 'required' => false, 'example' => 'Repeat', 'title' => ''], 'ExtendInfo' => ['description' => 'extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used as the encoding type for the Android application customer link. '."\n" .'`SKILL_ID`: Skill ID, used as the encoding type for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. '."\n" .'When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => [ 'description' => 'Type of User ID.'."\n" ."\n" .'`OPEN_ID`: Default User ID identity. '."\n" .'`UNION_ID`: Organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie skill application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'title' => '', ], 'Id' => ['description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device ID information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used as the encoding type for the Android application customer link. '."\n" .'`SKILL_ID`: Skill ID, used as the encoding type for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => [ 'description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. '."\n" .'When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'enum' => [], 'title' => '', ], 'IdType' => [ 'description' => 'Type of device ID.'."\n" ."\n" .'`OPEN_ID`: Default device ID identity. '."\n" .'`UNION_ID`: Organization-dimension device ID identity. This value is available only after an organization has been requested on the Tmall Genie skill application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['UNION_ID', 'OPEN_ID'], 'title' => '', ], 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenServiceResult', 'description' => 'OpenServiceResult', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Actual return result of the service', 'type' => 'object', 'properties' => [ 'RawId' => ['title' => '', 'description' => 'third-party ID', 'type' => 'string', 'example' => '550144364'], 'Source' => ['title' => '', 'description' => 'Source', 'type' => 'string', 'example' => 'ximalayav2'], 'AlbumRawId' => ['title' => '', 'description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744'], 'AlbumName' => ['title' => '', 'description' => 'Third-party album name', 'type' => 'string', 'example' => '晚安妈妈睡前故事'], 'Liked' => ['title' => '', 'description' => 'is collected', 'type' => 'boolean', 'example' => 'false'], 'Singer' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '晚安妈妈'], 'Title' => ['title' => '', 'description' => 'title', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈'], 'Cover' => [ 'title' => '', 'description' => 'thumbnail image object', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Medium' => ['description' => 'medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Small' => ['description' => 'small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], 'PlayMode' => ['title' => '', 'description' => 'Playback pattern (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Repeat'], 'AudioLength' => ['title' => '', 'description' => 'Length', 'type' => 'integer', 'format' => 'int32', 'example' => '190'], 'Progress' => ['title' => '', 'description' => 'Playback progress of the song', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'LyricUrl' => ['title' => '', 'description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'], 'Copyright' => ['title' => '', 'description' => 'The copyright field is upgraded to indicate whether the content is playable: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Type' => ['description' => 'type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], 'ItemUrl' => ['description' => 'Playback URL', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], 'DefaultPlayOrder' => ['description' => 'Default playback order of the package: 0 for sequential, 1 for reverse.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Valid' => ['description' => 'Playback availability: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Pos' => ['description' => 'Position of the item in the playlist', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'example' => '', ], 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the value is false, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Playlist Creation', 'changeSet' => [], ], 'CreatePlayingListOAuth2' => [ 'summary' => 'Playlist creation uses OAuth2 authorization.', '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' => 'Business parameters ', 'type' => 'object', 'properties' => [ 'PlayFrom' => ['description' => 'Playback source, the unique identifier for configuring playback control capabilities. '."\n" ."\n" .'Optional. Default value is "default". ', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'ContentType' => ['description' => 'Content type for playback'."\n" ."\n" .'Content: content; Album: album; Playlist: collect', 'type' => 'string', 'required' => true, 'example' => 'content', 'title' => ''], 'ContentList' => [ 'description' => 'Playback objects ', 'type' => 'array', 'items' => [ 'description' => 'Playback object ', 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'Third-party ID. '."\n" ."\n" .'If the item is content, this is the content ID; if it is an album, this is the album ID. ', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'required' => true, 'example' => 'xiami', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], 'Index' => ['description' => 'Index of the item to play'."\n" ."\n" .'Can be empty. Default is 0, which means playback starts from the beginning.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'NeedAlbumContinued' => ['description' => 'Indicates whether album playback should continue from the last played episode. For example, if the last playback stopped at episode 5, whether to resume from episode 5. Default is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'PlayMode' => ['description' => 'Playback pattern'."\n" ."\n" .'Repeat all: Repeat; Shuffle: Shuffle; Repeat one: RepeatOne; Play in order: Normal.', 'type' => 'string', 'required' => false, 'example' => 'Repeat', 'title' => ''], 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view it in the Tmall Genie AI Platform console. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => [ 'description' => 'The type of device ID: '."\n" .'OPEN_ID: The default device ID. '."\n" .'UNION_ID: The organization-level device ID. You must request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['UNION_ID', 'OPEN_ID'], 'title' => '', ], 'Id' => ['description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Actual return result from the service', 'type' => 'object', 'properties' => [ 'RawId' => ['title' => '', 'description' => 'third-party ID', 'type' => 'string', 'example' => '123123'], 'Source' => ['title' => '', 'description' => 'Source', 'type' => 'string', 'example' => 'qignting'], 'AlbumRawId' => ['title' => '', 'description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744'], 'AlbumName' => ['title' => '', 'description' => 'Third-party album name', 'type' => 'string', 'example' => '晚安妈妈睡前故事'], 'Liked' => ['title' => '', 'description' => 'is collected', 'type' => 'boolean', 'example' => 'false'], 'Singer' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '晚安妈妈'], 'Title' => ['title' => '', 'description' => 'title', 'type' => 'string', 'example' => '超能狂少在都市'], 'Cover' => [ 'title' => '', 'description' => 'thumbnail image object', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Medium' => ['description' => 'medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Small' => ['description' => 'small image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'CanResize' => ['description' => 'Indicates whether cropping using OSS rules is allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], 'PlayMode' => ['title' => '', 'description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Repeat'], 'AudioLength' => ['title' => '', 'description' => 'Length', 'type' => 'integer', 'format' => 'int32', 'example' => '190'], 'Progress' => ['title' => '', 'description' => 'Song playback progress', 'type' => 'integer', 'format' => 'int32', 'example' => '96.0'], 'LyricUrl' => ['title' => '', 'description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'], 'Copyright' => ['title' => '', 'description' => 'The copyright field has been upgraded to indicate whether the content is playable: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Type' => ['description' => 'type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'program', 'title' => ''], 'ItemUrl' => ['description' => 'Playback URL', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Valid' => ['description' => 'Playback availability status: VALID(10), UNKNOWN(20), NOT_VALID(30).', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Pos' => ['description' => 'Position of this item in the playlist.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], 'Message' => ['title' => '', 'description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the value is false, check the Message field.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qignting\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 96,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"program\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 1\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Playlist Creation_OAuth2', 'changeSet' => [], ], 'CreateScheduleTask' => [ 'summary' => 'Create a scheduled task.', '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' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'IdempotentId' => ['title' => '', 'description' => 'Idempotent ID', 'type' => 'string', 'required' => false, 'example' => '1'], 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'description' => '', 'example' => ''], 'UserId' => ['title' => 'User ID', 'type' => 'string', 'description' => '', 'example' => ''], 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'description' => '', 'example' => ''], 'ScheduleDTO' => [ 'title' => '', 'description' => 'Scheduling information', 'type' => 'object', 'properties' => [ 'ScheduleType' => [ 'title' => '', 'description' => 'Schedule Type', 'type' => 'string', 'required' => true, 'example' => 'ONCE', 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_DAY'], ], 'Once' => [ 'title' => '', 'description' => 'One-time Scan Configuration', 'type' => 'object', 'properties' => [ 'Year' => ['title' => '', 'description' => 'Trigger Year', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'], 'Month' => ['title' => '', 'description' => 'Trigger Month', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], 'Day' => ['title' => '', 'description' => 'Trigger day', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '26'], 'Hour' => ['title' => '', 'description' => 'Trigger Hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12'], 'Minute' => ['title' => '', 'description' => 'Trigger Minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], 'required' => false, 'example' => '', ], 'Weekly' => [ 'title' => '', 'description' => 'Loop schedule configuration', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ 'title' => '', 'description' => 'Trigger days of the week, where 1–7 represent Monday through Sunday, respectively', 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'description' => '', 'title' => ''], 'required' => false, 'example' => '', ], 'Hours' => [ 'title' => '', 'description' => 'Trigger hour', 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'description' => '', 'title' => ''], 'required' => false, 'example' => '', ], 'Minutes' => [ 'title' => '', 'description' => 'Trigger minute', 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'description' => '', 'title' => ''], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'StatutoryWorkingDay' => [ 'title' => '', 'description' => 'Statutory working day schedule configuration', 'type' => 'object', 'properties' => [ 'Hours' => [ 'title' => '', 'description' => 'Trigger hour; Multiple Choice ', 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'description' => '', 'title' => ''], 'required' => false, 'example' => '', ], 'Minutes' => [ 'title' => '', 'description' => 'Trigger minute; Multiple Choice ', 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'description' => '', 'title' => ''], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'ScheduleStartTime' => ['title' => '', 'description' => 'Schedule Start Time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1656318855000'], 'ScheduleEndTime' => ['title' => '', 'description' => 'Schedule end time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1661589255000'], ], 'required' => true, 'example' => '', ], 'ActionDTOs' => [ 'title' => '', 'description' => 'Scheduling action parameters', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'customAction' => ['description' => 'Vendor-defined command', 'type' => 'object', 'required' => false, 'example' => '{"k1":"v1","k2":{"key":1}}', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'AccessKeyId' => ['title' => 'AccessKey ID of the caller', 'type' => 'string', 'description' => '', 'example' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User Identifier Information ', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId) ', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], 'IdType' => ['title' => '', 'description' => 'Type of User ID: '."\n" .'- OPEN_ID: The default User ID identity. '."\n" .'- UNION_ID: The User ID identity at the organization dimension. This is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding Type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer links; SKILL_ID: Skill ID, used for cloud-based links. ', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID; Required if IdType is UNION_ID', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => ['title' => '', 'description' => 'Type of device ID: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after applying for an organization in the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer linkage; SKILL_ID: skill ID, used for cloud linkage.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the SkillID of the application. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '调用成功'], 'Result' => ['description' => 'ID of the successfully created job', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F7E2****B7C94', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', 'title' => 'Create a scheduled task', 'description' => 'Configure a triggering task for Custom instruction data in the ecosystem based on scheduling rules such as one-time, daily, or business days.', 'responseParamsDescription' => 'Success occurs only when the service returns a status code of 200; otherwise, it indicates failure.', 'changeSet' => [], ], 'DeleteAlarms' => [ 'summary' => 'Delete alarms. You can delete multiple alarms at the same time.', 'path' => '/v1.0/ssp/deleteAlarms', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Invoker', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AlarmIds' => [ 'title' => '', 'description' => 'Alarms to delete', 'type' => 'array', 'format' => 'int64', 'items' => ['description' => 'Set of alarm IDs to delete', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567', 'title' => ''], 'required' => true, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ 'title' => '', 'description' => 'Type of the User ID: '."\n" .'- OPEN_ID: The default User ID identity. '."\n" .'- UNION_ID: The User ID identity at the organization dimension. This is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Maojing, and each way corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer ingest endpoint; SKILL_ID refers to the skill ID, which is the encoding type for the cloud ingest endpoint.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ 'title' => '', 'description' => 'Type of the device ID: OPEN_ID: default device ID; UNION_ID: organization-dimension device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the SkillID of the application; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code returned by the alarm service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '闹钟id为空'], 'Result' => ['description' => 'Indicates whether the alarm deletion was executed successfully', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'request ID', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"闹钟id为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', 'title' => 'Batch delete alarms', 'responseParamsDescription' => 'The request is successful only when the returned status code is 200; otherwise, it has failed.', 'changeSet' => [], ], 'DeleteScheduleTask' => [ 'summary' => 'Delete a scheduled task.', 'path' => '/v1.0/ssp/DeleteScheduleTask', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'ID of the job to delete', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'], 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'description' => '', 'example' => ''], 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'description' => '', 'example' => ''], 'UserId' => ['title' => 'User ID', 'type' => 'string', 'description' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'AccessKey ID of the caller', 'type' => 'string', 'description' => '', 'example' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], 'IdType' => ['title' => '', 'description' => 'Type of User ID: OPEN_ID: default User ID identifier; UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the Maojing user identifier, and each way corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer link; SKILL_ID refers to the skill ID, which is the encoding type for the cloud link.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => ['title' => '', 'description' => 'Type of the device ID: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after an organization has been registered on the Maojing skill application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: Skill ID, used in the cloud link.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'string', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => '调用成功'], 'Result' => ['title' => '', 'description' => 'Response result', 'type' => 'boolean', 'example' => 'true'], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F7E2****B7C94'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', 'title' => 'Delete Scheduled Task', 'description' => 'Deletes a specified scheduled task by its ID.', 'responseParamsDescription' => 'The operation is successful only when the service returns status code 200. Otherwise, it indicates failure.', 'changeSet' => [], ], 'DeleteSub' => [ 'summary' => 'Delete a subscribed album.', 'path' => '/v1.0/ssp/deleteSub', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SubId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Subscription album record ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '81'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'Result' => ['title' => '', 'description' => 'Return Result', 'type' => 'boolean', 'example' => 'true'], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0AA6C15C-FD61-1E32-9881-480CC6F35A70'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0AA6C15C-FD61-1E32-9881-480CC6F35A70\\"\\n}","type":"json"}]', 'title' => 'Delete a subscribed album', 'changeSet' => [], ], 'DeviceControl' => [ 'summary' => 'Control property values such as device volume.', 'path' => '/v1.0/ssp/control', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => [], 'produces' => [], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ControlRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for volume control ', 'type' => 'object', 'properties' => [ 'Volume' => ['title' => '', 'description' => 'Target volume value ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Muted' => ['title' => '', 'description' => 'Indicates whether mute is enabled. If this field is set to true, you must also specify the volume value as 0. ', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of device ID information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding Type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can View this in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ 'title' => '', 'description' => 'The type of Device ID: '."\n" .'OPEN_ID: The default Device ID identity. '."\n" .'UNION_ID: The organization-dimension Device ID identity. You must request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID of the device. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1*****2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Error code returned. A value of 200 indicates that the call Succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => ['title' => '', 'description' => 'Detailed Result returned.', 'type' => 'boolean', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": false,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Control property values such as device volume', 'description' => 'Specify a device to modify property values such as volume.'."\n", 'changeSet' => [], ], 'EcologyOpennessAuthenticate' => [ 'summary' => 'Use the login-state access token for authentication to obtain the third-party user identifier and the Tmall Genie user\'s openId. ', 'path' => '/v1.0/ssp/ecologyOpennessAuthenticate', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/x-www-form-urlencoded'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'LoginStateAccessToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'logon state access token', 'type' => 'string', 'required' => true, 'example' => 'd15aa*****ee'], ], [ 'name' => 'EncodeType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'entity Type', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'], ], [ 'name' => 'EncodeKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'entity key', 'type' => 'string', 'required' => true, 'example' => '12*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73****9-175A-1324-8202-9FAAB*****A'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ 'title' => '', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'UserOpenId' => ['title' => '', 'description' => 'Tmall Genie user openId ', 'type' => 'string', 'example' => 'o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ=='], 'EncodeType' => ['title' => '', 'description' => 'entity Type', 'type' => 'string', 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'entity key', 'type' => 'string', 'example' => '12****7'], 'SceneCode' => ['title' => '', 'description' => 'scenario code', 'type' => 'string', 'example' => '******'], 'ThirdUserType' => ['title' => '', 'description' => 'Third-party user type ', 'type' => 'string', 'example' => '******'], 'ThirdUserIdentifier' => ['title' => '', 'description' => 'Third-party user identifier ', 'type' => 'string', 'example' => '******'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"SceneCode\\": \\"******\\",\\n \\"ThirdUserType\\": \\"******\\",\\n \\"ThirdUserIdentifier\\": \\"******\\"\\n }\\n}","type":"json"}]', 'title' => 'Ecosystem Open Authentication', 'description' => 'Note: When the login state expires, the integrator must reinitiate the authorization login flow to obtain a new login state (entry service API: AuthLoginWithThirdUserInfo).'."\n" ."\n" .'- Invoke the service API with the login-state access credential (LoginStateAccessToken) parameter by using the Java SDK (for SDKs in other languages, consult Tmall Genie developers during integration). '."\n" .'If the API call throws a TeaException and TeaException.code is InvalidAuthentication, the login state has expired.'."\n" ."\n" .'- Invoke the service API by sending an HTTP request with the login-state access credential (LoginStateAccessToken) parameter. '."\n" .'If the HTTP response status code returned by the API call is 400, the login state has expired. ', 'changeSet' => [], ], 'EcologyOpennessSendVerificationCode' => [ 'summary' => 'Ecosystem Open API for sending SMS verification codes ', 'path' => '/v1.0/ssp/ecologyOpennessSendVerificationCode', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/x-www-form-urlencoded'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ 'name' => 'PhoneNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Phone number ', 'type' => 'string', 'required' => true, 'example' => '18612345678'], ], [ 'name' => 'Region', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Region encoding ', 'type' => 'string', 'required' => true, 'example' => '+86'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ 'title' => '', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'ExpireIn' => ['title' => '', 'description' => 'Validity Period (unit: seconds) ', 'type' => 'integer', 'format' => 'int32', 'example' => '900'], 'RepeatInterval' => ['title' => '', 'description' => 'Recency before the next resend is allowed (unit: seconds) ', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"ExpireIn\\": 900,\\n \\"RepeatInterval\\": 60\\n }\\n}","type":"json"}]', 'title' => 'Ecosystem Open API for sending SMS verification codes ', 'changeSet' => [], ], 'FindUserlistToAuthLoginWithPhoneNumber' => [ 'summary' => 'Find a list of accounts that can be authorized to log on by phone number ', 'path' => '/v1.0/ssp/findUserlistToAuthLoginWithPhoneNumber', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Session ID', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Region encoding', 'type' => 'string', 'required' => true, 'example' => '+86'], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Phone number', 'type' => 'string', 'required' => true, 'example' => '18612345678'], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Text message verification code', 'type' => 'string', 'required' => true, 'example' => '123456'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ 'title' => '', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'UserListToAuthLogin' => [ 'title' => '', 'description' => 'List of accounts eligible for authorization login ', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'Account eligible for authorization login', 'type' => 'object', 'properties' => [ 'UserType' => ['title' => '', 'description' => 'User Type '."\n" .'TAOBAO: Taobao user '."\n" .'ALIGENIE: Tmall Genie user ', 'type' => 'string', 'example' => 'ALIGENIE'], 'EncryptedUserIdentifier' => ['title' => '', 'description' => 'Encrypted User Identifier ', 'type' => 'string', 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh'], 'Nickname' => ['title' => '', 'description' => 'Nickname ', 'type' => 'string', 'example' => 'XXX'], 'Avatar' => ['title' => '', 'description' => 'Profile picture ', 'type' => 'string', 'example' => 'https://xxx'], 'FindingType' => ['title' => '', 'description' => 'User Search Type '."\n" ."\n" .'For Taobao users, the value is fixed as: '."\n" .'PHONE_NUMBER_BINDING_WITH_TAOBAO: The phoneNumber is queried as the phone number bound to a Taobao account. '."\n" ."\n" .'For Tmall Genie users, the value can be: '."\n" .'PHONE_NUMBER_BINDING_WITH_ALIGENIE: The phoneNumber is queried as the phone number bound to a Tmall Genie device; '."\n" .'PHONE_NUMBER_BINDING_WITH_TAOBAO: The phoneNumber is queried as the phone number bound to a Taobao account.', 'type' => 'string', 'example' => 'PHONE_NUMBER_BINDING_WITH_ALIGENIE：phoneNumber'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'DataObj' => [ 'title' => '', 'description' => 'When the code is 5140003, it indicates that the invocation failed because no account list eligible for authorization login was found for the given phone number. The frontend can prompt the user to confirm generating a Jingle account via the phone number or suggest registering a Taobao account using the phone number first. In subsequent flows, the frontend must return the sessionId from DataObj to the server. ', 'type' => 'object', 'properties' => [ 'SessionId' => ['title' => '', 'description' => 'Session ID ', 'type' => 'string', 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"UserListToAuthLogin\\": [\\n {\\n \\"UserType\\": \\"ALIGENIE\\",\\n \\"EncryptedUserIdentifier\\": \\"KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh\\",\\n \\"Nickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"https://xxx\\",\\n \\"FindingType\\": \\"PHONE_NUMBER_BINDING_WITH_ALIGENIE：phoneNumber\\"\\n }\\n ]\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","type":"json"}]', 'title' => 'Query a list of accounts eligible for authorization login by phone number', 'changeSet' => [], ], 'GetAlarm' => [ 'summary' => 'Retrieve the detailed information of a specific alarm clock. ', 'path' => '/v1.0/ssp/getAlarm', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AlarmId' => ['description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567', 'title' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ 'title' => '', 'description' => 'Type of User ID: OPEN_ID: default User ID identifier; UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the Maojing User Identifier, and each corresponds to a different encoding type: '."\n" .'- PACKAGE_NAME: APK package name, used for Android application customer-side flows '."\n" .'- SKILL_ID: Skill ID, used for cloud-side flows', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s SkillID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ 'title' => '', 'description' => 'Type of Device ID: '."\n" .'- OPEN_ID: default device ID identity '."\n" .'- UNION_ID: organization-dimension device ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding Type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding Type: PACKAGE_NAME: APK package name, used for the Android application Customer link; SKILL_ID: Skill ID, used for the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type: when the encoding type is SKILL_ID, the value is the application\'s SkillID; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code returned by the alarm service ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'id为空'], 'Result' => [ 'title' => '', 'description' => 'Alarm details ', 'type' => 'object', 'properties' => [ 'AlarmId' => ['title' => '', 'description' => 'Alarm ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], 'ScheduleTypeDesc' => ['title' => '', 'description' => 'Chinese description of the loop type', 'type' => 'string', 'example' => '单次'], 'TriggerDateDesc' => ['title' => '', 'description' => 'Trigger date description (one-time) ', 'type' => 'string', 'example' => '2022-07-29'], 'TriggerTimeDesc' => ['title' => '', 'description' => 'Trigger time description ', 'type' => 'string', 'example' => '10:00'], 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule Information ', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '', 'description' => 'Schedule Type / Loop Type: ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORYWORKINGDAY -> Statutory working day ', 'type' => 'string', 'example' => 'ONCE', 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], ], 'Once' => [ 'title' => '', 'description' => 'One-time: This property is active when the loop type is ONCE. ', 'type' => 'object', 'properties' => [ 'Year' => ['title' => '', 'description' => 'Trigger Time: Year ', 'type' => 'integer', 'format' => 'int32', 'example' => '2022'], 'Month' => ['title' => '', 'description' => 'Trigger Time: Month ', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], 'Day' => ['title' => '', 'description' => 'Trigger time: Day', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'example' => '', ], 'StatutoryWorkingDay' => [ 'title' => '', 'description' => 'Statutory working day: This property is active when the loop Type is STATUTORYWORKINGDAY.', 'type' => 'object', 'properties' => [ 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'example' => '', ], 'Weekly' => [ 'title' => '', 'description' => 'Weekly loop: This property is active when the loop Type is WEEKLY.', 'type' => 'object', 'properties' => [ 'Hour' => ['title' => '', 'description' => 'Trigger time: Hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: Minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'DaysOfWeek' => [ 'title' => '', 'description' => 'Collection of days of the week to trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week. If triggered every day, include all numbers.', 'type' => 'array', 'items' => ['description' => 'Monday', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'MusicInfo' => [ 'title' => '', 'description' => 'Ringtone Information ', 'type' => 'object', 'properties' => [ 'MusicType' => ['title' => '', 'description' => 'Ringtone Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone Category Name ', 'type' => 'string', 'example' => 'xx音乐'], 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MusicName' => ['title' => '', 'description' => 'Ringtone Name ', 'type' => 'string', 'example' => 'xx铃声'], 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'example' => 'http://xx'], ], 'example' => '', ], 'Volume' => ['title' => '', 'description' => 'Ringtone volume ', 'type' => 'integer', 'format' => 'int32', 'example' => '40'], 'Status' => ['title' => '', 'description' => 'status: 0 Normal, 1 deleted, 2 shutdown ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'example' => '', ], 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"id为空\\",\\n \\"Result\\": {\\n \\"AlarmId\\": 1234567,\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', 'title' => 'Retrieve Details of a Single Alarm', 'responseParamsDescription' => 'The operation is successful only when the service returns a status code of 200; otherwise, it indicates failure. ', 'changeSet' => [], ], 'GetAlbum' => [ 'summary' => 'Retrieve album information by a specific ID. ', 'path' => '/v1.0/ssp/GetAlbum', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => ['description' => 'Album ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12343', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'Default Value: song ', 'type' => 'string', 'required' => true, 'example' => 'song', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Code' => ['description' => 'Code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ 'Alias' => [ 'description' => 'Alias ', 'type' => 'array', 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'title' => '', 'example' => '', ], 'Audition' => ['description' => 'Is auditionable ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ 'description' => 'Author information ', 'type' => 'array', 'items' => [ 'description' => 'Author information ', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ 'description' => 'Author types', 'type' => 'array', 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], 'title' => '', 'example' => '', ], 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'Id' => ['description' => 'Author primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13123', 'title' => ''], 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qignting', 'title' => ''], 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Category' => ['description' => 'Transform controlType based on the public category it belongs to ', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CommCateId' => ['description' => 'Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ 'description' => 'Album cover image', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Small' => ['description' => 'Small Image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], 'HotScore' => ['description' => 'Popularity Score ', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Id' => ['description' => 'Album ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1231231', 'title' => ''], 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qignting', 'title' => ''], 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Type' => ['description' => 'Transform to favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], 'Valid' => ['description' => 'Indicates whether the album is playable. ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Finished' => ['description' => 'Is finished ', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''], 'TotalEpisode' => ['description' => 'Total number of episodes ', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '23242', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 13123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Finished\\": \\"FINISHED\\",\\n \\"TotalEpisode\\": 12,\\n \\"RawId\\": \\"23242\\"\\n }\\n}","type":"json"}]', 'title' => 'Retrieve album information by a specific ID ', 'changeSet' => [], ], 'GetAlbumDetailById' => [ 'summary' => 'Retrieve album information.', 'path' => '/v1.0/ssp/getAlbumDetailById', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AlbumId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Album ID', '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' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Album content', 'type' => 'object', 'properties' => [ 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '51999575'], 'AlbumTitle' => ['title' => '', 'description' => 'Album Title', 'type' => 'string', 'example' => '小科学家探索'], 'AlbumDescription' => ['title' => '', 'description' => 'Album Description', 'type' => 'string', 'example' => '每次一个百科知识或者故事\\n丰富孩子的视野，拓展眼界和知识面，培养和孩子的探究能力和好奇心\\n\\n'], 'AlbumCoverUrl' => ['title' => '', 'description' => 'Album thumbnail', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg'], 'AlbumContentList' => [ 'title' => '', 'description' => 'Album content list', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Album content ID', 'type' => 'string', 'example' => '468009044'], 'Title' => ['title' => '', 'description' => 'Album content title', 'type' => 'string', 'example' => '001为什么肚子饿时会咕咕叫'], 'Duration' => ['title' => '', 'description' => 'Album content duration', 'type' => 'string', 'example' => '3分24秒'], 'OrderIndex' => ['title' => '', 'description' => 'Album content sorting', 'type' => 'string', 'example' => '1000'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'A0B7CACD-485B-14E2-854F-39EACB09E45B'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"AlbumTitle\\": \\"小科学家探索\\",\\n \\"AlbumDescription\\": \\"每次一个百科知识或者故事\\\\\\\\n丰富孩子的视野，拓展眼界和知识面，培养和孩子的探究能力和好奇心\\\\\\\\n\\\\\\\\n\\",\\n \\"AlbumCoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"AlbumContentList\\": [\\n {\\n \\"Id\\": \\"468009044\\",\\n \\"Title\\": \\"001为什么肚子饿时会咕咕叫\\",\\n \\"Duration\\": \\"3分24秒\\",\\n \\"OrderIndex\\": \\"1000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A0B7CACD-485B-14E2-854F-39EACB09E45B\\"\\n}","type":"json"}]', 'title' => 'Retrieve album information', 'changeSet' => [], ], 'GetAligenieUserInfo' => [ 'summary' => 'Obtain the Aligenie account information bound to a third party by using the logon state credential ', 'path' => '/v1.0/ssp/getAligenieUserInfo', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'LoginStateAccessToken', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Logon state access credential ', 'type' => 'string', 'required' => true, 'example' => '99ce8a70c23a94f8569e1a525bef6e85'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'Result' => [ 'type' => 'object', 'properties' => [ 'AligenieNickname' => ['title' => '', 'description' => 'Aligenie user nickname ', 'type' => 'string', 'example' => 'XXX'], 'Avatar' => ['title' => '', 'description' => 'URL of the Aligenie user profile picture ', 'type' => 'string', 'example' => 'http://img.alicdn.com/xxx.jpg'], 'Deletable' => ['title' => '', 'description' => 'Indicates whether the account can be logged off ', 'type' => 'boolean', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": {\\n \\"AligenieNickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"http://img.alicdn.com/xxx.jpg\\",\\n \\"Deletable\\": false\\n }\\n}","type":"json"}]', 'title' => 'Obtain the Aligenie account information bound to a third party ', 'description' => 'Note: When the logon state expires, the integrator must initiate the authorization logon flow again to obtain a new logon state (entry service API: AuthLoginWithThirdUserInfo).'."\n" ."\n" .'- Invoke the service API with the logon state access credential (LoginStateAccessToken) parameter by using the Java software development kit (SDK). For SDKs in other languages, consult the Tmall Genie developer team during integration. '."\n" .'If the API call throws a TeaException and TeaException.code is InvalidAuthentication, the logon state has expired.'."\n" ."\n" .'- Invoke the service API by sending an HTTP request with the logon state access credential (LoginStateAccessToken) parameter. '."\n" .'If the HTTP response status code returned by the API call is 400, the logon state has expired. ', 'changeSet' => [], ], 'GetCodeEnhance' => [ 'summary' => 'Obtain the 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' => '', 'description' => 'Activation Channel, such as WeChat mini program or third-party app.', 'type' => 'object', 'properties' => [ 'Channel' => ['title' => '', 'description' => 'Activation Channel, such as WeChat or ThirdApp.', 'type' => 'string', 'required' => true, 'example' => 'WeChat、ThirdApp'], 'ExtInfo' => ['title' => '', 'description' => 'Extension information.', 'type' => 'string', 'required' => false, 'example' => '{}'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of User Identifier information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding Type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ 'title' => '', 'description' => 'Type of User ID: '."\n" .'OPENID: The default User ID identifier. '."\n" .'UNIONID: The organization-dimension User ID identifier. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'User Identifier. Enter the value of userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Returned error code. A value of 200 indicates that the invocation Succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => ['title' => '', 'description' => 'Detailed returned information.', 'type' => 'string', 'example' => 'Aexfgc'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": \\"Aexfgc\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Obtain authCode', 'description' => 'Obtain the corresponding authCode by specifying the user ID.', 'changeSet' => [], ], 'GetContent' => [ 'summary' => 'Retrieve content information by a specific 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' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'Default value: song ', 'type' => 'string', 'required' => true, 'example' => 'song', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Message information ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request RequestId ', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Result' => [ 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ 'Alias' => [ 'description' => 'Alias', 'type' => 'array', 'items' => ['description' => 'Alias', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'title' => '', 'example' => '', ], 'Audition' => ['description' => 'Is audition available ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ 'description' => 'Content authors ', 'type' => 'array', 'items' => [ 'description' => 'Content author ', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ 'description' => 'author type', 'type' => 'array', 'items' => ['description' => 'author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], 'title' => '', 'example' => '', ], 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'Id' => ['description' => 'Author primary key ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Category' => ['description' => 'Transform controlType based on the associated public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Charge' => ['description' => 'is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CommCateId' => ['description' => 'ID of the corresponding category', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ 'description' => 'album thumbnail image', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used to crop the image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], 'HotScore' => ['description' => 'Popularity score', 'type' => 'number', 'format' => 'double', 'example' => '内容描述', 'title' => ''], 'Id' => ['description' => 'Content ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Title' => ['description' => 'title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Type' => ['description' => 'Transform to favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], 'Valid' => ['description' => 'Indicates whether the content is playable.', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Duration' => ['description' => 'duration information', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'title' => ''], 'AlbumId' => ['description' => 'ID of the corresponding album', 'type' => 'string', 'example' => '1231', 'title' => ''], 'Lyric' => ['description' => 'Lyric information', 'type' => 'string', 'example' => 'http://1231.lrc', 'title' => ''], 'Styles' => [ 'description' => 'Genre ', 'type' => 'array', 'items' => ['description' => 'Genre ', 'type' => 'string', 'example' => '1312', 'title' => ''], 'title' => '', 'example' => '', ], 'RawId' => ['description' => 'third-party ID of the content', 'type' => 'string', 'example' => '1231231', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 123123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 0,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"1231\\",\\n \\"Lyric\\": \\"http://1231.lrc\\",\\n \\"Styles\\": [\\n \\"1312\\"\\n ],\\n \\"RawId\\": \\"1231231\\"\\n }\\n}","type":"json"}]', 'title' => 'Retrieve content information by a specific ID ', 'changeSet' => [], ], 'GetCurrentPlayingItem' => [ 'summary' => 'Obtain the current playback item. ', 'path' => '/v1.0/ssp/GetCurrentPlayingItem', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identification information ', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'The encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: The APK package name, which is the encoding type for the Android application customer link. `SKILL_ID`: The skill ID, which is the encoding type for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of User ID.'."\n" ."\n" .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'The User Identifier, which can be set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'The organization ID. This field is required if IdType is set to UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information ', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application client link. `SKILL_ID`: Skill ID, used for the cloud-based link. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type '."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'Type of device ID '."\n" ."\n" .'`OPEN_ID`: The default device ID identifier. `UNION_ID`: Device ID identifier at the organization dimension. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device identifier, set to either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Actual return result of the service ', 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '550144364', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], 'AlbumRawId' => ['description' => 'Third-party album ID ', 'type' => 'string', 'example' => '260744', 'title' => ''], 'AlbumName' => ['description' => 'Third-party album name ', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], 'Liked' => ['description' => 'is collected ', 'type' => 'string', 'example' => 'false', 'title' => ''], 'Singer' => ['description' => 'author ', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], 'Title' => ['description' => 'title ', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], 'Cover' => [ 'description' => 'Thumbnail image object', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal) ', 'type' => 'string', 'example' => 'Repeat', 'title' => ''], 'AudioLength' => ['description' => 'Length ', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], 'Progress' => ['description' => 'Song playback progress ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'LyricUrl' => ['description' => 'Lyrics URL ', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], 'Copyright' => ['description' => 'The copyright field is upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], 'ItemUrl' => ['description' => 'Playback URL ', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential order, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Valid' => ['description' => 'Indicates whether playback is allowed: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Pos' => ['description' => 'The position of this item in the playlist ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Additional information. A common scenario is providing a brief description for failed invocations to help the caller identify the issue. ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the invocation fails, check the Message field for details. ', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": \\"false\\",\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Obtain the currently playing item ', 'changeSet' => [], ], 'GetCurrentPlayingList' => [ 'summary' => 'Obtain the current playlist.', 'path' => '/v1.0/ssp/GetCurrentPlayingList', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OpenQueryPlayListRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ 'PageNum' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '15', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the Tmall Genie User Identifier, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of User ID.'."\n" ."\n" .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User Identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of Device ID.'."\n" ."\n" .'`OPEN_ID`: The default Device ID identity. `UNION_ID`: The organization-dimension Device ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Actual return result of the service', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'Third-party ID ', 'type' => 'string', 'example' => '550144364', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], 'AlbumRawId' => ['description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744', 'title' => ''], 'AlbumName' => ['description' => 'Third-party album name', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], 'Liked' => ['description' => 'is collected', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Singer' => ['description' => 'author', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], 'Title' => ['description' => 'title', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], 'Cover' => [ 'description' => 'Thumbnail image object ', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Mediam' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'AudioLength' => ['description' => 'Length', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], 'Progress' => ['description' => 'Playback progress of the song', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'LyricUrl' => ['description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.) ', 'type' => 'string', 'example' => 'story', 'title' => ''], 'Copyright' => ['description' => 'The copyright field has been upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ItemUrl' => ['description' => 'Playback URL', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential, 1 for reverse order', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Valid' => ['description' => 'Whether playable: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Pos' => ['description' => 'Position of this item in the playlist', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Additional information. A typical scenario is providing a brief description for failed invocations to help the caller identify the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the invocation fails, check the Message field.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Normal\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Retrieve the current playlist', 'changeSet' => [], ], 'GetDeviceBasicInfo' => [ 'summary' => 'Obtain basic device information by Device ID. ', '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' => 'List of device identity information. ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which this product belongs. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ 'title' => '', 'description' => 'Type of device ID: '."\n" .'- OPEN_ID: The default device ID. '."\n" .'- UNION_ID: The organization-dimension device ID. You must request an organization in the Open Platform in advance.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information returned. ', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'Name of the device. ', 'type' => 'string', 'example' => '我的设备'], 'FirmwareVersion' => ['title' => '', 'description' => 'Firmware version of the device. ', 'type' => 'string', 'example' => '2.0.3'], 'Mac' => ['title' => '', 'description' => 'MAC address of the device. ', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'], 'Sn' => ['title' => '', 'description' => 'SN information of the device. ', 'type' => 'string', 'example' => '1200xxx048'], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.GetDeviceBasicInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Obtain basic device information ', 'changeSet' => [], ], 'GetDeviceIdByIdentity' => [ 'summary' => 'Obtain the Device ID based on the device MAC or SN.', 'path' => '/v1.0/ssp/getDeviceIdByIdentity', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'EncodeType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'], ], [ 'name' => 'EncodeKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which this product belongs. You can view it in the Tmall Genie AI platform console. ', 'type' => 'string', 'required' => true, 'example' => '129****0946'], ], [ 'name' => 'IdentityType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Device authentication type. Enter **MAC**, **SN**, or **CTEI**. ', 'type' => 'string', 'required' => true, 'example' => 'MAC'], ], [ 'name' => 'IdentityId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Authentication identifier. Enter the MAC address or the SN value. ', 'type' => 'string', 'required' => true, 'example' => 'b4:xx:xx:xx:65:2b'], ], [ 'name' => 'ProductKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique product identifier ProductKey, which is a globally unique identity issued by the platform when the product is created in the Tmall Genie AI platform. This parameter is optional when IdentityType is **CTEI**. ', 'type' => 'string', 'required' => false, 'example' => 'Mm*****XnZ8'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list.', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'The return result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information returned.', 'type' => 'object', 'properties' => [ 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the device. ', 'type' => 'string', 'example' => 'A963*0158'], 'DeviceUnionIds' => [ 'title' => '', 'description' => 'Organization ID and UnionId information corresponding to the device.', 'type' => 'array', 'items' => [ 'description' => 'Information list', 'type' => 'object', 'properties' => [ 'OrganizationId' => ['title' => '', 'description' => 'Organization ID.', 'type' => 'string', 'example' => '1**2'], 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device.', 'type' => 'string', 'example' => '1553*B0C3'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7DA****A0726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7DA****A0726E\\"\\n}","type":"json"}]', 'title' => 'Obtain Device ID ', 'changeSet' => [], ], 'GetDeviceSetting' => [ 'summary' => 'Obtain the user settings of a device. ', 'path' => '/v1.0/ssp/getDeviceSetting', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Keys', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Set of specified keys for device Settings, '."\n" .'Do Not Disturb mode: nightMode ', 'type' => 'array', 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of device identity information. ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Set this parameter to PROJECT_ID. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project that contains the ProductKey of this product in the Tmall Genie AI Platform.', 'type' => 'string', 'required' => true, 'example' => '12345'], 'IdType' => [ 'title' => '', 'description' => 'The type of Device ID. '."\n" .'OPEN_ID: The default device identity. '."\n" .'UNION_ID: The device identity at the organization dimension. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'Device ID. Configure this parameter as deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '122'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API. ', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Returned error code. The value 200 indicates that the call Succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => ['title' => '', 'description' => 'Returns specific device Settings information. ', 'type' => 'object', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Obtain the user settings of a device ', 'changeSet' => [], ], 'GetDeviceStatusDetail' => [ 'summary' => 'Obtain device status details.', 'path' => '/v1.0/ssp/getDeviceStatusDetail', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Keys', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'A collection of specified keys for device settings: '."\n" .'Player: player '."\n" .'Device volume: speaker '."\n" .'Battery level: power', 'type' => 'array', 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of device identification information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the product’s project here. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ 'title' => '', 'description' => 'Type of device ID: '."\n" .'OPEN_ID: The default device ID. '."\n" .'UNION_ID: An organization-level device ID. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'OPEN_ID'], ], 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Returned error code. 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Returned detailed information.', 'type' => 'object', 'properties' => [ 'Player' => [ 'title' => '', 'description' => 'Player information', 'type' => 'object', 'properties' => [ 'AudioAnchor' => ['title' => '', 'description' => 'Artist ', 'type' => 'string', 'example' => '刘德华'], 'AudioExt' => ['title' => '', 'description' => 'Extension Information ', 'type' => 'string', 'example' => '""'], 'AudioId' => ['title' => '', 'description' => 'Audio ID ', 'type' => 'string', 'example' => '123'], 'Format' => ['title' => '', 'description' => 'Song Type (mp3) ', 'type' => 'string', 'example' => 'mp3'], 'AudioSource' => ['title' => '', 'description' => 'Song Source (xiami) ', 'type' => 'string', 'example' => 'xiami'], 'AudioLength' => ['title' => '', 'description' => 'Song length, in seconds', 'type' => 'string', 'example' => '253'], 'Source' => ['title' => '', 'description' => 'Playback Source (cloud) ', 'type' => 'string', 'example' => 'cloud'], 'AudioUrl' => ['title' => '', 'description' => 'Song URL', 'type' => 'string', 'example' => 'https://xxx'], 'AudioName' => ['title' => '', 'description' => 'Song Name', 'type' => 'string', 'example' => ''], 'AudioAlbum' => ['title' => '', 'description' => 'Song Album ', 'type' => 'string', 'example' => ''], 'Progress' => ['title' => '', 'description' => 'Playback progress', 'type' => 'string', 'example' => '30'], 'Timestamp' => ['title' => '', 'description' => 'Reporting Time ', 'type' => 'string', 'example' => ''], 'Status' => ['title' => '', 'description' => 'Playback status, pause', 'type' => 'string', 'example' => 'pause'], ], 'example' => '', ], 'Speaker' => [ 'title' => '', 'description' => 'Volume information ', 'type' => 'object', 'properties' => [ 'Volume' => ['title' => '', 'description' => 'Current volume value ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Muted' => ['title' => '', 'description' => 'Is muted', 'type' => 'boolean', 'example' => ''], ], 'example' => '', ], 'Power' => [ 'title' => '', 'description' => 'Battery information ', 'type' => 'object', 'properties' => [ 'Quantity' => ['title' => '', 'description' => 'Battery value ', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'Status' => ['title' => '', 'description' => 'Power status ', 'type' => 'string', 'example' => ''], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Player\\": {\\n \\"AudioAnchor\\": \\"刘德华\\",\\n \\"AudioExt\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AudioId\\": \\"123\\",\\n \\"Format\\": \\"mp3\\",\\n \\"AudioSource\\": \\"xiami\\",\\n \\"AudioLength\\": \\"253\\",\\n \\"Source\\": \\"cloud\\",\\n \\"AudioUrl\\": \\"https://xxx\\",\\n \\"AudioName\\": \\"\\",\\n \\"AudioAlbum\\": \\"\\",\\n \\"Progress\\": \\"30\\",\\n \\"Timestamp\\": \\"\\",\\n \\"Status\\": \\"pause\\"\\n },\\n \\"Speaker\\": {\\n \\"Volume\\": 10,\\n \\"Muted\\": false\\n },\\n \\"Power\\": {\\n \\"Quantity\\": 30,\\n \\"Status\\": \\"\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Get device status details', 'changeSet' => [], ], 'GetDeviceStatusInfo' => [ 'summary' => 'Obtain the online status of a device based on its openID. ', 'path' => '/v1.0/ssp/getDeviceStatusInfo', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of device identity information. ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Set this parameter to **PROJECT_ID**. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view it in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ 'title' => '', 'description' => 'The Type of the Device ID: '."\n" .'- OPEN_ID: The default device ID identity. '."\n" .'- UNION_ID: The organization-dimension device ID identity. You must request an organization in the Open Platform in advance.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'Device identifier. Specify the value of deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID of the device. This parameter is required if IdType is set to UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information returned. ', 'type' => 'object', 'properties' => [ 'Online' => ['title' => '', 'description' => 'Indicates whether the device is online. A value of 0 means offline, and 1 means online. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.GetDeviceStatusInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Online\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Obtain device status ', 'changeSet' => [], ], 'GetDeviceTag' => [ 'summary' => 'Obtain the tag information of a device.', 'path' => '/v1.0/ssp/getDeviceTag', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of device identity information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project in the Tmall Genie AI platform where the product\'s ProductKey resides.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ 'title' => '', 'description' => 'The type of Device ID:'."\n" .' - OPEN_ID: The default device identity.'."\n" .'- UNION_ID: The device identity at the organization dimension, which requires a prior request for an organization on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'Device identifier. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list.', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'The return result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information returned.', 'type' => 'object', 'properties' => [ 'DeviceTags' => ['title' => '', 'description' => 'Tag information of the device.', 'type' => 'object', 'example' => '{ "antest1": "antest1", "antest": "a" }'], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceTags\\": {\\n \\"antest1\\": \\"antest1\\",\\n \\"antest\\": \\"a\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Obtain device tags', 'changeSet' => [], ], 'GetJiangSuTelecomData' => [ 'summary' => 'Derived requirements from Jiangsu Telecom\'s self-developed desktop launcher project. HaoBai expects to collect statistics on the activation rate, active user rate, and top user usage patterns after the project is published, and to generate daily and weekly reports. Daily reports are synchronized automatically via API, while weekly reports are synchronized offline.', 'path' => '/v1.0/ssp/GetJiangSuTelecomData', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'Date', 'in' => 'query', 'schema' => ['description' => 'Date in the format yyyy-MM-dd. This refers to the data timestamp when the data becomes available, not the date when the data was generated. Data is always produced on a T+1 basis.', 'type' => 'string', 'required' => false, 'example' => '2024-11-09', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code. Returns 200 for normal responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Actual return result of the service', 'type' => 'object', 'properties' => [ 'OssUrl' => ['description' => 'OSS object URL, valid for 10 minutes', 'type' => 'string', 'example' => 'http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OssUrl\\": \\"http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949\\"\\n}","type":"json"}]', 'title' => 'Retrieve data from Jiangsu Telecom HaoBai', 'changeSet' => [], ], 'GetScheduleTask' => [ 'summary' => 'Obtain scheduled task information.', 'path' => '/v1.0/ssp/GetScheduleTask', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'ID of the job to query', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'], 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], 'UserId' => ['title' => 'User ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'AccessKey of the caller', 'type' => 'string', 'description' => '', 'example' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], 'IdType' => ['title' => '', 'description' => 'Type of the User ID: OPENID—the default User ID identity; UNIONID—the organization-dimension User ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME indicates the APK package name, used in the Android application customer flow; SKILL_ID indicates the skill ID, used in the cloud-based flow.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILLID, the value is the application\'s SkillID. When the encoding type is PACKAGENAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device ID information ', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => ['title' => '', 'description' => 'Device ID type: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform. ', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link. ', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s SkillID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => '调用成功'], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F7E21065-6C21-1158-A2F9-AEFE5CAB7C94'], 'Result' => [ 'title' => '', 'description' => 'Service response parameters', 'type' => 'object', 'properties' => [ 'ScheduleId' => ['title' => '', 'description' => 'Job ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], 'ScheduleType' => [ 'title' => '', 'description' => 'Schedule Type', 'type' => 'string', 'example' => 'ONCE', 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_DAY'], ], 'Cron' => ['title' => '', 'description' => 'Trigger Cron Expression ', 'type' => 'string', 'example' => '0 10 20 30 6 ? 2022'], 'ScheduleStartTime' => ['description' => 'Validity Period - Start Time', 'type' => 'string', 'example' => '1656577473000', 'title' => ''], 'ScheduleEndTime' => ['description' => 'Validity Period - End Time', 'type' => 'string', 'example' => '1659169473000', 'title' => ''], 'ActionTopicList' => [ 'description' => 'Trigger behavior', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CustomAction' => ['description' => 'Vendor-defined command', 'type' => 'object', 'example' => '{"k1":"v1","k2":{"key":1}}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"RequestId\\": \\"F7E21065-6C21-1158-A2F9-AEFE5CAB7C94\\",\\n \\"Result\\": {\\n \\"ScheduleId\\": 1234567,\\n \\"ScheduleType\\": \\"ONCE\\",\\n \\"Cron\\": \\"0 10 20 30 6 ? 2022\\",\\n \\"ScheduleStartTime\\": \\"1656577473000\\",\\n \\"ScheduleEndTime\\": \\"1659169473000\\",\\n \\"ActionTopicList\\": [\\n {\\n \\"CustomAction\\": {\\n \\"k1\\": \\"v1\\",\\n \\"k2\\": {\\n \\"key\\": 1\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Retrieve scheduled task information ', 'description' => 'Query the details of a specified scheduled task by its ID.', 'responseParamsDescription' => 'The request is successful only when the service returns a status code of 200; otherwise, it indicates failure.', 'changeSet' => [], ], 'GetUnreadMessageCount' => [ 'summary' => 'Query the number of unread messages for a user.', 'path' => '/v1.0/ssp/getUnreadMessageCount', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier from Maojing, and each method corresponds to a different encoding type: PACKAGENAME for the APK package name used in the Android application client link, and SKILLID for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the application\'s Skill ID. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], 'IdType' => ['description' => 'Type of User ID: OPENID is the default user ID identity; UNIONID is the organization-dimension user ID identity, which is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Service Return Result', 'type' => 'object', 'properties' => [ 'Message' => ['title' => 'Id of the request', 'description' => 'Error message', 'type' => 'string', 'example' => '用户信息不存在'], 'Code' => ['description' => 'Status code returned by the service', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Result' => ['description' => 'Number of unread messages', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"用户信息不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": 10\\n}","type":"json"}]', 'title' => 'Query the Number of Unread Messages', 'changeSet' => [], ], 'GetUserByDeviceId' => [ 'summary' => 'Obtain the User ID attached to a device by the device\'s openID. ', 'path' => '/v1.0/ssp/getUserByDeviceId', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of device identity information. ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Set this parameter to **PROJECT_ID**. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Set this parameter to the Project ID of the product’s ProductKey in the Tmall Genie AI platform. ', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ 'title' => '', 'description' => 'Type of the device ID: '."\n" .'- OPEN_ID: The default device ID. '."\n" .'- UNION_ID: The organization-dimension device ID. You must request an organization on the Open Platform in advance. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'Device identifier, configured as either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is set to UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'The list of user information returned. ', 'type' => 'object', 'properties' => [ 'UserOpenId' => ['title' => '', 'description' => 'The openID corresponding to the user information. ', 'type' => 'string', 'example' => '0963*0158'], 'UserUnionIds' => [ 'title' => '', 'description' => 'The list of organization IDs and UnionIDs for the user. ', 'type' => 'array', 'items' => [ 'description' => 'List of information ', 'type' => 'object', 'properties' => [ 'OrganizationId' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'example' => '1**2'], 'UserUnionId' => ['title' => '', 'description' => 'The user\'s UnionID. ', 'type' => 'string', 'example' => '1553*B0C3'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => 'true', ], 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.GetUserByDeviceId.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"0963*0158\\",\\n \\"UserUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"UserUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Obtain the User ID attached to a device ', 'changeSet' => [], ], 'GetWeather' => [ 'summary' => 'Query the weather.', 'path' => '/v1.0/ssp/GetWeather', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], 'UserId' => ['title' => 'User ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], 'RequestId' => ['title' => 'Request ID', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Caller AccessKey', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], 'required' => false, 'docRequired' => false, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='], 'IdType' => ['title' => '', 'description' => 'Type of user ID: OPEN_ID: default user ID identifier; UNION_ID: organization-dimension user ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer links; SKILL_ID: skill ID, used for cloud-based links.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device ID information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='], 'IdType' => ['title' => '', 'description' => 'Type of the device ID: OPEN_ID is the default device ID identity; UNION_ID is the organization-dimension device ID identity, which is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID of Maojing, and each way corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer link; SKILL_ID refers to the skill ID, which is the encoding type for the cloud link.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. This field is required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '调用成功'], 'Code' => ['title' => 'HttpCode', 'description' => 'HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'model data', 'type' => 'object', 'properties' => [ 'CurrentMeteorology' => [ 'title' => '', 'description' => 'Current weather', 'type' => 'object', 'properties' => [ 'Weather' => [ 'title' => '', 'description' => 'Daytime weather', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Weather code: for example, "000,100"', 'type' => 'string', 'example' => '000'], 'Name' => ['title' => '', 'description' => 'Weather name description: "Sunny (000), Multicloud (100), Overcast (101), Rain (200), Light rain (201), Light to moderate rain (202), Moderate rain (203), Moderate to heavy rain (204), Heavy rain (205), Heavy to storm rain (206), Storm rain (207), Heavy storm rain (209), Severe storm rain (211), Showers (212), Thunderstorms (213), Freezing rain (214), Snow (300), Sleet (301), Snow showers (302), Light snow (303), Light to moderate snow (304), Moderate snow (305), Heavy snow (307), Blizzard (309), Fog (400), Dust (501), Sand blowing (502), Sandstorm (503), Severe sandstorm (504), Mostly sunny (000), Partly cloudy (100), Light showers (212), Lightning (213), Ice pellets (214), Thunderstorms with hail (215), Light snow showers (302), Freezing fog (400), Haze (500), Dust whirls (502), Localized showers (212), Thunderstorm (213), Ice needles (214), Hail (215), Intense showers (212)"', 'type' => 'string', 'example' => '晴'], ], 'example' => '', ], 'Temperature' => [ 'title' => '', 'description' => 'Temperature', 'type' => 'object', 'properties' => [ 'Current' => ['title' => '', 'description' => 'Current temperature value', 'type' => 'string', 'example' => '36'], 'CurrentDesc' => ['title' => '', 'description' => 'Description of the current temperature value', 'type' => 'string', 'example' => '36度'], 'High' => ['title' => '', 'description' => 'Maximum temperature value', 'type' => 'string', 'example' => '37'], 'HighDesc' => ['title' => '', 'description' => 'Description of the maximum temperature value', 'type' => 'string', 'example' => '37度'], 'Low' => ['title' => '', 'description' => 'Lowest temperature', 'type' => 'string', 'example' => '28'], 'LowDesc' => ['title' => '', 'description' => 'Description of the lowest temperature', 'type' => 'string', 'example' => '28度'], 'Logical' => ['title' => '', 'description' => 'Temperature with logic, as follows:', 'type' => 'string', 'example' => '41'], ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F7E2****B7C94', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"调用成功\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"CurrentMeteorology\\": {\\n \\"Weather\\": {\\n \\"Code\\": \\"000\\",\\n \\"Name\\": \\"晴\\"\\n },\\n \\"Temperature\\": {\\n \\"Current\\": \\"36\\",\\n \\"CurrentDesc\\": \\"36度\\",\\n \\"High\\": \\"37\\",\\n \\"HighDesc\\": \\"37度\\",\\n \\"Low\\": \\"28\\",\\n \\"LowDesc\\": \\"28度\\",\\n \\"Logical\\": \\"41\\"\\n }\\n }\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]', 'title' => 'Query weather', 'description' => 'Query the weather data for the location of the device based on the Device Information obtained from system parameters.', 'responseParamsDescription' => 'The request is successful only when the status code returned by the service is 200; otherwise, it indicates failure.', 'changeSet' => [], ], 'IndexControlPlayingList' => [ 'summary' => 'Click a playlist to start playback. ', 'path' => '/v1.0/ssp/IndexControlPlayingList', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OpenIndexControlRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The index to be played back', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], 'NeedContentContinued' => ['description' => 'Whether content playback should continue. Default is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'Type of User ID'."\n" ."\n" .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity, which is available only after an organization has been requested on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'Type of device ID'."\n" ."\n" .'`OPEN_ID`: The default device ID identity. `UNION_ID`: Device ID identity at the organization dimension. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Actual return result from the service ', 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '550144364', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], 'AlbumRawId' => ['description' => 'Third-party album ID', 'type' => 'string', 'example' => '260744', 'title' => ''], 'AlbumName' => ['description' => 'Third-party album Name', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], 'Liked' => ['description' => 'Indicates whether the item is collected ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Singer' => ['description' => 'Author ', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], 'Title' => ['description' => 'Title ', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], 'Cover' => [ 'description' => 'Thumbnail image object', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal) ', 'type' => 'string', 'example' => 'Repeat', 'title' => ''], 'AudioLength' => ['description' => 'Length ', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], 'Progress' => ['description' => 'Playback progress of the song ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'LyricUrl' => ['description' => 'Lyrics URL', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], 'Copyright' => ['description' => 'The copyright field is upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ItemUrl' => ['description' => 'Playback URL ', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential order, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Valid' => ['description' => 'Indicates whether playback is allowed: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Pos' => ['description' => 'The position of this item in the playlist', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. If the invocation fails, check the Message field for details. ', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Click to play from playlist', 'changeSet' => [], ], 'InvalidateThirdPartyAppLoginState' => [ 'summary' => 'When a user operation (not initiated from the device side) causes the login session of a third-party application on the device to become invalid (for example, the user logs on to the same account from a new device, invalidating the session on the old device, or the user changes their password, which invalidates the session on the old device), the third party must invoke this API to notify Tmall Genie. ', 'path' => '/v1.0/ssp/invalidateThirdPartyAppLoginState', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/x-www-form-urlencoded'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identification information ', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='], 'IdType' => ['title' => '', 'description' => 'The type of Device ID. OPEN_ID: the default device identity. UNION_ID: the device identity at the organization dimension, which is available only after an organization has been requested on the Maojing Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'], 'EncodeType' => ['title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the Tmall Genie device ID, and each method corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, used in the Android application customer flow; SKILL_ID refers to the skill ID, used in the cloud-based flow. ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the Skill ID of the application. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => 'com.*.*.*'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'ThirdPartyAppId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Third-party application identity', 'type' => 'string', 'required' => true, 'example' => 'com.*.*.*'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'success'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Invalidate Third-Party Application Login Session ', 'description' => '> Modify message notification template '."\n" .'> - You need to query the templateId first, then modify other parameters based on the templateId. ', 'changeSet' => [], ], 'ListAlarms' => [ 'summary' => 'Perform a paged query to retrieve the alarm clock list of a specific User on a device. ', 'path' => '/v1.0/ssp/listAlarm', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'CurrentPage' => ['title' => '', 'description' => 'Current page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Number of entries per page: maximum value is 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'], 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ 'title' => '', 'description' => 'Type of the User ID: '."\n" .'- OPEN_ID: The default User ID identity. '."\n" .'- UNION_ID: The User ID identity at the organization dimension. This is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, which is the encoding type for the Android application customer link; SKILL_ID refers to the skill ID, which is the encoding type for the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ 'title' => '', 'description' => 'Device ID type: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'status code returned by the alarm service ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => '设备账号未关联'], 'Result' => [ 'description' => 'collection of alarm list results ', 'type' => 'object', 'properties' => [ 'TotalCount' => ['title' => '', 'description' => 'total number of entries ', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'PageCount' => ['title' => '', 'description' => 'total number of pages ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'PageSize' => ['title' => '', 'description' => 'number of entries per page: maximum is 100; values exceeding 100 are treated as 100 ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'CurrentPage' => ['title' => '', 'description' => 'current page ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Model' => [ 'title' => '', 'description' => 'alarm list ', 'type' => 'array', 'items' => [ 'description' => 'alarm details ', 'type' => 'object', 'properties' => [ 'AlarmId' => ['title' => '', 'description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], 'ScheduleTypeDesc' => ['title' => '', 'description' => 'Chinese description of loop type', 'type' => 'string', 'example' => '单次'], 'TriggerDateDesc' => ['title' => '', 'description' => 'Trigger date description (one-time)', 'type' => 'string', 'example' => '2022-07-29'], 'TriggerTimeDesc' => ['title' => '', 'description' => 'Trigger time description', 'type' => 'string', 'example' => '10:00'], 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule information ', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '', 'description' => 'Schedule Type / Loop Type: ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORYWORKINGDAY -> Statutory working day ', 'type' => 'string', 'example' => 'ONCE', 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], ], 'Once' => [ 'title' => '', 'description' => 'One-time: This property is active when the loop type is ONCE. ', 'type' => 'object', 'properties' => [ 'Year' => ['title' => '', 'description' => 'Trigger Time: Year ', 'type' => 'integer', 'format' => 'int32', 'example' => '2022'], 'Month' => ['title' => '', 'description' => 'Trigger Time: Month ', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], 'Day' => ['title' => '', 'description' => 'Trigger time: day', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'example' => '', ], 'Weekly' => [ 'title' => '', 'description' => 'Weekly loop: This property is active when the loop Type is WEEKLY.', 'type' => 'object', 'properties' => [ 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'DaysOfWeek' => [ 'title' => '', 'description' => 'Collection of days of the week to trigger', 'type' => 'array', 'items' => ['description' => 'Collection of days of the week to trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week (1 for Monday, 2 for Tuesday, etc.). If the schedule applies to every day, include all values.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'StatutoryWorkingDay' => [ 'title' => '', 'description' => 'Statutory working day: This property is active when the loop Type is STATUTORYWORKINGDAY.', 'type' => 'object', 'properties' => [ 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'example' => '', ], ], 'example' => '', ], 'MusicInfo' => [ 'title' => '', 'description' => 'Music information', 'type' => 'object', 'properties' => [ 'MusicType' => ['title' => '', 'description' => 'Ringtone Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone Category Name ', 'type' => 'string', 'example' => 'xx音乐'], 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MusicName' => ['title' => '', 'description' => 'Ringtone Name ', 'type' => 'string', 'example' => 'xx铃声'], 'MusicUrl' => ['title' => '', 'description' => 'Music URL ', 'type' => 'string', 'example' => 'http://xx'], ], 'example' => '', ], 'Volume' => ['title' => '', 'description' => 'Ringtone volume, default 40', 'type' => 'integer', 'format' => 'int32', 'example' => '40'], 'Status' => ['title' => '', 'description' => 'Status: 0 Normal, 1 Deleted, 2 Shutdown', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"AlarmId\\": 1234567,\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', 'title' => 'Query alarm list', 'responseParamsDescription' => '1. The request is considered successful only if the returned status code is 200; otherwise, it is failed. '."\n" .'2. The paging parameters in the response do not match the actual number of items in the list; this is for demonstration purposes only. ', 'changeSet' => [], ], 'ListAlbumDetail' => [ 'summary' => 'Obtain the content list within a music audio album. ', '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' => 'album ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '121321', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => ['description' => 'page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'number of records per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], ], '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' => 'Code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Message information ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ 'CurrentPageNum' => ['description' => 'Current page number ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OpenDataItemList' => [ 'description' => 'Data information ', 'type' => 'array', 'items' => [ 'description' => 'Data information ', 'type' => 'object', 'properties' => [ 'Alias' => [ 'description' => 'Alias', 'type' => 'array', 'items' => ['description' => 'alias', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'title' => '', 'example' => '', ], 'Audition' => ['description' => 'Indicates whether the content is available for audition ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ 'description' => 'Author of the content ', 'type' => 'array', 'items' => [ 'description' => 'Content author ', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ 'description' => 'Author type ', 'type' => 'array', 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], 'title' => '', 'example' => '', ], 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'Id' => ['description' => 'Primary key ID of the author ', 'type' => 'integer', 'format' => 'int64', 'example' => '12314', 'title' => ''], 'Online' => ['description' => 'Whether the author is online ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Category' => ['description' => 'Transform controlType based on the associated public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CommCateId' => ['description' => 'category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ 'description' => 'Content thumbnail ', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], 'Duration' => ['description' => 'Duration', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'title' => ''], 'HotScore' => ['description' => 'popularity score', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Id' => ['description' => 'content ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1231231', 'title' => ''], 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], 'OrderIndex' => ['description' => 'OrderIndex sequence', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Styles' => [ 'description' => 'style', 'type' => 'array', 'items' => ['description' => 'style', 'type' => 'string', 'example' => '13131', 'title' => ''], 'title' => '', 'example' => '', ], 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Type' => ['description' => 'Transform favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], 'Valid' => ['description' => 'Indicates whether the content is playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'RawId' => ['description' => 'Third-party ID ', 'type' => 'string', 'example' => '12323423', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'TotalSize' => ['description' => 'total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '21421', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"CurrentPageNum\\": 1,\\n \\"OpenDataItemList\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 12314,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"Duration\\": 180,\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"OrderIndex\\": 1,\\n \\"Source\\": \\"qingting\\",\\n \\"Styles\\": [\\n \\"13131\\"\\n ],\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"12323423\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 21421\\n }\\n}","type":"json"}]', 'title' => 'Obtain the content list in a music audio album', 'changeSet' => [], ], 'ListAlbumIsAdded' => [ 'summary' => 'Whether the album is subscribed.', 'path' => '/v1.0/ssp/listAlbumIsAdded', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AlbumIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Album ID list', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51999575'], 'required' => true, 'docRequired' => true, 'minItems' => 1, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device Information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BCC85E69-5DA6-197E-A8C1-8A1B19CF781B'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'Result' => [ 'title' => '', 'description' => 'Result', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '51999575'], 'IsAdded' => ['title' => '', 'description' => 'Whether it is subscribed', 'type' => 'string', 'example' => 'false'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCC85E69-5DA6-197E-A8C1-8A1B19CF781B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"IsAdded\\": \\"false\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Whether the album is subscribed', 'changeSet' => [], ], 'ListCateContent' => [ 'summary' => 'Obtain the content under a specific category according to the specified sorting order. ', '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' => 'Request Parameters', 'type' => 'object', 'properties' => [ 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '80010', 'title' => ''], 'IsAlbum' => ['description' => 'Indicates whether to query albums', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], 'SortBy' => ['description' => 'Sorting field', 'type' => 'string', 'required' => false, 'example' => 'hot_score', 'title' => ''], 'SortOrder' => [ 'description' => 'Sorting order', 'type' => 'string', 'required' => true, 'example' => 'DESC', 'enum' => ['ASC', 'DESC'], 'title' => '', ], 'PageNum' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is SKILL_ID, the value is the Skill ID of the application. '."\n" .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'PACKAGE_NAME: APK package name, used for the Android application customer link. '."\n" .'SKILL_ID: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], 'IdType' => ['description' => 'Type of User ID.'."\n" ."\n" .'OPEN_ID: The default User ID identifier. '."\n" .'UNION_ID: The organization-dimension User ID identifier. This value is available only after an organization has been registered on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identifier information', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" ."\n" .'When the encoding type is SKILL_ID, the value is the application\'s Skill ID. '."\n" .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'PACKAGE_NAME: APK package name, used for the Android application customer link.'."\n" .'SKILL_ID: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'Device identifier, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej=', 'title' => ''], 'IdType' => ['description' => 'Type of device ID'."\n" ."\n" .'OPEN_ID: Default device ID identifier. '."\n" .'UNION_ID: Organization-level device ID identifier. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], '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' => 'code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'message information ', 'type' => 'string', 'example' => 'sucess', 'title' => ''], 'Result' => [ 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ 'TotalSize' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '12002', 'title' => ''], 'CurrentPageNum' => ['description' => 'Current page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'OpenDataItemList' => [ 'description' => 'Data information ', 'type' => 'array', 'items' => [ 'description' => 'Data information ', 'type' => 'object', 'properties' => [ 'id' => ['description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '26152778', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Authors' => [ 'description' => 'author information', 'type' => 'array', 'items' => [ 'description' => 'author information', 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'third-party author ID', 'type' => 'string', 'example' => '123123', 'title' => ''], 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'AuthorTypes' => [ 'description' => 'Author type', 'type' => 'array', 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], 'title' => '', 'example' => '', ], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Cover' => [ 'description' => 'profile picture', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'default image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Medium' => ['description' => 'medium image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Small' => ['description' => 'small image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'CanResize' => ['description' => 'Indicates whether the image can be cropped using OSS rules. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Id' => ['description' => 'Primary key ID of the author information ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Online' => ['description' => 'Whether it is online', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], 'Category' => ['description' => 'Transform controlType based on the assigned public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Type' => ['description' => 'Transform favoriteType based on the associated public category.', 'type' => 'string', 'example' => 'program', 'title' => ''], 'HotScore' => ['description' => 'Popularity score', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], 'Valid' => ['description' => 'Indicates whether the content is playable.', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Cover' => [ 'description' => 'Album thumbnail image', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg', 'title' => ''], 'Mediam' => ['description' => 'Medium image (Deprecated)', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/20170207175.jpg', 'title' => ''], 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020675.jpg', 'title' => ''], 'canResize' => ['description' => 'Indicates whether cropping can be performed using OSS rules.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CommCateId' => ['description' => 'Category ID', 'type' => 'string', 'example' => '80012017', 'title' => ''], 'Alias' => [ 'description' => 'Alias', 'type' => 'array', 'items' => ['description' => 'Alias', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'title' => '', 'example' => '', ], 'Charge' => ['description' => 'Whether it is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Audition' => ['description' => 'Is audition available', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '作者：月不醉 简介：啥，假冒你男友？退役兵王回归都市后做了一名小保安，机缘巧合下却被冷艳女总拉去客串男友，从此之后，他与冷艳老总开始纠缠不清···拳打恶一代，脚踩高富帅，哥哥我专治各种不服。面对各类的阴谋阳谋，面对各种黑恶势力，且看哥如何称霸都市，踏上巅峰！', 'title' => ''], 'RawId' => ['description' => 'Third-party ID of the album', 'type' => 'string', 'example' => '206775', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"sucess\\",\\n \\"Result\\": {\\n \\"TotalSize\\": 12002,\\n \\"CurrentPageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"OpenDataItemList\\": [\\n {\\n \\"id\\": 26152778,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Authors\\": [\\n {\\n \\"RawId\\": \\"123123\\",\\n \\"Gender\\": \\"MALE\\",\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Source\\": \\"qingting\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Mediam\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Category\\": \\"audio\\",\\n \\"Type\\": \\"program\\",\\n \\"HotScore\\": 0,\\n \\"Valid\\": \\"VALID\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/20170207175.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020675.jpg\\",\\n \\"canResize\\": false\\n },\\n \\"CommCateId\\": \\"80012017\\",\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Charge\\": false,\\n \\"Audition\\": true,\\n \\"Description\\": \\"作者：月不醉 简介：啥，假冒你男友？退役兵王回归都市后做了一名小保安，机缘巧合下却被冷艳女总拉去客串男友，从此之后，他与冷艳老总开始纠缠不清···拳打恶一代，脚踩高富帅，哥哥我专治各种不服。面对各类的阴谋阳谋，面对各种黑恶势力，且看哥如何称霸都市，踏上巅峰！\\",\\n \\"RawId\\": \\"206775\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Retrieve content under a specific category sorted in the specified order.', 'changeSet' => [], ], 'ListCateInfo' => [ 'summary' => 'Obtain category information.', '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' => 'Default value is song (the extension field currently only supports song)', 'type' => 'string', 'required' => true, 'example' => 'song'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'Returned parameters', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80064', 'title' => ''], 'CateName' => ['description' => 'Category name', 'type' => 'string', 'example' => '时尚生活', 'title' => ''], 'ParentCateId' => ['description' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80064,\\n \\"CateName\\": \\"时尚生活\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","type":"json"}]', 'title' => 'Obtain the music audio category list', 'changeSet' => [], ], 'ListCommonCateFirstFloor' => [ 'summary' => 'Obtain the top-level category list for music or audio.', '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' => 'Default value: song (extension field currently only supports song)', 'type' => 'string', 'required' => true, 'example' => 'song'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Result' => [ 'description' => 'Return Result', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80012', 'title' => ''], 'CateName' => ['description' => 'Category name', 'type' => 'string', 'example' => '有声内容', 'title' => ''], 'ParentCateId' => ['description' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80012,\\n \\"CateName\\": \\"有声内容\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', 'title' => 'Obtain the top-level category list for music or audio', 'changeSet' => [], ], 'ListCommonCateSecondFloor' => [ 'summary' => 'Retrieve the list of level-2 categories under a specified level-1 category.', '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' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '80010', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Return Result', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CateId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80018009', 'title' => ''], 'CateName' => ['description' => 'Category Name', 'type' => 'string', 'example' => '儿童笑话', 'title' => ''], 'ParentCateId' => ['description' => 'Parent category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '80018', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80018009,\\n \\"CateName\\": \\"儿童笑话\\",\\n \\"ParentCateId\\": 80018\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', 'title' => 'Retrieve the list of level-2 categories under a specified level-1 category', 'changeSet' => [], ], 'ListDeviceBasicInfo' => [ 'summary' => 'Batch retrieve basic device information based on a list of device openIDs. ', 'path' => '/v1.0/ssp/listDeviceBasicInfo', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DeviceInfos', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of device identity information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can view this in the Tmall Genie AI Platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ 'title' => '', 'description' => 'Type of device ID:'."\n" .'- OPEN_ID: Default device ID identity.'."\n" .'- UNION_ID: Organization-dimension device ID identity. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Ids' => [ 'title' => '', 'description' => 'List of device identity information.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Device identifier. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'required' => false, 'example' => '', ], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID of the device. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information returned. ', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the device. ', 'type' => 'string', 'example' => '我的设备'], 'FirmwareVersion' => ['title' => '', 'description' => 'The firmware version of the device. ', 'type' => 'string', 'example' => '2.0.3'], 'Mac' => ['title' => '', 'description' => 'The MAC address of the device. ', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'], 'Sn' => ['title' => '', 'description' => 'The SN information of the device. ', 'type' => 'string', 'example' => '1200xx048'], ], 'description' => 'List of device information returned. ', 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.ListDeviceBasicInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xx048\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Batch query basic device information', 'changeSet' => [], ], 'ListDeviceByUserId' => [ 'summary' => 'Obtain the list of attached Device IDs based on the user\'s openID. ', 'path' => '/v1.0/ssp/listDeviceByUserId', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of User Identifier information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can view this in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'IdType' => [ 'title' => '', 'description' => 'Type of the User ID:'."\n" .' - OPEN_ID: The default User ID identifier.'."\n" .' - UNION_ID: A User ID identifier in the organization dimension. You must request an organization in the Open Platform beforehand.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'User Identifier. Enter the value of userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list. ', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'The return result of invoking this API. ', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The returned error code, where 200 indicates that the invocation succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information returned. ', 'type' => 'array', 'items' => [ 'description' => 'List of information entries ', 'type' => 'object', 'properties' => [ 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the Device Information.', 'type' => 'string', 'example' => 'A963*0158'], 'DeviceUnionIds' => [ 'title' => '', 'description' => 'Organization ID and UnionId information corresponding to the device. ', 'type' => 'array', 'items' => [ 'description' => 'List of information entries ', 'type' => 'object', 'properties' => [ 'OrganizationId' => ['title' => '', 'description' => 'The organization ID. ', 'type' => 'string', 'example' => '1**2'], 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device. ', 'type' => 'string', 'example' => '1553*B0C3'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.ListDeviceByUserId.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Obtain the list of devices attached to a user', 'changeSet' => [], ], 'ListDeviceByUserIdAndChanel' => [ 'summary' => 'Obtain the device list for a specified channel.', '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' => '', 'description' => 'Activation channel, such as WeChat mini program or third-party app.', 'type' => 'object', 'properties' => [ 'Channel' => ['title' => '', 'description' => 'Activation provisioning channel, such as WeChat or ThirdApp.', 'type' => 'string', 'required' => true, 'example' => 'WeChat、ThirdApp'], 'ExtInfo' => ['title' => '', 'description' => 'Extension information.', 'type' => 'string', 'required' => false, 'example' => '{}'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'List of User Identifier information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding Type; enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type; enter the Project ID of the project to which the product belongs. You can view this in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ 'title' => '', 'description' => 'The Type of the User ID: '."\n" .'OPEN_ID: The default User ID identity. '."\n" .'UNION_ID: The User ID identity at the organization dimension, which requires you to request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'User Identifier; enter the value of userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID; required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1***2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return Result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The returned error code. The value 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'List of information', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the Device Information.', 'type' => 'string', 'example' => 'A963*0158'], 'DeviceUnionIds' => [ 'title' => '', 'description' => 'List of information', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OrganizationId' => ['title' => '', 'description' => 'Organization ID.', 'type' => 'string', 'example' => '1***2'], 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device.', 'type' => 'string', 'example' => '1553*B0C3'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'RE***D'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1***2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"RE***D\\"\\n}","type":"json"}]', 'title' => 'Obtain the device list for a specified Channel', 'changeSet' => [], ], 'ListDeviceIdByIdentities' => [ 'summary' => 'Batch retrieve Device IDs by device MAC/SN.', 'path' => '/v1.0/ssp/listDeviceIdByIdentities', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'EncodeType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Encoding type. Enter **PROJECT_ID** here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'], ], [ 'name' => 'EncodeKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The value corresponding to the encoding type. Enter the Project ID of the project to which this product belongs. You can view it in the Tmall Genie AI platform console. ', 'type' => 'string', 'required' => true, 'example' => '125****0946'], ], [ 'name' => 'IdentityType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Device authentication type. Enter **MAC** or **SN**. ', 'type' => 'string', 'required' => true, 'example' => 'MAC'], ], [ 'name' => 'IdentityIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of device authentication identifiers. ', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Authentication identifier. Enter the MAC address or SN value. ', 'type' => 'string', 'required' => true, 'example' => 'b4:xx:xx:xx:65:2b'], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ProductKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique product identifier ProductKey, which is a globally unique identity issued by the platform when creating a product in the Tmall Genie AI platform. ', 'type' => 'string', 'required' => true, 'example' => 'Mm*****XnZ8'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns a data list.', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'The return result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The returned error code. A value of 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'A list of detailed returned information.', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'DeviceOpenId' => ['title' => '', 'description' => 'The openId corresponding to the device. ', 'type' => 'string', 'example' => 'A963*0158'], 'DeviceUnionIds' => [ 'title' => '', 'description' => 'The organization ID and UnionId information corresponding to the device.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OrganizationId' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'example' => '1**2'], 'DeviceUnionId' => ['title' => '', 'description' => 'The UnionId of the device.', 'type' => 'string', 'example' => '1553*B0C3'], ], 'description' => 'Information list', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => 'Information list', 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Batch retrieve Device IDs ', 'changeSet' => [], ], 'ListMusic' => [ 'summary' => 'Query the list of ringtones under a specified music category.', 'path' => '/v1.0/ssp/listMusic', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID, returned by the queryMusicType API', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name, returned by the queryMusicType API', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'], 'MusicId' => ['title' => '', 'description' => 'Ringtone ID, an extension field; currently not required', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], 'MusicName' => ['title' => '', 'description' => 'Ringtone name, an extension field; currently not required to be passed.', 'type' => 'string', 'required' => false, 'example' => 'xx铃声'], 'CurrentPage' => ['title' => '', 'description' => 'Current page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Number of entries per page: maximum value is 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ 'title' => '', 'description' => 'Type of user ID: OPEN_ID: default user ID identifier; UNION_ID: organization-dimension user ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer links; SKILL_ID: skill ID, used for cloud-based links', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID, required if IdType is UNION_ID', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device ID information ', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ 'title' => '', 'description' => 'Type of the device ID: OPEN_ID indicates the default device ID; UNION_ID indicates the organization-dimension device ID, which is available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME refers to the APK package name, used in the Android application customer link; SKILL_ID refers to the skill ID, used in the cloud link. ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type: when the encoding type is SKILL_ID, the value is the application\'s SkillID; when the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code returned by the alarm service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '音乐类型名称为空'], 'Result' => [ 'description' => 'collection of ringtone query results', 'type' => 'object', 'properties' => [ 'TotalCount' => ['title' => '', 'description' => 'Total number of entries', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'PageCount' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'PageSize' => ['title' => '', 'description' => 'Number of entries per page: maximum value is 100; values exceeding 100 are treated as 100', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'CurrentPage' => ['title' => '', 'description' => 'Current page', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Model' => [ 'title' => '', 'description' => 'List of ringtones', 'type' => 'array', 'items' => [ 'description' => 'Ringtone information', 'type' => 'object', 'properties' => [ 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name ', 'type' => 'string', 'example' => 'xx'], 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MusicName' => ['title' => '', 'description' => 'Ringtone name ', 'type' => 'string', 'example' => 'xx'], 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'example' => 'http://xx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"音乐类型名称为空\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', 'title' => 'Query paginated ringtone list ', 'responseParamsDescription' => 'The request is successful only if the returned status code is 200; otherwise, it has failed.', 'changeSet' => [], ], 'ListPlayHistory' => [ 'summary' => 'Obtain the history playback API.', 'path' => '/v1.0/ssp/ListPlayHistory', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Request', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Request Parameters ', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Type of content: music, program (audiobook), story, children_song, or radio ', 'type' => 'string', 'required' => false, 'example' => 'music', 'title' => ''], 'PageNum' => ['description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identification information ', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is SKILL_ID, the value is the Skill ID of the application.'."\n" .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client application.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'The encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'PACKAGE_NAME: The APK package name. This is the encoding type for the Android application customer link.'."\n" .'SKILL_ID: The skill ID. This is the encoding type for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'The User Identifier, which can be set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], 'IdType' => ['description' => 'The type of User ID.'."\n" ."\n" .'OPEN_ID: The default User ID identity.'."\n" .'UNION_ID: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'The organization ID. This field is required when IdType is set to UNION_ID.', 'type' => 'string', 'required' => true, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information ', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'Value corresponding to the encoding type '."\n" ."\n" .'When the encoding type is SKILL_ID, this value is the application\'s Skill ID. '."\n" .'When the encoding type is PACKAGE_NAME, this value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" ."\n" .'PACKAGE_NAME: APK package name, used for Android application client-side identification. '."\n" .'SKILL_ID: Skill ID, used for cloud-based identification. ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'Device ID, set to either deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej=', 'title' => ''], 'IdType' => ['description' => 'Type of device ID '."\n" ."\n" .'OPEN_ID: Default device ID identity. '."\n" .'UNION_ID: Organization-dimension device ID identity. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID. ', 'type' => 'string', 'required' => true, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], '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' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'Return Result', 'type' => 'array', 'items' => [ 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'Alias' => [ 'description' => 'Alias ', 'type' => 'array', 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'title' => '', 'example' => '', ], 'Audition' => ['description' => 'Is audition available', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ 'description' => 'Authors of the content', 'type' => 'array', 'items' => [ 'description' => 'Content author', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ 'description' => 'Author types', 'type' => 'array', 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], 'title' => '', 'example' => '', ], 'Cover' => [ 'description' => 'Profile picture', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'RawId' => ['description' => 'Third-party author ID', 'type' => 'string', 'example' => '123123', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Id' => ['description' => 'Author primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Category' => ['description' => "\n" .'Transform controlType based on the category', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CommCateId' => ['description' => 'Category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ 'description' => 'Album cover image', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'Content description', 'type' => 'string', 'example' => '内容描述', 'title' => ''], 'HotScore' => ['description' => 'Hot Score ', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Id' => ['description' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Type' => ['description' => 'Convert to favoriteType based on the associated public category', 'type' => 'string', 'example' => 'program', 'title' => ''], 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Valid' => ['description' => 'Indicates whether the content is playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Type\\": \\"program\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Valid\\": \\"VALID\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Get Playback History API ', 'changeSet' => [], ], 'ListRecommendContent' => [ 'summary' => 'Obtain daily recommended music or audio.', 'path' => '/v1.0/ssp/ListRecommendContent', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Request', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Request Parameters', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'Default value: song (currently, the extension field supports only song)', 'type' => 'string', 'required' => false, 'example' => 'song', 'title' => ''], 'Count' => ['description' => 'Quantity of recommendations', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identification information', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is SKILL_ID, the value is the Skill ID of the application. '."\n" .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'PACKAGE_NAME: APK package name, used for the Android application client path.'."\n" .'SKILL_ID: Skill ID, used for the cloud-based path.', 'type' => 'string', 'required' => false, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw=', 'title' => ''], 'IdType' => ['description' => 'Type of User ID.'."\n" ."\n" .'OPEN_ID: The default User ID identifier. '."\n" .'UNION_ID: The organization-dimension User ID identifier. This value is available only after an organization has been requested on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" ."\n" .'When the encoding type is SKILL_ID, the value is the application\'s Skill ID.'."\n" .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => false, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'PACKAGE_NAME: APK package name, used for the Android application client path.'."\n" .'SKILL_ID: Skill ID, used for the cloud-based path.', 'type' => 'string', 'required' => false, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej=', 'title' => ''], 'IdType' => ['description' => 'Type of device ID'."\n" ."\n" .'OPEN_ID: Default device ID identity.'."\n" .'UNION_ID: Organization-dimension device ID identity. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Code encoding', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Message information', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request RequestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E', 'title' => ''], 'Result' => [ 'description' => 'Return Result', 'type' => 'array', 'items' => [ 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'Alias' => [ 'description' => 'Alias ', 'type' => 'array', 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'title' => '', 'example' => '', ], 'Audition' => ['description' => 'Is audition available', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ 'description' => 'Content author', 'type' => 'array', 'items' => [ 'description' => 'Content author', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ 'description' => 'Author types ', 'type' => 'array', 'items' => ['description' => 'Author type ', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], 'title' => '', 'example' => '', ], 'Cover' => [ 'description' => 'Profile picture', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used to crop the image ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'RawId' => ['description' => 'Third-party author ID', 'type' => 'string', 'example' => '12311', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Id' => ['description' => 'Author primary key ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Online' => ['description' => 'Whether the author is online ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Category' => ['description' => 'Transform controlType based on the assigned public category', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Charge' => ['description' => 'Whether the content is charged ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CommCateId' => ['description' => 'Corresponding category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ 'description' => 'Album cover image ', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'Content description', 'type' => 'string', 'example' => '内容描述', 'title' => ''], 'HotScore' => ['description' => "\n" .'Hot Score', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Id' => ['description' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'ItemType' => ['description' => "\n" .'Type of content, such as music, audio, radio, jokes, etc. ', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Title' => ['description' => 'Title ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Type' => ['description' => 'Transformed favoriteType based on the associated public category ', 'type' => 'string', 'example' => 'program', 'title' => ''], 'Valid' => ['description' => 'Whether playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'RawId' => ['description' => 'Third-party ID ', 'type' => 'string', 'example' => '123123', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"12311\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"123123\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Obtain daily recommended music or audio', 'changeSet' => [], ], 'ListSub' => [ 'summary' => 'The user has subscribed to the list.', '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' => 'Pagination Parameters', 'type' => 'object', 'properties' => [ 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device Information ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'description' => '', 'title' => '', ], 'EncodeKey' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], 'IdType' => [ 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'description' => '', 'title' => '', ], 'Id' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'description' => '', 'title' => '', ], 'EncodeKey' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], 'IdType' => [ 'type' => 'string', 'required' => true, 'example' => 'UNION_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'description' => '', 'title' => '', ], 'Id' => ['type' => 'string', 'required' => true, 'example' => '123', 'description' => '', 'title' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'Result' => [ 'title' => '', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'TotalCount' => ['title' => '', 'description' => 'Total number of data entries ', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'TotalPageCount' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'HasNext' => ['title' => '', 'description' => 'Is there a next page ', 'type' => 'boolean', 'default' => 'false', 'example' => ''], 'DataList' => [ 'title' => '', 'description' => 'Subscription list', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Subscription record ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'DeviceId' => ['title' => '', 'description' => 'Device ID', 'type' => 'string', 'example' => '5874DBCCA3038FAA1A70A8060F07F26D'], 'UserId' => ['title' => '', 'description' => 'User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1152893538998276761'], 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule information ', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ 'title' => '', 'description' => 'Trigger epoch ', 'type' => 'array', 'items' => ['title' => '', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'maxItems' => 7, 'minItems' => 1, 'example' => '', ], 'Hour' => ['title' => '', 'description' => 'Trigger hour ', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], 'Minute' => ['title' => '', 'description' => 'Trigger minute ', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], ], 'example' => '', ], 'AlbumId' => ['title' => '', 'description' => 'Album ID ', 'type' => 'string', 'example' => '51999575'], 'PlayMode' => ['title' => '', 'description' => 'Playback mode', 'type' => 'string', 'example' => 'sequence'], 'DailyStudyCnt' => ['title' => '', 'description' => 'Daily study quantity ', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'CoverUrl' => ['title' => '', 'description' => 'Album thumbnail ', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg'], 'Title' => ['title' => '', 'description' => 'Album title ', 'type' => 'string', 'example' => '小科学家探索'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '0D0C09C2-ADC1-198B-964D-24F4FAD967DB'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": false,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": 1152893538998276700,\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2,\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"Title\\": \\"小科学家探索\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0D0C09C2-ADC1-198B-964D-24F4FAD967DB\\"\\n}","type":"json"}]', 'title' => 'User subscribed list ', 'changeSet' => [], ], 'ListSubAlbum' => [ 'summary' => 'Album List.', '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' => '', 'description' => 'Category ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '80011'], 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'required' => false, 'example' => '4476001'], 'Title' => ['title' => '', 'description' => 'Album title', 'type' => 'string', 'required' => false, 'example' => '睡前故事'], 'Page' => [ 'title' => '', 'description' => 'Pagination Parameters', 'type' => 'object', 'properties' => [ 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], 'required' => true, 'docRequired' => true, 'example' => '', ], 'DeviceId' => ['title' => 'Device ID', 'type' => 'string', 'docRequired' => true, 'example' => '5874DBCCA3038FAA1A70A8060F07F26D', 'description' => ''], 'UserId' => ['title' => 'User ID', 'type' => 'string', 'docRequired' => true, 'example' => '1152893538998276761', 'description' => ''], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device Information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'EncodeKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'IdType' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'Id' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'OrganizationId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Result', 'type' => 'object', 'properties' => [ 'TotalCount' => ['title' => '', 'description' => 'total number of entries', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'TotalPageCount' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'HasNext' => ['title' => '', 'description' => 'Indicates whether there is a next page.', 'type' => 'boolean', 'example' => ''], 'DataList' => [ 'title' => '', 'description' => 'Album List', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Record ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'CategoryId' => ['title' => '', 'description' => 'Album category ID', 'type' => 'integer', 'format' => 'int32', 'example' => '80011'], 'AlbumId' => ['title' => '', 'description' => 'Album ID', 'type' => 'string', 'example' => '4476001'], 'Title' => ['title' => '', 'description' => 'Album title', 'type' => 'string', 'example' => '睡前故事'], 'CoverUrl' => ['title' => '', 'description' => 'Album thumbnail', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg'], 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule information', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ 'title' => '', 'description' => 'trigger epoch', 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], 'example' => '', ], 'Hour' => ['title' => '', 'description' => 'trigger hour', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], 'Minute' => ['title' => '', 'description' => 'trigger minute', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], 'ScheduleId' => ['title' => '', 'description' => 'scheduled task ID', 'type' => 'integer', 'format' => 'int64', 'example' => ''], ], 'example' => '', ], 'TotalEpisode' => ['title' => '', 'description' => 'Total number of episodes', 'type' => 'integer', 'format' => 'int32', 'example' => '23'], 'Sequence' => ['title' => '', 'description' => 'Sorting', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'IsAdded' => ['title' => '', 'description' => 'Is subscribed', 'type' => 'boolean', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'CB13B8D7-37FB-1B3E-8EB9-65BB413267E1'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": false,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"CategoryId\\": 80011,\\n \\"AlbumId\\": \\"4476001\\",\\n \\"Title\\": \\"睡前故事\\",\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23,\\n \\"ScheduleId\\": 0\\n },\\n \\"TotalEpisode\\": 23,\\n \\"Sequence\\": 1,\\n \\"IsAdded\\": false\\n }\\n ]\\n },\\n \\"RequestId\\": \\"CB13B8D7-37FB-1B3E-8EB9-65BB413267E1\\"\\n}","type":"json"}]', 'title' => 'Album List', 'changeSet' => [], ], 'ListSubscriptionAlbumCategory' => [ 'summary' => 'Album categorization.', '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' => 'Category name', 'type' => 'string', 'required' => false, 'example' => '儿歌'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Additional information', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'List of categories', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CategoryId' => ['title' => '', 'description' => 'Category ID', 'type' => 'string', 'example' => '80011'], 'CategoryName' => ['title' => '', 'description' => 'Category name', 'type' => 'string', 'example' => '儿童'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '60E7A523-9766-1D07-87A2-6E587420C59B'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CategoryId\\": \\"80011\\",\\n \\"CategoryName\\": \\"儿童\\"\\n }\\n ],\\n \\"RequestId\\": \\"60E7A523-9766-1D07-87A2-6E587420C59B\\"\\n}","type":"json"}]', 'title' => 'Album categorization', 'changeSet' => [], ], 'ListUserMessage' => [ 'summary' => 'Query the list of user message records based on the query conditions, including the start time and the number of entries to return.', 'path' => '/v1.0/ssp/listUserMessage', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'BeforeTime', 'in' => 'query', 'schema' => ['description' => 'After a specific point in time ', 'type' => 'string', 'required' => false, 'example' => '2022-07-27 14:06:55.984', 'title' => ''], ], [ 'name' => 'limit', 'in' => 'query', 'schema' => ['description' => 'Number of records to query ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identifier information ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. There are multiple ways to obtain the user identifier for Maojing, and each method corresponds to a different encoding type: - PACKAGENAME: APK package name, used for Android application client links - SKILLID: Skill ID, used for cloud-based links ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the application\'s Skill ID. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app. ', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => [ 'description' => 'Type of user ID: - OPENID: Default user ID identifier - UNIONID: Organization-level user ID identifier, available only after an organization has been registered on the Maojing skill application Open Platform ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'title' => '', ], 'Id' => ['description' => 'User identifier (userOpenId or userUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID ', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Service Return Result', 'type' => 'object', 'properties' => [ 'Message' => ['title' => 'Id of the request', 'description' => 'error message', 'type' => 'string', 'example' => '外部userId映射关系不存在'], 'Code' => ['description' => 'Status code returned by the service. SUCCESS indicates success; otherwise, it indicates failure.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Result' => [ 'description' => 'List of user message query results', 'type' => 'array', 'items' => [ 'description' => 'Message details', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'Message ID', 'type' => 'string', 'example' => '123456', 'title' => ''], 'GmtCreate' => ['description' => 'Time when the message was sent', 'type' => 'string', 'example' => '2022-07-27 14:06:27.000', 'title' => ''], 'Status' => ['description' => 'Message status: 0 indicates unread, and 1 indicates read.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Source' => ['description' => 'Message source: app or box', 'type' => 'string', 'example' => 'app', 'title' => ''], 'Type' => ['description' => 'Currently only audio is supported.', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Content' => ['description' => 'Message text', 'type' => 'string', 'example' => '哈哈哈', 'title' => ''], 'Url' => ['description' => 'Audio message link ', 'type' => 'string', 'example' => 'http://xx', 'title' => ''], 'SourceUuid' => ['description' => 'Source Device ID', 'type' => 'string', 'example' => 'AF188**065EE4B**DD68CE**951D84D4', 'title' => ''], 'DeviceName' => ['description' => 'Device name ', 'type' => 'string', 'example' => '卧室的小芳', 'title' => ''], 'Pic' => ['description' => 'Device Image', 'type' => 'string', 'example' => 'http://xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"123456\\",\\n \\"GmtCreate\\": \\"2022-07-27 14:06:27.000\\",\\n \\"Status\\": 0,\\n \\"Source\\": \\"app\\",\\n \\"Type\\": \\"audio\\",\\n \\"Content\\": \\"哈哈哈\\",\\n \\"Url\\": \\"http://xx\\",\\n \\"SourceUuid\\": \\"AF188**065EE4B**DD68CE**951D84D4\\",\\n \\"DeviceName\\": \\"卧室的小芳\\",\\n \\"Pic\\": \\"http://xx\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Query the list of user message records ', 'changeSet' => [], ], 'MobileRecommend' => [ 'summary' => 'Shift the project to obtain recommended songs, including daily recommendations, popular songs, and genre-based playlists.', 'path' => '/v1.0/ssp/mobile/recommend/music', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User information – userId', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => ['description' => 'The value corresponding to the encoding Type. Enter the Project ID of the project to which this product belongs.', 'type' => 'string', 'required' => true, 'example' => '1414895629783187053', 'title' => ''], 'IdType' => [ 'description' => 'ID Type', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'title' => '', ], 'Id' => ['description' => 'ID value', 'type' => 'string', 'required' => true, 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. This parameter is Required when IdType is set to UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '暂无', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => [ 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs.', 'type' => 'string', 'required' => true, 'example' => '1414895629783187053', 'enum' => [], 'title' => '', ], 'IdType' => [ 'description' => 'Type of the device ID.'."\n" ."\n" .'OPEN_ID: Default device ID.'."\n" .'UNION_ID: Organization-level device ID. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['UNION_ID', 'OPEN_ID'], 'title' => '', ], 'Id' => ['description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. This parameter is required when **IdType** is set to **UNION_ID**.', 'type' => 'string', 'required' => false, 'example' => '暂无', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'BotId', 'in' => 'query', 'schema' => ['description' => 'Bot ID.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Request Type: Obtain daily recommendations, hot songs, or genre-based playlists.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['STYLE' => '', 'DAILY_REC' => '', 'HOT' => ''], 'example' => 'DAILY_REC', 'title' => '', ], ], [ 'name' => 'Style', 'in' => 'query', 'schema' => [ 'description' => 'Required when the request type is STYLE.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['钢琴' => '', '抖音' => '', '欢快' => '', '轻音乐' => '', '流行' => '', 'DJ' => 'DJ'], 'example' => '轻音乐', 'title' => '', ], ], [ 'name' => 'Count', 'in' => 'query', 'schema' => ['description' => 'Quantity of recommended Result', 'type' => 'string', 'required' => false, 'example' => '6', 'title' => ''], ], ], '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' => 'Return code of the invocation', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'If an error occurs, the error message will be output.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'Request result.', 'type' => 'array', 'items' => [ 'description' => 'Actual return result from the service', 'type' => 'object', 'properties' => [ 'Source' => ['description' => 'Source of the content', 'type' => 'string', 'example' => 'KG', 'title' => ''], 'RawId' => ['description' => 'Third-party ID of the content', 'type' => 'string', 'example' => '550144364', 'title' => ''], 'Cover' => ['description' => 'Album thumbnail image', 'type' => 'string', 'example' => 'http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg', 'title' => ''], 'Authors' => [ 'description' => 'Author information', 'type' => 'array', 'items' => ['description' => 'Author information', 'type' => 'string', 'example' => '["周杰伦"]', 'title' => ''], 'title' => '', 'example' => '', ], 'Title' => ['description' => 'Content title', 'type' => 'string', 'example' => '稻香', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], '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"}]', 'title' => 'Shift Lightweight Managed Recommendation API', 'description' => 'Different scenarios (such as daily recommendations and popular songs) can be distinguished by the Type parameter.', 'changeSet' => [], ], 'PlayAndPauseControl' => [ 'summary' => 'Playback and pause control.', 'path' => '/v1.0/ssp/PlayAndPauseControl', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OpenPlayAndPauseControlParam', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ 'OpenPlayAndPauseCommand' => [ 'description' => 'Playback: Play; Pause: Pause.', 'type' => 'string', 'required' => true, 'example' => 'Play', 'enum' => ['Play', 'Pause'], 'title' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier from Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer flow. `SKILL_ID`: Skill ID, used for the cloud-based flow.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of User ID.'."\n" ."\n" .'`OPEN_ID`: The default user ID identity. `UNION_ID`: The organization-dimension user ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User identifier, set to either userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device identity for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. `SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'If the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. If the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of Device ID.'."\n" ."\n" .'`OPEN_ID`: The default device ID identity. `UNION_ID`: The organization-dimension device ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device ID, which can be set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. This parameter is required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => ['description' => 'Actual return result from the service', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Message' => ['description' => 'Additional information. In typical scenarios, this provides a brief description of a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. The value true means success, and false means failure. If the invocation fails, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Playback and pause control', 'changeSet' => [], ], 'PlayModeControl' => [ 'summary' => 'Switch playback mode.', 'path' => '/v1.0/ssp/PlayModeControl', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OpenPlayModeControlRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Business parameters', 'type' => 'object', 'properties' => [ 'OpenPlayMode' => [ 'description' => 'Playback mode'."\n" ."\n" .'List loop: Repeat; Shuffle: Shuffle; Single track loop: RepeatOne; NAT mode: Normal;', 'type' => 'string', 'required' => true, 'example' => 'Normal', 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'], 'title' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User Identifier information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer ingest endpoint. `SKILL_ID`: Skill ID, used for the cloud-side ingest endpoint.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'Type of User ID'."\n" ."\n" .'`OPEN_ID`: The default User ID identity. `UNION_ID`: Organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User Identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for Android application customer journeys. `SKILL_ID`: Skill ID, used for cloud-based journeys.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'Type of device ID'."\n" ."\n" .'`OPEN_ID`: Default device ID identity. `UNION_ID`: Organization-dimension device ID identity, available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Actual return result of the service', 'type' => 'object', 'properties' => [ 'OpenPlayMode' => [ 'description' => 'Playback mode'."\n" ."\n" .'List loop: Repeat; Shuffle: Shuffle; Single-track loop: RepeatOne; NAT mode: Normal;', 'type' => 'string', 'example' => 'Normal', 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'], 'title' => '', ], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the value is false, check the Message field for details.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OpenPlayMode\\": \\"Normal\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Switch playback mode', 'changeSet' => [], ], 'PreviousAndNextControl' => [ 'summary' => 'Control the next or previous track in the created playlist. ', 'path' => '/v1.0/ssp/PreviousAndNextControl', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'OpenControlPlayingListRequest', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Business parameters ', 'type' => 'object', 'properties' => [ 'Cmd' => ['description' => 'Next track: NEXT; Previous track: PREVIOUS ', 'type' => 'string', 'required' => true, 'example' => 'NEXT', 'title' => ''], 'IsFromDevice' => ['description' => 'Whether initiated by the device. Default is false. ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'ExtendInfo' => ['type' => 'object', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identity from Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for Android application client-side flows. `SKILL_ID`: Skill ID, used for cloud-side flows.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of User ID.'."\n" ."\n" .'`OPEN_ID`: The default user identity. `UNION_ID`: The organization-dimension user identity, which is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device ID information ', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for Android application customer journeys. `SKILL_ID`: Skill ID, used for cloud-based journeys. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of Device ID.'."\n" ."\n" .'`OPEN_ID`: The default device identity. `UNION_ID`: The organization-dimension device identity, which is available only after an organization has been requested on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device ID, set to deviceOpenId or deviceUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => [ 'description' => 'Actual return result from the service ', 'type' => 'object', 'properties' => [ 'RawId' => ['description' => 'Third-party ID', 'type' => 'string', 'example' => '550144364', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => 'ximalayav2', 'title' => ''], 'AlbumRawId' => ['description' => 'Third-party album ID ', 'type' => 'string', 'example' => '260744', 'title' => ''], 'AlbumName' => ['description' => 'Third-party album name ', 'type' => 'string', 'example' => '晚安妈妈睡前故事', 'title' => ''], 'Liked' => ['description' => 'is collected ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Singer' => ['description' => 'author ', 'type' => 'string', 'example' => '晚安妈妈', 'title' => ''], 'Title' => ['description' => 'title ', 'type' => 'string', 'example' => '足球鞋赛车 晚安妈妈', 'title' => ''], 'Cover' => [ 'description' => 'Thumbnail image object', 'type' => 'object', 'properties' => [ 'Img' => ['description' => 'Default image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Large' => ['description' => 'Large image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Mediam' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Medium' => ['description' => 'Medium image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'Small' => ['description' => 'Small image', 'type' => 'string', 'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640', 'title' => ''], 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'PlayMode' => ['description' => 'Playback mode (Repeat, Shuffle, RepeatOne, Normal) ', 'type' => 'string', 'example' => 'Repeat', 'title' => ''], 'AudioLength' => ['description' => 'Length ', 'type' => 'integer', 'format' => 'int32', 'example' => '190', 'title' => ''], 'Progress' => ['description' => 'Song playback progress ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'LyricUrl' => ['description' => 'Lyrics URL ', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc', 'title' => ''], 'Type' => ['description' => 'Type (such as music, program, joke, news, children_song, radio, etc.)', 'type' => 'string', 'example' => 'story', 'title' => ''], 'Copyright' => ['description' => 'The copyright field is upgraded to indicate whether playback is allowed: 0 means playable, 1 or 2 means not playable.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ItemUrl' => ['description' => 'Playback URL ', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3', 'title' => ''], 'DefaultPlayOrder' => ['description' => 'Default playback order for the package: 0 for sequential, 1 for reverse order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Valid' => ['description' => 'Indicates whether playback is allowed: VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Pos' => ['description' => 'The position of this item in the playlist ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'Additional information, typically used to briefly describe a failed invocation to help the caller troubleshoot the issue. ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. A value of true means success, and false means failure. When the value is false, check the Message field for details. ', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Next/Previous Track Control ', 'changeSet' => [], ], 'ProgressControl' => [ 'summary' => 'Progress control.', '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' => 'Business parameters', 'type' => 'object', 'properties' => [ 'Progress' => ['description' => 'Song progress, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', 'title' => ''], 'ExtendInfo' => ['description' => 'Extension information', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the Tmall Genie user identity, and each way corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application client path. `SKILL_ID`: Skill ID, used for the cloud-based path.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of User ID.'."\n" ."\n" .'`OPEN_ID`: The default User ID identity. `UNION_ID`: The organization-dimension User ID identity, which is available only after an organization has been requested on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'User identifier, set to userOpenId or userUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type.'."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer flow. `SKILL_ID`: Skill ID, used for the cloud-based flow.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'title' => ''], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the Skill ID of the application. When the encoding type is `PACKAGE_NAME`, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => ['description' => 'The type of Device ID.'."\n" ."\n" .'`OPEN_ID`: The default device identity. `UNION_ID`: The organization-dimension device identity, which is available only after an organization has been requested on the Tmall Genie Skills Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'Id' => ['description' => 'Device ID. Set to either deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code of the invocation', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Result' => ['description' => 'Actual return result of the service', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Message' => ['description' => 'Additional information. In typical scenarios, this provides a brief description of a failed invocation to help the caller identify the issue.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '10002398812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. true indicates success, and false indicates failure. When the invocation fails, pay attention to the Message field.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'Progress control', 'changeSet' => [], ], 'QueryMusicType' => [ 'summary' => 'Obtain the collection of alarm music types supported by the device.', 'path' => '/v1.0/ssp/queryMusicType', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Invoker', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identifier information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ 'title' => '', 'description' => 'Type of User ID: OPEN_ID: default User ID identity; UNION_ID: organization-dimension User ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the Maojing user identifier, and each way corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for Android application customer journeys; SKILL_ID: skill ID, used for cloud-based journeys.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Device identity information', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'device ID (deviceOpenId or deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ 'title' => '', 'description' => 'Type of the device ID: OPEN_ID: default device ID; UNION_ID: organization-level device ID, available only after requesting an organization in the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device identity for Maojing, and each way corresponds to a different encoding type: PACKAGE_NAME: APK package name, used for the Android application customer link; SKILL_ID: skill ID, used for the cloud link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the application\'s SkillID. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code returned by the alarm service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '设备账号未关联'], 'Result' => [ 'description' => 'List of ringtone types', 'type' => 'array', 'items' => [ 'description' => 'Details of a ringtone type', 'type' => 'object', 'properties' => [ 'MusicType' => ['title' => '', 'description' => 'Ringtone type ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MusicTypeName' => ['title' => 'musicTypeName', 'description' => 'Name of the ringtone category', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'request ID', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\"\\n }\\n ],\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', 'title' => 'Obtain the list of alarm music types', 'responseParamsDescription' => 'The operation is successful only when the status code returned by the service is 200; otherwise, it indicates failure.', 'changeSet' => [], ], 'QueryUserDeviceListByTmeUserId' => [ 'summary' => 'Obtain the list of authorized Tmall Genie users and their devices by using the TME user ID, for use by KuGou Cloud Push Song service ', 'path' => '/v1.0/ssp/queryUserDeviceListByTmeUserId', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json', 'application/x-www-form-urlencoded'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'], 'parameters' => [ [ 'name' => 'TmeUserId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'TME User ID', 'type' => 'string', 'required' => true, 'example' => 'FDEEDE337BAA780793D72F7F20BEF2F5'], ], [ 'name' => 'Sp', 'in' => 'query', 'schema' => ['title' => '', 'description' => '"KG": KuGou '."\n" .'"KW": Kuwo '."\n" .'"QM": QQ Music', 'type' => 'string', 'required' => true, 'example' => 'KG'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00'], 'Code' => ['title' => '', 'description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message ', 'type' => 'string', 'example' => 'success'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded ', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ 'title' => '', 'description' => 'Response Result ', 'type' => 'object', 'properties' => [ 'Sp' => ['title' => '', 'description' => '"KG": KuGou '."\n" .'"KW": Kuwo '."\n" .'"QM": QQ Music', 'type' => 'string', 'example' => 'KG'], 'EncodeType' => ['title' => '', 'description' => 'entity Type (pass-through by third party)', 'type' => 'string', 'example' => 'PROJECT_ID'], 'EncodeKey' => ['title' => '', 'description' => 'entity key (pass-through by third party)', 'type' => 'string', 'example' => '12****7'], 'AligenieUserInfoList' => [ 'title' => '', 'description' => 'Tmall Genie User List ', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OpenUserId' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg=='], 'UserNickname' => ['title' => '', 'description' => 'User nickname ', 'type' => 'string', 'example' => 'a***e'], 'AuthorizedDeviceList' => [ 'title' => '', 'description' => 'User Authorization device List ', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OpenDeviceId' => ['title' => '', 'description' => 'Device ID ', 'type' => 'string', 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM='], 'DeviceName' => ['title' => '', 'description' => 'device name', 'type' => 'string', 'example' => 'CC'], 'Online' => ['title' => '', 'description' => 'Indicates whether the device is online ', 'type' => 'boolean', 'example' => 'true'], 'TmeProductId' => ['description' => 'TME product ID ', 'title' => 'TME product ID ', 'type' => 'string', 'example' => ''], 'TmeDeviceId' => ['description' => 'Device ID exposed to TME ', 'title' => 'Device ID exposed to TME ', 'type' => 'string', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Sp\\": \\"KG\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"AligenieUserInfoList\\": [\\n {\\n \\"OpenUserId\\": \\"R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==\\",\\n \\"UserNickname\\": \\"a***e\\",\\n \\"AuthorizedDeviceList\\": [\\n {\\n \\"OpenDeviceId\\": \\"fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=\\",\\n \\"DeviceName\\": \\"CC\\",\\n \\"Online\\": true,\\n \\"TmeProductId\\": \\"\\",\\n \\"TmeDeviceId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Obtain authorized Tmall Genie users and device list by TME user ID', 'changeSet' => [], ], 'ReadMessage' => [ 'summary' => 'Set a message to read status.', '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' => 'User information', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. There are multiple ways to obtain the User Identifier in Maojing, and each method corresponds to a different encoding type: PACKAGENAME for the APK package name used in Android client application links, and SKILLID for the skill ID used in cloud-based links.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the Skill ID of the application. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IdType' => [ 'description' => 'Type of User ID: OPENID is the default User ID identity. UNIONID is the organization-dimension User ID identity, which is available only after an organization has been registered on the Maojing Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'title' => '', ], 'Id' => ['description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => '123L', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'MessageId', 'in' => 'query', 'schema' => ['description' => 'Message ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'Message' => ['title' => 'Id of the request', 'description' => 'error message', 'type' => 'string', 'example' => '外部userId映射关系不存在'], 'Code' => ['description' => 'Status code returned by the service. Only "SUCCESS" indicates success; all other values indicate failure.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Result' => ['description' => 'Succeeded in marking as read', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","type":"json"}]', 'title' => 'Mark a Message as Read', 'changeSet' => [], ], 'ScanCodeBind' => [ 'summary' => 'A screen-equipped device completes activation and attachment between the user and the device by scanning a QR code.', 'path' => '/v1.0/ssp/scanCode', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'UserInfo', 'in' => 'formData', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User identity information ', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter PROJECT_ID here. ', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project to which the product belongs. You can view this in the Tmall Genie AI Platform console. ', 'type' => 'string', 'required' => true, 'example' => '129****0946'], 'IdType' => [ 'title' => '', 'description' => 'Device ID type: '."\n" .'OPEN_ID: Default Device ID identifier. '."\n" .'UNION_ID: Organization-dimension Device ID identifier. You must request an organization in advance on the Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'User Identifier. Enter the value of userOpenId or userUnionId. ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID. ', 'type' => 'string', 'required' => false, 'example' => '111'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'BindReq', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for QR code scanning binding', 'type' => 'object', 'properties' => [ 'Code' => ['title' => 'authCode', 'description' => 'authCode', 'type' => 'string', 'required' => true, 'example' => 'ASdfre'], 'ClientId' => ['title' => '', 'description' => 'Product client ID ', 'type' => 'string', 'required' => true, 'example' => 'RnY8v0W0ZVn58ZrUAOr2RD'], 'ExtInfo' => ['title' => '', 'description' => 'Extension parameter', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}'], 'UserId' => ['title' => 'Genie User ID ', 'type' => 'string', 'required' => true, 'example' => '123456', 'description' => ''], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Result message', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'The returned error code. A value of 200 indicates that the invocation succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => [ 'title' => '', 'description' => 'Detailed information returned.', 'type' => 'object', 'properties' => [ 'BizType' => ['title' => '', 'description' => 'Product categorization', 'type' => 'string', 'example' => 'AILABS'], 'BizGroup' => ['title' => '', 'description' => 'Product group', 'type' => 'string', 'example' => 'X1'], 'UserOpenId' => ['title' => 'DAFE****ce3ej=', 'description' => 'DAFE****ce3ej=', 'type' => 'string', 'example' => '用户OpenId'], 'DeviceOpenId' => ['title' => 'A963*0158', 'description' => 'A963*0158', 'type' => 'string', 'example' => '设备OpenId'], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '686DF82F-45C4-7DF7-8B67-27B91CFD63A9'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"BizType\\": \\"AILABS\\",\\n \\"BizGroup\\": \\"X1\\",\\n \\"UserOpenId\\": \\"用户OpenId\\",\\n \\"DeviceOpenId\\": \\"设备OpenId\\"\\n },\\n \\"RequestId\\": \\"686DF82F-45C4-7DF7-8B67-27B91CFD63A9\\"\\n}","type":"json"}]', 'title' => 'Activate and attach by scanning a QR code', 'description' => 'Perform activation and attachment by scanning the QR code related to activation and attachment displayed on the device.', 'changeSet' => [], ], 'ScgSearch' => [ 'summary' => 'Query the content of a selection pool by its ID.', 'path' => '/v1.0/ssp/scgSearch', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'TopicId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Selection pool ID. Optional values: MC201132 (Ethnic Chinese Style), MC201136 (Pop Music), MC201139 (Sweet Love), MC201133 (Folk), MC201137 (Relaxing Reading), MC201138 (Happiness), PA202029 (Stories), PA202030 (Children\'s Songs), PA202028 (Chinese Classics and History), PA202032 (Encyclopedia), PA202031 (English Children\'s Songs)', 'type' => 'string', 'required' => true, 'example' => 'MC201132'], ], [ 'name' => 'ScgFilter', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Query filter', 'type' => 'object', 'properties' => [ 'SortParam' => [ 'title' => '', 'description' => 'Sorting parameters', 'type' => 'object', 'properties' => [ 'SortKey' => ['title' => '', 'description' => 'Sorting field', 'type' => 'string', 'required' => false, 'example' => 'internal_id'], 'SortText' => ['title' => '', 'description' => 'Sorting field (default: empty string)', 'type' => 'string', 'required' => false, 'example' => '“”'], 'SortOrder' => ['title' => '', 'description' => 'Sorting order', 'type' => 'string', 'required' => false, 'example' => 'ASC'], ], 'required' => true, 'example' => '', ], 'UseOffSet' => ['title' => '', 'description' => 'Whether to use the pageParam object for paging. Choose either offSetParam or pageParam. The default paging mode is pageParam.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], 'OffSetParam' => [ 'title' => '', 'description' => 'Paging type', 'type' => 'object', 'properties' => [ 'Offset' => ['title' => '', 'description' => 'Number of skipped items', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Limit' => ['title' => '', 'description' => 'Number of returned items', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], 'required' => false, 'example' => '', ], 'PageParam' => [ 'title' => '', 'description' => 'Paging type', 'type' => 'object', 'properties' => [ 'PageSize' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], 'required' => false, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'PageNum' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => 'OK'], 'PageSize' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Result' => [ 'title' => '', 'description' => 'Detailed returned information.', 'type' => 'array', 'items' => [ 'description' => 'Returned content data', 'type' => 'object', 'properties' => [ 'Source' => ['title' => '', 'description' => 'Content source', 'type' => 'string', 'example' => 'xiami'], 'Title' => ['title' => '', 'description' => 'Content title ', 'type' => 'string', 'example' => '那个人'], 'Type' => ['title' => '', 'description' => 'Content type ', 'type' => 'string', 'example' => 'music'], 'Cover' => [ 'title' => '', 'description' => 'Thumbnail ', 'type' => 'object', 'properties' => [ 'Img' => ['title' => '', 'description' => 'Thumbnail image (Img, Large, Medium, and Small may not appear simultaneously; only one of them may be present) ', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], 'canResize' => ['title' => '', 'description' => 'Whether scaling is supported ', 'type' => 'boolean', 'example' => 'false'], 'Large' => ['title' => '', 'description' => 'Large graph ', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], 'Medium' => ['title' => '', 'description' => 'Medium image', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], 'Small' => ['title' => '', 'description' => 'Small image ', 'type' => 'string', 'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg'], ], 'example' => '', ], 'Alias' => [ 'title' => '', 'description' => 'Alias ', 'type' => 'array', 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '那个人', 'title' => ''], 'example' => '', ], 'SupportAudition' => ['title' => '', 'description' => 'Whether audition is supported ', 'type' => 'boolean', 'example' => 'false'], 'ContentType' => ['title' => '', 'description' => 'Content type ', 'type' => 'string', 'example' => 'MUSIC_CONTENT'], 'Singers' => ['title' => '', 'description' => 'Singer name ', 'type' => 'string', 'example' => '黎偌天'], 'AlbumRawId' => ['title' => '', 'description' => 'Album ID ', 'type' => 'string', 'example' => '1795716629'], 'Album' => ['title' => '', 'description' => 'Whether it is an album ', 'type' => 'boolean', 'example' => 'false'], 'AlbumType' => ['title' => '', 'description' => 'Album type ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'AuthorIds' => [ 'title' => '', 'description' => 'Author ID ', 'type' => 'array', 'items' => ['description' => 'Author ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1795716629', 'title' => ''], 'example' => '', ], 'IsAudition' => ['title' => '', 'description' => 'Whether audition is available', 'type' => 'boolean', 'example' => 'false'], 'AuthorNames' => [ 'title' => '', 'description' => 'Author names ', 'type' => 'array', 'items' => ['description' => 'Author name ', 'type' => 'string', 'example' => '"王一鸣Iris", "黎偌天", "薛晨雨"', 'title' => ''], 'example' => '', ], 'NeedCharge' => ['title' => '', 'description' => 'Whether charging is required ', 'type' => 'boolean', 'example' => 'false'], 'IsCharge' => ['title' => '', 'description' => 'Is charged', 'type' => 'string', 'example' => 'false'], 'Category' => ['title' => '', 'description' => 'Category', 'type' => 'string', 'example' => 'audio'], 'RawId' => ['title' => '', 'description' => 'Third-party content ID ', 'type' => 'string', 'example' => '1795716629'], ], 'title' => '', 'example' => '', ], 'example' => '{"sourceId":0,"copyright":0,"releaseTime":1196438400000,"hotScore":0.9546929544543479,"tppExtendInfo":"{\\"userEvent\\":\\"前台投放\\",\\"scgTopicName\\":\\"inside民族中国风曲风音乐库\\",\\"scgTopicId\\":\\"MC201132\\"}","source":"xiami","title":"题帕三绝","type":"music","x1Pv30d":10307,"valid":10,"cover":{"img":"http://img.xiami.net/qianxun/07d8ec1a38a5462c3afbfac41413b8af/47244c25fcf3a8f67442d02e3127d023-500x432.jpg","canResize":false},"duration":0,"rawId":"1771626071","albumType":0,"alias":["题帕三绝"],"id":268033175,"supportAudition":false,"contentType":"MUSIC_CONTENT","authorIds":[],"singers":"陈力","albumRawId":"1771626071","album":false,"x1PvTotal":14676,"commCateId":80021001,"finished":0,"isAudition":false,"appIds":[],"authorNames":["陈力","王立平","曹雪芹"],"needCharge":false,"isCharge":false,"category":"audio"}', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"xiami\\",\\n \\"Title\\": \\"那个人\\",\\n \\"Type\\": \\"music\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"canResize\\": false,\\n \\"Large\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Medium\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Small\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\"\\n },\\n \\"Alias\\": [\\n \\"那个人\\"\\n ],\\n \\"SupportAudition\\": false,\\n \\"ContentType\\": \\"MUSIC_CONTENT\\",\\n \\"Singers\\": \\"黎偌天\\",\\n \\"AlbumRawId\\": \\"1795716629\\",\\n \\"Album\\": false,\\n \\"AlbumType\\": 0,\\n \\"AuthorIds\\": [\\n 1795716629\\n ],\\n \\"IsAudition\\": false,\\n \\"AuthorNames\\": [\\n \\"\\\\\\"王一鸣Iris\\\\\\", \\\\\\"黎偌天\\\\\\", \\\\\\"薛晨雨\\\\\\"\\"\\n ],\\n \\"NeedCharge\\": false,\\n \\"IsCharge\\": \\"false\\",\\n \\"Category\\": \\"audio\\",\\n \\"RawId\\": \\"1795716629\\"\\n }\\n ],\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200\\n}","type":"json"}]', 'title' => 'Query content in a selection pool by selection pool ID', 'changeSet' => [], ], 'SearchContent' => [ 'summary' => 'Search according to specific search criteria. ', 'path' => '/v1.0/ssp/SearchContent', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Request', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Request Parameters ', 'type' => 'object', 'properties' => [ 'Query' => ['description' => 'Query keyword ', 'type' => 'string', 'required' => false, 'example' => '周杰伦', 'title' => ''], 'Cate' => ['description' => 'The search scope: music or audio. '."\n" .'Input parameter enumeration: music | program ', 'type' => 'string', 'required' => false, 'example' => 'music', 'title' => ''], 'SubCate' => ['description' => 'When `cate` is `music`, `subCate` can be omitted. '."\n" .'If `subCate` is provided, it can be one of the following: '."\n" .'`song` (Song), `singer` (Artist), `album` (Album). '."\n" ."\n" .'When `cate` is `program`, `subCate` can be omitted. '."\n" .'If `subCate` is provided, it can be one of the following: '."\n" .'`album` (Album), `audio` (Program Audio), `radio` (Radio Station).'."\n", 'type' => 'string', 'required' => false, 'example' => 'singer', 'title' => ''], 'QueryAlbum' => ['description' => 'Whether to query albums ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'PageNum' => ['description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of records per page ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User identification information', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'The value corresponding to the encoding type.'."\n" ."\n" .'When the encoding type is SKILL_ID, the value is the Skill ID of the application. '."\n" .'When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the user identifier for Tmall Genie, and each method corresponds to a different encoding type. '."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. '."\n" .'`SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'User identifier, set to either `userOpenId` or `userUnionId`.', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => ''], 'IdType' => ['description' => 'The Type of the User ID.'."\n" ."\n" .'OPEN_ID: The default User ID identity. '."\n" .'UNION_ID: The organization-dimension User ID identity. This value is available only after an organization has been requested on the Tmall Genie Skills Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when `IdType` is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Device identification information', 'type' => 'object', 'properties' => [ 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. '."\n" ."\n" .'When the encoding type is `SKILL_ID`, the value is the application\'s Skill ID. '."\n" .'When the encoding type is `PACKAGE_NAME`, the value is the `packageName` of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45', 'title' => ''], 'EncodeType' => ['description' => 'Encoding type. There are multiple ways to obtain the device ID for Tmall Genie, and each method corresponds to a different encoding type. '."\n" ."\n" .'`PACKAGE_NAME`: APK package name, used for the Android application customer link. '."\n" .'`SKILL_ID`: Skill ID, used for the cloud-based link.', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'title' => ''], 'Id' => ['description' => 'Device ID, set to either `deviceOpenId` or `deviceUnionId`.', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej=', 'title' => ''], 'IdType' => ['description' => 'Type of device ID. '."\n" ."\n" .'`OPEN_ID`: Default device ID identity. '."\n" .'`UNION_ID`: Organization-dimension device ID identity. This value is available only after an organization has been registered on the Tmall Genie Skill Application Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID. Required when `IdType` is `UNION_ID`.', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'], 'Code' => ['description' => 'code encoding ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'message information ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'return information ', 'type' => 'array', 'items' => [ 'description' => 'return information ', 'type' => 'object', 'properties' => [ 'Alias' => [ 'description' => 'Alias ', 'type' => 'array', 'items' => ['description' => 'Alias ', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'title' => '', 'example' => '', ], 'Audition' => ['description' => 'Is audition available ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Authors' => [ 'description' => 'Authors of the content ', 'type' => 'array', 'items' => [ 'description' => 'Author information ', 'type' => 'object', 'properties' => [ 'AuthorTypes' => [ 'description' => 'Author type', 'type' => 'array', 'items' => ['description' => 'Author type', 'type' => 'string', 'example' => 'ANCHOR', 'title' => ''], 'title' => '', 'example' => '', ], 'Cover' => [ 'description' => 'Profile picture ', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used for cropping ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'https://a.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Gender' => ['description' => 'Gender ', 'type' => 'string', 'example' => 'MALE', 'title' => ''], 'RawId' => ['description' => 'Third-party author ID ', 'type' => 'string', 'example' => '123123', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Id' => ['description' => 'Author primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'Title' => ['description' => 'Author title ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Description' => ['description' => 'Author description ', 'type' => 'string', 'example' => '播音呆瓜小贼', 'title' => ''], 'Online' => ['description' => 'Is online', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Category' => ['description' => 'Transform controlType based on the associated public category ', 'type' => 'string', 'example' => 'audio', 'title' => ''], 'Charge' => ['description' => 'Is charged', 'type' => 'boolean', 'example' => 'fasle', 'title' => ''], 'CommCateId' => ['description' => 'The corresponding category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017', 'title' => ''], 'Cover' => [ 'description' => 'Album thumbnail image ', 'type' => 'object', 'properties' => [ 'CanResize' => ['description' => 'Indicates whether OSS rules can be used to crop the image ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Img' => ['description' => 'Default image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Large' => ['description' => 'Large image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Mediam' => ['description' => 'Medium image (Deprecated) ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Medium' => ['description' => 'Medium image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], 'Small' => ['description' => 'Small image ', 'type' => 'string', 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'Content description ', 'type' => 'string', 'example' => '内容描述', 'title' => ''], 'HotScore' => ['description' => 'Popularity score ', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Id' => ['description' => 'Content ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709', 'title' => ''], 'ItemType' => ['description' => 'Type of content, such as music, audio, radio, jokes, etc.', 'type' => 'string', 'example' => 'ALBUM', 'title' => ''], 'Source' => ['description' => 'Source', 'type' => 'string', 'example' => 'qingting', 'title' => ''], 'Title' => ['description' => 'Title', 'type' => 'string', 'example' => '超能狂少在都市', 'title' => ''], 'Type' => ['description' => 'Transform favoriteType based on the associated public category ', 'type' => 'string', 'example' => 'program', 'title' => ''], 'Valid' => ['description' => 'Indicates whether the item is playable ', 'type' => 'string', 'example' => 'VALID', 'title' => ''], 'Duration' => ['description' => 'Duration information', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'title' => ''], 'AlbumId' => ['description' => 'The corresponding album ID ', 'type' => 'string', 'example' => '13123', 'title' => ''], 'Lyric' => ['description' => 'Lyric information ', 'type' => 'string', 'example' => 'http://a1231.lrc', 'title' => ''], 'OrderIndex' => ['description' => 'Content sorting value', 'type' => 'string', 'example' => '1', 'title' => ''], 'Styles' => [ 'description' => 'Music styles ', 'type' => 'array', 'items' => ['description' => 'Music style ', 'type' => 'string', 'example' => '1231', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": true,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"13123\\",\\n \\"Lyric\\": \\"http://a1231.lrc\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Styles\\": [\\n \\"1231\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Search by specific search criteria ', 'changeSet' => [], ], 'SendMessage' => [ 'summary' => 'Send a message.', 'path' => '/v1.0/ssp/sendMessage', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Url', 'in' => 'query', 'schema' => ['description' => 'Message URL', 'type' => 'string', 'required' => false, 'example' => 'http://xx', 'title' => ''], ], [ 'name' => 'UserInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. There are multiple ways to obtain the User Identifier for Maojing, and each method corresponds to a different encoding type: - PACKAGENAME: APK package name, used for Android application customer links - SKILLID: Skill ID, used for cloud-based links', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], 'title' => '', ], 'EncodeKey' => ['description' => 'Value corresponding to the encoding type. When the encoding type is SKILLID, this value is the application\'s Skill ID. When the encoding type is PACKAGENAME, this value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '123L', 'title' => ''], 'IdType' => [ 'description' => 'Type of User ID: - OPENID: default User ID identity - UNIONID: organization-dimension User ID identity, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], 'title' => '', ], 'Id' => ['description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => '123L', 'title' => ''], 'OrganizationId' => ['description' => 'Organization ID; required when IdType is UNION_ID', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => ''], ], 'required' => true, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'Message' => ['title' => 'Id of the request', 'description' => 'Error message; if present, the send operation failed', 'type' => 'string', 'example' => '外部userId映射关系不存在'], 'Code' => ['description' => 'Status code returned by the service; "SUCCESS" indicates success, otherwise it indicates failure', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Result' => ['description' => 'Message sending result', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","type":"json"}]', 'title' => 'Send Message', 'changeSet' => [], ], 'SetDeviceSetting' => [ 'summary' => 'Modify the user settings of a device.', 'path' => '/v1.0/ssp/setDeviceSetting', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Key', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The collection of keys specified for device settings: '."\n" .'Do Not Disturb mode: nightMode', 'type' => 'string', 'required' => true, 'example' => 'nightMode'], ], [ 'name' => 'Value', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Attribute Value', 'type' => 'any', 'required' => false, 'example' => '{"enable":true}'], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of user identifier information.', 'type' => 'object', 'properties' => [ 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. Enter PROJECT_ID here.', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. Enter the Project ID of the project where the product resides. You can view it in the Tmall Genie AI platform console.', 'type' => 'string', 'required' => true, 'example' => '123'], 'IdType' => [ 'title' => '', 'description' => 'The type of Device ID: '."\n" .'OPEN_ID: The default device identity. '."\n" .'UNION_ID: The organization-dimension device identity. You must request an organization in advance on the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['title' => '', 'description' => 'Device ID. Enter the value of deviceOpenId or deviceUnionId.', 'type' => 'string', 'required' => true, 'example' => '123'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Return result of invoking this API.', 'type' => 'string', 'example' => 'success'], 'Code' => ['title' => '', 'description' => 'Error code returned. A value of 200 indicates that the call succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Result' => ['title' => '', 'description' => 'Execution result of the settings.', 'type' => 'boolean', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0EC7*726E'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": false,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Modify the user settings of a device', 'changeSet' => [], ], 'ThirdImmediateMsgPush' => [ 'summary' => 'Third-party real-time information data change event push ', 'path' => '/v1.0/ssp/thirdImmediateMsgPush', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'user ID ', 'title' => 'user ID ', 'type' => 'string', 'example' => 'userId', 'required' => false], ], [ 'name' => 'OrderId', 'in' => 'query', 'schema' => ['description' => 'Order ID', 'title' => 'Order ID', 'type' => 'string', 'example' => 'orderId', 'required' => false], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'Request source', 'title' => 'Request source', 'type' => 'string', 'example' => 'source', 'required' => false], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => ['description' => 'Business type (FLIGHT: flight, TRAIN: train)', 'title' => 'Business type (FLIGHT: flight, TRAIN: train)', 'type' => 'string', 'example' => 'FLIGHT', 'required' => false], ], [ 'name' => 'TrafficChangeType', 'in' => 'query', 'schema' => ['description' => 'change type (TRAIN_ISSUED, FLIGHT_CHANGED) ', 'title' => 'change type (TRAIN_ISSUED, FLIGHT_CHANGED) ', 'type' => 'string', 'example' => 'TRAIN_ISSUED', 'required' => false], ], [ 'name' => 'TrafficChangeTypeDesc', 'in' => 'query', 'schema' => ['description' => 'change type description (ticket issued, rebooked) ', 'title' => 'change type description (ticket issued, rebooked) ', 'type' => 'string', 'example' => '已出票', 'required' => false], ], [ 'name' => 'ChangeDetail', 'in' => 'query', 'schema' => ['description' => 'Change details (JSON-formatted change data)', 'title' => 'Change details (JSON-formatted change data)', 'type' => 'string', 'example' => '{}', 'required' => false], ], [ 'name' => 'TrafficJourneyIds', 'in' => 'query', 'schema' => ['description' => 'Journey IDs to change', 'title' => 'Journey IDs to change', 'type' => 'string', 'example' => 'trafficJourneyIds', 'required' => false], ], [ 'name' => 'TrafficSubOrderIds', 'in' => 'query', 'schema' => ['description' => 'sub-order ID of the changed train request ', 'title' => 'sub-order ID of the changed train request ', 'type' => 'string', 'example' => 'trafficSubOrderIds', 'required' => false], ], [ 'name' => 'PsgIds', 'in' => 'query', 'schema' => ['description' => 'Passenger IDs to change', 'title' => 'Passenger IDs to change', 'type' => 'string', 'example' => 'psgIds', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'title' => '', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'whether the invocation succeeded ', 'title' => 'whether the invocation succeeded ', 'type' => 'boolean', 'example' => ''], 'ErrorCode' => ['description' => 'error code ', 'title' => 'error code ', 'type' => 'string', 'example' => '500000000'], 'ErrorMsg' => ['description' => 'error message ', 'title' => 'error message ', 'type' => 'string', 'example' => '服务器内部异常'], 'Model' => [ 'description' => 'push result ', 'title' => 'push result ', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'request ID ', 'title' => 'request ID ', 'type' => 'string', 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B'], 'Success' => ['description' => 'whether the push succeeded ', 'title' => 'whether the push succeeded ', 'type' => 'boolean', 'example' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Third-party real-time information data change event push ', 'changeSet' => [ ['createdAt' => '2025-09-01T09:51:37.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-09-01T02:40:36.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-09-01T02:40:31.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-09-01T02:36:01.000Z', 'description' => 'OpenAPI offline'], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": false,\\n \\"ErrorCode\\": \\"500000000\\",\\n \\"ErrorMsg\\": \\"服务器内部异常\\",\\n \\"Model\\": {\\n \\"RequestId\\": \\"2DF6FEFE-3301-16DD-ABCC-968A9524920B\\",\\n \\"Success\\": false\\n }\\n}","type":"json"}]', ], 'UnbindAligenieUser' => [ 'summary' => 'Detach the relationship between a third-party account and a Tmall Genie account by using a logon credential.'."\n", 'path' => '/v1.0/ssp/unbindAligenieUser', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/x-www-form-urlencoded'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'LoginStateAccessToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Logon credential', 'type' => 'string', 'required' => true, 'example' => '99ce8a70c23a94f8569e1a525bef6e85'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'], 'Code' => ['title' => '', 'description' => 'Response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Response message', 'type' => 'string', 'example' => 'OK'], 'Success' => ['title' => '', 'description' => 'Flag indicating whether the invocation succeeded', 'type' => 'boolean', 'example' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'Detach the relationship between a third-party account and a Tmall Genie account', 'description' => 'Note: When the logon credential expires, the integrator must initiate the authorization logon flow again to obtain a new logon credential (entry service API: AuthLoginWithThirdUserInfo).'."\n" ."\n" .'- Invoke the service API with the logon credential (LoginStateAccessToken) parameter via the Java software development kit (SDK). For SDKs in other languages, consult Tmall Genie developers during integration. '."\n" .'If the API call throws a TeaException and TeaException.code is "InvalidAuthentication", the logon credential has expired.'."\n" ."\n" .'- Invoke the service API by sending an HTTP request with the logon credential (LoginStateAccessToken) parameter. '."\n" .'If the HTTP response status code returned by the API call is 400, the logon credential has expired.'."\n", 'changeSet' => [], ], 'UnbindDevice' => [ 'summary' => 'Detach the binding relationship based on the user\'s open information and the device\'s open information. ', 'path' => '/v1.0/ssp/unbindDevice', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of device identity information. ', 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. Set this parameter to **PROJECT_ID**. ', 'example' => 'PROJECT_ID', 'required' => true, 'title' => '', 'type' => 'string', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type, which is the Project ID of the project where the product resides. You can view it in the Tmall Genie AI platform console. ', 'example' => '12**45', 'required' => true, 'title' => '', 'type' => 'string'], 'IdType' => [ 'description' => 'The type of Device ID. '."\n" .'- OPEN_ID: The default device ID identity. '."\n" .'- UNION_ID: The organization-dimension device ID identity. You must request an organization in advance on the Open Platform. '."\n", 'example' => 'OPEN_ID', 'required' => true, 'title' => '', 'type' => 'string', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['description' => 'Device identifier. Enter the value of deviceOpenId or deviceUnionId. ', 'example' => 'DAFE****ce3ej=', 'required' => true, 'title' => '', 'type' => 'string'], 'OrganizationId' => ['description' => 'Organization ID. This parameter is required if IdType is set to UNION_ID. ', 'example' => '1**2', 'required' => false, 'title' => '', 'type' => 'string'], ], 'required' => true, 'title' => '', 'type' => 'object', 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of user identifier information. '."\n", 'properties' => [ 'EncodeType' => [ 'description' => 'Encoding type. Enter **PROJECT_ID** here. '."\n", 'example' => 'PROJECT_ID', 'required' => true, 'title' => '', 'type' => 'string', 'enum' => ['PROJECT_ID'], ], 'EncodeKey' => ['description' => 'The value corresponding to the encoding type, which is the Project ID of the project where this product resides. You can view it in the Tmall Genie AI Platform console. '."\n", 'example' => '12**45', 'required' => true, 'title' => '', 'type' => 'string'], 'IdType' => [ 'description' => 'The type of User ID: '."\n" .'- OPEN_ID: The default user ID identity. '."\n" .'- UNION_ID: The organization-dimension user ID identity. You must request an organization in advance on the Open Platform. '."\n", 'example' => 'OPEN_ID', 'required' => true, 'title' => '', 'type' => 'string', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'Id' => ['description' => 'User identifier. Enter the value of userOpenId or userUnionId. '."\n", 'example' => 'HOFF****my7Iw=', 'required' => true, 'title' => '', 'type' => 'string'], 'OrganizationId' => ['description' => 'Organization ID. Required if IdType is UNION_ID. '."\n", 'example' => '1**2', 'required' => false, 'title' => '', 'type' => 'string'], ], 'required' => true, 'title' => '', 'type' => 'object', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Returns a data list. ', 'properties' => [ 'Message' => ['description' => 'The return result of invoking this API. ', 'example' => 'success', 'title' => '', 'type' => 'string'], 'Code' => ['description' => 'The error code returned. A value of 200 indicates that the call succeeded. ', 'example' => '200', 'format' => 'int32', 'title' => '', 'type' => 'integer'], 'Result' => ['description' => 'Indicates whether the device was detached successfully. ', 'example' => 'true', 'title' => '', 'type' => 'boolean'], 'RequestId' => ['description' => 'The request ID. ', 'example' => '0EC7*726E', 'title' => '', 'type' => 'string'], ], 'title' => '', 'type' => 'object', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'AliGenie.UnbindDevice.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], ], 500 => [ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]', 'title' => 'Detach Device ', 'changeSet' => [], ], 'UpdateAlarm' => [ 'summary' => 'Update an alarm, including its trigger time, loop type, and music. ', 'path' => '/v1.0/ssp/updateAlarm', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AliGenie_Auth_SPI' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Payload', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Input parameters for the service request', 'type' => 'object', 'properties' => [ 'ScheduleInfo' => [ 'title' => '', 'description' => 'Schedule information ', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '', 'description' => 'Schedule Type / Loop Type: '."\n" .'ONCE -> One-time, WEEKLY -> Weekly loop, STATUTORY_WORKING_DAY -> Statutory working day ', 'type' => 'string', 'required' => true, 'example' => 'WEEKLY', 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'], ], 'Once' => [ 'title' => '', 'description' => 'One-time: This property is active when the loop type is ONCE. ', 'type' => 'object', 'properties' => [ 'Year' => ['title' => '', 'description' => 'Trigger time: Year ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'], 'Month' => ['title' => '', 'description' => 'Trigger time: Month ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'], 'Day' => ['title' => '', 'description' => 'Trigger time: day', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], 'Hour' => ['title' => '', 'description' => 'Trigger time: hour', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], 'required' => false, 'example' => '', ], 'Weekly' => [ 'title' => '', 'description' => 'Weekly loop: This property is active when the loop Type is WEEKLY.', 'type' => 'object', 'properties' => [ 'DaysOfWeek' => [ 'title' => '', 'description' => 'Collection of days of the week to trigger: Numeric values between 1 and 7, where each number corresponds to a specific day of the week (1 for Monday, 2 for Tuesday, etc.). To trigger every day, include all values from 1 to 7.', 'type' => 'array', 'items' => ['description' => 'Monday', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'required' => false, 'example' => '', ], 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger time: minute', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], 'required' => false, 'example' => '', ], 'StatutoryWorkingDay' => [ 'title' => '', 'description' => 'Statutory Working Day: This property is active when the loop Type is STATUTORY_WORKING_DAY. ', 'type' => 'object', 'properties' => [ 'Hour' => ['title' => '', 'description' => 'Trigger Time: Hour ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], 'Minute' => ['title' => '', 'description' => 'Trigger Time: Minute ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], 'required' => false, 'example' => '', ], ], 'required' => true, 'example' => '', ], 'MusicInfo' => [ 'title' => '', 'description' => 'Ringtone information', 'type' => 'object', 'properties' => [ 'MusicType' => ['title' => '', 'description' => 'Ringtone category ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12'], 'MusicTypeName' => ['title' => '', 'description' => 'Ringtone category name', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'], 'MusicId' => ['title' => '', 'description' => 'Ringtone ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], 'MusicName' => ['title' => '', 'description' => 'Ringtone name', 'type' => 'string', 'required' => true, 'example' => 'xx铃声'], 'MusicUrl' => ['title' => '', 'description' => 'Ringtone URL ', 'type' => 'string', 'required' => false, 'example' => 'http://music-url.mp3'], ], 'required' => true, 'example' => '', ], 'AlarmId' => ['title' => '', 'description' => 'Alarm ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'], 'Volume' => ['title' => '', 'description' => 'Ringtone volume', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'default' => '40'], 'RequestId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'UserId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'AccessKeyId' => ['title' => 'Caller', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'DeviceId' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'UserInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'User Identifier Information ', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'User Identifier (userOpenId or userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='], 'IdType' => [ 'title' => '', 'description' => 'Type of the User ID: - OPEN_ID: default User ID identifier - UNION_ID: organization-dimension User ID identifier, available only after an organization has been requested on the Maojing Skill Application Open Platform', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding Type: There are multiple ways to obtain the User Identifier for Maojing, and each method corresponds to a different encoding Type: '."\n" .'- PACKAGE_NAME: APK package name, used for the Android application Customer link '."\n" .'- SKILL_ID: Skill ID, used for the cloud link ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'Value corresponding to the encoding type. If the encoding type is SKILL_ID, the value is the application\'s Skill ID. If the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'Organization ID. Required if IdType is UNION_ID.', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'device identity information ', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'device ID (deviceOpenId or deviceUnionId) ', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='], 'IdType' => [ 'title' => '', 'description' => 'Type of device ID: OPEN_ID: default device ID; UNION_ID: organization-dimension device ID, available only after an organization has been requested on the Maojing Skill Application Open Platform. ', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'enum' => ['OPEN_ID', 'UNION_ID'], ], 'EncodeType' => [ 'title' => '', 'description' => 'Encoding type. There are multiple ways to obtain the device ID for Maojing, and each method corresponds to a different encoding type: PACKAGE_NAME: APK package name, used in the Android application customer link; SKILL_ID: skill ID, used in the cloud link. ', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME', 'enum' => ['PACKAGE_NAME', 'SKILL_ID'], ], 'EncodeKey' => ['title' => '', 'description' => 'The value corresponding to the encoding type. When the encoding type is SKILL_ID, the value is the Skill ID of the application. When the encoding type is PACKAGE_NAME, the value is the packageName of the corresponding client app.', 'type' => 'string', 'required' => true, 'example' => '12**45'], 'OrganizationId' => ['title' => '', 'description' => 'organization ID; required if IdType is UNION_ID ', 'type' => 'string', 'required' => false, 'example' => '1**2'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AmpResult', 'description' => 'AmpResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code returned by the alarm service ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => 'xx为空'], 'Result' => ['description' => 'Indicates whether the update succeeded ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'request ID ', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","type":"json"}]', 'title' => 'Update Alarm ', 'responseParamsDescription' => 'The operation is successful only if the status code returned by the service is 200; otherwise, it indicates failure. ', 'changeSet' => [], ], ], 'endpoints' => [], 'errorCodes' => [ ['code' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.GetPhoneNumber.BizError', 'message' => 'The user has no phoneNumber.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', 'message' => 'The user information does not exist.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Notifications.Application.Invalid', 'message' => 'The AliGenie app info is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Notifications.Application.Status', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Notifications.Application.Url', 'message' => 'The AliGenie app awaken url is missing.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'The device not bind user.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'Failed to identify device.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'message' => 'Failed to identify user.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Public.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => ''], ['code' => 'AliGenie.Public.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.PushNotifications.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template information is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template is unavailable.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template does not exist.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'message' => 'The template placeholder information is missing.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'message' => 'Failed to identify message target.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.Reminder.CreateFail', 'message' => 'The creation request is not allowed.', 'http_code' => 403, 'description' => ''], ['code' => 'AliGenie.Reminder.DeviceError', 'message' => 'The device is offline.', 'http_code' => 504, 'description' => ''], ['code' => 'AliGenie.Reminder.HasNoAuthority', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 505, 'description' => ''], ['code' => 'AliGenie.Reminder.StopService', 'message' => 'The servic has stopped.', 'http_code' => 503, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.Device.Offline', 'message' => 'The target device is not online.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Body', 'message' => 'You must specify request body.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', 'message' => 'You must specify EncodeKey.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'You must specify EncodeType.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'The specified EncodeType is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'You must specify GenieAppId.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app does not exist.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The GenieApp information is inmcomplete.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not configured wake up link.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The application is not installed.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', 'message' => 'You must specify OrganizationId.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'You must specify Path.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'The wake up path is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', 'message' => 'You must specify TargetIdentity.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'You must specify TargetInfo.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'The specified TargetInfo is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'You must specify TargetType.', 'http_code' => 400, 'description' => ''], ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'The specified TargetType is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid', 'http_code' => 400, 'description' => ''], ['code' => 'ServerError', 'message' => 'internal server error', 'http_code' => 500, 'description' => ''], ['code' => 'SystemError', 'message' => 'System Error occured.', 'http_code' => 400, 'description' => '.'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ThirdImmediateMsgPush'], ], 'createdAt' => '2025-09-01T09:51:37.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ThirdImmediateMsgPush'], ['description' => 'OpenAPI offline', 'api' => 'ThirdImmediateMsgPush'], ], 'createdAt' => '2025-09-01T02:40:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ThirdImmediateMsgPush'], ], 'createdAt' => '2025-09-01T02:36:01.000Z', 'description' => '', ], ], ];