'1.0',
'info' => [
'style' => 'AliGenie',
'product' => 'AliGenie',
'version' => 'ssp_1.0',
],
'directories' => [
[
'id' => 171020,
'title' => null,
'type' => 'directory',
'children' => [
'AuthLoginWithThirdUserInfo',
'EcologyOpennessSendVerificationCode',
'FindUserlistToAuthLoginWithPhoneNumber',
'AuthLoginWithAligenieUserInfo',
'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber',
'AuthLoginWithTaobaoUserInfo',
'EcologyOpennessAuthenticate',
'GetAligenieUserInfo',
'UnbindAligenieUser',
'QueryUserDeviceListByTmeUserId',
'InvalidateThirdPartyAppLoginState',
],
],
[
'id' => 170170,
'title' => null,
'type' => 'directory',
'children' => [
'CheckAuthCodeBindForExt',
'GetCodeEnhance',
'ScanCodeBind',
],
],
[
'id' => 96289,
'title' => null,
'type' => 'directory',
'children' => [
'GetUserByDeviceId',
'ListDeviceByUserId',
'UnbindDevice',
'ListDeviceByUserIdAndChanel',
],
],
[
'id' => 96293,
'title' => null,
'type' => 'directory',
'children' => [
'GetDeviceIdByIdentity',
'ListDeviceIdByIdentities',
'GetDeviceBasicInfo',
'ListDeviceBasicInfo',
'GetDeviceStatusInfo',
'GetDeviceTag',
'DeviceControl',
'GetDeviceSetting',
'GetDeviceStatusDetail',
'SetDeviceSetting',
],
],
[
'id' => 170173,
'title' => null,
'type' => 'directory',
'children' => [
[
'id' => 199234,
'title' => null,
'type' => 'directory',
'children' => [
'GetJiangSuTelecomData',
],
],
[
'id' => 170178,
'title' => null,
'type' => 'directory',
'children' => [
'ScgSearch',
'AddAndRemoveFavoriteContent',
'CreatePlayingList',
'GetAlbum',
'GetContent',
'GetCurrentPlayingItem',
'GetCurrentPlayingList',
'IndexControlPlayingList',
'ListAlbumDetail',
'ListCateContent',
'ListCateInfo',
'ListCommonCateFirstFloor',
'ListCommonCateSecondFloor',
'ListPlayHistory',
'ListRecommendContent',
'PlayAndPauseControl',
'PlayModeControl',
'PreviousAndNextControl',
'ProgressControl',
'SearchContent',
'CloudPlayer',
'MobileRecommend',
],
],
[
'id' => 170194,
'title' => null,
'type' => 'directory',
'children' => [
'AddSub',
'DeleteSub',
'ListAlbumIsAdded',
'ListSub',
'ListSubAlbum',
'ListSubscriptionAlbumCategory',
'GetAlbumDetailById',
],
],
[
'id' => 170201,
'title' => null,
'type' => 'directory',
'children' => [
'GetUnreadMessageCount',
'ListUserMessage',
'ReadMessage',
'SendMessage',
],
],
[
'id' => 170204,
'title' => null,
'type' => 'directory',
'children' => [
'CreateAlarm',
'DeleteAlarms',
'GetAlarm',
'ListAlarms',
'ListMusic',
'QueryMusicType',
'UpdateAlarm',
],
],
[
'id' => 170174,
'title' => null,
'type' => 'directory',
'children' => [
'CreateScheduleTask',
'DeleteScheduleTask',
'GetScheduleTask',
],
],
[
'id' => 171175,
'title' => null,
'type' => 'directory',
'children' => [
'GetWeather',
],
],
],
],
[
'id' => 263709,
'title' => null,
'type' => 'directory',
'children' => [
'CreatePlayingListOAuth2',
'ThirdImmediateMsgPush',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AuthLoginWithThirdUserInfo' => [
'summary' => '通过三方用户信息进行授权登录',
'path' => '/v1.0/ssp/authLoginWithThirdUserInfo',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SceneCode',
'in' => 'formData',
'schema' => [
'title' => '场景码,需提前向天猫精灵申请',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'wechat_ecology_openness',
],
],
[
'name' => 'ThirdUserType',
'in' => 'formData',
'schema' => [
'title' => '三方用户类型,场景接入申请完成后进行分配',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'weChatUser',
],
],
[
'name' => 'ThirdUserIdentifier',
'in' => 'formData',
'schema' => [
'title' => '三方用户唯一标识',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'o5qxy6EItZBasv2VZAf-MGwllHL4',
],
],
[
'name' => 'ExtInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '扩展信息',
'description' => '',
'type' => 'object',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
'default' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'LoginStateAccessToken' => [
'title' => '登录态访问令牌',
'description' => '',
'type' => 'string',
'example' => 'bd9ccdb121ee950ddead51e943e081fe',
],
'ExpiredTimeLong' => [
'title' => '登录态访问令牌过期时间',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1659428051452',
'default' => '1659333475811',
],
],
],
'DataObj' => [
'title' => '当Code为5140001时,代表登录失败,原因是三方用户未绑定到天猫精灵用户,前端需要根据此错误码走用户手机号授权登录流程,后续流程前端需要将DataObj中SessionId带回服务端。',
'description' => '',
'type' => 'object',
'properties' => [
'SessionId' => [
'title' => '会话id',
'description' => '',
'type' => 'string',
'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"bd9ccdb121ee950ddead51e943e081fe\\",\\n \\"ExpiredTimeLong\\": 1659428051452\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 73C67BD9-175A-1324-8202-9FAABBB3E6FA\\n 200\\n OK\\n true\\n \\n f6221a258d8cfcb7c82fbf9fff9a164b\\n 1659428051452\\n \\n \\n dbe2eb4458302b9246c6da17fbc95f4b\\n \\n","errorExample":""}]',
],
'EcologyOpennessSendVerificationCode' => [
'summary' => '生态开放发送短信验证码',
'path' => '/v1.0/ssp/ecologyOpennessSendVerificationCode',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SessionId',
'in' => 'formData',
'schema' => [
'title' => '会话id',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
[
'name' => 'PhoneNumber',
'in' => 'formData',
'schema' => [
'title' => '手机号码',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '18612345678',
],
],
[
'name' => 'Region',
'in' => 'formData',
'schema' => [
'title' => '地区编码',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '+86',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'ExpireIn' => [
'title' => '有效期(单位:秒)',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '900',
],
'RepeatInterval' => [
'title' => '下次可重新发送的时间间隔(单位:秒)',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"ExpireIn\\": 900,\\n \\"RepeatInterval\\": 60\\n }\\n}","type":"json"}]',
],
'FindUserlistToAuthLoginWithPhoneNumber' => [
'summary' => '通过手机号寻找可授权登录的账号列表',
'path' => '/v1.0/ssp/findUserlistToAuthLoginWithPhoneNumber',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SessionId',
'in' => 'query',
'schema' => [
'title' => '会话id',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'title' => '地区编码',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '+86',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'title' => '手机号码',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '18612345678',
],
],
[
'name' => 'Code',
'in' => 'query',
'schema' => [
'title' => '短信验证码',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'UserListToAuthLogin' => [
'title' => '可授权登录的账号列表',
'description' => '',
'type' => 'array',
'items' => [
'title' => '可授权登录的账号',
'description' => '',
'type' => 'object',
'properties' => [
'UserType' => [
'title' => '用户类型'."\n"
.'TAOBAO:淘宝用户'."\n"
.'ALIGENIE:天猫精灵用户',
'description' => '',
'type' => 'string',
'example' => 'ALIGENIE',
],
'EncryptedUserIdentifier' => [
'title' => '加密过的用户标识',
'description' => '',
'type' => 'string',
'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh',
],
'Nickname' => [
'title' => '用户昵称',
'description' => '',
'type' => 'string',
'example' => 'XXX',
],
'Avatar' => [
'title' => '用户头像',
'description' => '',
'type' => 'string',
'example' => 'https://xxx',
],
'FindingType' => [
'title' => '用户发现类型'."\n"
."\n"
.'淘宝用户固定为:PHONE_NUMBER_BINDING_WITH_TAOBAO:phoneNumber作为淘宝绑定手机号查询到的;'."\n"
."\n"
.'天猫精灵用户为:'."\n"
.'PHONE_NUMBER_BINDING_WITH_ALIGENIE:phoneNumber作为精灵绑定手机号查询到的;'."\n"
.'PHONE_NUMBER_BINDING_WITH_TAOBAO:phoneNumber作为淘宝绑定手机号查询到的;',
'description' => '',
'type' => 'string',
'example' => 'PHONE_NUMBER_BINDING_WITH_ALIGENIE:phoneNumber',
],
],
],
],
],
],
'DataObj' => [
'title' => 'Code为5140003时代表调用失败,原因是该手机号未找到可授权登录的账号列表,前端可以让用户确认通过手机号生成精灵账号,也可提示用户先基于手机号注册淘宝账号,后续流程前端需要将DataObj中sessionId带回服务端。',
'description' => '',
'type' => 'object',
'properties' => [
'SessionId' => [
'title' => '会话id',
'description' => '',
'type' => 'string',
'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserListToAuthLogin\\": [\\n {\\n \\"UserType\\": \\"ALIGENIE\\",\\n \\"EncryptedUserIdentifier\\": \\"KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh\\",\\n \\"Nickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"https://xxx\\",\\n \\"FindingType\\": \\"PHONE_NUMBER_BINDING_WITH_ALIGENIE:phoneNumber\\"\\n }\\n ]\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","type":"json"}]',
],
'AuthLoginWithAligenieUserInfo' => [
'summary' => '通过指定精灵账号进行授权登录',
'path' => '/v1.0/ssp/authLoginWithAligenieUserInfo',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SessionId',
'in' => 'formData',
'schema' => [
'title' => '会话id',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
[
'name' => 'EncryptedAligenieUserIdentifier',
'in' => 'formData',
'schema' => [
'title' => '加密过的精灵用户标识',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'UYugfm/3Nb9q24AyES2rYmC5tIglSoDX3Mbna/vrldcjGPtC8VzFwo+CU5c4CHLjrK7ekskG2WVaevM5Zi9f0w==',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
'default' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'LoginStateAccessToken' => [
'title' => '登录态访问令牌',
'description' => '',
'type' => 'string',
'example' => 'd15aa92de679d0d225aa845268be19ee',
],
'ExpiredTimeLong' => [
'title' => '登录态访问令牌过期时间(长整型)',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1659506854230',
'default' => '1659506854230',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]',
],
'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber' => [
'summary' => '通过手机号生成精灵账号进行授权登录',
'path' => '/v1.0/ssp/authLoginWithAligenieUserInfoGeneratedByPhoneNumber',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SessionId',
'in' => 'formData',
'schema' => [
'title' => '会话id',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
'default' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'LoginStateAccessToken' => [
'title' => '登录态访问令牌',
'description' => '',
'type' => 'string',
'example' => 'd15aa92de679d0d225aa845268be19ee',
],
'ExpiredTimeLong' => [
'title' => '登录态访问令牌过期时间(长整型)',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1659506854230',
'default' => '1659506854230',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]',
],
'AuthLoginWithTaobaoUserInfo' => [
'summary' => '通过指定淘宝账号进行授权登录',
'path' => '/v1.0/ssp/authLoginWithTaobaoUserInfo',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SessionId',
'in' => 'formData',
'schema' => [
'title' => '会话id',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
[
'name' => 'EncryptedTaobaoUserIdentifier',
'in' => 'formData',
'schema' => [
'title' => '加密过的淘宝用户标识',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'LoginStateAccessToken' => [
'title' => '登录态访问令牌',
'description' => '',
'type' => 'string',
'example' => 'd15aa92de679d0d225aa845268be19ee',
],
'ExpiredTimeLong' => [
'title' => '登录态访问令牌过期时间(长整型)',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1659506854230',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]',
],
'EcologyOpennessAuthenticate' => [
'summary' => '生态开放鉴权',
'path' => '/v1.0/ssp/ecologyOpennessAuthenticate',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'LoginStateAccessToken',
'in' => 'formData',
'schema' => [
'title' => '登录态访问令牌',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'd15aa*****ee',
],
],
[
'name' => 'EncodeType',
'in' => 'formData',
'schema' => [
'title' => '实体类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
],
[
'name' => 'EncodeKey',
'in' => 'formData',
'schema' => [
'title' => '实体key',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73****9-175A-1324-8202-9FAAB*****A',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
'default' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'UserOpenId' => [
'title' => '精灵用户openId',
'description' => '',
'type' => 'string',
'example' => 'o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==',
],
'EncodeType' => [
'title' => '实体类型',
'description' => '',
'type' => 'string',
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '实体key',
'description' => '',
'type' => 'string',
'example' => '12****7',
],
'SceneCode' => [
'title' => '场景码',
'description' => '',
'type' => 'string',
'example' => '******',
],
'ThirdUserType' => [
'title' => '三方用户类型',
'description' => '',
'type' => 'string',
'example' => '******',
],
'ThirdUserIdentifier' => [
'title' => '三方用户标识',
'description' => '',
'type' => 'string',
'example' => '******',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"SceneCode\\": \\"******\\",\\n \\"ThirdUserType\\": \\"******\\",\\n \\"ThirdUserIdentifier\\": \\"******\\"\\n }\\n}","type":"json"}]',
],
'GetAligenieUserInfo' => [
'summary' => '获取三方绑定的精灵账号信息',
'path' => '/v1.0/ssp/getAligenieUserInfo',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'LoginStateAccessToken',
'in' => 'query',
'schema' => [
'title' => '登录态访问凭证',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '99ce8a70c23a94f8569e1a525bef6e85',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
],
'Result' => [
'type' => 'object',
'properties' => [
'AligenieNickname' => [
'title' => '精灵用户昵称',
'description' => '',
'type' => 'string',
'example' => 'XXX',
],
'Avatar' => [
'title' => '精灵用户头像地址',
'description' => '',
'type' => 'string',
'example' => 'http://img.alicdn.com/xxx.jpg',
],
'Deletable' => [
'title' => '是否可注销',
'description' => '',
'type' => 'boolean',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"AligenieNickname\\": \\"XXX\\",\\n \\"Avatar\\": \\"http://img.alicdn.com/xxx.jpg\\",\\n \\"Deletable\\": true\\n }\\n}","type":"json"}]',
],
'UnbindAligenieUser' => [
'summary' => '解除三方和精灵账号的关系',
'path' => '/v1.0/ssp/unbindAligenieUser',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'LoginStateAccessToken',
'in' => 'formData',
'schema' => [
'title' => '登录态访问凭证',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '99ce8a70c23a94f8569e1a525bef6e85',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'QueryUserDeviceListByTmeUserId' => [
'summary' => '通过tme用户id获取授权的天猫精灵用户+设备列表',
'path' => '/v1.0/ssp/queryUserDeviceListByTmeUserId',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
],
'parameters' => [
[
'name' => 'TmeUserId',
'in' => 'query',
'schema' => [
'title' => 'TME用户id',
'description' => '',
'type' => 'string',
'required' => true,
],
],
[
'name' => 'Sp',
'in' => 'query',
'schema' => [
'title' => '"KG":酷狗'."\n"
.'"KW":酷我'."\n"
.'"QM":Q音',
'description' => '',
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
],
'Result' => [
'title' => '响应结果',
'description' => '',
'type' => 'object',
'properties' => [
'Sp' => [
'title' => '"KG":酷狗'."\n"
.'"KW":酷我'."\n"
.'"QM":Q音',
'description' => '',
'type' => 'string',
],
'EncodeType' => [
'title' => '实体类型(三方透传即可)',
'description' => '',
'type' => 'string',
],
'EncodeKey' => [
'title' => '实体key(三方透传即可)',
'description' => '',
'type' => 'string',
],
'AligenieUserInfoList' => [
'title' => '天猫精灵用户列表',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OpenUserId' => [
'title' => '用户id',
'description' => '',
'type' => 'string',
],
'UserNickname' => [
'title' => '用户昵称',
'description' => '',
'type' => 'string',
],
'AuthorizedDeviceList' => [
'title' => '用户授权的设备列表',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OpenDeviceId' => [
'title' => '按照天猫精灵开放平台标准加密的设备id',
'description' => '',
'type' => 'string',
],
'DeviceName' => [
'title' => '设备名称',
'description' => '',
'type' => 'string',
],
'Online' => [
'title' => '设备是否在线',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'TmeProductId' => [
'title' => 'TME产品id',
'type' => 'string',
],
'TmeDeviceId' => [
'title' => '透出给TME的设备id',
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Sp\\": \\"KG\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"AligenieUserInfoList\\": [\\n {\\n \\"OpenUserId\\": \\"R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==\\",\\n \\"UserNickname\\": \\"a***e\\",\\n \\"AuthorizedDeviceList\\": [\\n {\\n \\"OpenDeviceId\\": \\"fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=\\",\\n \\"DeviceName\\": \\"CC\\",\\n \\"Online\\": true,\\n \\"TmeProductId\\": \\"\\",\\n \\"TmeDeviceId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'InvalidateThirdPartyAppLoginState' => [
'summary' => '失效三方应用登录态',
'path' => '/v1.0/ssp/invalidateThirdPartyAppLoginState',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'com.*.*.*',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'ThirdPartyAppId',
'in' => 'formData',
'schema' => [
'title' => '三方应用标识',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'com.*.*.*',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B',
],
'Code' => [
'title' => '响应码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Success' => [
'title' => '调用是否成功标志',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CheckAuthCodeBindForExt' => [
'summary' => '轮询激活绑定结果',
'path' => '/v1.0/ssp/checkAuthCodeBindForExt',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'EncodeType',
'in' => 'query',
'schema' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
],
[
'name' => 'EncodeKey',
'in' => 'query',
'schema' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
[
'name' => 'AuthCode',
'in' => 'query',
'schema' => [
'title' => '指定用户和渠道获取的authCode',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Aexfgc',
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户标识信息列表。',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'title' => '用户Id的类型:'."\n"
.'OPEN_ID:默认的用户ID标识。'."\n"
.'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '用户标识,填写userOpenId或userUnionId的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1***2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '调用该接口的返回结果。',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '详细信息',
'description' => '',
'type' => 'object',
'properties' => [
'UserOpenInfo' => [
'title' => '用户开放信息',
'description' => '',
'type' => 'object',
'properties' => [
'IdType' => [
'title' => 'USER_ID',
'description' => 'USER_ID',
'type' => 'string',
'example' => 'USER_ID',
],
'Id' => [
'title' => '对外的用户id',
'description' => '',
'type' => 'string',
'example' => '0963*0158',
],
],
],
'DeviceOpenInfo' => [
'title' => '设备开放信息',
'description' => '',
'type' => 'object',
'properties' => [
'IdType' => [
'title' => 'DEVICE_ID',
'description' => 'DEVICE_ID',
'type' => 'string',
'example' => 'DEVICE_ID',
],
'Id' => [
'title' => '对外的设备id',
'description' => '',
'type' => 'string',
'example' => 'A963*0158',
],
],
],
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenInfo\\": {\\n \\"IdType\\": \\"USER_ID\\",\\n \\"Id\\": \\"0963*0158\\"\\n },\\n \\"DeviceOpenInfo\\": {\\n \\"IdType\\": \\"DEVICE_ID\\",\\n \\"Id\\": \\"A963*0158\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
],
'GetCodeEnhance' => [
'summary' => '获取authCode',
'path' => '/v1.0/ssp/getCodeEnhance',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ChannelInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '激活渠道,如微信小程序,三方app等',
'description' => '',
'type' => 'object',
'properties' => [
'Channel' => [
'title' => '激活渠道,如WeChat',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'WeChat、ThirdApp',
],
'ExtInfo' => [
'title' => '扩展信息',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户标识信息列表。',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'title' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '用户标识,填写userOpenId或userUnionId的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '调用该接口的返回结果。',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回的详细信息。',
'description' => '',
'type' => 'string',
'example' => 'Aexfgc',
],
'RequestId' => [
'title' => '请求ID。',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": \\"Aexfgc\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
],
'ScanCodeBind' => [
'summary' => '扫描二维码激活绑定设备',
'path' => '/v1.0/ssp/scanCode',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'formData',
'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '129****0946',
],
'IdType' => [
'title' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '用户标识,填写userOpenId或userUnionId的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '111',
],
],
'required' => true,
],
],
[
'name' => 'BindReq',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '扫描绑定入参',
'description' => '',
'type' => 'object',
'properties' => [
'Code' => [
'title' => 'authCode',
'description' => 'authCode',
'type' => 'string',
'required' => true,
'example' => 'ASdfre',
],
'ClientId' => [
'title' => '产品clientId',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'RnY8v0W0ZVn58ZrUAOr2RD',
],
'ExtInfo' => [
'title' => '扩展参数',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"key":"value"}',
],
'UserId' => [
'title' => '精灵用户id',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '结果信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回的详细信息。',
'description' => '',
'type' => 'object',
'properties' => [
'BizType' => [
'title' => '产品分类',
'description' => '',
'type' => 'string',
'example' => 'AILABS',
],
'BizGroup' => [
'title' => '产品分组',
'description' => '',
'type' => 'string',
'example' => 'X1',
],
'UserOpenId' => [
'title' => 'DAFE****ce3ej=',
'description' => 'DAFE****ce3ej=',
'type' => 'string',
'example' => '用户opneId',
],
'DeviceOpenId' => [
'title' => 'A963*0158',
'description' => 'A963*0158',
'type' => 'string',
'example' => '设备OpenId',
],
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '686DF82F-45C4-7DF7-8B67-27B91CFD63A9',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"BizType\\": \\"AILABS\\",\\n \\"BizGroup\\": \\"X1\\",\\n \\"UserOpenId\\": \\"用户OpenId\\",\\n \\"DeviceOpenId\\": \\"设备OpenId\\"\\n },\\n \\"RequestId\\": \\"686DF82F-45C4-7DF7-8B67-27B91CFD63A9\\"\\n}","type":"json"}]',
],
'GetUserByDeviceId' => [
'summary' => '查询设备绑定的用户',
'path' => '/v1.0/ssp/getUserByDeviceId',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '用户open信息',
'description' => '',
'type' => 'object',
'properties' => [
'UserOpenId' => [
'title' => '用户信息对应的openId',
'description' => '',
'type' => 'string',
'example' => '0963*0158',
],
'UserUnionIds' => [
'title' => '组织id及归一id列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'OrganizationId' => [
'title' => '组织id',
'description' => '',
'type' => 'string',
'example' => '1**2',
],
'UserUnionId' => [
'title' => '组织id对应的归一id',
'description' => '',
'type' => 'string',
'example' => '1553*B0C3',
],
],
],
],
],
'example' => 'true',
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.GetUserByDeviceId.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"0963*0158\\",\\n \\"UserUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"UserUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n 0963*0158\\n \\n 1**2\\n 1553*B0C3\\n \\n \\n 0EC7*726E\\n","errorExample":""}]',
],
'ListDeviceByUserId' => [
'summary' => '查询用户名下的设备',
'path' => '/v1.0/ssp/listDeviceByUserId',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回result',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DeviceOpenId' => [
'title' => '设备信息对应的openId',
'description' => '',
'type' => 'string',
'example' => 'A963*0158',
],
'DeviceUnionIds' => [
'title' => '组织id及归一id列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'OrganizationId' => [
'title' => '组织id',
'description' => '',
'type' => 'string',
'example' => '1**2',
],
'DeviceUnionId' => [
'title' => '组织id对应的归一id',
'description' => '',
'type' => 'string',
'example' => '1553*B0C3',
],
],
],
],
],
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.ListDeviceByUserId.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n A963*0158\\n \\n 1**2\\n 1553*B0C3\\n \\n \\n 0EC7*726E\\n","errorExample":""}]',
],
'UnbindDevice' => [
'summary' => '解绑设备',
'path' => '/v1.0/ssp/unbindDevice',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'properties' => [
'EncodeType' => [
'description' => '',
'example' => 'PROJECT_ID',
'required' => true,
'title' => '编码类型,此处填写“PROJECT_ID”',
'type' => 'string',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'example' => '12**45',
'required' => true,
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'type' => 'string',
],
'IdType' => [
'description' => '',
'example' => 'OPEN_ID',
'required' => true,
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'type' => 'string',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'example' => 'DAFE****ce3ej=',
'required' => true,
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'type' => 'string',
],
'OrganizationId' => [
'description' => '',
'example' => '1**2',
'required' => false,
'title' => '组织ID,如果IdType为UNION_ID时必填',
'type' => 'string',
],
],
'required' => true,
'title' => '设备标识信息',
'type' => 'object',
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'properties' => [
'EncodeType' => [
'description' => '',
'example' => 'PROJECT_ID',
'required' => true,
'title' => '编码类型,此处填写“PROJECT_ID”',
'type' => 'string',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'example' => '12**45',
'required' => true,
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'type' => 'string',
],
'IdType' => [
'description' => '',
'example' => 'OPEN_ID',
'required' => true,
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在开放平台申请过组织后才会有',
'type' => 'string',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'example' => 'HOFF****my7Iw=',
'required' => true,
'title' => '用户标识(userOpenId或userUnionId)',
'type' => 'string',
],
'OrganizationId' => [
'description' => '',
'example' => '1**2',
'required' => false,
'title' => '组织ID,如果IdType为UNION_ID时必填',
'type' => 'string',
],
],
'required' => true,
'title' => '用户标识信息',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'properties' => [
'Message' => [
'description' => '',
'example' => 'success',
'title' => '返回的错误信息',
'type' => 'string',
],
'Code' => [
'description' => '',
'example' => '200',
'format' => 'int32',
'title' => '返回的错误码',
'type' => 'integer',
],
'Result' => [
'description' => '',
'example' => 'true',
'title' => '是否解绑成功',
'type' => 'boolean',
],
'RequestId' => [
'description' => '',
'example' => '0EC7*726E',
'title' => '请求id',
'type' => 'string',
],
],
'title' => '返回数据体',
'type' => 'object',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.UnbindDevice.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n true\\n 0EC7*726E\\n","errorExample":""}]',
],
'ListDeviceByUserIdAndChanel' => [
'summary' => '获取指定渠道的设备列表',
'path' => '/v1.0/ssp/listDeviceByUserIdAndChanel',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ChannelInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '激活渠道,如微信小程序,三方app等',
'description' => '',
'type' => 'object',
'properties' => [
'Channel' => [
'title' => '激活配网渠道,如WeChat',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'WeChat、ThirdApp',
],
'ExtInfo' => [
'title' => '扩展信息',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户标识信息列表。',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'title' => '用户Id的类型:'."\n"
.'OPEN_ID:默认的用户ID标识。'."\n"
.'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '用户标识,填写userOpenId或userUnionId的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1***2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '调用该接口的返回结果。',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '信息列表',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeviceOpenId' => [
'title' => '设备信息对应的openId。',
'description' => '',
'type' => 'string',
'example' => 'A963*0158',
],
'DeviceUnionIds' => [
'title' => '设备信息列表',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OrganizationId' => [
'title' => '组织ID。',
'description' => '',
'type' => 'string',
'example' => '1***2',
],
'DeviceUnionId' => [
'title' => '设备的UnionId。',
'description' => '',
'type' => 'string',
'example' => '1553*B0C3',
],
],
],
],
],
],
],
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => 'RE***D',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1***2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"RE***D\\"\\n}","type":"json"}]',
],
'GetDeviceIdByIdentity' => [
'summary' => '获取设备信息',
'path' => '/v1.0/ssp/getDeviceIdByIdentity',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'EncodeType',
'in' => 'query',
'schema' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
],
[
'name' => 'EncodeKey',
'in' => 'query',
'schema' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '129****0946',
],
],
[
'name' => 'IdentityType',
'in' => 'query',
'schema' => [
'title' => '填写设备认证类型,“MAC”或者“SN”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'MAC',
],
],
[
'name' => 'IdentityId',
'in' => 'query',
'schema' => [
'title' => '认证标识,填写MAC地址或者SN的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'b4:xx:xx:xx:65:2b',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'title' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Mm*****XnZ8',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回result',
'description' => '',
'type' => 'object',
'properties' => [
'DeviceOpenId' => [
'title' => '设备信息对应的openId',
'description' => '',
'type' => 'string',
'example' => 'A963*0158',
],
'DeviceUnionIds' => [
'title' => '组织id及归一id列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'OrganizationId' => [
'title' => '组织id',
'description' => '',
'type' => 'string',
'example' => '1**2',
],
'DeviceUnionId' => [
'title' => '组织id对应的归一id',
'description' => '',
'type' => 'string',
'example' => '1553*B0C3',
],
],
],
],
],
],
'RequestId' => [
'title' => '请求ID,用于排查问题,如果没有这个参数,可以在responseHeader里进行排查。',
'description' => '',
'type' => 'string',
'example' => '0EC7DA****A0726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7DA****A0726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n A963*0158\\n \\n 1**2\\n 1553*B0C3\\n \\n \\n 0EC7DA****A0726E\\n","errorExample":""}]',
],
'ListDeviceIdByIdentities' => [
'summary' => '批量获取设备openId',
'path' => '/v1.0/ssp/listDeviceIdByIdentities',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'EncodeType',
'in' => 'query',
'schema' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
],
[
'name' => 'EncodeKey',
'in' => 'query',
'schema' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '125****0946',
],
],
[
'name' => 'IdentityType',
'in' => 'query',
'schema' => [
'title' => '填写设备认证类型,“MAC”或者“SN”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'MAC',
],
],
[
'name' => 'IdentityIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'title' => '认证标识,填写MAC地址或者SN的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'b4:xx:xx:xx:65:2b',
],
'required' => false,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'title' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Mm*****XnZ8',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回result',
'description' => '',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'DeviceOpenId' => [
'title' => '设备信息对应的openId',
'description' => '',
'type' => 'string',
'example' => 'A963*0158',
],
'DeviceUnionIds' => [
'title' => '组织id及归一id列表',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OrganizationId' => [
'title' => '组织id',
'description' => '',
'type' => 'string',
'example' => '1**2',
],
'DeviceUnionId' => [
'title' => '组织id对应的归一id',
'description' => '',
'type' => 'string',
'example' => '1553*B0C3',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n \\n A963*0158\\n \\n 1**2\\n 1553*B0C3\\n \\n \\n \\n 0EC7*726E\\n","errorExample":""}]',
],
'GetDeviceBasicInfo' => [
'summary' => '获取设备认证信息',
'path' => '/v1.0/ssp/getDeviceBasicInfo',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回result',
'description' => '',
'type' => 'object',
'properties' => [
'Name' => [
'title' => '设备名称',
'description' => '',
'type' => 'string',
'example' => '我的设备',
],
'FirmwareVersion' => [
'title' => '固件版本',
'description' => '',
'type' => 'string',
'example' => '2.0.3',
],
'Mac' => [
'title' => '设备MAC地址',
'description' => '',
'type' => 'string',
'example' => 'b4:xx:xx:xx:65:2b',
],
'Sn' => [
'title' => '设备SN',
'description' => '',
'type' => 'string',
'example' => '1200xxx048',
],
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.GetDeviceBasicInfo.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n 我的设备\\n 2.0.3\\n b4:xx:xx:xx:65:2b\\n 1200xxx048\\n \\n 0EC7*726E\\n","errorExample":""}]',
],
'ListDeviceBasicInfo' => [
'summary' => '批量获取设备基本信息',
'path' => '/v1.0/ssp/listDeviceBasicInfo',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceInfos',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Ids' => [
'title' => '设备标识列表(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'array',
'items' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'required' => false,
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回result,key为deviceOpenId或deviceUnionId,value为对应的设备信息',
'description' => '',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Name' => [
'title' => '设备名称',
'description' => '',
'type' => 'string',
'example' => '我的设备',
],
'FirmwareVersion' => [
'title' => '固件版本',
'description' => '',
'type' => 'string',
'example' => '2.0.3',
],
'Mac' => [
'title' => '设备MAC地址',
'description' => '',
'type' => 'string',
'example' => 'b4:xx:xx:xx:65:2b',
],
'Sn' => [
'title' => '设备SN',
'description' => '',
'type' => 'string',
'example' => '1200xx048',
],
],
'description' => '',
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.ListDeviceBasicInfo.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xx048\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n \\n 我的设备\\n 2.0.3\\n b4:xx:xx:xx:65:2b\\n 1200xx048\\n \\n \\n 0EC7*726E\\n\\n","errorExample":""}]',
],
'GetDeviceStatusInfo' => [
'summary' => '获取设备状态信息',
'path' => '/v1.0/ssp/getDeviceStatusInfo',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回result',
'description' => '',
'type' => 'object',
'properties' => [
'Online' => [
'title' => '是否在线,0为不在线,1为在线',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.GetDeviceStatusInfo.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Online\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n 1\\n \\n 0EC7*726E\\n","errorExample":""}]',
],
'GetDeviceTag' => [
'summary' => '获取设备标签',
'path' => '/v1.0/ssp/getDeviceTag',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写“PROJECT_ID”',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回数据体',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '返回的错误信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回result',
'description' => '',
'type' => 'object',
'properties' => [
'DeviceTags' => [
'title' => '设备标签结果',
'description' => '',
'type' => 'object',
'example' => '{ "antest1": "antest1", "antest": "a" }',
],
],
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
'errorMessage' => 'The request parameter is invalid.',
],
],
500 => [
[
'errorCode' => 'AliGenie.Public.InternalError',
'errorMessage' => 'An internal error occurred.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceTags\\": {\\n \\"antest1\\": \\"antest1\\",\\n \\"antest\\": \\"a\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n \\n \\n antest1\\n a\\n \\n \\n 0EC7*726E\\n","errorExample":""}]',
],
'DeviceControl' => [
'summary' => '设备控制',
'path' => '/v1.0/ssp/control',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [],
'produces' => [],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ControlRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '控制音量入参',
'description' => '',
'type' => 'object',
'properties' => [
'Volume' => [
'title' => '音量目标值',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Muted' => [
'title' => '是否静音',
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
'required' => false,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息列表。',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'title' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'title' => '设备的组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1*****2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'title' => '调用该接口的返回结果。',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回的详细信息。',
'description' => '',
'type' => 'boolean',
],
'RequestId' => [
'title' => '请求ID。',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
],
'GetDeviceSetting' => [
'summary' => '获取设备的用户设置',
'path' => '/v1.0/ssp/getDeviceSetting',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [],
'produces' => [],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Keys',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备设置指定的Key集合,'."\n"
.'勿扰模式:nightMode',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息列表。',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12345',
],
'IdType' => [
'title' => '设备Id的类型'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '设备标识,配置为deviceOpenId或deviceUnionId。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '122',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '调用该接口的返回结果。',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回具体的设备设置信息。',
'description' => '',
'type' => 'object',
],
'RequestId' => [
'title' => '请求ID。',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
],
'GetDeviceStatusDetail' => [
'summary' => '获取设备状态详情',
'path' => '/v1.0/ssp/getDeviceStatusDetail',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Keys',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备设置指定的Key集合,'."\n"
.'如播放器:player',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息列表。',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'title' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'OPEN_ID',
],
],
'Id' => [
'title' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '调用该接口的返回结果。',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '返回的详细信息。',
'description' => '',
'type' => 'object',
'properties' => [
'Player' => [
'title' => '播放器信息',
'description' => '',
'type' => 'object',
'properties' => [
'AudioAnchor' => [
'title' => '歌手',
'description' => '',
'type' => 'string',
'example' => '刘德华',
],
'AudioExt' => [
'title' => '扩展信息',
'description' => '',
'type' => 'string',
'example' => '""',
],
'AudioId' => [
'title' => '歌曲id',
'description' => '',
'type' => 'string',
'example' => '123',
],
'Format' => [
'title' => '歌曲类型(mp3)',
'description' => '',
'type' => 'string',
'example' => 'mp3',
],
'AudioSource' => [
'title' => '歌曲来源(xiami)',
'description' => '',
'type' => 'string',
'example' => 'xiami',
],
'AudioLength' => [
'title' => ' 歌曲长度,秒',
'description' => '',
'type' => 'string',
'example' => '253',
],
'Source' => [
'title' => '播放来源(cloud)',
'description' => '',
'type' => 'string',
'example' => 'cloud',
],
'AudioUrl' => [
'title' => '歌曲url',
'description' => '',
'type' => 'string',
'example' => 'https://xxx',
],
'AudioName' => [
'title' => '歌曲名称',
'description' => '',
'type' => 'string',
],
'AudioAlbum' => [
'title' => '歌曲专辑',
'description' => '',
'type' => 'string',
],
'Progress' => [
'title' => '播放进度',
'description' => '',
'type' => 'string',
'example' => '30',
],
'Timestamp' => [
'title' => '上报时间',
'description' => '',
'type' => 'string',
],
'Status' => [
'title' => '播放状态,pause',
'description' => '',
'type' => 'string',
'example' => 'pause',
],
],
],
'Speaker' => [
'title' => '音量信息',
'description' => '',
'type' => 'object',
'properties' => [
'Volume' => [
'title' => '音量当前值',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Muted' => [
'title' => '是否静音',
'description' => '',
'type' => 'boolean',
],
],
],
'Power' => [
'title' => '电量信息',
'description' => '',
'type' => 'object',
'properties' => [
'Quantity' => [
'title' => '电量值',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'Status' => [
'title' => '电源状态',
'description' => '',
'type' => 'string',
],
],
],
],
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Player\\": {\\n \\"AudioAnchor\\": \\"刘德华\\",\\n \\"AudioExt\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AudioId\\": \\"123\\",\\n \\"Format\\": \\"mp3\\",\\n \\"AudioSource\\": \\"xiami\\",\\n \\"AudioLength\\": \\"253\\",\\n \\"Source\\": \\"cloud\\",\\n \\"AudioUrl\\": \\"https://xxx\\",\\n \\"AudioName\\": \\"\\",\\n \\"AudioAlbum\\": \\"\\",\\n \\"Progress\\": \\"30\\",\\n \\"Timestamp\\": \\"\\",\\n \\"Status\\": \\"pause\\"\\n },\\n \\"Speaker\\": {\\n \\"Volume\\": 10,\\n \\"Muted\\": true\\n },\\n \\"Power\\": {\\n \\"Quantity\\": 30,\\n \\"Status\\": \\"\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
],
'SetDeviceSetting' => [
'summary' => '修改设备设置',
'path' => '/v1.0/ssp/setDeviceSetting',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Key',
'in' => 'formData',
'schema' => [
'title' => '设备设置指定的Key集合,'."\n"
.'勿扰模式:nightMode',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'nightMode',
],
],
[
'name' => 'Value',
'in' => 'formData',
'schema' => [
'title' => '属性值',
'description' => '',
'type' => 'any',
'required' => false,
'example' => '{"enable":true}',
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'title' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'title' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填。',
'description' => '',
'type' => 'string',
'required' => false,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '调用该接口的返回结果。',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '返回的错误码,200表示调用成功。',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '设置执行结果',
'description' => '',
'type' => 'boolean',
],
'RequestId' => [
'title' => '请求ID。',
'description' => '',
'type' => 'string',
'example' => '0EC7*726E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
],
'GetJiangSuTelecomData' => [
'summary' => '江苏电信号百',
'path' => '/v1.0/ssp/GetJiangSuTelecomData',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'Date',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2024-11-09',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'OssUrl' => [
'description' => '',
'type' => 'string',
'example' => 'http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA',
],
],
],
'Message' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'successful',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OssUrl\\": \\"http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949\\"\\n}","type":"json"}]',
],
'ScgSearch' => [
'summary' => '选品池投放能力',
'path' => '/v1.0/ssp/scgSearch',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'TopicId',
'in' => 'query',
'schema' => [
'title' => '选品池ID 可选:MC201132(民族中国风),MC201136(流行音乐),MC201139(甜蜜爱情),MC201133(民谣),MC201137(放松阅读),MC201138(快乐),PA202029(故事),PA202030(儿歌),PA202028(国学历史),PA202032(百科),PA202031(英文儿歌)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'MC201132',
],
],
[
'name' => 'ScgFilter',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '查询filter',
'description' => '',
'type' => 'object',
'properties' => [
'SortParam' => [
'title' => '排序参数',
'description' => '',
'type' => 'object',
'properties' => [
'SortKey' => [
'title' => '排序字段',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'internal_id',
],
'SortText' => [
'title' => '排序字段(默认空字符串)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '“”',
],
'SortOrder' => [
'title' => '排序顺序',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ASC',
],
],
'required' => true,
],
'UseOffSet' => [
'title' => '是否使用pageParam对象分页,offSetParam和pageParam二选一,默认分页模式为pageParam',
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
'OffSetParam' => [
'title' => '分页类型',
'description' => '',
'type' => 'object',
'properties' => [
'Offset' => [
'title' => '跳过的条目数量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Limit' => [
'title' => '返回的条目数量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
'required' => false,
],
'PageParam' => [
'title' => '分页类型',
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'title' => '每页记录条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'PageNum' => [
'title' => '页数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
'required' => false,
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'result',
'description' => 'result',
'type' => 'object',
'properties' => [
'PageNum' => [
'title' => '页数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Message' => [
'title' => '响应信息',
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'PageSize' => [
'title' => '每页记录条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Result' => [
'title' => '返回的内容数据',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Source' => [
'title' => '内容来源',
'description' => '',
'type' => 'string',
'example' => 'xiami',
],
'Title' => [
'title' => '内容标题',
'description' => '',
'type' => 'string',
'example' => '',
],
'Type' => [
'title' => '内容类型',
'description' => '',
'type' => 'string',
'example' => 'music',
],
'Cover' => [
'title' => '内容封面',
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'title' => '封面图片',
'description' => '',
'type' => 'string',
'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg',
],
'canResize' => [
'title' => '是否支持缩放',
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Large' => [
'title' => '大图',
'description' => '',
'type' => 'string',
'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg',
],
'Medium' => [
'title' => '中图',
'description' => '',
'type' => 'string',
'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg',
],
'Small' => [
'title' => '小图',
'description' => '',
'type' => 'string',
'example' => 'http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg',
],
],
],
'Alias' => [
'title' => '别名',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'SupportAudition' => [
'title' => '是否支持试听'."\n",
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'ContentType' => [
'title' => '内容类型',
'description' => '',
'type' => 'string',
'example' => 'MUSIC_CONTENT',
],
'Singers' => [
'title' => '歌手名',
'description' => '',
'type' => 'string',
'example' => '',
],
'AlbumRawId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'example' => '1795716629',
],
'Album' => [
'title' => '是否为专辑',
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'AlbumType' => [
'title' => '专辑类型',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'AuthorIds' => [
'title' => '作者ID'."\n",
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1795716629',
],
],
'IsAudition' => [
'title' => '能否试听',
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'AuthorNames' => [
'title' => '作者姓名',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'NeedCharge' => [
'title' => '是否需要收费',
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'IsCharge' => [
'title' => '是否收费',
'description' => '',
'type' => 'string',
'example' => 'false',
],
'Category' => [
'title' => '类别',
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'RawId' => [
'title' => '三方内容Id',
'description' => '',
'type' => 'string',
'example' => '1795716629',
],
],
],
'example' => '',
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
],
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"xiami\\",\\n \\"Title\\": \\"那个人\\",\\n \\"Type\\": \\"music\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"canResize\\": false,\\n \\"Large\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Medium\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Small\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\"\\n },\\n \\"Alias\\": [\\n \\"那个人\\"\\n ],\\n \\"SupportAudition\\": false,\\n \\"ContentType\\": \\"MUSIC_CONTENT\\",\\n \\"Singers\\": \\"黎偌天\\",\\n \\"AlbumRawId\\": \\"1795716629\\",\\n \\"Album\\": false,\\n \\"AlbumType\\": 0,\\n \\"AuthorIds\\": [\\n 1795716629\\n ],\\n \\"IsAudition\\": false,\\n \\"AuthorNames\\": [\\n \\"\\\\\\"王一鸣Iris\\\\\\", \\\\\\"黎偌天\\\\\\", \\\\\\"薛晨雨\\\\\\"\\"\\n ],\\n \\"NeedCharge\\": false,\\n \\"IsCharge\\": \\"false\\",\\n \\"Category\\": \\"audio\\",\\n \\"RawId\\": \\"1795716629\\"\\n }\\n ],\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n OK\\n 10\\n \\n xiami\\n 那个人\\n music\\n \\n
http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\n false\\n \\n 那个人\\n false\\n MUSIC_CONTENT\\n 黎偌天\\n 1795716629\\n false\\n 0\\n 1795716629\\n false\\n \\"王一鸣Iris\\", \\"黎偌天\\", \\"薛晨雨\\"\\n false\\n false\\n audio\\n 1795716629\\n \\n 73C67BD9-175A-1324-8202-9FAABBB3E6FA\\n 200\\n","errorExample":""}]',
],
'AddAndRemoveFavoriteContent' => [
'summary' => '收藏/取消收藏',
'path' => '/v1.0/ssp/AddAndRemoveFavoriteContent',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenAddAndRemoveFavoriteContentRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'PackageType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'CONTENT',
],
'OpenSourceRawIdPair' => [
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2105818057',
],
'Source' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'xiami',
],
'ExtendInfo' => [
'description' => '',
'type' => 'object',
'required' => false,
],
],
'required' => true,
],
'FavoriteCmd' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ADD',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '121212121',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"121212121\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n success\\n 121212121\\n true\\n","errorExample":""}]',
],
'CreatePlayingList' => [
'summary' => '播放列表创建',
'path' => '/v1.0/ssp/CreatePlayingList',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenCreatePlayingListRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'PlayFrom' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'default',
],
'ContentType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'content',
],
'ContentList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12345',
],
'Source' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'xiami',
],
],
'required' => true,
],
'required' => true,
],
'Index' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
'NeedAlbumContinued' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PlayMode' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Repeat',
],
'ExtendInfo' => [
'description' => '',
'type' => 'object',
'required' => false,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
'enum' => [],
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'UNION_ID',
'OPEN_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'OpenServiceResult',
'description' => 'OpenServiceResult',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '调用返回码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'title' => '三方id',
'description' => '',
'type' => 'string',
'example' => '550144364',
],
'Source' => [
'title' => '来源',
'description' => '',
'type' => 'string',
'example' => 'ximalayav2',
],
'AlbumRawId' => [
'title' => '三方专辑id',
'description' => '',
'type' => 'string',
'example' => '260744',
],
'AlbumName' => [
'title' => '三方专辑id',
'description' => '',
'type' => 'string',
'example' => '',
],
'Liked' => [
'title' => '是否收藏',
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Singer' => [
'title' => '作者',
'description' => '',
'type' => 'string',
'example' => '',
],
'Title' => [
'title' => '标题',
'description' => '',
'type' => 'string',
'example' => '',
],
'Cover' => [
'title' => '封面图片对象',
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'PlayMode' => [
'title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
'description' => '',
'type' => 'string',
'example' => 'Repeat',
],
'AudioLength' => [
'title' => '长度',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '190',
],
'Progress' => [
'title' => '歌曲播放进度',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'LyricUrl' => [
'title' => '歌词url',
'description' => '',
'type' => 'string',
'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
],
'Copyright' => [
'title' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'story',
],
'ItemUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
],
'DefaultPlayOrder' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Pos' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'Message' => [
'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 550144364\\n ximalayav2\\n 260744\\n 晚安妈妈睡前故事\\n false\\n 晚安妈妈\\n 足球鞋赛车 晚安妈妈\\n \\n
http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n false\\n \\n Repeat\\n 190\\n \\n https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\n 0\\n story\\n https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\n 1\\n VALID\\n 0\\n \\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'GetAlbum' => [
'summary' => '根据id获取专辑信息',
'path' => '/v1.0/ssp/GetAlbum',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '12343',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'song',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'Alias' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Audition' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ANCHOR',
],
],
'Gender' => [
'description' => '',
'type' => 'string',
'example' => 'MALE',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13123',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qignting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Charge' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CommCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80012017',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
],
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'HotScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1231231',
],
'ItemType' => [
'description' => '',
'type' => 'string',
'example' => 'ALBUM',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qignting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Finished' => [
'description' => '',
'type' => 'string',
'example' => 'FINISHED',
],
'TotalEpisode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '23242',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 13123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Finished\\": \\"FINISHED\\",\\n \\"TotalEpisode\\": 12,\\n \\"RawId\\": \\"23242\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n 200\\n \\n 超能狂少在都市\\n false\\n \\n ANCHOR\\n MALE\\n 13123\\n false\\n qignting\\n 超能狂少在都市\\n \\n audio\\n false\\n 80012017\\n \\n false\\n
http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n \\n 内容描述\\n 10\\n 1231231\\n ALBUM\\n qignting\\n 超能狂少在都市\\n program\\n VALID\\n FINISHED\\n 12\\n 23242\\n \\n","errorExample":""}]',
],
'GetContent' => [
'summary' => '按照特定的id获取内容信息',
'path' => '/v1.0/ssp/GetContent',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '123123',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'song',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'Alias' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Audition' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ANCHOR',
],
],
'Gender' => [
'description' => '',
'type' => 'string',
'example' => 'MALE',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '123123',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Charge' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CommCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80012017',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
],
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'HotScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'ItemType' => [
'description' => '',
'type' => 'string',
'example' => 'ALBUM',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Duration' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '180',
],
'AlbumId' => [
'description' => '',
'type' => 'string',
'example' => '1231',
],
'Lyric' => [
'description' => '',
'type' => 'string',
'example' => 'http://1231.lrc',
],
'Styles' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '1312',
],
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '1231231',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 123123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 0,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"1231\\",\\n \\"Lyric\\": \\"http://1231.lrc\\",\\n \\"Styles\\": [\\n \\"1312\\"\\n ],\\n \\"RawId\\": \\"1231231\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n \\n 超能狂少在都市\\n false\\n \\n ANCHOR\\n MALE\\n 123123\\n false\\n qingting\\n 播音呆瓜小贼\\n \\n audio\\n false\\n 80012017\\n \\n false\\n
http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n \\n 内容描述\\n 13597709\\n ALBUM\\n qingting\\n 超能狂少在都市\\n program\\n VALID\\n 180\\n 1231\\n http://1231.lrc\\n 1312\\n 1231231\\n \\n","errorExample":""}]',
],
'GetCurrentPlayingItem' => [
'summary' => '获取当前播放项',
'path' => '/v1.0/ssp/GetCurrentPlayingItem',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '550144364',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'ximalayav2',
],
'AlbumRawId' => [
'description' => '',
'type' => 'string',
'example' => '260744',
],
'AlbumName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Liked' => [
'description' => '',
'type' => 'string',
'example' => 'false',
],
'Singer' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'PlayMode' => [
'description' => '',
'type' => 'string',
'example' => 'Repeat',
],
'AudioLength' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '190',
],
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'LyricUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
],
'Copyright' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'story',
],
'ItemUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
],
'DefaultPlayOrder' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Pos' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": \\"false\\",\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 550144364\\n ximalayav2\\n 260744\\n 晚安妈妈睡前故事\\n false\\n 晚安妈妈\\n 足球鞋赛车 晚安妈妈\\n \\n
http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n false\\n \\n Repeat\\n 190\\n \\n 0\\n story\\n https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\n 1\\n VALID\\n 0\\n \\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'GetCurrentPlayingList' => [
'summary' => '获取当前播放列表',
'path' => '/v1.0/ssp/GetCurrentPlayingList',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenQueryPlayListRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '15',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '550144364',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'ximalayav2',
],
'AlbumRawId' => [
'description' => '',
'type' => 'string',
'example' => '260744',
],
'AlbumName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Liked' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Singer' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'PlayMode' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
'AudioLength' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '190',
],
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'LyricUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'story',
],
'Copyright' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ItemUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
],
'DefaultPlayOrder' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Pos' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Normal\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 550144364\\n ximalayav2\\n 260744\\n 晚安妈妈睡前故事\\n false\\n 晚安妈妈\\n 足球鞋赛车 晚安妈妈\\n \\n
http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n false\\n \\n Normal\\n 190\\n \\n story\\n 0\\n https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\n 1\\n VALID\\n 0\\n \\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'IndexControlPlayingList' => [
'summary' => '播放列表点击播放',
'path' => '/v1.0/ssp/IndexControlPlayingList',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenIndexControlRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Index' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '0',
],
'NeedContentContinued' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'ExtendInfo' => [
'description' => '',
'type' => 'object',
'required' => false,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '550144364',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'ximalayav2',
],
'AlbumRawId' => [
'description' => '',
'type' => 'string',
'example' => '260744',
],
'AlbumName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Liked' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Singer' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'PlayMode' => [
'description' => '',
'type' => 'string',
'example' => 'Repeat',
],
'AudioLength' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '190',
],
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'LyricUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'story',
],
'Copyright' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ItemUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
],
'DefaultPlayOrder' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Pos' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 550144364\\n ximalayav2\\n 260744\\n 晚安妈妈睡前故事\\n false\\n 晚安妈妈\\n 足球鞋赛车 晚安妈妈\\n \\n
http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n false\\n \\n Repeat\\n 190\\n \\n story\\n 0\\n https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\n 1\\n VALID\\n 0\\n \\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'ListAlbumDetail' => [
'summary' => '获取音乐音频专辑里面的内容列表',
'path' => '/v1.0/ssp/ListAlbumDetail',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '121321',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'CurrentPageNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'OpenDataItemList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Alias' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Audition' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ANCHOR',
],
],
'Gender' => [
'description' => '',
'type' => 'string',
'example' => 'MALE',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '12314',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Charge' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CommCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80012017',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
],
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Duration' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '180',
],
'HotScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1231231',
],
'ItemType' => [
'description' => '',
'type' => 'string',
'example' => 'ALBUM',
],
'OrderIndex' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Styles' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '13131',
],
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '12323423',
],
],
],
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '21421',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"CurrentPageNum\\": 1,\\n \\"OpenDataItemList\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 12314,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"Duration\\": 180,\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"OrderIndex\\": 1,\\n \\"Source\\": \\"qingting\\",\\n \\"Styles\\": [\\n \\"13131\\"\\n ],\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"12323423\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 21421\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n 200\\n success\\n \\n 1\\n \\n 超能狂少在都市\\n false\\n \\n ANCHOR\\n MALE\\n 12314\\n false\\n qingting\\n 播音呆瓜小贼\\n \\n audio\\n false\\n 80012017\\n \\n false\\n
http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n \\n 内容描述\\n 180\\n 10\\n 1231231\\n ALBUM\\n 1\\n qingting\\n 13131\\n 超能狂少在都市\\n program\\n VALID\\n 12323423\\n \\n 10\\n 21421\\n \\n","errorExample":""}]',
],
'ListCateContent' => [
'summary' => '根据特定的类目,按照指定的排序顺序获取该类目下的内容.',
'path' => '/v1.0/ssp/ListCateContent',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Request',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'CateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '80010',
],
'IsAlbum' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
'SortBy' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'hot_score',
],
'SortOrder' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DESC',
'enum' => [
'ASC',
'DESC',
],
],
'PageNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'sucess',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '12002',
],
'CurrentPageNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'OpenDataItemList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '26152778',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '123123',
],
'Gender' => [
'description' => '',
'type' => 'string',
'example' => 'MALE',
],
'AuthorTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ANCHOR',
],
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'ItemType' => [
'description' => '',
'type' => 'string',
'example' => 'ALBUM',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'HotScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '0',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718275.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/20170207175.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020675.jpg',
],
'canResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'CommCateId' => [
'description' => '',
'type' => 'string',
'example' => '80012017',
],
'Alias' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Charge' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Audition' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '206775',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"sucess\\",\\n \\"Result\\": {\\n \\"TotalSize\\": 12002,\\n \\"CurrentPageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"OpenDataItemList\\": [\\n {\\n \\"id\\": 26152778,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Authors\\": [\\n {\\n \\"RawId\\": \\"123123\\",\\n \\"Gender\\": \\"MALE\\",\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Source\\": \\"qingting\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Mediam\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Category\\": \\"audio\\",\\n \\"Type\\": \\"program\\",\\n \\"HotScore\\": 0,\\n \\"Valid\\": \\"VALID\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/20170207175.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020675.jpg\\",\\n \\"canResize\\": false\\n },\\n \\"CommCateId\\": \\"80012017\\",\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Charge\\": false,\\n \\"Audition\\": true,\\n \\"Description\\": \\"作者:月不醉 简介:啥,假冒你男友?退役兵王回归都市后做了一名小保安,机缘巧合下却被冷艳女总拉去客串男友,从此之后,他与冷艳老总开始纠缠不清···拳打恶一代,脚踩高富帅,哥哥我专治各种不服。面对各类的阴谋阳谋,面对各种黑恶势力,且看哥如何称霸都市,踏上巅峰!\\",\\n \\"RawId\\": \\"206775\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n 200\\n sucess\\n \\n 12002\\n 1\\n 10\\n \\n 26152778\\n qingting\\n 超能狂少在都市\\n \\n 123123\\n MALE\\n ANCHOR\\n qingting\\n \\n
https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n false\\n \\n 13597709\\n 播音呆瓜小贼\\n 播音呆瓜小贼\\n true\\n \\n ALBUM\\n audio\\n program\\n 0\\n VALID\\n \\n
http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718275.jpg\\n http://pic.qtfm.cn/2017/0207/20170207175.jpg\\n http://pic.qtfm.cn/2017/0207/2017020675.jpg\\n false\\n \\n 80012017\\n 超能狂少在都市\\n false\\n true\\n 作者:月不醉 简介:啥,假冒你男友?退役兵王回归都市后做了一名小保安,机缘巧合下却被冷艳女总拉去客串男友,从此之后,他与冷艳老总开始纠缠不清···拳打恶一代,脚踩高富帅,哥哥我专治各种不服。面对各类的阴谋阳谋,面对各种黑恶势力,且看哥如何称霸都市,踏上巅峰!\\n 206775\\n \\n \\n","errorExample":""}]',
],
'ListCateInfo' => [
'summary' => '获取音乐音频类目列表',
'path' => '/v1.0/ssp/ListCateInfo',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => 'A short description of struct',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'song',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80064',
],
'CateName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ParentCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80064,\\n \\"CateName\\": \\"时尚生活\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n \\n 80064\\n 时尚生活\\n 0\\n \\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n","errorExample":""}]',
],
'ListCommonCateFirstFloor' => [
'summary' => '获取音乐/音频的一级类目列表',
'path' => '/v1.0/ssp/ListCommonCateFirstFloor',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => 'A short description of struct',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'song',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80012',
],
'CateName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ParentCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80012,\\n \\"CateName\\": \\"有声内容\\",\\n \\"ParentCateId\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n \\n 80012\\n 有声内容\\n 0\\n \\n success\\n","errorExample":""}]',
],
'ListCommonCateSecondFloor' => [
'summary' => '获取指定一级类目下面的二级类目列表',
'path' => '/v1.0/ssp/ListCommonCateSecondFloor',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ParentCateId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '80010',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80018009',
],
'CateName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ParentCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80018',
],
],
],
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80018009,\\n \\"CateName\\": \\"儿童笑话\\",\\n \\"ParentCateId\\": 80018\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n 200\\n \\n 80018009\\n 儿童笑话\\n 80018\\n \\n success\\n","errorExample":""}]',
],
'ListPlayHistory' => [
'summary' => '获取用户的播放历史',
'path' => '/v1.0/ssp/ListPlayHistory',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Request',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'music',
],
'PageNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Alias' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Audition' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ANCHOR',
],
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
],
],
'Gender' => [
'description' => '',
'type' => 'string',
'example' => 'MALE',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '123123',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Charge' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CommCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80012017',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
],
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'HotScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'ItemType' => [
'description' => '',
'type' => 'string',
'example' => 'ALBUM',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Type\\": \\"program\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Valid\\": \\"VALID\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n 200\\n success\\n \\n 超能狂少在都市\\n false\\n \\n ANCHOR\\n \\n false\\n
https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n \\n MALE\\n 123123\\n qingting\\n 13597709\\n 播音呆瓜小贼\\n 播音呆瓜小贼\\n false\\n \\n audio\\n false\\n 80012017\\n \\n false\\n
http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n \\n 内容描述\\n 10\\n 13597709\\n ALBUM\\n qingting\\n program\\n 超能狂少在都市\\n VALID\\n \\n","errorExample":""}]',
],
'ListRecommendContent' => [
'summary' => '获取每日推荐的音乐或者音频',
'path' => '/v1.0/ssp/ListRecommendContent',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Request',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'song',
],
'Count' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Alias' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Audition' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ANCHOR',
],
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
],
],
'Gender' => [
'description' => '',
'type' => 'string',
'example' => 'MALE',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '12311',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Charge' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CommCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80012017',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
],
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'HotScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'ItemType' => [
'description' => '',
'type' => 'string',
'example' => 'ALBUM',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '123123',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"12311\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"123123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n F12B6147-5925-19E5-A3AD-E1EE1360F34E\\n \\n 超能狂少在都市\\n false\\n \\n ANCHOR\\n \\n false\\n
https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n \\n MALE\\n 12311\\n qingting\\n 13597709\\n 播音呆瓜小贼\\n 播音呆瓜小贼\\n false\\n \\n audio\\n false\\n 80012017\\n \\n false\\n
http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n \\n 内容描述\\n 10\\n 13597709\\n ALBUM\\n qingting\\n 超能狂少在都市\\n program\\n VALID\\n 123123\\n \\n","errorExample":""}]',
],
'PlayAndPauseControl' => [
'summary' => '播放暂停控制',
'path' => '/v1.0/ssp/PlayAndPauseControl',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenPlayAndPauseControlParam',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'OpenPlayAndPauseCommand' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Play',
'enum' => [
'Play',
'Pause',
],
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'PlayModeControl' => [
'summary' => '播放模式切换',
'path' => '/v1.0/ssp/PlayModeControl',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenPlayModeControlRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'OpenPlayMode' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Normal',
'enum' => [
'Repeat',
'Shuffle',
'RepeatOne',
'Normal',
],
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'OpenPlayMode' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
'enum' => [
'Repeat',
'Shuffle',
'RepeatOne',
'Normal',
],
],
],
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OpenPlayMode\\": \\"Normal\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n Normal\\n \\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'PreviousAndNextControl' => [
'summary' => '上下首控制',
'path' => '/v1.0/ssp/PreviousAndNextControl',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenControlPlayingListRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Cmd' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'NEXT',
],
'IsFromDevice' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'ExtendInfo' => [
'type' => 'object',
'required' => false,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '550144364',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'ximalayav2',
],
'AlbumRawId' => [
'description' => '',
'type' => 'string',
'example' => '260744',
],
'AlbumName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Liked' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Singer' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640',
],
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'PlayMode' => [
'description' => '',
'type' => 'string',
'example' => 'Repeat',
],
'AudioLength' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '190',
],
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'LyricUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'story',
],
'Copyright' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ItemUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
],
'DefaultPlayOrder' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Pos' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n 550144364\\n ximalayav2\\n 260744\\n 晚安妈妈睡前故事\\n false\\n 晚安妈妈\\n 足球鞋赛车 晚安妈妈\\n \\n
http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\n false\\n \\n Repeat\\n 190\\n \\n story\\n 0\\n https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\n 1\\n VALID\\n 0\\n \\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'ProgressControl' => [
'summary' => '进度控制',
'path' => '/v1.0/ssp/ProgressControl',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenProgressControlRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '12',
],
'ExtendInfo' => [
'description' => '',
'type' => 'object',
'required' => false,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n success\\n 10002398812\\n true\\n","errorExample":""}]',
],
'SearchContent' => [
'summary' => '按照特定的搜索条件搜索',
'path' => '/v1.0/ssp/SearchContent',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Request',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Query' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'Cate' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'music',
],
'SubCate' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'singer',
],
'QueryAlbum' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'PageNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Alias' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Audition' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorTypes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ANCHOR',
],
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'https://a.jpg',
],
],
],
'Gender' => [
'description' => '',
'type' => 'string',
'example' => 'MALE',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '123123',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Charge' => [
'description' => '',
'type' => 'boolean',
'example' => 'fasle',
],
'CommCateId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80012017',
],
'Cover' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
],
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'HotScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '13597709',
],
'ItemType' => [
'description' => '',
'type' => 'string',
'example' => 'ALBUM',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'qingting',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Duration' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '180',
],
'AlbumId' => [
'description' => '',
'type' => 'string',
'example' => '13123',
],
'Lyric' => [
'description' => '',
'type' => 'string',
'example' => 'http://a1231.lrc',
],
'OrderIndex' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'Styles' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '1231',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": true,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"13123\\",\\n \\"Lyric\\": \\"http://a1231.lrc\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Styles\\": [\\n \\"1231\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n \\n 超能狂少在都市\\n false\\n \\n ANCHOR\\n \\n false\\n
https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n https://a.jpg\\n \\n MALE\\n 123123\\n qingting\\n 13597709\\n 播音呆瓜小贼\\n 播音呆瓜小贼\\n true\\n \\n audio\\n false\\n 80012017\\n \\n false\\n
http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\n \\n 10\\n 13597709\\n ALBUM\\n qingting\\n 超能狂少在都市\\n VALID\\n 180\\n \\n","errorExample":""}]',
],
'CloudPlayer' => [
'summary' => '云播放器:对外',
'path' => '/v1.0/ssp/cloud/player',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1234',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
'enum' => [],
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'UNION_ID',
'OPEN_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1234',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
'required' => true,
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'KG' => '',
],
'example' => 'KG',
],
],
[
'name' => 'SongIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
'required' => true,
'maxItems' => 200,
'minItems' => 1,
],
],
[
'name' => 'CurPlayIndex',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
'maximum' => '200',
'minimum' => '1',
],
],
[
'name' => 'PlayMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'Shuffle' => '',
'RepeatOne' => '',
'Repeat' => '',
'Normal' => '',
],
'example' => 'Normal',
],
],
[
'name' => 'SongId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'B7D82DB0-DD59-5756-AC62-871C9D7DBC36',
],
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7D82DB0-DD59-5756-AC62-871C9D7DBC36\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true\\n}","type":"json"}]',
],
'MobileRecommend' => [
'summary' => '移动轻纳管',
'path' => '/v1.0/ssp/mobile/recommend/music',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1414895629783187053',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1414895629783187053',
'enum' => [],
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'UNION_ID',
'OPEN_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
'required' => true,
],
],
[
'name' => 'BotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '10',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'STYLE' => '',
'DAILY_REC' => '',
'HOT' => '',
],
'example' => 'DAILY_REC',
],
],
[
'name' => 'Style',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'钢琴' => '',
'抖音' => '',
'欢快' => '',
'轻音乐' => '',
'流行' => '',
'DJ' => 'DJ',
],
'example' => '',
],
],
[
'name' => 'Count',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '6',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '5C5809B4-F465-52E0-9A8B-61396F9E593B',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'KG',
],
'RawId' => [
'description' => '',
'type' => 'string',
'example' => '550144364',
],
'Cover' => [
'description' => '',
'type' => 'string',
'example' => 'http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg',
],
'Authors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5809B4-F465-52E0-9A8B-61396F9E593B\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"KG\\",\\n \\"RawId\\": \\"550144364\\",\\n \\"Cover\\": \\"http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg\\",\\n \\"Authors\\": [\\n \\"[\\\\\\"周杰伦\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"稻香\\"\\n }\\n ]\\n}","type":"json"}]',
],
'AddSub' => [
'summary' => '新增订阅',
'path' => '/v1.0/ssp/addSub',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AddSubscriptionInfoRequest',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '订阅专辑request',
'description' => '',
'type' => 'object',
'properties' => [
'DeviceId' => [
'title' => '设备ID',
'type' => 'string',
'docRequired' => true,
'example' => '5874DBCCA3038FAA1A70A8060F07F26D',
],
'UserId' => [
'title' => '用户ID',
'type' => 'string',
'docRequired' => true,
'example' => '1152893538998276761',
],
'ScheduleInfo' => [
'title' => '定时信息',
'description' => '',
'type' => 'object',
'properties' => [
'DaysOfWeek' => [
'title' => '设置按周提醒的具体日期,取值范围为:1~7',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '7',
'minimum' => '1',
'example' => '1,3,5,7,6',
'enum' => [
'1',
'2',
'3',
'4',
'5',
'6',
'7',
],
],
'required' => true,
'docRequired' => true,
'maxItems' => 7,
'minItems' => 1,
],
'Hour' => [
'title' => '提醒触发的时间时钟数,0~23',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '23',
'minimum' => '0',
'example' => '1',
],
'Minute' => [
'title' => '提醒触发的分钟,0~59',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '59',
'minimum' => '0',
'example' => '23',
],
],
'required' => true,
'docRequired' => true,
],
'AlbumId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '51999575',
],
'PlayMode' => [
'title' => '播放模式(目前只支持sequence)',
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sequence',
],
'DailyStudyCnt' => [
'title' => '每天学习数量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'type' => 'string',
'required' => false,
'example' => '123',
'enum' => [],
],
'IdType' => [
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'type' => 'string',
'required' => false,
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'type' => 'string',
'required' => false,
'example' => '123',
'enum' => [],
],
'IdType' => [
'type' => 'string',
'required' => false,
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'type' => 'string',
'required' => false,
'example' => '123',
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
],
'Result' => [
'title' => '结果',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '订阅专辑记录ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '81',
],
'DeviceId' => [
'title' => '设备ID',
'description' => '',
'type' => 'string',
'example' => '5874DBCCA3038FAA1A70A8060F07F26D',
],
'UserId' => [
'title' => '用户ID',
'description' => '',
'type' => 'string',
'example' => '1152893538998276761',
],
'ScheduleInfo' => [
'title' => '定时信息',
'description' => '',
'type' => 'object',
'properties' => [
'DaysOfWeek' => [
'title' => '提醒触发的周期',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
'Hour' => [
'title' => '提醒触发的小时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'Minute' => [
'title' => '提醒触发的分钟',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '23',
],
],
],
'AlbumId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'example' => '51999575',
],
'PlayMode' => [
'title' => '播放模式',
'description' => '',
'type' => 'string',
'example' => 'sequence',
],
'DailyStudyCnt' => [
'title' => '每天学习数量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
'Message' => [
'title' => '附加信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => 'B99D27ED-4E12-1414-9FDE-599C57C4B204',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Result\\": {\\n \\"Id\\": 81,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": \\"1152893538998276761\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B99D27ED-4E12-1414-9FDE-599C57C4B204\\"\\n}","type":"json"}]',
],
'DeleteSub' => [
'summary' => '删除订阅',
'path' => '/v1.0/ssp/deleteSub',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SubId',
'in' => 'query',
'schema' => [
'title' => '订阅专辑记录ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '81',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '附加信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'title' => '返回结果',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '0AA6C15C-FD61-1E32-9881-480CC6F35A70',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0AA6C15C-FD61-1E32-9881-480CC6F35A70\\"\\n}","type":"json"}]',
],
'ListAlbumIsAdded' => [
'summary' => '专辑是否被订阅',
'path' => '/v1.0/ssp/listAlbumIsAdded',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AlbumIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '专辑idList',
'description' => '',
'type' => 'array',
'items' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '51999575',
],
'required' => true,
'docRequired' => true,
'minItems' => 1,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => false,
],
'EncodeKey' => [
'type' => 'string',
'required' => false,
],
'IdType' => [
'type' => 'string',
'required' => false,
],
'Id' => [
'type' => 'string',
'required' => false,
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => false,
],
'EncodeKey' => [
'type' => 'string',
'required' => false,
],
'IdType' => [
'type' => 'string',
'required' => false,
],
'Id' => [
'type' => 'string',
'required' => false,
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => 'BCC85E69-5DA6-197E-A8C1-8A1B19CF781B',
],
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '附加信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'title' => '结果',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AlbumId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'example' => '51999575',
],
'IsAdded' => [
'title' => '是否被订阅',
'description' => '',
'type' => 'string',
'example' => 'false',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'IdempotentParameterMismatch',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCC85E69-5DA6-197E-A8C1-8A1B19CF781B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"IsAdded\\": \\"false\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListSub' => [
'summary' => '订阅列表',
'path' => '/v1.0/ssp/listSub',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Page',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '分页参数',
'description' => '',
'type' => 'object',
'properties' => [
'PageNum' => [
'title' => '第几页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
'PageSize' => [
'title' => '每页多少条',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'type' => 'string',
'required' => true,
'example' => 'UNION_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '附加信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Result' => [
'title' => '结果',
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'title' => '共计多少数据',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'TotalPageCount' => [
'title' => '共计多少页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'HasNext' => [
'title' => '是否有下一页',
'description' => '',
'type' => 'boolean',
'default' => 'false',
],
'DataList' => [
'title' => '订阅列表',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => '订阅记录ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'DeviceId' => [
'title' => '设备ID',
'description' => '',
'type' => 'string',
'example' => '5874DBCCA3038FAA1A70A8060F07F26D',
],
'UserId' => [
'title' => '用户ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1152893538998276761',
],
'ScheduleInfo' => [
'title' => '定时信息',
'description' => '',
'type' => 'object',
'properties' => [
'DaysOfWeek' => [
'title' => '触发周期',
'description' => '',
'type' => 'array',
'items' => [
'title' => '',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'maxItems' => 7,
'minItems' => 1,
],
'Hour' => [
'title' => '触发小时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'Minute' => [
'title' => '触发分钟',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '23',
],
],
],
'AlbumId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'example' => '51999575',
],
'PlayMode' => [
'title' => '播放模式',
'description' => '',
'type' => 'string',
'example' => 'sequence',
],
'DailyStudyCnt' => [
'title' => '每天学习数量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'CoverUrl' => [
'title' => '专辑封面',
'description' => '',
'type' => 'string',
'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg',
],
'Title' => [
'title' => '专辑标题',
'description' => '',
'type' => 'string',
'example' => '小科学家探索',
],
],
],
],
],
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '0D0C09C2-ADC1-198B-964D-24F4FAD967DB',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": true,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": 1152893538998276700,\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2,\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"Title\\": \\"小科学家探索\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0D0C09C2-ADC1-198B-964D-24F4FAD967DB\\"\\n}","type":"json"}]',
],
'ListSubAlbum' => [
'summary' => '订阅专辑元数据列表',
'path' => '/v1.0/ssp/listSubAlbum',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'QuerySubscriptionAlbumRequest',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => 'request',
'description' => 'request',
'type' => 'object',
'properties' => [
'CategoryId' => [
'title' => '分类ID',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '80011',
],
'AlbumId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '4476001',
],
'Title' => [
'title' => '专辑标题',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '睡前故事',
],
'Page' => [
'title' => '分页参数',
'description' => '',
'type' => 'object',
'properties' => [
'PageNum' => [
'title' => '第几页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
'PageSize' => [
'title' => '每页多少条',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
'required' => true,
'docRequired' => true,
],
'DeviceId' => [
'title' => '设备ID',
'type' => 'string',
'docRequired' => true,
'example' => '5874DBCCA3038FAA1A70A8060F07F26D',
],
'UserId' => [
'title' => '用户ID',
'type' => 'string',
'docRequired' => true,
'example' => '1152893538998276761',
],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => false,
],
'EncodeKey' => [
'type' => 'string',
'required' => false,
],
'IdType' => [
'type' => 'string',
'required' => false,
],
'Id' => [
'type' => 'string',
'required' => false,
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户信息',
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'type' => 'string',
'required' => false,
],
'EncodeKey' => [
'type' => 'string',
'required' => false,
],
'IdType' => [
'type' => 'string',
'required' => false,
],
'Id' => [
'type' => 'string',
'required' => false,
],
'OrganizationId' => [
'type' => 'string',
'required' => false,
],
],
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '附加信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '结果',
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'title' => '共计多少条',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TotalPageCount' => [
'title' => '共计多少页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'HasNext' => [
'title' => '是否有下一页',
'description' => '',
'type' => 'boolean',
],
'DataList' => [
'title' => '专辑List',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => '记录ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CategoryId' => [
'title' => '专辑分类ID',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '80011',
],
'AlbumId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'example' => '4476001',
],
'Title' => [
'title' => '专辑标题',
'description' => '',
'type' => 'string',
'example' => '睡前故事',
],
'CoverUrl' => [
'title' => '专辑封面',
'description' => '',
'type' => 'string',
'example' => 'https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg',
],
'ScheduleInfo' => [
'title' => '定时信息',
'description' => '',
'type' => 'object',
'properties' => [
'DaysOfWeek' => [
'title' => '触发周期',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
'Hour' => [
'title' => '触发小时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'Minute' => [
'title' => '触发分钟',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '23',
],
'ScheduleId' => [
'title' => '定时任务ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
],
],
],
'TotalEpisode' => [
'title' => '共多少集',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '23',
],
'Sequence' => [
'title' => '排序',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'IsAdded' => [
'title' => '是否已订阅',
'description' => '',
'type' => 'boolean',
],
],
],
],
],
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => 'CB13B8D7-37FB-1B3E-8EB9-65BB413267E1',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": true,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"CategoryId\\": 80011,\\n \\"AlbumId\\": \\"4476001\\",\\n \\"Title\\": \\"睡前故事\\",\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23,\\n \\"ScheduleId\\": 0\\n },\\n \\"TotalEpisode\\": 23,\\n \\"Sequence\\": 1,\\n \\"IsAdded\\": true\\n }\\n ]\\n },\\n \\"RequestId\\": \\"CB13B8D7-37FB-1B3E-8EB9-65BB413267E1\\"\\n}","type":"json"}]',
],
'ListSubscriptionAlbumCategory' => [
'summary' => '内容订阅元数据分类',
'path' => '/v1.0/ssp/listSubscriptionAlbumCategory',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'CategoryName',
'in' => 'query',
'schema' => [
'title' => '分类名称',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '儿歌',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'title' => '附加信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '分类List',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CategoryId' => [
'title' => '分类ID',
'description' => '',
'type' => 'string',
'example' => '80011',
],
'CategoryName' => [
'title' => '分类名称',
'description' => '',
'type' => 'string',
'example' => '儿童',
],
],
],
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '60E7A523-9766-1D07-87A2-6E587420C59B',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'IdempotentParameterMismatch',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CategoryId\\": \\"80011\\",\\n \\"CategoryName\\": \\"儿童\\"\\n }\\n ],\\n \\"RequestId\\": \\"60E7A523-9766-1D07-87A2-6E587420C59B\\"\\n}","type":"json"}]',
],
'GetAlbumDetailById' => [
'summary' => '获取专辑数据',
'path' => '/v1.0/ssp/getAlbumDetailById',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AlbumId',
'in' => 'query',
'schema' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '51999575',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '附加信息',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Code' => [
'title' => '状态码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '专辑内容',
'description' => '',
'type' => 'object',
'properties' => [
'AlbumId' => [
'title' => '专辑ID',
'description' => '',
'type' => 'string',
'example' => '51999575',
],
'AlbumTitle' => [
'title' => '专辑标题',
'description' => '',
'type' => 'string',
'example' => '小科学家探索',
],
'AlbumDescription' => [
'title' => '专辑描述',
'description' => '',
'type' => 'string',
'example' => '每次一个百科知识或者故事\\n丰富孩子的视野,拓展眼界和知识面,培养和孩子的探究能力和好奇心\\n\\n',
],
'AlbumCoverUrl' => [
'title' => '专辑封面',
'description' => '',
'type' => 'string',
'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg',
],
'AlbumContentList' => [
'title' => '专辑内容List',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => '专辑内容ID',
'description' => '',
'type' => 'string',
'example' => '468009044',
],
'Title' => [
'title' => '专辑内容标题',
'description' => '',
'type' => 'string',
'example' => '001为什么肚子饿时会咕咕叫',
],
'Duration' => [
'title' => '专辑内容时长',
'description' => '',
'type' => 'string',
'example' => '3分24秒',
],
'OrderIndex' => [
'title' => '专辑内容排序',
'description' => '',
'type' => 'string',
'example' => '1000',
],
],
],
],
],
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => 'A0B7CACD-485B-14E2-854F-39EACB09E45B',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IdempotentParameterMismatch',
'errorMessage' => 'IdempotentParameterMismatch',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"AlbumTitle\\": \\"小科学家探索\\",\\n \\"AlbumDescription\\": \\"每次一个百科知识或者故事\\\\\\\\n丰富孩子的视野,拓展眼界和知识面,培养和孩子的探究能力和好奇心\\\\\\\\n\\\\\\\\n\\",\\n \\"AlbumCoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"AlbumContentList\\": [\\n {\\n \\"Id\\": \\"468009044\\",\\n \\"Title\\": \\"001为什么肚子饿时会咕咕叫\\",\\n \\"Duration\\": \\"3分24秒\\",\\n \\"OrderIndex\\": \\"1000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A0B7CACD-485B-14E2-854F-39EACB09E45B\\"\\n}","type":"json"}]',
],
'GetUnreadMessageCount' => [
'summary' => '查询未读留言数量',
'path' => '/v1.0/ssp/getUnreadMessageCount',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'SUCCESS',
],
'Result' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"用户信息不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n 用户信息不存在\\n SUCCESS\\n 10\\n","errorExample":""}]',
],
'ListUserMessage' => [
'summary' => '获取留言列表',
'path' => '/v1.0/ssp/listUserMessage',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'BeforeTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2022-07-27 14:06:55.984',
],
],
[
'name' => 'limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'SUCCESS',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '',
'type' => 'string',
'example' => '123456',
],
'GmtCreate' => [
'description' => '',
'type' => 'string',
'example' => '2022-07-27 14:06:27.000',
],
'Status' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'app',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'audio',
],
'Content' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Url' => [
'description' => '',
'type' => 'string',
'example' => 'http://xx',
],
'SourceUuid' => [
'description' => '',
'type' => 'string',
'example' => 'AF188**065EE4B**DD68CE**951D84D4',
],
'DeviceName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Pic' => [
'description' => '',
'type' => 'string',
'example' => 'http://xx',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"123456\\",\\n \\"GmtCreate\\": \\"2022-07-27 14:06:27.000\\",\\n \\"Status\\": 0,\\n \\"Source\\": \\"app\\",\\n \\"Type\\": \\"audio\\",\\n \\"Content\\": \\"哈哈哈\\",\\n \\"Url\\": \\"http://xx\\",\\n \\"SourceUuid\\": \\"AF188**065EE4B**DD68CE**951D84D4\\",\\n \\"DeviceName\\": \\"卧室的小芳\\",\\n \\"Pic\\": \\"http://xx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 外部userId映射关系不存在\\n SUCCESS\\n \\n 123456\\n 2022-07-27 14:06:27.000\\n 0\\n app\\n audio\\n 哈哈哈\\n http://xx\\n AF188**065EE4B**DD68CE**951D84D4\\n 卧室的小芳\\n http://xx\\n \\n","errorExample":""}]',
],
'ReadMessage' => [
'summary' => '读取留言',
'path' => '/v1.0/ssp/readMessage',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123L',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12345',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'SUCCESS',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 外部userId映射关系不存在\\n SUCCESS\\n true\\n","errorExample":""}]',
],
'SendMessage' => [
'summary' => '发送留言',
'path' => '/v1.0/ssp/sendMessage',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Url',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'http://xx',
],
],
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
'enum' => [
'PROJECT_ID',
],
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123L',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123L',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'Message' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'SUCCESS',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 外部userId映射关系不存在\\n SUCCESS\\n true\\n","errorExample":""}]',
],
'CreateAlarm' => [
'summary' => '创建闹钟',
'path' => '/v1.0/ssp/createAlarm',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'ScheduleInfo' => [
'title' => '调度信息',
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '调度类型/循环类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ONCE',
'enum' => [
'ONCE',
'WEEKLY',
'STATUTORY_WORKING_DAY',
],
],
'Once' => [
'title' => '单次',
'description' => '',
'type' => 'object',
'properties' => [
'Year' => [
'title' => '触发时间:年',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2022',
],
'Month' => [
'title' => '触发时间:月',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '8',
],
'Day' => [
'title' => '触发时间:日',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
'Weekly' => [
'title' => '周循环',
'description' => '',
'type' => 'object',
'properties' => [
'DaysOfWeek' => [
'title' => '周几触发集合',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'required' => false,
],
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
'StatutoryWorkingDay' => [
'title' => '法定工作日',
'description' => '',
'type' => 'object',
'properties' => [
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
],
'required' => true,
],
'MusicInfo' => [
'title' => '音乐信息',
'description' => '',
'type' => 'object',
'properties' => [
'MusicType' => [
'title' => '音乐类别id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'MusicTypeName' => [
'title' => '音乐类别名称',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
'MusicId' => [
'title' => '音乐id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'MusicName' => [
'title' => '音乐名称',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
'MusicUrl' => [
'title' => '音乐url',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'http://xx',
],
],
'required' => true,
],
'Volume' => [
'title' => '音乐信息',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '40',
'default' => '40',
],
'RequestId' => [
'type' => 'string',
'required' => true,
],
'UserId' => [
'type' => 'string',
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方',
'type' => 'string',
'required' => true,
],
'DeviceId' => [
'type' => 'string',
'required' => true,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => '',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '43***28C-A810-5***-8747-EC226A086881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n xx为空\\n 1234567\\n 43***28C-A810-5***-8747-EC226A086881\\n","errorExample":""}]',
],
'DeleteAlarms' => [
'summary' => '闹钟批量删除',
'path' => '/v1.0/ssp/deleteAlarms',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'required' => true,
],
'UserId' => [
'type' => 'string',
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方',
'type' => 'string',
'required' => true,
],
'DeviceId' => [
'type' => 'string',
'required' => true,
],
'AlarmIds' => [
'title' => '待删除闹钟',
'description' => '',
'type' => 'array',
'format' => 'int64',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1234567',
],
'required' => true,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '43***28C-A810-5***-8747-EC226A086881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"闹钟id为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 闹钟id为空\\n true\\n 43***28C-A810-5***-8747-EC226A086881\\n","errorExample":""}]',
],
'GetAlarm' => [
'summary' => '获取单个闹钟',
'path' => '/v1.0/ssp/getAlarm',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'required' => true,
],
'UserId' => [
'type' => 'string',
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方',
'type' => 'string',
'required' => true,
],
'DeviceId' => [
'type' => 'string',
'required' => true,
],
'AlarmId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'title' => '模型数据',
'description' => '',
'type' => 'object',
'properties' => [
'AlarmId' => [
'title' => '闹钟id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'ScheduleTypeDesc' => [
'title' => '循环类型描述',
'description' => '',
'type' => 'string',
'example' => '',
],
'TriggerDateDesc' => [
'title' => '触发日期描述(单次)',
'description' => '',
'type' => 'string',
'example' => '2022-07-29',
],
'TriggerTimeDesc' => [
'title' => '触发时间描述',
'description' => '',
'type' => 'string',
'example' => '10:00',
],
'ScheduleInfo' => [
'title' => '调度信息',
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '循环类型',
'description' => '',
'type' => 'string',
'example' => 'ONCE',
'enum' => [
'ONCE',
'WEEKLY',
'STATUTORY_WORKING_DAY',
],
],
'Once' => [
'title' => '单次',
'description' => '',
'type' => 'object',
'properties' => [
'Year' => [
'title' => '触发时间:年',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2022',
],
'Month' => [
'title' => '触发时间:月',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
],
'Day' => [
'title' => '触发时间:日',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '29',
],
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'StatutoryWorkingDay' => [
'title' => '法定工作日',
'description' => '',
'type' => 'object',
'properties' => [
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'Weekly' => [
'title' => '周循环',
'description' => '',
'type' => 'object',
'properties' => [
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分'."\n",
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DaysOfWeek' => [
'title' => '周几触发集合',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
'MusicInfo' => [
'title' => '音乐信息',
'description' => '',
'type' => 'object',
'properties' => [
'MusicType' => [
'title' => '音乐类别id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MusicTypeName' => [
'title' => '音乐类别名称',
'description' => '',
'type' => 'string',
'example' => '',
],
'MusicId' => [
'title' => '音乐id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MusicName' => [
'title' => '音乐名称',
'description' => '',
'type' => 'string',
'example' => '',
],
'MusicUrl' => [
'title' => '音乐url',
'description' => '',
'type' => 'string',
'example' => 'http://xx',
],
],
],
'Volume' => [
'title' => '音量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '40',
],
'Status' => [
'title' => '状态 0 正常 1 删除 2 关闭',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '43***28C-A810-5***-8747-EC226A086881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"id为空\\",\\n \\"Result\\": {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 123454321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n id为空\\n \\n 1234567\\n 123454321\\n AF18***065EE4BD***68CEFD9***84D4\\n 单次\\n 2022-07-29\\n 10:00\\n \\n ONCE\\n \\n 2022\\n 7\\n 29\\n 10\\n 0\\n \\n \\n 10\\n 0\\n \\n \\n 10\\n 0\\n 1\\n \\n \\n \\n 1\\n xx音乐\\n 1\\n xx铃声\\n http://xx\\n \\n 40\\n 0\\n \\n 43***28C-A810-5***-8747-EC226A086881\\n","errorExample":""}]',
],
'ListAlarms' => [
'summary' => '查询闹钟列表',
'path' => '/v1.0/ssp/listAlarm',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'CurrentPage' => [
'title' => '当前页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
'PageSize' => [
'title' => '每页条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '10',
],
'RequestId' => [
'type' => 'string',
'required' => true,
],
'UserId' => [
'type' => 'string',
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方',
'type' => 'string',
'required' => true,
],
'DeviceId' => [
'type' => 'string',
'required' => true,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'title' => '总条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'PageCount' => [
'title' => '总页数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageSize' => [
'title' => '每页条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'CurrentPage' => [
'title' => '当前页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Model' => [
'title' => '闹钟列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AlarmId' => [
'title' => '闹钟id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'ScheduleTypeDesc' => [
'title' => '循环类型描述',
'description' => '',
'type' => 'string',
'example' => '',
],
'TriggerDateDesc' => [
'title' => '触发日期描述(单次)',
'description' => '',
'type' => 'string',
'example' => '2022-07-29',
],
'TriggerTimeDesc' => [
'title' => '触发时间描述',
'description' => '',
'type' => 'string',
'example' => '10:00',
],
'ScheduleInfo' => [
'title' => '调度信息',
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '循环类型',
'description' => '',
'type' => 'string',
'example' => 'ONCE',
'enum' => [
'ONCE',
'WEEKLY',
'STATUTORY_WORKING_DAY',
],
],
'Once' => [
'title' => '单次',
'description' => '',
'type' => 'object',
'properties' => [
'Year' => [
'title' => '触发时间:年',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2022',
],
'Month' => [
'title' => '触发时间:月',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
],
'Day' => [
'title' => '触发时间:日',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '29',
],
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'Weekly' => [
'title' => '周循环',
'description' => '',
'type' => 'object',
'properties' => [
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DaysOfWeek' => [
'title' => '周几触发集合',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'StatutoryWorkingDay' => [
'title' => '法定工作日',
'description' => '',
'type' => 'object',
'properties' => [
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
],
'MusicInfo' => [
'title' => '音乐信息',
'description' => '',
'type' => 'object',
'properties' => [
'MusicType' => [
'title' => '音乐类别id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MusicTypeName' => [
'title' => '音乐类别名称',
'description' => '',
'type' => 'string',
'example' => '',
],
'MusicId' => [
'title' => '音乐id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MusicName' => [
'title' => '音乐名称',
'description' => '',
'type' => 'string',
'example' => '',
],
'MusicUrl' => [
'title' => '音乐url',
'description' => '',
'type' => 'string',
'example' => 'http://xx',
],
],
],
'Volume' => [
'title' => '音量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '40',
],
'Status' => [
'title' => '状态 0 正常 1 删除 2 关闭',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '43***28C-A810-5***-8747-EC226A086881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 1234321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 设备账号未关联\\n \\n 100\\n 10\\n 10\\n 1\\n \\n 1234567\\n 1234321\\n AF18***065EE4BD***68CEFD9***84D4\\n 单次\\n 2022-07-29\\n 10:00\\n \\n ONCE\\n \\n 2022\\n 7\\n 29\\n 10\\n 0\\n \\n \\n 10\\n 0\\n 1\\n \\n \\n 10\\n 0\\n \\n \\n \\n 1\\n xx音乐\\n 1\\n xx铃声\\n http://xx\\n \\n 40\\n 0\\n \\n \\n 43***28C-A810-5***-8747-EC226A086881\\n","errorExample":""}]',
],
'ListMusic' => [
'summary' => '基于音乐类型查询铃声列表(分页)',
'path' => '/v1.0/ssp/listMusic',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'required' => true,
],
'UserId' => [
'type' => 'string',
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方',
'type' => 'string',
'required' => true,
],
'DeviceId' => [
'type' => 'string',
'required' => true,
],
'MusicType' => [
'title' => '音乐类别id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'MusicTypeName' => [
'title' => '音乐类别名称',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
'MusicId' => [
'title' => '音乐id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'MusicName' => [
'title' => '音乐名称',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'CurrentPage' => [
'title' => '当前页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
'PageSize' => [
'title' => '每页条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '10',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'title' => '总条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'PageCount' => [
'title' => '总页数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageSize' => [
'title' => '每页条数',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'CurrentPage' => [
'title' => '当前页',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Model' => [
'title' => '铃声列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'MusicType' => [
'title' => '音乐类别id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MusicTypeName' => [
'title' => '音乐类别名称',
'description' => '',
'type' => 'string',
'example' => 'xx',
],
'MusicId' => [
'title' => '音乐id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MusicName' => [
'title' => '音乐名称',
'description' => '',
'type' => 'string',
'example' => 'xx',
],
'MusicUrl' => [
'title' => '音乐url',
'description' => '',
'type' => 'string',
'example' => 'http://xx',
],
],
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '43***28C-A810-5***-8747-EC226A086881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"音乐类型名称为空\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 音乐类型名称为空\\n \\n 100\\n 10\\n 10\\n 1\\n \\n 1\\n xx\\n 1\\n xx\\n http://xx\\n \\n \\n 43***28C-A810-5***-8747-EC226A086881\\n","errorExample":""}]',
],
'QueryMusicType' => [
'summary' => '获取闹钟音乐类型列表',
'path' => '/v1.0/ssp/queryMusicType',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
'required' => true,
],
'UserId' => [
'type' => 'string',
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方',
'type' => 'string',
'required' => true,
],
'DeviceId' => [
'type' => 'string',
'required' => true,
],
],
'required' => false,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'MusicType' => [
'title' => '铃声类型id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MusicTypeName' => [
'title' => 'musicTypeName',
'description' => '',
'type' => 'string',
'example' => 'xx',
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '43***28C-A810-5***-8747-EC226A086881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\"\\n }\\n ],\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 设备账号未关联\\n \\n 1\\n xx\\n \\n 43***28C-A810-5***-8747-EC226A086881\\n","errorExample":""}]',
],
'UpdateAlarm' => [
'summary' => '更新闹钟',
'path' => '/v1.0/ssp/updateAlarm',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'ScheduleInfo' => [
'title' => '调度信息',
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '调度类型/循环类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'WEEKLY',
'enum' => [
'ONCE',
'WEEKLY',
'STATUTORY_WORKING_DAY',
],
],
'Once' => [
'title' => '单次',
'description' => '',
'type' => 'object',
'properties' => [
'Year' => [
'title' => '触发时间:年',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2022',
],
'Month' => [
'title' => '触发时间:月',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '8',
],
'Day' => [
'title' => '触发时间:日',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
'Weekly' => [
'title' => '周循环',
'description' => '',
'type' => 'object',
'properties' => [
'DaysOfWeek' => [
'title' => '周几触发集合',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'required' => false,
],
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
'StatutoryWorkingDay' => [
'title' => '法定工作日',
'description' => '',
'type' => 'object',
'properties' => [
'Hour' => [
'title' => '触发时间:时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'Minute' => [
'title' => '触发时间:分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
],
'required' => true,
],
'MusicInfo' => [
'title' => '音乐信息',
'description' => '',
'type' => 'object',
'properties' => [
'MusicType' => [
'title' => '音乐类别id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '12',
],
'MusicTypeName' => [
'title' => '音乐类别名称',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
'MusicId' => [
'title' => '音乐id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '2',
],
'MusicName' => [
'title' => '音乐名称',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
'MusicUrl' => [
'title' => '音乐url',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'http://music-url.mp3',
],
],
'required' => true,
],
'AlarmId' => [
'title' => '闹钟id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
'Volume' => [
'title' => '音量',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '40',
'default' => '40',
],
'RequestId' => [
'type' => 'string',
'required' => true,
],
'UserId' => [
'type' => 'string',
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方',
'type' => 'string',
'required' => true,
],
'DeviceId' => [
'type' => 'string',
'required' => true,
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'OPEN_ID',
'UNION_ID',
],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
'enum' => [
'PACKAGE_NAME',
'SKILL_ID',
],
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '43***28C-A810-5***-8747-EC226A086881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n xx为空\\n true\\n 43***28C-A810-5***-8747-EC226A086881\\n","errorExample":""}]',
],
'CreateScheduleTask' => [
'summary' => '创建定时任务',
'path' => '/v1.0/ssp/CreateScheduleTask',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'IdempotentId' => [
'title' => '幂等id',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
'DeviceId' => [
'title' => '设备id',
'type' => 'string',
],
'UserId' => [
'title' => '用户id',
'type' => 'string',
],
'RequestId' => [
'title' => '请求id',
'type' => 'string',
],
'ScheduleDTO' => [
'title' => '调度信息',
'description' => '',
'type' => 'object',
'properties' => [
'ScheduleType' => [
'title' => '调度类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ONCE',
'enum' => [
'ONCE',
'WEEKLY',
'STATUTORY_DAY',
],
],
'Once' => [
'title' => '单次调度配置',
'description' => '',
'type' => 'object',
'properties' => [
'Year' => [
'title' => '触发年',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2022',
],
'Month' => [
'title' => '触发月',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '7',
],
'Day' => [
'title' => '触发日',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '26',
],
'Hour' => [
'title' => '触发时',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
'Minute' => [
'title' => '触发分',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
'required' => false,
],
'Weekly' => [
'title' => '循环调度配置',
'description' => '',
'type' => 'object',
'properties' => [
'DaysOfWeek' => [
'title' => '触发星期,1-7分别代表周一到周日',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '7',
],
'required' => false,
],
'Hours' => [
'title' => '触发时',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
'required' => false,
],
'Minutes' => [
'title' => '触发分',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
'required' => false,
],
],
'required' => false,
],
'StatutoryWorkingDay' => [
'title' => '法定工作日调度配置',
'description' => '',
'type' => 'object',
'properties' => [
'Hours' => [
'title' => '触发时,可多选',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
'required' => false,
],
'Minutes' => [
'title' => '触发分,可多选',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
'required' => false,
],
],
'required' => false,
],
'ScheduleStartTime' => [
'title' => '调度开始时间',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1656318855000',
],
'ScheduleEndTime' => [
'title' => '调度结束时间',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1661589255000',
],
],
'required' => true,
],
'ActionDTOs' => [
'title' => '调度行动参数',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'customAction' => [
'description' => '',
'type' => 'object',
'required' => false,
'example' => '{"k1":"v1","k2":{"key":1}}',
],
],
'required' => false,
],
'required' => true,
],
'AccessKeyId' => [
'title' => '调用方ak',
'type' => 'string',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F7E2****B7C94',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 调用成功\\n 1234567\\n F7E2****B7C94\\n","errorExample":""}]',
],
'DeleteScheduleTask' => [
'summary' => '删除定时任务',
'path' => '/v1.0/ssp/DeleteScheduleTask',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '待删除的调度id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
'DeviceId' => [
'title' => '设备id',
'type' => 'string',
],
'RequestId' => [
'title' => '请求id',
'type' => 'string',
],
'UserId' => [
'title' => '用户id',
'type' => 'string',
],
'AccessKeyId' => [
'title' => '调用方ak',
'type' => 'string',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '错误码',
'description' => '',
'type' => 'string',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Result' => [
'title' => '删除结果',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => 'F7E2****B7C94',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 调用成功\\n true\\n F7E2****B7C94\\n","errorExample":""}]',
],
'GetScheduleTask' => [
'summary' => '查询定时任务',
'path' => '/v1.0/ssp/GetScheduleTask',
'methods' => [
'post',
],
'schemes' => [
'https',
'http',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '待查询的调度id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
'RequestId' => [
'title' => '请求id',
'type' => 'string',
'required' => false,
],
'DeviceId' => [
'title' => '设备id',
'type' => 'string',
'required' => false,
],
'UserId' => [
'title' => '用户id',
'type' => 'string',
'required' => false,
],
'AccessKeyId' => [
'title' => '调用方ak',
'type' => 'string',
],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '错误码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => 'F7E21065-6C21-1158-A2F9-AEFE5CAB7C94',
],
'Result' => [
'title' => '服务响应出参',
'description' => '',
'type' => 'object',
'properties' => [
'ScheduleId' => [
'title' => '调度id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'ScheduleType' => [
'title' => '调度类型',
'description' => '',
'type' => 'string',
'example' => 'ONCE',
'enum' => [
'ONCE',
'WEEKLY',
'STATUTORY_DAY',
],
],
'Cron' => [
'title' => '触发cron表达式',
'description' => '',
'type' => 'string',
'example' => '0 10 20 30 6 ? 2022',
],
'ScheduleStartTime' => [
'description' => '',
'type' => 'string',
'example' => '1656577473000',
],
'ScheduleEndTime' => [
'description' => '',
'type' => 'string',
'example' => '1659169473000',
],
'ActionTopicList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomAction' => [
'description' => '',
'type' => 'object',
'example' => '{"k1":"v1","k2":{"key":1}}',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"RequestId\\": \\"F7E21065-6C21-1158-A2F9-AEFE5CAB7C94\\",\\n \\"Result\\": {\\n \\"ScheduleId\\": 1234567,\\n \\"ScheduleType\\": \\"ONCE\\",\\n \\"Cron\\": \\"0 10 20 30 6 ? 2022\\",\\n \\"ScheduleStartTime\\": \\"1656577473000\\",\\n \\"ScheduleEndTime\\": \\"1659169473000\\",\\n \\"ActionTopicList\\": [\\n {\\n \\"CustomAction\\": {\\n \\"k1\\": \\"v1\\",\\n \\"k2\\": {\\n \\"key\\": 1\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 调用成功\\n F7E21065-6C21-1158-A2F9-AEFE5CAB7C94\\n \\n 362*****8C1\\n 1234567\\n ONCE\\n 0 10 20 30 6 ? 2022\\n 1656577473000\\n 1659169473000\\n \\n \\n","errorExample":""}]',
],
'GetWeather' => [
'summary' => '查询天气',
'path' => '/v1.0/ssp/GetWeather',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '服务请求入参',
'description' => '',
'type' => 'object',
'properties' => [
'DeviceId' => [
'title' => '设备id',
'type' => 'string',
'required' => false,
],
'UserId' => [
'title' => '用户id',
'type' => 'string',
'required' => false,
],
'RequestId' => [
'title' => '请求id',
'type' => 'string',
'required' => false,
],
'AccessKeyId' => [
'title' => '调用方ak',
'type' => 'string',
'required' => false,
],
],
'required' => false,
'docRequired' => false,
],
],
[
'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '用户标识(userOpenId或userUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HOFF****my7Iw=',
],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '设备标识(deviceOpenId或deviceUnionId)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DAFE****ce3ej=',
],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12**45',
],
'OrganizationId' => [
'title' => '组织ID,如果IdType为UNION_ID时必填',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1**2',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AmpResult',
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
'Message' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '',
],
'Code' => [
'title' => 'HttpCode',
'description' => 'HttpCode',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '模型数据',
'description' => '',
'type' => 'object',
'properties' => [
'CurrentMeteorology' => [
'title' => '当前天气',
'description' => '',
'type' => 'object',
'properties' => [
'Weather' => [
'title' => '白天天气',
'description' => '',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '天气编号: 形如:"000,100"',
'description' => '',
'type' => 'string',
'example' => '000',
],
'Name' => [
'title' => '天气名称描述: "晴(000),多云(100)"',
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
'Temperature' => [
'title' => '温度',
'description' => '',
'type' => 'object',
'properties' => [
'Current' => [
'title' => '当前温度气温值',
'description' => '',
'type' => 'string',
'example' => '36',
],
'CurrentDesc' => [
'title' => '当前温度气温值描述',
'description' => '',
'type' => 'string',
'example' => '',
],
'High' => [
'title' => '气温最高值',
'description' => '',
'type' => 'string',
'example' => '37',
],
'HighDesc' => [
'title' => '气温最高值描述',
'description' => '',
'type' => 'string',
'example' => '',
],
'Low' => [
'title' => '气温最低值',
'description' => '',
'type' => 'string',
'example' => '28',
],
'LowDesc' => [
'title' => '气温最低值描述',
'description' => '',
'type' => 'string',
'example' => '',
],
'Logical' => [
'title' => '带有逻辑的温度,逻辑如下:',
'description' => '',
'type' => 'string',
'example' => '41',
],
],
],
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F7E2****B7C94',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"调用成功\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"CurrentMeteorology\\": {\\n \\"Weather\\": {\\n \\"Code\\": \\"000\\",\\n \\"Name\\": \\"晴\\"\\n },\\n \\"Temperature\\": {\\n \\"Current\\": \\"36\\",\\n \\"CurrentDesc\\": \\"36度\\",\\n \\"High\\": \\"37\\",\\n \\"HighDesc\\": \\"37度\\",\\n \\"Low\\": \\"28\\",\\n \\"LowDesc\\": \\"28度\\",\\n \\"Logical\\": \\"41\\"\\n }\\n }\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 调用成功\\n 200\\n \\n \\n \\n 000\\n 晴\\n \\n \\n 36\\n 36度\\n 37\\n 37度\\n 28\\n 28度\\n 41\\n \\n \\n \\n F7E2****B7C94\\n","errorExample":""}]',
],
'CreatePlayingListOAuth2' => [
'summary' => '播放列表创建走OAuth2授权',
'path' => '/v1.0/ssp/CreatePlayingListOAuth2',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'OpenCreatePlayingListRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'PlayFrom' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'default',
],
'ContentType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'content',
],
'ContentList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12345',
],
'Source' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'xiami',
],
],
'required' => true,
],
'required' => true,
],
'Index' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
'NeedAlbumContinued' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PlayMode' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Repeat',
],
'ExtendInfo' => [
'description' => '',
'type' => 'object',
'required' => false,
],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'EncodeType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
],
'EncodeKey' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'IdType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
'enum' => [
'UNION_ID',
'OPEN_ID',
],
],
'Id' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
'OrganizationId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'title' => '调用返回码',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '',
'type' => 'object',
'properties' => [
'RawId' => [
'title' => '三方id',
'description' => '',
'type' => 'string',
'example' => '123123',
],
'Source' => [
'title' => '来源',
'description' => '',
'type' => 'string',
'example' => 'qignting',
],
'AlbumRawId' => [
'title' => '三方专辑id',
'description' => '',
'type' => 'string',
'example' => '260744',
],
'AlbumName' => [
'title' => '三方专辑名称',
'description' => '',
'type' => 'string',
'example' => '',
],
'Liked' => [
'title' => '是否收藏',
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Singer' => [
'title' => '作者',
'description' => '',
'type' => 'string',
'example' => '',
],
'Title' => [
'title' => '标题',
'description' => '',
'type' => 'string',
'example' => '',
],
'Cover' => [
'title' => '封面图片对象',
'description' => '',
'type' => 'object',
'properties' => [
'Img' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Large' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Mediam' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Medium' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'Small' => [
'description' => '',
'type' => 'string',
'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
],
'CanResize' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
],
],
'PlayMode' => [
'title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
'description' => '',
'type' => 'string',
'example' => 'Repeat',
],
'AudioLength' => [
'title' => '长度',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '190',
],
'Progress' => [
'title' => '歌曲播放进度',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '96.0',
],
'LyricUrl' => [
'title' => '歌词url',
'description' => '',
'type' => 'string',
'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
],
'Copyright' => [
'title' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'program',
],
'ItemUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
],
'DefaultPlayOrder' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Valid' => [
'description' => '',
'type' => 'string',
'example' => 'VALID',
],
'Pos' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'Message' => [
'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '10002398812',
],
'Success' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qignting\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 96,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"program\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 1\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'ThirdImmediateMsgPush' => [
'summary' => '三方即时信息数据变更事件推送',
'path' => '/v1.0/ssp/thirdImmediateMsgPush',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'title' => '用户id',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'userId',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'title' => '订单id',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'orderId',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'title' => '请求来源',
'type' => 'string',
'example' => 'source',
],
],
[
'name' => 'BizType',
'in' => 'query',
'schema' => [
'title' => '业务类型(FLIGHT:航班、TRAIN:火车)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FLIGHT',
],
],
[
'name' => 'TrafficChangeType',
'in' => 'query',
'schema' => [
'title' => '变动类型(TRAIN_ISSUED、FLIGHT_CHANGED)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'trafficChangeType',
],
],
[
'name' => 'TrafficChangeTypeDesc',
'in' => 'query',
'schema' => [
'title' => '变动类型描述(已出票、已改签)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'trafficChangeTypeDesc',
],
],
[
'name' => 'ChangeDetail',
'in' => 'query',
'schema' => [
'title' => '变动信息明细(变动数据json)',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'changeDetail',
],
],
[
'name' => 'TrafficJourneyIds',
'in' => 'query',
'schema' => [
'title' => '变更的行程id',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'trafficJourneyIds',
],
],
[
'name' => 'TrafficSubOrderIds',
'in' => 'query',
'schema' => [
'title' => '变更的火车申请单子订单id',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'trafficSubOrderIds',
],
],
[
'name' => 'PsgIds',
'in' => 'query',
'schema' => [
'title' => '变更的乘客id',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'psgIds',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'Success' => [
'title' => '调用是否成功',
'description' => '',
'type' => 'boolean',
],
'ErrorCode' => [
'title' => '错误码',
'description' => '',
'type' => 'string',
'example' => '500000000',
],
'ErrorMsg' => [
'title' => '错误信息',
'description' => '',
'type' => 'string',
'example' => '服务器内部异常',
],
'Model' => [
'title' => '推送结果',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B',
],
'Success' => [
'title' => '是否推送成功',
'description' => '',
'type' => 'boolean',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"500000000\\",\\n \\"ErrorMsg\\": \\"服务器内部异常\\",\\n \\"Model\\": {\\n \\"RequestId\\": \\"2DF6FEFE-3301-16DD-ABCC-968A9524920B\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'openapi.aligenie.com',
],
],
];