summaryrefslogtreecommitdiff
path: root/data/zh_cn/aligenie
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/aligenie
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/aligenie')
-rw-r--r--data/zh_cn/aligenie/aiso_1.0/api-docs.php92
-rw-r--r--data/zh_cn/aligenie/iap_1.0/api-docs.php4228
-rw-r--r--data/zh_cn/aligenie/ip_1.0/api-docs.php18195
-rw-r--r--data/zh_cn/aligenie/oauth2_1.0/api-docs.php795
-rw-r--r--data/zh_cn/aligenie/ssp_1.0/api-docs.php17844
5 files changed, 10863 insertions, 30291 deletions
diff --git a/data/zh_cn/aligenie/aiso_1.0/api-docs.php b/data/zh_cn/aligenie/aiso_1.0/api-docs.php
index f796054..c3e3069 100644
--- a/data/zh_cn/aligenie/aiso_1.0/api-docs.php
+++ b/data/zh_cn/aligenie/aiso_1.0/api-docs.php
@@ -1,18 +1,12 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'AliGenie',
- 'product' => 'AliGenie',
- 'version' => 'aiso_1.0',
- ],
+ 'info' => ['style' => 'AliGenie', 'product' => 'AliGenie', 'version' => 'aiso_1.0'],
'directories' => [
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'AppAuth',
- ],
+ 'children' => ['AppAuth'],
],
],
'components' => [
@@ -21,39 +15,26 @@
'apis' => [
'AppAuth' => [
'path' => '/v1.0/aiso/AppAuth',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AccessKey',
'in' => 'formData',
- 'schema' => [
- 'title' => 'ak',
- 'type' => 'string',
- ],
+ 'schema' => ['title' => 'ak', 'type' => 'string'],
],
[
'name' => 'AppId',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用id',
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '应用id', 'type' => 'string'],
],
],
'responses' => [
@@ -62,57 +43,25 @@
'title' => 'Result<AuthTokenDTO>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'Code' => ['type' => 'integer', 'format' => 'int32'],
'Result' => [
'type' => 'object',
'properties' => [
- 'AccessKey' => [
- 'title' => '应用凭证ak',
- 'type' => 'string',
- ],
- 'AccessToken' => [
- 'title' => '访问令牌',
- 'type' => 'string',
- ],
- 'RefreshToken' => [
- 'title' => '刷新令牌',
- 'type' => 'string',
- ],
- 'AccessTokenExpire' => [
- 'title' => '有效时间单位:s',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'RefreshTokenExpire' => [
- 'title' => '有效时间单位:s',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'AppId' => [
- 'title' => '应用id',
- 'type' => 'string',
- ],
- 'Uuid' => [
- 'title' => '分配到的sdk所处设备的uuid',
- 'type' => 'string',
- ],
+ 'AccessKey' => ['title' => '应用凭证ak', 'type' => 'string'],
+ 'AccessToken' => ['title' => '访问令牌', 'type' => 'string'],
+ 'RefreshToken' => ['title' => '刷新令牌', 'type' => 'string'],
+ 'AccessTokenExpire' => ['title' => '有效时间单位:s', 'type' => 'integer', 'format' => 'int64'],
+ 'RefreshTokenExpire' => ['title' => '有效时间单位:s', 'type' => 'integer', 'format' => 'int64'],
+ 'AppId' => ['title' => '应用id', 'type' => 'string'],
+ 'Uuid' => ['title' => '分配到的sdk所处设备的uuid', 'type' => 'string'],
],
],
- 'Message' => [
- 'type' => 'string',
- ],
+ 'Message' => ['type' => 'string'],
'ExtendInfo' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- ],
- ],
- 'RequestId' => [
- 'type' => 'string',
+ 'additionalProperties' => ['type' => 'any'],
],
+ 'RequestId' => ['type' => 'string'],
],
],
],
@@ -121,9 +70,6 @@
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'openapi.aligenie.com',
- ],
+ ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'openapi.aligenie.com'],
],
];
diff --git a/data/zh_cn/aligenie/iap_1.0/api-docs.php b/data/zh_cn/aligenie/iap_1.0/api-docs.php
index 56d11ac..b6f19ad 100644
--- a/data/zh_cn/aligenie/iap_1.0/api-docs.php
+++ b/data/zh_cn/aligenie/iap_1.0/api-docs.php
@@ -1,255 +1,173 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'AliGenie',
- 'product' => 'AliGenie',
- 'version' => 'iap_1.0',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'AliGenie', 'version' => 'iap_1.0'],
'directories' => [
[
- 'id' => 167271,
- 'title' => '应用商业化',
- 'type' => 'directory',
- 'children' => [
- 'GetBusAppConfig',
- 'AppUseTimeReport',
- 'PullCashier',
- 'VideoAppReport',
- 'GetAccountForApp',
- ],
- ],
- [
- 'id' => 95708,
- 'title' => '获取手机号',
+ 'children' => ['GetBusAppConfig', 'AppUseTimeReport', 'PullCashier', 'VideoAppReport', 'GetAccountForApp'],
'type' => 'directory',
- 'children' => [
- 'GetPhoneNumber',
- ],
+ 'title' => '应用商业化',
+ 'id' => 128276,
],
[
- 'id' => 95710,
- 'title' => '日程提醒',
+ 'children' => ['GetPhoneNumber'],
'type' => 'directory',
- 'children' => [
- 'CreateReminder',
- 'GetReminder',
- 'ListReminders',
- 'UpdateReminder',
- 'DeleteReminder',
- ],
+ 'title' => '获取手机号',
+ 'id' => 128282,
],
[
- 'id' => 95716,
- 'title' => '应用唤起',
+ 'children' => ['CreateReminder', 'GetReminder', 'ListReminders', 'UpdateReminder', 'DeleteReminder'],
'type' => 'directory',
- 'children' => [
- 'WakeUpApp',
- ],
+ 'title' => '日程提醒',
+ 'id' => 128284,
],
[
- 'id' => 95719,
- 'title' => '消息推送',
+ 'children' => ['WakeUpApp'],
'type' => 'directory',
- 'children' => [
- 'PushNotifications',
- 'SendNotifications',
- ],
+ 'title' => '应用唤起',
+ 'id' => 128290,
],
[
- 'id' => 263437,
- 'title' => '其他',
+ 'children' => ['PushNotifications', 'SendNotifications'],
'type' => 'directory',
- 'children' => [
- 'CheckThirdRightSendPlan',
- 'CallBackThirdRightSendPlan',
- ],
+ 'title' => '消息推送',
+ 'id' => 128292,
],
[
- 'id' => 0,
- 'title' => '其它',
+ 'children' => ['CheckThirdRightSendPlan', 'CallBackThirdRightSendPlan'],
'type' => 'directory',
- 'children' => [
- 'ThirdImmediateMsgPush',
- ],
+ 'title' => '其他',
+ 'id' => 128295,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetBusAppConfig' => [
- 'summary' => '获取应用配置。',
- 'path' => '/v1.0/iap/app/config/get',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AppUseTimeReport' => [
+ 'summary' => '用于在天猫精灵设备上上报应用的使用时长。',
+ 'path' => '/v1.0/iap/vip/use/time/report',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '业务参数',
'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'SubjectId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'DeviceId' => [
- 'type' => 'string',
- ],
- 'phone' => [
- 'title' => '手机号',
- 'description' => '手机号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '136****1111',
- ],
- 'originUuid' => [
- 'title' => '明文uuid',
- 'description' => '明文uuid',
- 'type' => 'string',
- 'required' => false,
- 'example' => '731D5F********DC3B',
- ],
+ 'UserId' => ['title' => '用户id', 'type' => 'string', 'required' => true],
+ 'DeviceId' => ['title' => '设备di', 'type' => 'string', 'required' => false],
+ 'SubjectId' => ['title' => '应用id', 'type' => 'string', 'required' => true],
+ 'Action' => ['title' => '操作', 'description' => '动作项'."\n"
+ ."\n"
+ .'- start表示开始'."\n"
+ .'- end表示结束', 'type' => 'string', 'required' => true, 'example' => 'start'],
+ 'StepCode' => ['title' => '步进码', 'description' => '步进码,开始与结束的动作要唯一匹配。', 'type' => 'string', 'required' => true, 'example' => '2'],
+ 'ResourceId' => ['title' => '资源id', 'description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => '1'],
+ 'ResourceType' => ['title' => 'resourceType', 'description' => '资源类型:'."\n"
+ ."\n"
+ .'- 0表示游戏'."\n"
+ .'- 1表示音频'."\n"
+ .'- 2表示视频', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ 'IsPrivilege' => ['title' => '是否会员专享权益:1-是 0-否', 'description' => '是否会员专享权益:'."\n"
+ ."\n"
+ .'- 1表示是 '."\n"
+ .'- 0表示否', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ 'VipType' => ['title' => '会员类型', 'description' => '会员类型:'."\n"
+ ."\n"
+ .'- 0表示猫精会员'."\n"
+ .'- 1表示三方自有会员', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ 'originUuid' => ['description' => '明文uuid', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B'],
],
'required' => false,
],
],
[
'name' => 'UserInfo',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(UserOpenId或UserUnionId)',
- 'description' => '用户标识(UserOpenId或UserUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型 '."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SKILL_ID',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
+ 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型。',
'type' => 'string',
'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型 '."\n"
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SKILL_ID',
- 'enum' => [
- 'SKILL_ID',
- 'PACKAGE_NAME',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
+ 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型。',
'type' => 'string',
'required' => false,
- 'example' => '1**2',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => false,
],
@@ -262,48 +180,168 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RetCode' => [
- 'title' => '返回的错误码,0表示成功。',
- 'description' => '返回的错误码,0表示成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => ' 0',
- ],
- 'RetMsg' => [
- 'title' => '返回的错误信息,成功则不返回信息。',
- 'description' => '返回的错误信息,成功则不返回信息。',
- 'type' => 'string',
- 'example' => ' 请求异常',
- ],
+ 'RetCode' => ['description' => '返回的错误码,`0`表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RetMsg' => ['description' => '返回的错误信息,成功则不返回信息。', 'type' => 'string', 'example' => '请求异常'],
+ 'RetValue' => ['description' => '调用接口的结果'."\n"
+ ."\n"
+ .'- true表示成功'."\n"
+ .'- false表示失败', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => '500', 'errorMessage' => '内部服务错误_xxx', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<AppUseTimeReportResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</AppUseTimeReportResponse>","errorExample":""}]',
+ 'title' => '上报应用使用时长',
+ ],
+ 'CallBackThirdRightSendPlan' => [
+ 'summary' => '三方领取回调接口。',
+ 'path' => '/v1.0/iap/business/CallBackThirdRightSendPlan',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
+ 'schema' => ['title' => '设备类型', 'description' => '设备类型', 'type' => 'string', 'required' => false, 'example' => 'ailabs'],
+ ],
+ [
+ 'name' => 'BizGroup',
+ 'in' => 'query',
+ 'schema' => ['title' => '设备分组', 'description' => '设备分组', 'type' => 'string', 'required' => false, 'example' => 'cc'],
+ ],
+ [
+ 'name' => 'Sn',
+ 'in' => 'query',
+ 'schema' => ['title' => '设备对应的sn', 'description' => '设备对应的sn', 'type' => 'string', 'required' => false, 'example' => '01000019100307010000600'],
+ ],
+ [
+ 'name' => 'SupplierId',
+ 'in' => 'query',
+ 'schema' => ['title' => '供应商id', 'description' => '供应商id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'GenieOpenId',
+ 'in' => 'query',
+ 'schema' => ['title' => '精灵id', 'description' => '精灵id', 'type' => 'string', 'required' => false, 'example' => '1dsds2FzCXFGVA1ADS'],
+ ],
+ [
+ 'name' => 'ReceiveStatus',
+ 'in' => 'query',
+ 'schema' => ['title' => '领取状态', 'description' => '领取状态', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'CardType',
+ 'in' => 'query',
+ 'schema' => ['title' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡', 'description' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1001'],
+ ],
+ [
+ 'name' => 'ErrorMsg',
+ 'in' => 'query',
+ 'schema' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'required' => false, 'example' => '领取异常'],
+ ],
+ [
+ 'name' => 'ExtendInfo',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['title' => '扩展字段', 'description' => '扩展字段', 'type' => 'object', 'required' => false, 'example' => '{}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RetValue' => ['title' => '返回结果 true/false', 'description' => '返回结果 true/false', 'type' => 'boolean'],
+ 'RetMsg' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '系统异常'],
+ 'RetCode' => ['title' => '错误状态码', 'description' => '错误状态码', 'type' => 'string', 'example' => '400'],
+ 'requestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetValue\\": true,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetCode\\": \\"400\\",\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]',
+ 'title' => '三方领取会员回调',
+ ],
+ 'CheckThirdRightSendPlan' => [
+ 'summary' => '商业化移动屏三方app领卡校验。',
+ 'path' => '/v1.0/iap/business/CheckThirdRightSendPlan',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
+ 'schema' => ['title' => '设备类型', 'description' => '设备类型', 'type' => 'string', 'required' => false, 'example' => 'ailabs'],
+ ],
+ [
+ 'name' => 'BizGroup',
+ 'in' => 'query',
+ 'schema' => ['title' => '设备分组', 'description' => '设备分组', 'type' => 'string', 'required' => false, 'example' => 'cc'],
+ ],
+ [
+ 'name' => 'Sn',
+ 'in' => 'query',
+ 'schema' => ['title' => '设备sn', 'description' => '设备sn', 'type' => 'string', 'required' => false, 'example' => '01000019100307010000600'],
+ ],
+ [
+ 'name' => 'SupplierId',
+ 'in' => 'query',
+ 'schema' => ['title' => '供应商id', 'description' => '供应商id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'ExtendInfo',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['title' => '扩展字段', 'description' => '扩展字段', 'type' => 'object', 'required' => false, 'example' => '{}'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RetCode' => ['title' => '返回code', 'description' => '返回code', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RetMsg' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '系统异常'],
'RetValue' => [
- 'title' => '返回的结果对象',
- 'description' => '配置信息(VIP标、导购条、导购弹窗)',
+ 'description' => '调用接口的结果',
'type' => 'object',
'properties' => [
- 'VipLabel' => [
- 'title' => 'VIP透标URL',
- 'description' => 'VIP透标URL',
- 'type' => 'string',
- 'example' => 'https://******.com/design/******?imageId=xxxxx',
- ],
- 'ShoppingBar' => [
- 'title' => '导购条URL',
- 'description' => '导购条URL',
- 'type' => 'string',
- 'example' => 'https://******.com/design/******?imageId=xxxxx',
- ],
- 'ShoppingWindow' => [
- 'title' => '导购弹窗URL',
- 'description' => '导购弹窗URL',
- 'type' => 'string',
- 'example' => 'https://******.com/design/******?imageId=xxxxx',
- ],
- 'Cashier' => [
- 'title' => '收银台URL',
- 'description' => '收银台URL',
- 'type' => 'string',
- 'example' => 'https://******.com/*****/******?appId=xxxxx',
- ],
+ 'CardType' => ['title' => '卡种', 'description' => '卡种', 'type' => 'integer', 'format' => 'int32', 'example' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡'],
+ 'RightsExpiredDate' => ['title' => '权益失效时间', 'description' => '权益失效时间', 'type' => 'string', 'example' => '"1713262192005"'],
+ 'ActivateDate' => ['title' => '激活时间', 'description' => '激活时间', 'type' => 'string', 'example' => '"1713262192005"'],
+ 'ChannelCode' => ['title' => '渠道code', 'description' => '渠道code', 'type' => 'string', 'example' => 'TB'],
+ 'ChannelName' => ['title' => '渠道名称', 'description' => '渠道名称', 'type' => 'string', 'example' => '淘宝'],
+ 'RequestId' => ['title' => '请求iid', 'description' => '请求iid', 'type' => 'string', 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F'],
+ 'ExtendInfo' => ['title' => '扩展字段', 'description' => '扩展字段', 'type' => 'object', 'example' => '{}'],
],
],
],
@@ -312,40 +350,25 @@
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"\\\\t请求异常\\",\\n \\"RetValue\\": {\\n \\"VipLabel\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingBar\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingWindow\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"Cashier\\": \\"https://******.com/*****/******?appId=xxxxx\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取应用配置',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetValue\\": {\\n \\"CardType\\": 0,\\n \\"RightsExpiredDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ActivateDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ChannelCode\\": \\"TB\\",\\n \\"ChannelName\\": \\"淘宝\\",\\n \\"RequestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\",\\n \\"ExtendInfo\\": {}\\n }\\n}","type":"json"}]',
+ 'title' => '三方领取会员校验',
],
- 'AppUseTimeReport' => [
- 'summary' => '用于在天猫精灵设备上上报应用的使用时长。',
- 'path' => '/v1.0/iap/vip/use/time/report',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateReminder' => [
+ 'summary' => '用于在天猫精灵设备上创建提醒。',
+ 'path' => '/v1.0/iap/reminder/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'AliGenie_Auth_Token' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -354,90 +377,60 @@
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '业务参数',
+ 'title' => '服务请求入参',
+ 'description' => '该服务请求的入参。',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'title' => '用户id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'DeviceId' => [
- 'title' => '设备di',
- 'type' => 'string',
- 'required' => false,
- ],
- 'SubjectId' => [
- 'title' => '应用id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'Action' => [
- 'title' => '操作',
- 'description' => '动作项'."\n"
- ."\n"
- .'- start表示开始'."\n"
- .'- end表示结束',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'start',
- ],
- 'StepCode' => [
- 'title' => '步进码',
- 'description' => '步进码,开始与结束的动作要唯一匹配。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2',
- ],
- 'ResourceId' => [
- 'title' => '资源id',
- 'description' => '资源ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
- 'ResourceType' => [
- 'title' => 'resourceType',
- 'description' => '资源类型:'."\n"
- ."\n"
- .'- 0表示游戏'."\n"
- .'- 1表示音频'."\n"
- .'- 2表示视频',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- 'IsPrivilege' => [
- 'title' => '是否会员专享权益:1-是 0-否',
- 'description' => '是否会员专享权益:'."\n"
- ."\n"
- .'- 1表示是 '."\n"
- .'- 0表示否',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- 'VipType' => [
- 'title' => '会员类型',
- 'description' => '会员类型:'."\n"
- ."\n"
- .'- 0表示猫精会员'."\n"
- .'- 1表示三方自有会员',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'Content' => ['title' => '提醒内容', 'description' => '提醒信息的详细内容。', 'type' => 'string', 'required' => true, 'example' => '提醒内容'],
+ 'UserId' => ['title' => '精灵id', 'type' => 'string', 'required' => true, 'example' => '12****78'],
+ 'DeviceId' => ['title' => '设备id', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC'],
+ 'SubjectId' => ['title' => '应用id', 'type' => 'string', 'required' => true, 'example' => '20******01'],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '该调用是否为调试。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'],
+ 'RecurrenceRule' => [
+ 'title' => '提醒调度信息',
+ 'description' => '提醒的调度信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Year' => ['title' => '触发时间的年', 'description' => '触发提醒的时间年份。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2021'],
+ 'Month' => ['title' => '触发时间的月', 'description' => '触发提醒的时间月份。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'Day' => ['title' => '触发时间的日', 'description' => '触发提醒的时间日期。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25'],
+ 'Hour' => ['title' => '触发时间的时', 'description' => '触发提醒的时间时钟数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12'],
+ 'Minute' => ['title' => '触发时间的分', 'description' => '触发提醒的时间分钟数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'Second' => ['title' => '触发时间的秒', 'description' => '触发提醒的时间秒钟数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'Freq' => [
+ 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY',
+ 'description' => '循环类型:'."\n"
+ ."\n"
+ .'- ONCE:单次'."\n"
+ .'- DAILY:每天'."\n"
+ .'- WEEKLY:每周'."\n"
+ .'- MONTHLY:每月',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ONCE',
+ 'enum' => ['ONCE', 'DAILY', 'WEEKLY', 'MONTHLY'],
+ ],
+ 'StartDateTime' => ['title' => '开始时间,时间戳毫秒', 'description' => '提醒开始的生效时间,时间戳毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134400000'],
+ 'EndDateTime' => ['title' => '结束时间,时间戳毫秒', 'description' => '提醒结束的失效时间,时间戳毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134700000'],
+ 'DaysOfMonth' => [
+ 'title' => '月循环相关,表示每月的几号的集合,数值范围为1-31',
+ 'description' => '设置按月提醒,即每月几日触发提醒。',
+ 'type' => 'array',
+ 'items' => ['description' => '设置按月提醒的具体日期,取值范围为:1~31。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ ],
+ 'DaysOfWeek' => [
+ 'title' => '周循环相关,表示每周几触发,数值范围为1-7',
+ 'description' => '设置按周提醒,即每周几触发提醒。',
+ 'type' => 'array',
+ 'items' => ['description' => '设置按周提醒的具体日期,取值范围为:1~7。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ ],
+ ],
'required' => true,
- 'example' => '1',
- ],
- 'originUuid' => [
- 'description' => '明文uuid',
- 'type' => 'string',
- 'required' => false,
- 'example' => '731D5F********DC3B',
],
],
- 'required' => false,
+ 'required' => true,
],
],
[
@@ -446,59 +439,34 @@
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
- 'description' => '用户标识信息',
+ 'description' => '用户标识信息。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型 '."\n"
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型:'."\n"
.'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用平台申请了组织后才会有该值。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型。',
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 '."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**配置为**UNION_ID**时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -509,61 +477,37 @@
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
- 'description' => '设备标识信息',
+ 'description' => '设备标识信息。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型 '."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- OPEN_ID:默认的设备ID标识 '."\n"
.'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 。'."\n"
.'- SKILL_ID:技能ID,云端链路的编码类型。',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型设置为SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型设置为PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
- 'required' => false,
+ 'required' => true,
],
],
],
@@ -571,65 +515,32 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '调用该接口的返回信息。',
'type' => 'object',
'properties' => [
- 'RetCode' => [
- 'description' => '返回的错误码,`0`表示成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RetMsg' => [
- 'description' => '返回的错误信息,成功则不返回信息。',
- 'type' => 'string',
- 'example' => '请求异常',
- ],
- 'RetValue' => [
- 'description' => '调用接口的结果'."\n"
- ."\n"
- .'- true表示成功'."\n"
- .'- false表示失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Success' => ['title' => '服务成功标识', 'description' => '接口调用结果标识,true表示成功,false表示失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => '400'],
+ 'ErrorMsg' => ['title' => '错误信息', 'description' => '错误信息的详细描述。', 'type' => 'string', 'example' => '不能设置过去的时间。'],
+ 'Model' => ['title' => '创建的提醒id', 'description' => '创建的提醒ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '20****1'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => '500',
- 'errorMessage' => '内部服务错误_xxx',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<AppUseTimeReportResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</AppUseTimeReportResponse>","errorExample":""}]',
- 'title' => '上报应用使用时长',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateReminderResponse>\\n <Success>true</Success>\\n</CreateReminderResponse>","errorExample":""}]',
+ 'title' => '创建提醒',
],
- 'PullCashier' => [
- 'summary' => '用户在天猫精灵设备上拉起收银台。',
- 'path' => '/v1.0/iap/pull/cashier/',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteReminder' => [
+ 'summary' => '用户删除在天猫精灵设备上创建的提醒。',
+ 'path' => '/v1.0/iap/reminder/delete',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'AliGenie_Auth_Token' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -638,26 +549,17 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '业务参数',
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'SubjectId' => [
- 'title' => '应用id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'DeviceId' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'originUuid' => [
- 'description' => '明文uuid',
- 'type' => 'string',
- 'required' => false,
- 'example' => '731D5F********DC3B',
- ],
+ 'Id' => ['title' => '提醒的唯一id', 'description' => '提醒的唯一id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20****34'],
+ 'UserId' => ['title' => '精灵id', 'type' => 'string', 'required' => true, 'example' => '12****56'],
+ 'DeviceId' => ['title' => '设备id', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC'],
+ 'SubjectId' => ['title' => '应用id', 'type' => 'string', 'required' => true, 'example' => '20****01'],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '调试标识', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'],
],
- 'required' => false,
+ 'required' => true,
],
],
[
@@ -669,57 +571,29 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '用户Id的类型'."\n"
- ."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用平台申请过组织后才会有该值。',
+ .'- OPEN_ID:默认的用户ID标识'."\n"
+ .'- UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'example' => 'SKILL_ID',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为`UNION_ID`时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -733,58 +607,31 @@
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型 '."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ .'- OPEN_ID:默认的设备ID标识'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'required' => true,
+ 'example' => 'SKILL_ID',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为`UNION_ID`时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
- 'required' => false,
+ 'required' => true,
],
],
],
@@ -795,222 +642,106 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RetCode' => [
- 'title' => '错误吗',
- 'description' => '返回的错误码,`0`表示成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RetMsg' => [
- 'title' => '错误信息',
- 'description' => '返回的错误信息,成功则不返回信息。',
- 'type' => 'string',
- 'example' => '请求成功',
- ],
- 'RetValue' => [
- 'description' => '拉取收银台的结果,true表示成功,false表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Success' => ['title' => '服务成功标识', 'description' => '服务成功标识', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'ErrorMsg' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '参数错误。'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => '500',
- 'errorMessage' => '内部服务错误_xxx',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求成功\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<PullCashierResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</PullCashierResponse>","errorExample":""}]',
- 'title' => '拉起收银台',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数错误。\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteReminderResponse>\\n <Success>true</Success>\\n</DeleteReminderResponse>","errorExample":""}]',
+ 'title' => '删除提醒',
],
- 'VideoAppReport' => [
- 'summary' => '用于开发者在与猫精进行会员合作的场景下上报其会员信息。',
- 'path' => '/v1.0/iap/vip/use/video/report',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetAccountForApp' => [
+ 'summary' => '用于开发者在依赖于猫精会员的业务场景下获取会员信息。',
+ 'path' => '/v1.0/iap/vip/account/get',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'DeviceId' => [
- 'title' => '设备di',
- 'type' => 'string',
- 'required' => false,
- ],
- 'isLogin' => [
- 'description' => '会员是否登录。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'isVip' => [
- 'description' => '该账号是否为会员。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'startTime' => [
- 'description' => '会员的开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1652337963097',
- ],
- 'endTime' => [
- 'description' => '会员的结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1652337963097',
- ],
- 'loginNick' => [
- 'description' => '账号的昵称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'phone' => [
- 'description' => '账户的手机号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '188*777',
- ],
- 'pkgName' => [
- 'description' => '应用包名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'com.***.test',
- ],
- 'originUuid' => [
- 'description' => '明文uuid',
- 'type' => 'string',
- 'required' => false,
- 'example' => '731D5F********DC3B',
- ],
+ 'UserId' => ['type' => 'string', 'required' => true],
+ 'SubjectId' => ['type' => 'string', 'required' => true],
+ 'DeviceId' => ['type' => 'string'],
+ 'Phone' => ['description' => '授权会员的手机号码。', 'type' => 'string', 'required' => false, 'example' => '188*777'],
+ 'originUuid' => ['description' => '明文uuid', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B'],
],
'required' => false,
],
],
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型 '."\n"
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型'."\n"
.'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ .'- UNION_ID:组织维度的用户ID标识,在天猫精灵技能应用平台申请过组织后才会有该值。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型'."\n"
.'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
.'- SKILL_ID:技能ID,云端链路的编码类型。',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型 '."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ .'- OPEN_ID:默认的设备ID标识'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用平台申请过组织后才会有该值。',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -1020,28 +751,13 @@
'type' => 'string',
'required' => false,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => false,
],
@@ -1054,24 +770,20 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RetCode' => [
- 'description' => '返回的错误码,`0`表示成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RetMsg' => [
- 'description' => '返回的错误信息,成功则不返回信息。',
- 'type' => 'string',
- 'example' => '请求异常',
- ],
+ 'RetCode' => ['title' => '错误码', 'description' => '返回的错误码,`0`表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RetMsg' => ['title' => '错误信息', 'description' => '返回的错误信息,成功则不返回信息。', 'type' => 'string', 'example' => '请求异常'],
'RetValue' => [
- 'description' => '返回的调用结果'."\n"
- ."\n"
- .'- true表示成功'."\n"
- .'- false表示失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '用户信息',
+ 'description' => '返回的结果对象列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'IsVip' => ['title' => '是否VIP', 'description' => '是否为授权会员。', 'type' => 'boolean', 'example' => 'true'],
+ 'VipExpireAt' => ['title' => '若以前开通过会员,返回会员失效时间,若从未开通过会员,此字段为0', 'description' => '毫秒级时间戳'."\n"
+ ."\n"
+ .'- 若开通过会员,返回会员失效时间。'."\n"
+ .'- 若从未开通过会员,返回值固定为`0`。', 'type' => 'integer', 'format' => 'int64', 'example' => '1652340138347'],
+ 'StrVipExpire' => ['title' => '日期格式,到期时间', 'description' => '会员的到期时间。', 'type' => 'string', 'example' => '2022-05-12 15:22:18'],
+ ],
],
],
],
@@ -1079,71 +791,43 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => '500',
- 'errorMessage' => '内部服务错误_xxx',
- ],
+ ['errorCode' => '500', 'errorMessage' => '内部服务错误_xx', 'description' => ''],
+ ['errorCode' => '10000', 'errorMessage' => '猫精用户已更换手机号,请重登', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<VideoAppReportResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</VideoAppReportResponse>","errorExample":""}]',
- 'title' => '上报三方会员信息',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": {\\n \\"IsVip\\": true,\\n \\"VipExpireAt\\": 1652340138347,\\n \\"StrVipExpire\\": \\"2022-05-12 15:22:18\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAccountForAppResponse>\\n <RetCode>0</RetCode>\\n <RetValue>\\n <IsVip>true</IsVip>\\n <VipExpireAt>1652340138347</VipExpireAt>\\n <StrVipExpire>2022-05-12 15:22:18</StrVipExpire>\\n </RetValue>\\n</GetAccountForAppResponse>","errorExample":""}]',
+ 'title' => '获取猫精会员信息',
],
- 'GetAccountForApp' => [
- 'summary' => '用于开发者在依赖于猫精会员的业务场景下获取会员信息。',
- 'path' => '/v1.0/iap/vip/account/get',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetBusAppConfig' => [
+ 'summary' => '获取应用配置。',
+ 'path' => '/v1.0/iap/app/config/get',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'Payload',
'in' => 'query',
'style' => 'json',
'schema' => [
+ 'title' => '业务参数',
'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'SubjectId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'DeviceId' => [
- 'type' => 'string',
- ],
- 'Phone' => [
- 'description' => '授权会员的手机号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '188*777',
- ],
- 'originUuid' => [
- 'description' => '明文uuid',
- 'type' => 'string',
- 'required' => false,
- 'example' => '731D5F********DC3B',
- ],
+ 'UserId' => ['type' => 'string', 'required' => false],
+ 'SubjectId' => ['type' => 'string', 'required' => true],
+ 'DeviceId' => ['type' => 'string'],
+ 'phone' => ['title' => '手机号', 'description' => '手机号', 'type' => 'string', 'required' => false, 'example' => '136****1111'],
+ 'originUuid' => ['title' => '明文uuid', 'description' => '明文uuid', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B'],
],
'required' => false,
],
@@ -1157,55 +841,25 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(UserOpenId或UserUnionId)', 'description' => '用户标识(UserOpenId或UserUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型'."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID:组织维度的用户ID标识,在天猫精灵技能应用平台申请过组织后才会有该值。',
+ 'description' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'example' => 'SKILL_ID',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -1219,56 +873,25 @@
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 '."\n"
- .'- OPEN_ID:默认的设备ID标识'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用平台申请过组织后才会有该值。',
+ 'description' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => false,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => false,
- 'example' => '1**2',
+ 'example' => 'SKILL_ID',
+ 'enum' => ['SKILL_ID', 'PACKAGE_NAME'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => false,
],
@@ -1281,46 +904,17 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RetCode' => [
- 'title' => '错误码',
- 'description' => '返回的错误码,`0`表示成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RetMsg' => [
- 'title' => '错误信息',
- 'description' => '返回的错误信息,成功则不返回信息。',
- 'type' => 'string',
- 'example' => '请求异常',
- ],
+ 'RetCode' => ['title' => '返回的错误码,0表示成功。', 'description' => '返回的错误码,0表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => ' 0'],
+ 'RetMsg' => ['title' => '返回的错误信息,成功则不返回信息。', 'description' => '返回的错误信息,成功则不返回信息。', 'type' => 'string', 'example' => ' 请求异常'],
'RetValue' => [
- 'title' => '用户信息',
- 'description' => '返回的结果对象列表。',
+ 'title' => '返回的结果对象',
+ 'description' => '配置信息(VIP标、导购条、导购弹窗)',
'type' => 'object',
'properties' => [
- 'IsVip' => [
- 'title' => '是否VIP',
- 'description' => '是否为授权会员。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'VipExpireAt' => [
- 'title' => '若以前开通过会员,返回会员失效时间,若从未开通过会员,此字段为0',
- 'description' => '毫秒级时间戳'."\n"
- ."\n"
- .'- 若开通过会员,返回会员失效时间。'."\n"
- .'- 若从未开通过会员,返回值固定为`0`。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1652340138347',
- ],
- 'StrVipExpire' => [
- 'title' => '日期格式,到期时间',
- 'description' => '会员的到期时间。',
- 'type' => 'string',
- 'example' => '2022-05-12 15:22:18',
- ],
+ 'VipLabel' => ['title' => 'VIP透标URL', 'description' => 'VIP透标URL', 'type' => 'string', 'example' => 'https://******.com/design/******?imageId=xxxxx'],
+ 'ShoppingBar' => ['title' => '导购条URL', 'description' => '导购条URL', 'type' => 'string', 'example' => 'https://******.com/design/******?imageId=xxxxx'],
+ 'ShoppingWindow' => ['title' => '导购弹窗URL', 'description' => '导购弹窗URL', 'type' => 'string', 'example' => 'https://******.com/design/******?imageId=xxxxx'],
+ 'Cashier' => ['title' => '收银台URL', 'description' => '收银台URL', 'type' => 'string', 'example' => 'https://******.com/*****/******?appId=xxxxx'],
],
],
],
@@ -1328,41 +922,26 @@
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => '500',
- 'errorMessage' => '内部服务错误_xx',
- ],
- [
- 'errorCode' => '10000',
- 'errorMessage' => '猫精用户已更换手机号,请重登',
- ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": {\\n \\"IsVip\\": true,\\n \\"VipExpireAt\\": 1652340138347,\\n \\"StrVipExpire\\": \\"2022-05-12 15:22:18\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAccountForAppResponse>\\n <RetCode>0</RetCode>\\n <RetValue>\\n <IsVip>true</IsVip>\\n <VipExpireAt>1652340138347</VipExpireAt>\\n <StrVipExpire>2022-05-12 15:22:18</StrVipExpire>\\n </RetValue>\\n</GetAccountForAppResponse>","errorExample":""}]',
- 'title' => '获取猫精会员信息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"\\\\t请求异常\\",\\n \\"RetValue\\": {\\n \\"VipLabel\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingBar\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingWindow\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"Cashier\\": \\"https://******.com/*****/******?appId=xxxxx\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取应用配置',
],
'GetPhoneNumber' => [
'summary' => '获取用户在猫精设备绑定的手机号。需先在猫精技能应用平台进行能力申请,并在设备端得到用户授权。',
'path' => '/v1.0/iap/profile/phoneNumber',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_Token' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
@@ -1376,13 +955,7 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '用户Id的类型 '."\n"
@@ -1391,10 +964,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -1404,25 +974,10 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为`UNION_ID`时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为`UNION_ID`时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -1436,13 +991,7 @@
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型 '."\n"
@@ -1451,10 +1000,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -1464,25 +1010,10 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为`UNION_ID`时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为`UNION_ID`时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -1495,403 +1026,32 @@
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'phoneNumber' => [
- 'title' => '用户手机号',
- 'description' => '用户手机号',
- 'type' => 'string',
- 'example' => '137****',
- ],
+ 'phoneNumber' => ['title' => '用户手机号', 'description' => '用户手机号', 'type' => 'string', 'example' => '137****'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity',
- 'errorMessage' => 'The user information does not exist.',
- ],
- [
- 'errorCode' => 'AliGenie.GetPhoneNumber.BizError',
- 'errorMessage' => 'The user has no phoneNumber.',
- ],
+ ['errorCode' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', 'errorMessage' => 'The user information does not exist.', 'description' => ''],
+ ['errorCode' => 'AliGenie.GetPhoneNumber.BizError', 'errorMessage' => 'The user has no phoneNumber.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"phoneNumber\\": \\"137****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPhoneNumberResponse>\\n <phoneNumber>137****</phoneNumber>\\n</GetPhoneNumberResponse>","errorExample":""}]',
'title' => '获取用户猫精设备绑定的手机号',
],
- 'CreateReminder' => [
- 'summary' => '用于在天猫精灵设备上创建提醒。',
- 'path' => '/v1.0/iap/reminder/create',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AliGenie_Auth_Token' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'Payload',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '服务请求入参',
- 'description' => '该服务请求的入参。',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '提醒内容',
- 'description' => '提醒信息的详细内容。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '提醒内容',
- ],
- 'UserId' => [
- 'title' => '精灵id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12****78',
- ],
- 'DeviceId' => [
- 'title' => '设备id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BED****AAC',
- ],
- 'SubjectId' => [
- 'title' => '应用id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20******01',
- ],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '该调用是否为调试。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- 'default' => 'false',
- ],
- 'RecurrenceRule' => [
- 'title' => '提醒调度信息',
- 'description' => '提醒的调度信息。',
- 'type' => 'object',
- 'properties' => [
- 'Year' => [
- 'title' => '触发时间的年',
- 'description' => '触发提醒的时间年份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2021',
- ],
- 'Month' => [
- 'title' => '触发时间的月',
- 'description' => '触发提醒的时间月份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'Day' => [
- 'title' => '触发时间的日',
- 'description' => '触发提醒的时间日期。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '25',
- ],
- 'Hour' => [
- 'title' => '触发时间的时',
- 'description' => '触发提醒的时间时钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '12',
- ],
- 'Minute' => [
- 'title' => '触发时间的分',
- 'description' => '触发提醒的时间分钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'Second' => [
- 'title' => '触发时间的秒',
- 'description' => '触发提醒的时间秒钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'Freq' => [
- 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY',
- 'description' => '循环类型:'."\n"
- ."\n"
- .'- ONCE:单次'."\n"
- .'- DAILY:每天'."\n"
- .'- WEEKLY:每周'."\n"
- .'- MONTHLY:每月',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ONCE',
- 'enum' => [
- 'ONCE',
- 'DAILY',
- 'WEEKLY',
- 'MONTHLY',
- ],
- ],
- 'StartDateTime' => [
- 'title' => '开始时间,时间戳毫秒',
- 'description' => '提醒开始的生效时间,时间戳毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1635134400000',
- ],
- 'EndDateTime' => [
- 'title' => '结束时间,时间戳毫秒',
- 'description' => '提醒结束的失效时间,时间戳毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1635134700000',
- ],
- 'DaysOfMonth' => [
- 'title' => '月循环相关,表示每月的几号的集合,数值范围为1-31',
- 'description' => '设置按月提醒,即每月几日触发提醒。',
- 'type' => 'array',
- 'items' => [
- 'description' => '设置按月提醒的具体日期,取值范围为:1~31。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
- 'DaysOfWeek' => [
- 'title' => '周循环相关,表示每周几触发,数值范围为1-7',
- 'description' => '设置按周提醒,即每周几触发提醒。',
- 'type' => 'array',
- 'items' => [
- 'description' => '设置按周提醒的具体日期,取值范围为:1~7。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'UserInfo',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '用户标识信息',
- 'description' => '用户标识信息。',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型:'."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用平台申请了组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 '."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**配置为**UNION_ID**时,该参数必填。',
- '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' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 '."\n"
- .'- OPEN_ID:默认的设备ID标识 '."\n"
- .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 。'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'- 编码类型设置为SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型设置为PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '调用该接口的返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'title' => '服务成功标识',
- 'description' => '接口调用结果标识,true表示成功,false表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => '400',
- ],
- 'ErrorMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息的详细描述。',
- 'type' => 'string',
- 'example' => '不能设置过去的时间。',
- ],
- 'Model' => [
- 'title' => '创建的提醒id',
- 'description' => '创建的提醒ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20****1',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateReminderResponse>\\n <Success>true</Success>\\n</CreateReminderResponse>","errorExample":""}]',
- 'title' => '创建提醒',
- ],
'GetReminder' => [
'summary' => '用户获取在天猫精灵设备上创建的提醒。',
'path' => '/v1.0/iap/reminder/get',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_Token' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -1904,40 +1064,11 @@
'description' => '服务的请求入参。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '提醒的唯一id',
- 'description' => '提醒的唯一ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '20****34',
- ],
- 'UserId' => [
- 'title' => '精灵id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12****56',
- ],
- 'DeviceId' => [
- 'title' => '设备id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BED****AAC',
- ],
- 'SubjectId' => [
- 'title' => '应用id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20****01',
- ],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '该调用是否为调试。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'Id' => ['title' => '提醒的唯一id', 'description' => '提醒的唯一ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20****34'],
+ 'UserId' => ['title' => '精灵id', 'type' => 'string', 'required' => true, 'example' => '12****56'],
+ 'DeviceId' => ['title' => '设备id', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC'],
+ 'SubjectId' => ['title' => '应用id', 'type' => 'string', 'required' => true, 'example' => '20****01'],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '该调用是否为调试。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'],
],
'required' => true,
],
@@ -1951,13 +1082,7 @@
'description' => '用户的标识信息列表。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '用户Id的类型'."\n"
@@ -1966,10 +1091,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -1979,28 +1101,13 @@
'type' => 'string',
'required' => true,
'example' => 'SKILL_ID',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- ."\n"
- .'- 编码类型是SKILLID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**设置为**UNION_ID**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值。'."\n"
+ ."\n"
+ .'- 编码类型是SKILLID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**设置为**UNION_ID**时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -2014,13 +1121,7 @@
'description' => '设备的标识信息列表。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型 '."\n"
@@ -2029,10 +1130,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -2042,28 +1140,13 @@
'type' => 'string',
'required' => true,
'example' => 'SKILL_ID',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- ."\n"
- .'- 编码类型是SKILLID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**设置为**UNION_ID**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值。'."\n"
+ ."\n"
+ .'- 编码类型是SKILLID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**设置为**UNION_ID**时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -2076,25 +1159,9 @@
'description' => '调用该接口的返回信息列表。',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'title' => '服务成功标识',
- 'description' => '接口调用结果标识,true表示成功,false表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'ErrorMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息的详细描述。',
- 'type' => 'string',
- 'example' => '参数不合法。',
- ],
+ 'Success' => ['title' => '服务成功标识', 'description' => '接口调用结果标识,true表示成功,false表示失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'ErrorMsg' => ['title' => '错误信息', 'description' => '错误信息的详细描述。', 'type' => 'string', 'example' => '参数不合法。'],
'Model' => [
'title' => '提醒信息',
'description' => '提醒信息。',
@@ -2108,133 +1175,38 @@
'description' => '信息列表。',
'type' => 'object',
'properties' => [
- 'RemindId' => [
- 'title' => '提醒id',
- 'description' => '提醒信息的ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20*****1',
- ],
- 'RepeatCount' => [
- 'title' => '重复次数',
- 'description' => '重复提醒的次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ActionTopic' => [
- 'title' => '执行动作topic',
- 'description' => '提醒执行的动作topic。',
- 'type' => 'string',
- 'example' => '宝宝快去刷牙',
- ],
- 'DayDesc' => [
- 'title' => '触发条件描述',
- 'description' => '触发提醒的条件描述。',
- 'type' => 'string',
- 'example' => '每天',
- ],
- 'RemindTime' => [
- 'title' => '下次提醒时间',
- 'description' => '下次提醒时间。',
- 'type' => 'string',
- 'example' => '1629850800000',
- ],
- 'Week' => [
- 'title' => '触发为周几',
- 'description' => '按周触发提醒的日期,即每周几触发提醒。',
- 'type' => 'string',
- 'example' => '周三',
- ],
+ 'RemindId' => ['title' => '提醒id', 'description' => '提醒信息的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '20*****1'],
+ 'RepeatCount' => ['title' => '重复次数', 'description' => '重复提醒的次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ActionTopic' => ['title' => '执行动作topic', 'description' => '提醒执行的动作topic。', 'type' => 'string', 'example' => '宝宝快去刷牙'],
+ 'DayDesc' => ['title' => '触发条件描述', 'description' => '触发提醒的条件描述。', 'type' => 'string', 'example' => '每天'],
+ 'RemindTime' => ['title' => '下次提醒时间', 'description' => '下次提醒时间。', 'type' => 'string', 'example' => '1629850800000'],
+ 'Week' => ['title' => '触发为周几', 'description' => '按周触发提醒的日期,即每周几触发提醒。', 'type' => 'string', 'example' => '周三'],
'RecurrenceRule' => [
'title' => '调度信息',
'description' => '调度信息列表,即提醒的详细时间信息。',
'type' => 'object',
'properties' => [
- 'Freq' => [
- 'title' => '调度类型',
- 'description' => '提醒的循环周期。',
- 'type' => 'string',
- 'example' => 'WEEKLY',
- ],
- 'Year' => [
- 'title' => '年',
- 'description' => '提醒触发的时间年份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2021',
- ],
- 'Month' => [
- 'title' => '月',
- 'description' => '提醒触发的时间月份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Day' => [
- 'title' => '天',
- 'description' => '提醒触发的时间日期。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '27',
- ],
- 'Hour' => [
- 'title' => '小时',
- 'description' => '提醒触发的时间时钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '18',
- ],
- 'Minute' => [
- 'title' => '分',
- 'description' => '提醒触发的时间分钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Second' => [
- 'title' => '秒',
- 'description' => '提醒触发的时间秒钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'Freq' => ['title' => '调度类型', 'description' => '提醒的循环周期。', 'type' => 'string', 'example' => 'WEEKLY'],
+ 'Year' => ['title' => '年', 'description' => '提醒触发的时间年份。', 'type' => 'integer', 'format' => 'int32', 'example' => '2021'],
+ 'Month' => ['title' => '月', 'description' => '提醒触发的时间月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'Day' => ['title' => '天', 'description' => '提醒触发的时间日期。', 'type' => 'integer', 'format' => 'int32', 'example' => '27'],
+ 'Hour' => ['title' => '小时', 'description' => '提醒触发的时间时钟数。', 'type' => 'integer', 'format' => 'int32', 'example' => '18'],
+ 'Minute' => ['title' => '分', 'description' => '提醒触发的时间分钟数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Second' => ['title' => '秒', 'description' => '提醒触发的时间秒钟数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'DaysOfMonth' => [
'title' => '月的第几天 可用作月循环',
'description' => '按月提醒的信息。',
'type' => 'array',
- 'items' => [
- 'description' => '每月的哪天触发提醒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'items' => ['description' => '每月的哪天触发提醒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'DaysOfWeek' => [
'title' => '周循环字段,取值范围:1-7',
'description' => '按周提醒的信息。',
'type' => 'array',
- 'items' => [
- 'description' => '每周的周几触发提醒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- 'StartDateTime' => [
- 'title' => '调度开始时间',
- 'description' => '提醒生效的开始时间。',
- 'type' => 'string',
- 'format' => 'int64',
- 'example' => '1630054800000',
- ],
- 'EndDateTime' => [
- 'title' => '调度结束时间',
- 'description' => '提醒失效的结束时间。',
- 'type' => 'string',
- 'format' => 'int64',
- 'example' => '1661598000000',
+ 'items' => ['description' => '每周的周几触发提醒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'StartDateTime' => ['title' => '调度开始时间', 'description' => '提醒生效的开始时间。', 'type' => 'string', 'format' => 'int64', 'example' => '1630054800000'],
+ 'EndDateTime' => ['title' => '调度结束时间', 'description' => '提醒失效的结束时间。', 'type' => 'string', 'format' => 'int64', 'example' => '1661598000000'],
],
],
],
@@ -2252,24 +1224,15 @@
'ListReminders' => [
'summary' => '用户批量获取在天猫精灵设备上创建的提醒。',
'path' => '/v1.0/iap/reminder/list',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_Token' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -2282,32 +1245,10 @@
'description' => '服务的请求入参。',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'title' => '精灵id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12****56',
- ],
- 'DeviceId' => [
- 'title' => '设备id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BED****AAC',
- ],
- 'SubjectId' => [
- 'title' => '应用id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20****01',
- ],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '该调用是否为调试。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'UserId' => ['title' => '精灵id', 'type' => 'string', 'required' => true, 'example' => '12****56'],
+ 'DeviceId' => ['title' => '设备id', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC'],
+ 'SubjectId' => ['title' => '应用id', 'type' => 'string', 'required' => true, 'example' => '20****01'],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '该调用是否为调试。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'],
],
'required' => true,
],
@@ -2321,13 +1262,7 @@
'description' => '用户的标识信息列表。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '用户Id的类型'."\n"
@@ -2336,10 +1271,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -2349,28 +1281,13 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- ."\n"
- .'- 编码类型是SKILLID时,其值为应用的Skill ID。 '."\n"
- .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**配置为**UNION_ID**时,该参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值。'."\n"
+ ."\n"
+ .'- 编码类型是SKILLID时,其值为应用的Skill ID。 '."\n"
+ .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**配置为**UNION_ID**时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -2384,13 +1301,7 @@
'description' => '设备的标识信息列表。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型 '."\n"
@@ -2399,10 +1310,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -2412,28 +1320,13 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- ."\n"
- .'- 编码类型是SKILLID时,其值为应用的Skill ID。 '."\n"
- .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**设置为**UNION_ID**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值。'."\n"
+ ."\n"
+ .'- 编码类型是SKILLID时,其值为应用的Skill ID。 '."\n"
+ .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**设置为**UNION_ID**时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -2446,25 +1339,9 @@
'description' => '调用该接口的返回信息列表。',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'title' => '服务成功标识',
- 'description' => '接口调用结果标识,true表示成功,false表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'ErrorMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息的详细描述。',
- 'type' => 'string',
- 'example' => '参数不合法。',
- ],
+ 'Success' => ['title' => '服务成功标识', 'description' => '接口调用结果标识,true表示成功,false表示失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'ErrorMsg' => ['title' => '错误信息', 'description' => '错误信息的详细描述。', 'type' => 'string', 'example' => '参数不合法。'],
'Model' => [
'title' => '提醒信息',
'description' => '提醒信息。',
@@ -2478,133 +1355,38 @@
'description' => '信息列表。',
'type' => 'object',
'properties' => [
- 'RemindId' => [
- 'title' => '提醒id',
- 'description' => '提醒信息的ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20****1',
- ],
- 'RepeatCount' => [
- 'title' => '重复次数',
- 'description' => '重复提醒的次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ActionTopic' => [
- 'title' => '执行动作topic',
- 'description' => '提醒执行的动作topic。',
- 'type' => 'string',
- 'example' => '宝宝快去刷牙',
- ],
- 'DayDesc' => [
- 'title' => '触发条件描述',
- 'description' => '触发提醒的条件描述。',
- 'type' => 'string',
- 'example' => '每天',
- ],
- 'RemindTime' => [
- 'title' => '下次提醒时间',
- 'description' => '下次提醒时间。',
- 'type' => 'string',
- 'example' => '1629850800000',
- ],
- 'Week' => [
- 'title' => '触发为周几',
- 'description' => '按周触发提醒的日期,即每周几触发提醒。',
- 'type' => 'string',
- 'example' => '周三',
- ],
+ 'RemindId' => ['title' => '提醒id', 'description' => '提醒信息的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '20****1'],
+ 'RepeatCount' => ['title' => '重复次数', 'description' => '重复提醒的次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ActionTopic' => ['title' => '执行动作topic', 'description' => '提醒执行的动作topic。', 'type' => 'string', 'example' => '宝宝快去刷牙'],
+ 'DayDesc' => ['title' => '触发条件描述', 'description' => '触发提醒的条件描述。', 'type' => 'string', 'example' => '每天'],
+ 'RemindTime' => ['title' => '下次提醒时间', 'description' => '下次提醒时间。', 'type' => 'string', 'example' => '1629850800000'],
+ 'Week' => ['title' => '触发为周几', 'description' => '按周触发提醒的日期,即每周几触发提醒。', 'type' => 'string', 'example' => '周三'],
'RecurrenceRule' => [
'title' => '调度信息',
'description' => '调度信息列表,即提醒的详细时间信息。',
'type' => 'object',
'properties' => [
- 'Freq' => [
- 'title' => '调度类型',
- 'description' => '提醒的循环周期。',
- 'type' => 'string',
- 'example' => 'WEEKLY',
- ],
- 'Year' => [
- 'title' => '年',
- 'description' => '提醒触发的时间年份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2021',
- ],
- 'Month' => [
- 'title' => '月',
- 'description' => '提醒触发的时间月份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Day' => [
- 'title' => '天',
- 'description' => '提醒触发的时间日期。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '27',
- ],
- 'Hour' => [
- 'title' => '小时',
- 'description' => '提醒触发的时间时钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '18',
- ],
- 'Minute' => [
- 'title' => '分',
- 'description' => '提醒触发的时间分钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Second' => [
- 'title' => '秒',
- 'description' => '提醒触发的时间秒钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'Freq' => ['title' => '调度类型', 'description' => '提醒的循环周期。', 'type' => 'string', 'example' => 'WEEKLY'],
+ 'Year' => ['title' => '年', 'description' => '提醒触发的时间年份。', 'type' => 'integer', 'format' => 'int32', 'example' => '2021'],
+ 'Month' => ['title' => '月', 'description' => '提醒触发的时间月份。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'Day' => ['title' => '天', 'description' => '提醒触发的时间日期。', 'type' => 'integer', 'format' => 'int32', 'example' => '27'],
+ 'Hour' => ['title' => '小时', 'description' => '提醒触发的时间时钟数。', 'type' => 'integer', 'format' => 'int32', 'example' => '18'],
+ 'Minute' => ['title' => '分', 'description' => '提醒触发的时间分钟数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Second' => ['title' => '秒', 'description' => '提醒触发的时间秒钟数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'DaysOfMonth' => [
'title' => '月的第几天 可用作月循环',
'description' => '按月提醒的信息。',
'type' => 'array',
- 'items' => [
- 'description' => '每月的哪天触发提醒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'items' => ['description' => '每月的哪天触发提醒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'DaysOfWeek' => [
'title' => '周循环字段,取值范围:1-7',
'description' => '按周提醒的信息。',
'type' => 'array',
- 'items' => [
- 'description' => '每周的周几触发提醒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- 'StartDateTime' => [
- 'title' => '调度开始时间',
- 'description' => '提醒生效的开始时间。',
- 'type' => 'string',
- 'format' => 'int64',
- 'example' => '1630054800000',
- ],
- 'EndDateTime' => [
- 'title' => '调度结束时间',
- 'description' => '提醒失效的结束时间。',
- 'type' => 'string',
- 'format' => 'int64',
- 'example' => '1661598000000',
+ 'items' => ['description' => '每周的周几触发提醒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'StartDateTime' => ['title' => '调度开始时间', 'description' => '提醒生效的开始时间。', 'type' => 'string', 'format' => 'int64', 'example' => '1630054800000'],
+ 'EndDateTime' => ['title' => '调度结束时间', 'description' => '提醒失效的结束时间。', 'type' => 'string', 'format' => 'int64', 'example' => '1661598000000'],
],
],
],
@@ -2619,292 +1401,96 @@
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数不合法。\\",\\n \\"Model\\": {\\n \\"RemindResponses\\": [\\n {\\n \\"RemindId\\": 0,\\n \\"RepeatCount\\": 1,\\n \\"ActionTopic\\": \\"宝宝快去刷牙\\",\\n \\"DayDesc\\": \\"每天\\",\\n \\"RemindTime\\": \\"1629850800000\\",\\n \\"Week\\": \\"周三\\",\\n \\"RecurrenceRule\\": {\\n \\"Freq\\": \\"WEEKLY\\",\\n \\"Year\\": 2021,\\n \\"Month\\": 8,\\n \\"Day\\": 27,\\n \\"Hour\\": 18,\\n \\"Minute\\": 0,\\n \\"Second\\": 0,\\n \\"DaysOfMonth\\": [\\n 1\\n ],\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"StartDateTime\\": 1630054800000,\\n \\"EndDateTime\\": 1661598000000\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListRemindersResponse>\\n <Success>true</Success>\\n <ErrorCode>400</ErrorCode>\\n <ErrorMsg>参数不合法。</ErrorMsg>\\n <Model>\\n <RemindResponses>\\n <RepeatCount>1</RepeatCount>\\n <ActionTopic>宝宝快去刷牙</ActionTopic>\\n <DayDesc>每天</DayDesc>\\n <RemindTime>1629850800000</RemindTime>\\n <Week>周三</Week>\\n <RecurrenceRule>\\n <Freq>WEEKLY</Freq>\\n <Year>2021</Year>\\n <Month>8</Month>\\n <Day>27</Day>\\n <Hour>18</Hour>\\n <Minute>0</Minute>\\n <Second>0</Second>\\n <DaysOfMonth>1</DaysOfMonth>\\n <DaysOfWeek>1</DaysOfWeek>\\n <StartDateTime>1630054800000</StartDateTime>\\n <EndDateTime>1661598000000</EndDateTime>\\n </RecurrenceRule>\\n </RemindResponses>\\n </Model>\\n</ListRemindersResponse>","errorExample":""}]',
'title' => '获取提醒列表',
],
- 'UpdateReminder' => [
- 'summary' => '用户更新在天猫精灵设备上创建的提醒。',
- 'path' => '/v1.0/iap/reminder/update',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'PullCashier' => [
+ 'summary' => '用户在天猫精灵设备上拉起收银台。',
+ 'path' => '/v1.0/iap/pull/cashier/',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
- 'AliGenie_Auth_Token' => [],
+ 'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Payload',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '该服务的请求入参。',
+ 'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '提醒id',
- 'description' => '更新的提醒ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '20***34',
- ],
- 'Content' => [
- 'title' => '提醒内容',
- 'description' => '提醒信息的详细内容。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '更新提醒内容',
- ],
- 'SubjectId' => [
- 'title' => '应用id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20****01',
- ],
- 'UserId' => [
- 'title' => '精灵id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12****56',
- ],
- 'DeviceId' => [
- 'title' => '设备id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BED****AAC',
- ],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '该调用是否为调试。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- 'default' => 'false',
- ],
- 'RecurrenceRule' => [
- 'title' => '提醒调度信息',
- 'description' => '提醒的调度信息。',
- 'type' => 'object',
- 'properties' => [
- 'Year' => [
- 'title' => '触发时间的年',
- 'description' => '触发提醒的时间年份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2021',
- ],
- 'Month' => [
- 'title' => '触发时间的月',
- 'description' => '触发提醒的时间月份。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'Day' => [
- 'title' => '触发时间的日',
- 'description' => '触发提醒的时间日期。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '25',
- ],
- 'Hour' => [
- 'title' => '触发时间的时',
- 'description' => '触发提醒的时间时钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '12',
- ],
- 'Minute' => [
- 'title' => '触发时间的分',
- 'description' => '触发提醒的时间分钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'Second' => [
- 'title' => '触发时间的秒',
- 'description' => '触发提醒的时间秒钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'Freq' => [
- 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY',
- 'description' => '循环类型:'."\n"
- ."\n"
- .'- ONCE:单次'."\n"
- .'- DAILY:每天'."\n"
- .'- WEEKLY:每周'."\n"
- .'- MONTHLY:每月',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ONCE',
- 'enum' => [
- 'ONCE',
- 'DAILY',
- 'WEEKLY',
- 'MONTHLY',
- ],
- ],
- 'StartDateTime' => [
- 'title' => '开始时间,时间戳,毫秒',
- 'description' => '提醒开始的生效时间,时间戳毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1635134400000',
- ],
- 'EndDateTime' => [
- 'title' => '结束时间,时间戳,毫秒',
- 'description' => '提醒结束的失效时间,时间戳毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1635134700000',
- ],
- 'DaysOfMonth' => [
- 'title' => '月循环相关,表示每月的几号的集合,数值范围为1-31',
- 'description' => '设置按月提醒,即每月几号触发提醒。',
- 'type' => 'array',
- 'items' => [
- 'description' => '设置按月提醒的具体日期,取值范围为:1~31。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
- 'DaysOfWeek' => [
- 'title' => '周循环相关,表示每周几触发,数值范围为1-7',
- 'description' => '设置按周提醒,即每周几触发提醒。',
- 'type' => 'array',
- 'items' => [
- 'description' => '设置按周提醒的具体日期,取值范围为:1~7。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
+ 'SubjectId' => ['title' => '应用id', 'type' => 'string', 'required' => true],
+ 'DeviceId' => ['type' => 'string', 'required' => false],
+ 'originUuid' => ['description' => '明文uuid', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B'],
],
- 'required' => true,
+ 'required' => false,
],
],
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
- 'description' => '用户标识信息。',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型 '."\n"
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型'."\n"
+ ."\n"
.'- OPEN_ID:默认的用户ID标识。'."\n"
.'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用平台申请过组织后才会有该值。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
.'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
.'- SKILL_ID:技能ID,云端链路的编码类型。',
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- ."\n"
- .'- 编码类型设置为SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型设置为PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '设备标识信息',
- 'description' => '设备标识信息。',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型。'."\n"
+ 'description' => '设备Id的类型 '."\n"
.'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,在猫精技能应用平台申请过组织后才会有该值。',
+ .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
'type' => 'string',
- 'required' => true,
+ 'required' => false,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -2912,264 +1498,17 @@
.'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
.'- SKILL_ID:技能ID,云端链路的编码类型。',
'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- ."\n"
- .'- 编码类型设置为SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'- 编码类型设置为PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。',
- 'type' => 'string',
'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'title' => '服务成功标识',
- 'description' => '服务成功标识',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'ErrorMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '不能设置过去的时间。',
- ],
- 'Model' => [
- 'title' => '更新提醒的id',
- 'description' => '更新提醒的id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20****1',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"<UpdateReminderResponse>\\n <Success>true</Success>\\n</UpdateReminderResponse>","errorExample":""}]',
- 'title' => '更新提醒',
- ],
- 'DeleteReminder' => [
- 'summary' => '用户删除在天猫精灵设备上创建的提醒。',
- 'path' => '/v1.0/iap/reminder/delete',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AliGenie_Auth_Token' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'Payload',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '提醒的唯一id',
- 'description' => '提醒的唯一id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '20****34',
- ],
- 'UserId' => [
- 'title' => '精灵id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12****56',
- ],
- 'DeviceId' => [
- 'title' => '设备id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BED****AAC',
- ],
- 'SubjectId' => [
- 'title' => '应用id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20****01',
- ],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '调试标识',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- 'default' => 'false',
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '用户标识信息',
- 'description' => '用户标识信息',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型'."\n"
- .'- OPEN_ID:默认的用户ID标识'."\n"
- .'- UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SKILL_ID',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为`UNION_ID`时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'DeviceInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 '."\n"
- .'- OPEN_ID:默认的设备ID标识'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型'."\n"
- .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型'."\n"
- .'- SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SKILL_ID',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是`SKILL_ID`时,其值为应用的Skill ID; 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为`UNION_ID`时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
- 'required' => true,
+ 'required' => false,
],
],
],
@@ -3180,226 +1519,33 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'title' => '服务成功标识',
- 'description' => '服务成功标识',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'ErrorMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '参数错误。',
- ],
+ 'RetCode' => ['title' => '错误吗', 'description' => '返回的错误码,`0`表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RetMsg' => ['title' => '错误信息', 'description' => '返回的错误信息,成功则不返回信息。', 'type' => 'string', 'example' => '请求成功'],
+ 'RetValue' => ['description' => '拉取收银台的结果,true表示成功,false表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数错误。\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteReminderResponse>\\n <Success>true</Success>\\n</DeleteReminderResponse>","errorExample":""}]',
- 'title' => '删除提醒',
- ],
- 'WakeUpApp' => [
- 'summary' => '在带屏音箱上,主动唤起猫精的屏显应用。需先在猫精技能应用平台进行能力申请。',
- 'path' => '/v1.0/iap/wakeup',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AliGenie_Auth_SPI' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参。',
- 'type' => 'object',
- 'properties' => [
- 'Path' => [
- 'title' => '应用拉起路径,类似在技能应用控制台中填的唤起链接。',
- 'description' => '应用拉起路径,类似在技能应用控制台中填的唤起链接。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '应用拉起路径',
- ],
- 'SubjectId' => [
- 'title' => '猫精应用id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2021****001',
- ],
- 'TargetInfo' => [
- 'title' => '要拉起的目标设备信息。',
- 'description' => '要拉起的目标设备信息。',
- 'type' => 'object',
- 'properties' => [
- 'TargetType' => [
- 'title' => '推送目标类型,获取到对应设备标识时的类型 DEVICE_UNION_ID:设备unionId; DEVICE_OPEN_ID:设备openId',
- 'description' => '推送目标类型,获取到对应设备标识时的类型:'."\n"
- .'- `DEVICE_UNION_ID`:设备unionId'."\n"
- .'- `DEVICE_OPEN_ID`:设备openId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DEVICE_OPEN_ID',
- 'enum' => [
- 'DEVICE_UNION_ID',
- 'DEVICE_OPEN_ID',
- ],
- ],
- 'TargetIdentity' => [
- 'title' => '推送目标类型对应的标识值',
- 'description' => '推送目标类型对应的标识值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=',
- ],
- 'OrganizationId' => [
- 'title' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。',
- 'description' => '组织标识,推送类型是`XX_UNION_XX`时才需要配。当存在多种途径获取猫精设备标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '11',
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型: PACKAGE_NAME:apk包名 SKILL_ID:技能id',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型:'."\n"
- .'- PACKAGE_NAME:apk包名 '."\n"
- .'- SKILL_ID:技能ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,例如:编码类型是SKILLID,其值就为webhook服务中得到的skillId;编码类似是PACKAGENAME,其值就为对应客户端app的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- .'- 编码类型是SKILLID时,其值为webhook服务中得到的skill ID。'."\n"
- .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'apk包名',
- ],
- ],
- 'required' => true,
- ],
- 'IsDebug' => [
- 'title' => '是否调试',
- 'description' => '调试标识,当技能应用处于调试阶段时,设置此标识将决定获取技能应用信息时,是编辑态信息还是线上信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
- ],
- 'required' => true,
- ],
- ],
- ],
- 'responses' => [
- 200 => [],
- ],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.WakeUpApp.Device.Offline',
- 'errorMessage' => 'The Target Device is not online.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId',
- 'errorMessage' => 'The AliGenie app does not release.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Body',
- 'errorMessage' => 'You must specify request body.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo',
- 'errorMessage' => 'You must specify TargetInfo.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Path',
- 'errorMessage' => 'You must specify Path.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity',
- 'errorMessage' => 'You must specify TargetIdentity.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey',
- 'errorMessage' => 'You must specify EncodeKey.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType',
- 'errorMessage' => 'You must specify EncodeType.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType',
- 'errorMessage' => 'You must specify TargetType.',
- ],
- [
- 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId',
- 'errorMessage' => 'You must specify OrganizationId.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => '500', 'errorMessage' => '内部服务错误_xxx', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<WakeUpAppResponse/>","errorExample":""}]',
- 'title' => '主动唤起屏显应用',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求成功\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<PullCashierResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</PullCashierResponse>","errorExample":""}]',
+ 'title' => '拉起收银台',
],
'PushNotifications' => [
'summary' => '执行天猫精灵的消息推送功能。需先在猫精技能应用平台进行能力申请和消息模板配置。',
'path' => '/v1.0/iap/notifications',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
@@ -3428,40 +1574,19 @@
'type' => 'string',
'required' => false,
'example' => 'DEVICE_OPEN_ID',
- 'enum' => [
- 'DEVICE_UNION_ID',
- 'DEVICE_OPEN_ID',
- 'USER_UNION_ID',
- 'USER_OPEN_ID',
- ],
- ],
- 'TargetIdentity' => [
- 'title' => '推送目标类型对应的标识值。',
- 'description' => '推送目标类型对应的标识值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=',
+ 'enum' => ['DEVICE_UNION_ID', 'DEVICE_OPEN_ID', 'USER_UNION_ID', 'USER_OPEN_ID'],
],
+ 'TargetIdentity' => ['title' => '推送目标类型对应的标识值。', 'description' => '推送目标类型对应的标识值。', 'type' => 'string', 'required' => false, 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY='],
],
'required' => true,
],
- 'MessageTemplateId' => [
- 'title' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。',
- 'description' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2iU81*****G9elJ',
- ],
+ 'MessageTemplateId' => ['title' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。', 'description' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板ID。', 'type' => 'string', 'required' => true, 'example' => '2iU81*****G9elJ'],
'PlaceHolder' => [
'title' => '占位符信息,例如:模板是【你好,{nick}!】这里可以是:{"nick":"小甜甜"}',
'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。此外,在占位符参数里我们还可以对填写的应用调起链接增加参数,以支持跳转到指定地址的功能,如:`{"nick":"小甜甜","_URL_SUFFIX_":"xxx"}`。消息弹窗内的跳转地址就是:应用调起链接+`${_URL_SUFFIX_}`,此功能只对配置了调起链接的应用有效',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"nick":"小甜甜"}',
- 'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => '{"nick":"小甜甜"}', 'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。'],
'example' => '{"nick":"张三"}',
],
'EncodeType' => [
@@ -3472,35 +1597,13 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,例如:编码类型是SKILLID,其值就为webhook服务中得到的skillId;编码类似是PACKAGENAME,其值就为对应客户端app的packageName。',
- 'description' => '编码类型对应的值。'."\n"
- .'- 编码类型是SKILL_ID时,其值为webhook服务中得到的skill ID。'."\n"
- .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'apk包名',
- ],
- 'OrganizationId' => [
- 'title' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。',
- 'description' => '组织标识,推送类型是`XX_UNION_XX`时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2',
- ],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '调试标识,当技能应用处于调试阶段时,设置此标识将决定获取技能应用信息时,是编辑态信息还是线上信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,例如:编码类型是SKILLID,其值就为webhook服务中得到的skillId;编码类似是PACKAGENAME,其值就为对应客户端app的packageName。', 'description' => '编码类型对应的值。'."\n"
+ .'- 编码类型是SKILL_ID时,其值为webhook服务中得到的skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => 'apk包名'],
+ 'OrganizationId' => ['title' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。', 'description' => '组织标识,推送类型是`XX_UNION_XX`时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。', 'type' => 'string', 'required' => false, 'example' => '2'],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '调试标识,当技能应用处于调试阶段时,设置此标识将决定获取技能应用信息时,是编辑态信息还是线上信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
'required' => true,
],
@@ -3514,11 +1617,7 @@
'description' => '身份信息。',
'type' => 'object',
'properties' => [
- 'SubjectId' => [
- 'title' => '猫精应用id,【开发者平台-技能应用】创建应用后得到的应用id',
- 'type' => 'string',
- 'example' => '20*****01',
- ],
+ 'SubjectId' => ['title' => '猫精应用id,【开发者平台-技能应用】创建应用后得到的应用id', 'type' => 'string', 'example' => '20*****01'],
],
'required' => false,
],
@@ -3529,48 +1628,18 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder',
- 'errorMessage' => 'The template placeholder information is missing.',
- ],
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget',
- 'errorMessage' => 'Failed to identify message target.',
- ],
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId',
- 'errorMessage' => 'The template information is invalid.',
- ],
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.Application.Invalid',
- 'errorMessage' => 'The AliGenie app info is invalid.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.Application.Status',
- 'errorMessage' => 'The AliGenie app has not been released.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.Application.Url',
- 'errorMessage' => 'The AliGenie app awaken url is missing.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo',
- 'errorMessage' => 'Failed to identify device.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo',
- 'errorMessage' => 'Failed to identify user.',
- ],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'errorMessage' => 'The template placeholder information is missing.', 'description' => ''],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'errorMessage' => 'Failed to identify message target.', 'description' => ''],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'errorMessage' => 'The template information is invalid.', 'description' => ''],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.Application.Invalid', 'errorMessage' => 'The AliGenie app info is invalid.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.Application.Status', 'errorMessage' => 'The AliGenie app has not been released.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.Application.Url', 'errorMessage' => 'The AliGenie app awaken url is missing.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'errorMessage' => 'Failed to identify device.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'errorMessage' => 'Failed to identify user.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<PushNotificationsResponse/>","errorExample":""}]',
@@ -3579,24 +1648,15 @@
'SendNotifications' => [
'summary' => '执行天猫精灵的消息推送功能。需先在猫精技能应用平台进行能力申请和消息模板配置。',
'path' => '/v1.0/iap/general/notifications',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -3614,41 +1674,20 @@
'description' => '消息推送的目标信息。',
'type' => 'object',
'properties' => [
- 'DeviceId' => [
- 'title' => '设备id',
- 'type' => 'string',
- 'required' => true,
- ],
+ 'DeviceId' => ['title' => '设备id', 'type' => 'string', 'required' => true],
],
'required' => true,
],
- 'MessageTemplateId' => [
- 'title' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。',
- 'description' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2iU81*****G9elJ',
- ],
+ 'MessageTemplateId' => ['title' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。', 'description' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。', 'type' => 'string', 'required' => true, 'example' => '2iU81*****G9elJ'],
'PlaceHolder' => [
'title' => '占位符信息,例如:模板是【你好,{nick}!】这里可以是:{"nick":"小甜甜"}',
'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。此外,在占位符参数里我们还可以对填写的应用调起链接增加参数,以支持跳转到指定地址的功能,如:`{"nick":"小甜甜","_URL_SUFFIX_":"xxx"}`。消息弹窗内的跳转地址就是:应用调起链接+`${_URL_SUFFIX_}`,此功能只对配置了调起链接的应用有效',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。',
- 'example' => '{"nick":"小甜甜"}',
- ],
+ 'additionalProperties' => ['type' => 'string', 'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。', 'example' => '{"nick":"小甜甜"}'],
'example' => '{"nick":"张三"}',
],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '调试标识,当技能应用处于调试阶段时,设置此标识将决定获取技能应用信息时,是编辑态信息还是线上信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '调试标识,当技能应用处于调试阶段时,设置此标识将决定获取技能应用信息时,是编辑态信息还是线上信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
'required' => true,
],
@@ -3662,12 +1701,7 @@
'description' => '身份信息。',
'type' => 'object',
'properties' => [
- 'SubjectId' => [
- 'title' => '猫精应用标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20********01',
- ],
+ 'SubjectId' => ['title' => '猫精应用标识', 'type' => 'string', 'required' => true, 'example' => '20********01'],
],
'required' => false,
],
@@ -3681,13 +1715,7 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '用户Id的类型'."\n"
@@ -3696,10 +1724,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -3709,25 +1734,10 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -3741,13 +1751,7 @@
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型'."\n"
@@ -3756,10 +1760,7 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -3769,25 +1770,10 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -3798,137 +1784,176 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder',
- 'errorMessage' => 'The template placeholder information is missing.',
- ],
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget',
- 'errorMessage' => 'Failed to identify message target.',
- ],
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId',
- 'errorMessage' => 'The template information is invalid.',
- ],
- [
- 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.Application.Invalid',
- 'errorMessage' => 'The AliGenie app info is invalid.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.Application.Status',
- 'errorMessage' => 'The AliGenie app has not been released.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.Application.Url',
- 'errorMessage' => 'The AliGenie app awaken url is missing.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo',
- 'errorMessage' => 'Failed to identify device.',
- ],
- [
- 'errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo',
- 'errorMessage' => 'Failed to identify user.',
- ],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'errorMessage' => 'The template placeholder information is missing.', 'description' => ''],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'errorMessage' => 'Failed to identify message target.', 'description' => ''],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'errorMessage' => 'The template information is invalid.', 'description' => ''],
+ ['errorCode' => 'AliGenie.PushNotifications.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.Application.Invalid', 'errorMessage' => 'The AliGenie app info is invalid.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.Application.Status', 'errorMessage' => 'The AliGenie app has not been released.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.Application.Url', 'errorMessage' => 'The AliGenie app awaken url is missing.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'errorMessage' => 'Failed to identify device.', 'description' => ''],
+ ['errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'errorMessage' => 'Failed to identify user.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<SendNotificationsResponse/>","errorExample":""}]',
'title' => '消息推送_通用版',
],
- 'CheckThirdRightSendPlan' => [
- 'summary' => '商业化移动屏三方app领卡校验。',
- 'path' => '/v1.0/iap/business/CheckThirdRightSendPlan',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateReminder' => [
+ 'summary' => '用户更新在天猫精灵设备上创建的提醒。',
+ 'path' => '/v1.0/iap/reminder/update',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'AliGenie_Auth_Token' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'BizType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '设备类型',
- 'description' => '设备类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ailabs',
- ],
- ],
- [
- 'name' => 'BizGroup',
- 'in' => 'query',
- 'schema' => [
- 'title' => '设备分组',
- 'description' => '设备分组',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc',
- ],
- ],
- [
- 'name' => 'Sn',
- 'in' => 'query',
+ 'name' => 'Payload',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '设备sn',
- 'description' => '设备sn',
- 'type' => 'string',
- 'required' => false,
- 'example' => '01000019100307010000600',
+ 'title' => '服务请求入参',
+ 'description' => '该服务的请求入参。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '提醒id', 'description' => '更新的提醒ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20***34'],
+ 'Content' => ['title' => '提醒内容', 'description' => '提醒信息的详细内容。', 'type' => 'string', 'required' => true, 'example' => '更新提醒内容'],
+ 'SubjectId' => ['title' => '应用id', 'type' => 'string', 'required' => true, 'example' => '20****01'],
+ 'UserId' => ['title' => '精灵id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****56'],
+ 'DeviceId' => ['title' => '设备id', 'type' => 'string', 'required' => true, 'example' => 'BED****AAC'],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '该调用是否为调试。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'],
+ 'RecurrenceRule' => [
+ 'title' => '提醒调度信息',
+ 'description' => '提醒的调度信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Year' => ['title' => '触发时间的年', 'description' => '触发提醒的时间年份。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2021'],
+ 'Month' => ['title' => '触发时间的月', 'description' => '触发提醒的时间月份。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'Day' => ['title' => '触发时间的日', 'description' => '触发提醒的时间日期。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25'],
+ 'Hour' => ['title' => '触发时间的时', 'description' => '触发提醒的时间时钟数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12'],
+ 'Minute' => ['title' => '触发时间的分', 'description' => '触发提醒的时间分钟数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'Second' => ['title' => '触发时间的秒', 'description' => '触发提醒的时间秒钟数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'Freq' => [
+ 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY',
+ 'description' => '循环类型:'."\n"
+ ."\n"
+ .'- ONCE:单次'."\n"
+ .'- DAILY:每天'."\n"
+ .'- WEEKLY:每周'."\n"
+ .'- MONTHLY:每月',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ONCE',
+ 'enum' => ['ONCE', 'DAILY', 'WEEKLY', 'MONTHLY'],
+ ],
+ 'StartDateTime' => ['title' => '开始时间,时间戳,毫秒', 'description' => '提醒开始的生效时间,时间戳毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134400000'],
+ 'EndDateTime' => ['title' => '结束时间,时间戳,毫秒', 'description' => '提醒结束的失效时间,时间戳毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1635134700000'],
+ 'DaysOfMonth' => [
+ 'title' => '月循环相关,表示每月的几号的集合,数值范围为1-31',
+ 'description' => '设置按月提醒,即每月几号触发提醒。',
+ 'type' => 'array',
+ 'items' => ['description' => '设置按月提醒的具体日期,取值范围为:1~31。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ ],
+ 'DaysOfWeek' => [
+ 'title' => '周循环相关,表示每周几触发,数值范围为1-7',
+ 'description' => '设置按周提醒,即每周几触发提醒。',
+ 'type' => 'array',
+ 'items' => ['description' => '设置按周提醒的具体日期,取值范围为:1~7。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ 'required' => true,
],
],
[
- 'name' => 'SupplierId',
- 'in' => 'query',
+ 'name' => 'UserInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '供应商id',
- 'description' => '供应商id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => [
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型 '."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用平台申请过组织后才会有该值。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值。'."\n"
+ ."\n"
+ .'- 编码类型设置为SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型设置为PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
+ 'required' => true,
],
],
[
- 'name' => 'ExtendInfo',
- 'in' => 'query',
+ 'name' => 'DeviceInfo',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息。',
'type' => 'object',
- 'required' => false,
- 'example' => '{}',
+ 'properties' => [
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => [
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型。'."\n"
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,在猫精技能应用平台申请过组织后才会有该值。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值。'."\n"
+ ."\n"
+ .'- 编码类型设置为SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型设置为PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
+ 'required' => true,
],
],
],
@@ -3939,213 +1964,130 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RetCode' => [
- 'title' => '返回code',
- 'description' => '返回code',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RetMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '系统异常',
- ],
- 'RetValue' => [
- 'description' => '调用接口的结果',
- 'type' => 'object',
- 'properties' => [
- 'CardType' => [
- 'title' => '卡种',
- 'description' => '卡种',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡',
- ],
- 'RightsExpiredDate' => [
- 'title' => '权益失效时间',
- 'description' => '权益失效时间',
- 'type' => 'string',
- 'example' => '"1713262192005"',
- ],
- 'ActivateDate' => [
- 'title' => '激活时间',
- 'description' => '激活时间',
- 'type' => 'string',
- 'example' => '"1713262192005"',
- ],
- 'ChannelCode' => [
- 'title' => '渠道code',
- 'description' => '渠道code',
- 'type' => 'string',
- 'example' => 'TB',
- ],
- 'ChannelName' => [
- 'title' => '渠道名称',
- 'description' => '渠道名称',
- 'type' => 'string',
- 'example' => '淘宝',
- ],
- 'RequestId' => [
- 'title' => '请求iid',
- 'description' => '请求iid',
- 'type' => 'string',
- 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F',
- ],
- 'ExtendInfo' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'example' => '{}',
- ],
- ],
- ],
+ 'Success' => ['title' => '服务成功标识', 'description' => '服务成功标识', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'ErrorMsg' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '不能设置过去的时间。'],
+ 'Model' => ['title' => '更新提醒的id', 'description' => '更新提醒的id', 'type' => 'integer', 'format' => 'int64', 'example' => '20****1'],
],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetValue\\": {\\n \\"CardType\\": 0,\\n \\"RightsExpiredDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ActivateDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ChannelCode\\": \\"TB\\",\\n \\"ChannelName\\": \\"淘宝\\",\\n \\"RequestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\",\\n \\"ExtendInfo\\": {}\\n }\\n}","type":"json"}]',
- 'title' => '三方领取会员校验',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"<UpdateReminderResponse>\\n <Success>true</Success>\\n</UpdateReminderResponse>","errorExample":""}]',
+ 'title' => '更新提醒',
],
- 'CallBackThirdRightSendPlan' => [
- 'summary' => '三方领取回调接口。',
- 'path' => '/v1.0/iap/business/CallBackThirdRightSendPlan',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'VideoAppReport' => [
+ 'summary' => '用于开发者在与猫精进行会员合作的场景下上报其会员信息。',
+ 'path' => '/v1.0/iap/vip/use/video/report',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'BizType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '设备类型',
- 'description' => '设备类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ailabs',
- ],
- ],
- [
- 'name' => 'BizGroup',
- 'in' => 'query',
- 'schema' => [
- 'title' => '设备分组',
- 'description' => '设备分组',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc',
- ],
- ],
- [
- 'name' => 'Sn',
- 'in' => 'query',
- 'schema' => [
- 'title' => '设备对应的sn',
- 'description' => '设备对应的sn',
- 'type' => 'string',
- 'required' => false,
- 'example' => '01000019100307010000600',
- ],
- ],
- [
- 'name' => 'SupplierId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '供应商id',
- 'description' => '供应商id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'GenieOpenId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '精灵id',
- 'description' => '精灵id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1dsds2FzCXFGVA1ADS',
- ],
- ],
- [
- 'name' => 'ReceiveStatus',
- 'in' => 'query',
- 'schema' => [
- 'title' => '领取状态',
- 'description' => '领取状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'CardType',
- 'in' => 'query',
+ 'name' => 'Payload',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡',
- 'description' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '业务参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceId' => ['title' => '设备di', 'type' => 'string', 'required' => false],
+ 'isLogin' => ['description' => '会员是否登录。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ 'isVip' => ['description' => '该账号是否为会员。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ 'startTime' => ['description' => '会员的开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1652337963097'],
+ 'endTime' => ['description' => '会员的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1652337963097'],
+ 'loginNick' => ['description' => '账号的昵称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ 'phone' => ['description' => '账户的手机号码。', 'type' => 'string', 'required' => false, 'example' => '188*777'],
+ 'pkgName' => ['description' => '应用包名。', 'type' => 'string', 'required' => true, 'example' => 'com.***.test'],
+ 'originUuid' => ['description' => '明文uuid', 'type' => 'string', 'required' => false, 'example' => '731D5F********DC3B'],
+ ],
'required' => false,
- 'example' => '1001',
],
],
[
- 'name' => 'ErrorMsg',
- 'in' => 'query',
+ 'name' => 'UserInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '领取异常',
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => [
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型 '."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
+ 'required' => true,
],
],
[
- 'name' => 'ExtendInfo',
- 'in' => 'query',
+ 'name' => 'DeviceInfo',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息',
'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => [
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型 '."\n"
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ .'- PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'- SKILL_ID:技能ID,云端链路的编码类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'- 编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'- 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
'required' => false,
- 'example' => '{}',
],
],
],
@@ -4156,223 +2098,161 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RetValue' => [
- 'title' => '返回结果 true/false',
- 'description' => '返回结果 true/false',
- 'type' => 'boolean',
- ],
- 'RetMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '系统异常',
- ],
- 'RetCode' => [
- 'title' => '错误状态码',
- 'description' => '错误状态码',
- 'type' => 'string',
- 'example' => '400',
- ],
- 'requestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F',
- ],
+ 'RetCode' => ['description' => '返回的错误码,`0`表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RetMsg' => ['description' => '返回的错误信息,成功则不返回信息。', 'type' => 'string', 'example' => '请求异常'],
+ 'RetValue' => ['description' => '返回的调用结果'."\n"
+ ."\n"
+ .'- true表示成功'."\n"
+ .'- false表示失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => '500', 'errorMessage' => '内部服务错误_xxx', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetValue\\": true,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetCode\\": \\"400\\",\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]',
- 'title' => '三方领取会员回调',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"<VideoAppReportResponse>\\n <RetCode>0</RetCode>\\n <RetValue>true</RetValue>\\n</VideoAppReportResponse>","errorExample":""}]',
+ 'title' => '上报三方会员信息',
+ 'changeSet' => [],
],
- 'ThirdImmediateMsgPush' => [
- 'summary' => '三方即时信息数据变更事件推送。',
- 'path' => '/v1.0/iap/thirdImmediateMsgPush',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'WakeUpApp' => [
+ 'summary' => '在带屏音箱上,主动唤起猫精的屏显应用。需先在猫精技能应用平台进行能力申请。',
+ 'path' => '/v1.0/iap/wakeup',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '用户id',
- 'description' => '用户id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'userId',
- ],
- ],
- [
- 'name' => 'OrderId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '订单id',
- 'description' => '订单id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'orderId',
- ],
- ],
- [
- 'name' => 'BizType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务类型',
- 'description' => '业务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FLIGHT',
- ],
- ],
- [
- 'name' => 'TrafficChangeType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '变动类型',
- 'description' => '变动类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'trafficChangeType',
- ],
- ],
- [
- 'name' => 'TrafficChangeTypeDesc',
- 'in' => 'query',
- 'schema' => [
- 'title' => '变动类型描述',
- 'description' => '变动类型描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'trafficChangeTypeDesc',
- ],
- ],
- [
- 'name' => 'ChangeDetail',
- 'in' => 'query',
- 'schema' => [
- 'title' => '变动信息明细',
- 'description' => '变动信息明细',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'changeDetail',
- ],
- ],
- [
- 'name' => 'TrafficJourneyIds',
- 'in' => 'query',
- 'schema' => [
- 'title' => '变更的行程id',
- 'description' => '变更的行程id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'trafficJourneyIds',
- ],
- ],
- [
- 'name' => 'TrafficSubOrderIds',
- 'in' => 'query',
- 'schema' => [
- 'title' => '变更的火车申请单子订单id',
- 'description' => '变更的火车申请单子订单id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'trafficSubOrderIds',
- ],
- ],
- [
- 'name' => 'PsgIds',
- 'in' => 'query',
- 'schema' => [
- 'title' => '变更的乘客id',
- 'description' => '变更的乘客id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'psgIds',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '',
- 'description' => '',
+ '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' => '推送结果',
+ 'Path' => ['title' => '应用拉起路径,类似在技能应用控制台中填的唤起链接。', 'description' => '应用拉起路径,类似在技能应用控制台中填的唤起链接。', 'type' => 'string', 'required' => true, 'example' => '应用拉起路径'],
+ 'SubjectId' => ['title' => '猫精应用id', 'type' => 'string', 'required' => true, 'example' => '2021****001'],
+ 'TargetInfo' => [
+ 'title' => '要拉起的目标设备信息。',
+ 'description' => '要拉起的目标设备信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
+ 'TargetType' => [
+ 'title' => '推送目标类型,获取到对应设备标识时的类型 DEVICE_UNION_ID:设备unionId; DEVICE_OPEN_ID:设备openId',
+ 'description' => '推送目标类型,获取到对应设备标识时的类型:'."\n"
+ .'- `DEVICE_UNION_ID`:设备unionId'."\n"
+ .'- `DEVICE_OPEN_ID`:设备openId',
'type' => 'string',
- 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B',
+ 'required' => true,
+ 'example' => 'DEVICE_OPEN_ID',
+ 'enum' => ['DEVICE_UNION_ID', 'DEVICE_OPEN_ID'],
],
- 'Success' => [
- 'title' => '是否推送成功',
- 'description' => '是否推送成功',
- 'type' => 'boolean',
+ 'TargetIdentity' => ['title' => '推送目标类型对应的标识值', 'description' => '推送目标类型对应的标识值。', 'type' => 'string', 'required' => true, 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY='],
+ 'OrganizationId' => ['title' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。', 'description' => '组织标识,推送类型是`XX_UNION_XX`时才需要配。当存在多种途径获取猫精设备标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。', 'type' => 'string', 'required' => false, 'example' => '11'],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型: PACKAGE_NAME:apk包名 SKILL_ID:技能id',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型:'."\n"
+ .'- PACKAGE_NAME:apk包名 '."\n"
+ .'- SKILL_ID:技能ID',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,例如:编码类型是SKILLID,其值就为webhook服务中得到的skillId;编码类似是PACKAGENAME,其值就为对应客户端app的packageName。', 'description' => '编码类型对应的值。'."\n"
+ .'- 编码类型是SKILLID时,其值为webhook服务中得到的skill ID。'."\n"
+ .'- 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => 'apk包名'],
],
+ 'required' => true,
],
+ 'IsDebug' => ['title' => '是否调试', 'description' => '调试标识,当技能应用处于调试阶段时,设置此标识将决定获取技能应用信息时,是编辑态信息还是线上信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
+ 'required' => true,
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [
+ 200 => [],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.WakeUpApp.Device.Offline', 'errorMessage' => 'The Target Device is not online.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'errorMessage' => 'The AliGenie app does not release.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Body', 'errorMessage' => 'You must specify request body.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'errorMessage' => 'You must specify TargetInfo.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'errorMessage' => 'You must specify Path.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', 'errorMessage' => 'You must specify TargetIdentity.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', 'errorMessage' => 'You must specify EncodeKey.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'errorMessage' => 'You must specify EncodeType.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'errorMessage' => 'You must specify TargetType.', 'description' => ''],
+ ['errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', 'errorMessage' => 'You must specify OrganizationId.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"500000000\\",\\n \\"ErrorMsg\\": \\"服务器内部异常\\",\\n \\"Model\\": {\\n \\"RequestId\\": \\"2DF6FEFE-3301-16DD-ABCC-968A9524920B\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '三方即时信息数据变更事件推送',
+ 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<WakeUpAppResponse/>","errorExample":""}]',
+ 'title' => '主动唤起屏显应用',
],
],
- 'endpoints' => [
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'openapi.aligenie.com',
- ],
+ 'endpoints' => [],
+ 'errorCodes' => [
+ ['code' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.GetPhoneNumber.BizError', 'message' => 'The user has no phoneNumber.', 'http_code' => 400, 'description' => '用户未绑定手机号'],
+ ['code' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', 'message' => 'The user information does not exist.', 'http_code' => 400, 'description' => '用户信息不存在'],
+ ['code' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '参数错误'],
+ ['code' => 'AliGenie.Notifications.Application.Invalid', 'message' => 'The AliGenie app info is invalid.', 'http_code' => 400, 'description' => '应用信息缺失'],
+ ['code' => 'AliGenie.Notifications.Application.Status', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => '应用未发布'],
+ ['code' => 'AliGenie.Notifications.Application.Url', 'message' => 'The AliGenie app awaken url is missing.', 'http_code' => 400, 'description' => '应用唤起链接未配置'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'The device not bind user.', 'http_code' => 400, 'description' => '设备未绑定用户'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'Failed to identify device.', 'http_code' => 400, 'description' => '设备标识无法识别'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'message' => 'Failed to identify user.', 'http_code' => 400, 'description' => '用户标识无法识别'],
+ ['code' => 'AliGenie.Public.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '系统内部错误.'],
+ ['code' => 'AliGenie.Public.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template information is invalid.', 'http_code' => 400, 'description' => '模板信息有误'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template is unavailable.', 'http_code' => 400, 'description' => '模板未处于可用状态'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template does not exist.', 'http_code' => 400, 'description' => '模板不存在'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'message' => 'The template placeholder information is missing.', 'http_code' => 400, 'description' => '模板占位符信息未填充'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'message' => 'Failed to identify message target.', 'http_code' => 400, 'description' => '消息发送目标识别失败'],
+ ['code' => 'AliGenie.Reminder.CreateFail', 'message' => 'The creation request is not allowed.', 'http_code' => 403, 'description' => '提醒创建行为不合理'],
+ ['code' => 'AliGenie.Reminder.DeviceError', 'message' => 'The device is offline.', 'http_code' => 504, 'description' => '设备离线,暂时无法操作'],
+ ['code' => 'AliGenie.Reminder.HasNoAuthority', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 505, 'description' => '没有此数据操作权限'],
+ ['code' => 'AliGenie.Reminder.StopService', 'message' => 'The servic has stopped.', 'http_code' => 503, 'description' => '暂停服务'],
+ ['code' => 'AliGenie.WakeUpApp.Device.Offline', 'message' => 'The target device is not online.', 'http_code' => 400, 'description' => '目标设备不在线'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Body', 'message' => 'You must specify request body.', 'http_code' => 400, 'description' => '服务请求参数为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', 'message' => 'You must specify EncodeKey.', 'http_code' => 400, 'description' => 'EncodeKey为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'You must specify EncodeType.', 'http_code' => 400, 'description' => 'EncodeType为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'The specified EncodeType is invalid.', 'http_code' => 400, 'description' => 'EncodeType非法 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'You must specify GenieAppId.', 'http_code' => 400, 'description' => 'GenieAppId为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app does not exist.', 'http_code' => 400, 'description' => '猫精应用不存在 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The GenieApp information is inmcomplete.', 'http_code' => 400, 'description' => 'GenieApp信息不完整 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not configured wake up link.', 'http_code' => 400, 'description' => '猫精应用缺乏唤起链接配置 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The application is not installed.', 'http_code' => 400, 'description' => '应用未安装'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => '应用未发布'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', 'message' => 'You must specify OrganizationId.', 'http_code' => 400, 'description' => 'OrganizationId为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'You must specify Path.', 'http_code' => 400, 'description' => 'Path为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'The wake up path is invalid.', 'http_code' => 400, 'description' => '唤起路径有误 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', 'message' => 'You must specify TargetIdentity.', 'http_code' => 400, 'description' => 'TargetIdentity为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'You must specify TargetInfo.', 'http_code' => 400, 'description' => 'TargetInfo为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'The specified TargetInfo is invalid.', 'http_code' => 400, 'description' => 'TargetInfo信息有误'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'You must specify TargetType.', 'http_code' => 400, 'description' => 'TargetType为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'The specified TargetType is invalid.', 'http_code' => 400, 'description' => 'TargetType非法'],
+ ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid', 'http_code' => 400, 'description' => '参数无效'],
+ ['code' => 'ServerError', 'message' => 'internal server error', 'http_code' => 500, 'description' => '内部错误'],
+ ['code' => 'SystemError', 'message' => 'System Error occured.', 'http_code' => 400, 'description' => '系统异常'],
],
+ 'changeSet' => [],
];
diff --git a/data/zh_cn/aligenie/ip_1.0/api-docs.php b/data/zh_cn/aligenie/ip_1.0/api-docs.php
index ffa2631..1aecb41 100644
--- a/data/zh_cn/aligenie/ip_1.0/api-docs.php
+++ b/data/zh_cn/aligenie/ip_1.0/api-docs.php
@@ -1,1069 +1,465 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'AliGenie',
- 'product' => 'AliGenie',
- 'version' => 'ip_1.0',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'AliGenie', 'version' => 'ip_1.0'],
'directories' => [
- [
- 'id' => 172223,
- 'title' => '管理后台API',
- 'type' => 'directory',
- 'children' => [
- [
- 'id' => 176686,
- 'title' => '酒店管理',
- 'type' => 'directory',
- 'children' => [
- 'GetRelationProductList',
- 'CreateHotel',
- 'UpdateHotel',
- 'RemoveHotel',
- 'ListHotelInfo',
- 'ListHotels',
- 'AuditHotel',
- ],
- ],
- [
- 'id' => 176687,
- 'title' => '房间管理',
- 'type' => 'directory',
- 'children' => [
- 'ListHotelRooms',
- 'BatchAddHotelRoom',
- 'BatchDeleteHotelRoom',
- 'CheckoutWithAK',
- 'QueryHotelRoomDetail',
- ],
- ],
- [
- 'id' => 176688,
- 'title' => '客需服务',
- 'type' => 'directory',
- 'children' => [
- 'ListSceneCategory',
- 'ListDialogueTemplate',
- 'InsertHotelSceneBookItem',
- 'DeleteHotelSceneBookItem',
- 'UpdateHotelSceneBookItem',
- 'ListHotelSceneBookItems',
- 'ListHotelSceneItems',
- 'UpdateHotelSceneItem',
- 'GetHotelSceneItemDetail',
- 'InvokeRobotPush',
- ],
- ],
- [
- 'id' => 177617,
- 'title' => '客控管理',
- 'type' => 'directory',
- 'children' => [
- 'ImportHotelConfig',
- 'ImportRoomControlDevices',
- 'ImportRoomGenieScenes',
- 'PageGetHotelRoomDevices',
- 'QueryRoomControlDevices',
- 'GetHotelRoomDevice',
- 'ControlRoomDevice',
- 'PushVoiceBoxCommands',
- 'SyncDeviceStatusWithAk',
- 'CreateRcuScene',
- 'DeleteRcuScene',
- 'UpdateRcuScene',
- 'ExecuteScene',
- 'QuerySceneList',
- 'QueryRoomStatus',
- 'QueryRoomControlDevicesAndStatus',
- [
- 'id' => 183878,
- 'title' => '红外设备管理',
- 'type' => 'directory',
- 'children' => [
- 'ListAllProvinces',
- 'ListCitiesByProvince',
- 'ListSTBServiceProviders',
- 'ListInfraredDeviceBrands',
- 'ListInfraredRemoteControllers',
- ],
- ],
- ],
- ],
- [
- 'id' => 180467,
- 'title' => '问答管理',
- 'type' => 'directory',
- 'children' => [
- 'ListCustomQA',
- 'AddCustomQA',
- 'AddCustomQAV2',
- 'UpdateCustomQA',
- 'DeleteCustomQA',
- 'GetBasicInfoQA',
- 'UpdateBasicInfoQA',
- 'ListServiceQA',
- 'UpdateServiceQA',
- ],
- ],
- [
- 'id' => 177620,
- 'title' => '定制配置',
- 'type' => 'directory',
- 'children' => [
- 'AddCartoon',
- 'GetCartoon',
- 'DeleteCartoon',
- 'GetHotelScreenSaverStyle',
- 'AddOrUpdateHotelSetting',
- 'GetHotelSetting',
- 'DeleteHotelSetting',
- ],
- ],
- [
- 'id' => 176771,
- 'title' => '欢迎语配置',
- 'type' => 'directory',
- 'children' => [
- 'AddOrUpdateWelcomeText',
- 'GetWelcomeTextAndMusic',
- 'ResetWelcomeTextAndMusic',
- 'PushWelcomeTextAndMusic',
- 'PushWelcome',
- ],
- ],
- [
- 'id' => 176689,
- 'title' => '消息模板',
- 'type' => 'directory',
- 'children' => [
- 'AddMessageTemplate',
- 'ListHotelMessageTemplate',
- 'DeleteMessageTemplate',
- 'UpdateMessageTemplate',
- 'PushHotelMessage',
- ],
- ],
- [
- 'id' => 180476,
- 'title' => '工单管理',
- 'type' => 'directory',
- 'children' => [
- 'ListTickets',
- 'UpdateTicket',
- ],
- ],
- [
- 'id' => 176690,
- 'title' => '闹钟管理',
- 'type' => 'directory',
- 'children' => [
- 'DeleteHotelAlarm',
- 'ListHotelAlarm',
- 'CreateHotelAlarm',
- 'UpdateHotelAlarm',
- ],
- ],
- 'ChildAccountAuth',
- 'RemoveChildAccountAuth',
- [
- 'id' => 190022,
- 'title' => 'pms',
- 'type' => 'directory',
- 'children' => [
- 'PmsEventReport',
- ],
- ],
- ],
- ],
- [
- 'id' => 172229,
- 'title' => '设备端使用API',
- 'type' => 'directory',
- 'children' => [
- 'QueryDeviceStatus',
- 'ListHotelControlDevice',
- 'DeviceControl',
- 'ListHotelSceneItem',
- 'ListHotelServiceCategory',
- 'GetHotelOrderDetail',
- 'ListHotelOrder',
- 'SubmitHotelOrder',
- 'GetHotelNotice',
- 'GetHotelNoticeV2',
- 'GetHotelHomeBackImageAndModes',
- 'GetHotelSampleUtterances',
- 'GetHotelScreenSaver',
- 'RoomCheckOut',
- 'GetHotelContacts',
- 'GetHotelContactByNumber',
- 'GetHotelContactByGenieDevice',
- ],
- ],
- [
- 'id' => 179237,
- 'title' => '其他',
- 'type' => 'directory',
- 'children' => [
- 'AddOrUpdateScreenSaver',
- 'AddOrUpdateDisPlayModes',
- 'GetUnionId',
- 'HotelQrBind',
- ],
- ],
+ 'AddCartoon', 'AddCustomQA', 'AddCustomQAV2', 'AddMessageTemplate', 'AddOrUpdateDisPlayModes', 'AddOrUpdateHotelSetting', 'AddOrUpdateScreenSaver', 'AddOrUpdateWelcomeText', 'AuditHotel', 'BatchAddHotelRoom', 'BatchDeleteHotelRoom', 'CheckoutWithAK', 'ChildAccountAuth', 'ControlRoomDevice', 'CreateHotel', 'CreateHotelAlarm', 'CreateRcuScene', 'DeleteCartoon', 'DeleteCustomQA', 'DeleteHotelAlarm',
+ 'DeleteHotelSceneBookItem', 'DeleteHotelSetting', 'DeleteMessageTemplate', 'DeleteRcuScene', 'DeviceControl', 'ExecuteScene', 'GetBasicInfoQA', 'GetCartoon', 'GetHotelContactByGenieDevice', 'GetHotelContactByNumber', 'GetHotelContacts', 'GetHotelHomeBackImageAndModes', 'GetHotelNotice', 'GetHotelNoticeV2', 'GetHotelOrderDetail', 'GetHotelRoomDevice', 'GetHotelSampleUtterances', 'GetHotelSceneItemDetail', 'GetHotelScreenSaver', 'GetHotelScreenSaverStyle',
+ 'GetHotelSetting', 'GetRelationProductList', 'GetUnionId', 'GetWelcomeTextAndMusic', 'HotelQrBind', 'ImportHotelConfig', 'ImportRoomControlDevices', 'ImportRoomGenieScenes', 'InsertHotelSceneBookItem', 'InvokeRobotPush', 'ListAllProvinces', 'ListCitiesByProvince', 'ListCustomQA', 'ListDialogueTemplate', 'ListHotelAlarm', 'ListHotelControlDevice', 'ListHotelInfo', 'ListHotelMessageTemplate', 'ListHotelOrder', 'ListHotelRooms',
+ 'ListHotelSceneBookItems', 'ListHotelSceneItem', 'ListHotelSceneItems', 'ListHotelServiceCategory', 'ListHotels', 'ListInfraredDeviceBrands', 'ListInfraredRemoteControllers', 'ListSTBServiceProviders', 'ListSceneCategory', 'ListServiceQA', 'ListTickets', 'PageGetHotelRoomDevices', 'PmsEventReport', 'PushHotelMessage', 'PushVoiceBoxCommands', 'PushWelcome', 'PushWelcomeTextAndMusic', 'QueryDeviceStatus', 'QueryHotelRoomDetail', 'QueryRoomControlDevices',
+ 'QueryRoomControlDevicesAndStatus', 'QueryRoomStatus', 'QuerySceneList', 'RemoveChildAccountAuth', 'RemoveHotel', 'ResetWelcomeTextAndMusic', 'RoomCheckOut', 'SubmitHotelOrder', 'SyncDeviceStatusWithAk', 'UpdateBasicInfoQA', 'UpdateCustomQA', 'UpdateHotel', 'UpdateHotelAlarm', 'UpdateHotelSceneBookItem', 'UpdateHotelSceneItem', 'UpdateMessageTemplate', 'UpdateRcuScene', 'UpdateServiceQA', 'UpdateTicket',
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetRelationProductList' => [
- 'summary' => '获得创建酒店使用的关联产品列表。',
- 'path' => '/v1.0/ip/getRelationProductList',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddCartoon' => [
+ 'summary' => '增加或者编辑动画',
+ 'path' => '/v1.0/ip/addCartoon',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
- 'parameters' => [],
+ 'parameters' => [
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '520a0***eb'],
+ ],
+ [
+ 'name' => 'StartVideoUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '开机动画url', 'description' => '开机动画url', 'type' => 'string', 'required' => true, 'example' => 'https://***.mp4'],
+ ],
+ [
+ 'name' => 'StartVideoMd5',
+ 'in' => 'formData',
+ 'schema' => ['title' => '开机动画md5', 'description' => '开机动画md5', 'type' => 'string', 'required' => true, 'example' => '40c804***697'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<ProductInfo>>',
- 'description' => 'Result<List<ProductInfo>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回的详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '产品名称',
- 'description' => '产品名称',
- 'type' => 'string',
- 'example' => '橙蜂中控面板',
- ],
- 'Pk' => [
- 'title' => '产品pk',
- 'description' => '产品pk',
- 'type' => 'string',
- 'example' => 'jTOSl***l1odxImRw',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '扩展信息',
- 'example' => 'any',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '链路请求id', 'type' => 'string', 'example' => '0EC7*726E'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"橙蜂中控面板\\",\\n \\"Pk\\": \\"jTOSl***l1odxImRw\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"any\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '获得关联产品列表',
- 'description' => '获得创建酒店使用的关联产品列表。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '新增或者编辑动画',
+ 'description' => '请上传MP4格式视频⽂件编解码器:AAC,H.264,分辨率:1280*800,视频时⻓不超过10s,⽂件⼤⼩不超过10MB。上传开机动画文件,完成后下次开机重启两次后生效。',
],
- 'CreateHotel' => [
- 'summary' => '创建酒店接口。',
- 'path' => '/v1.0/ip/createHotel',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddCustomQA' => [
+ 'summary' => '自定义问答模块下的新增自定义问答功能。',
+ 'path' => '/v1.0/ip/addCustomQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'TbOpenId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '淘宝开放id',
- 'description' => '淘宝授权登录后获得,当前登录的淘宝开放user id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AAEV***E3d3Z2ETwh',
- ],
- ],
- [
- 'name' => 'AppKey',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '开放平台appKey',
- 'description' => '淘宝开放平台申请的用户淘宝授权登录的appKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => '333566791',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'],
],
[
- 'name' => 'HotelName',
+ 'name' => 'MajorQuestion',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店名称',
- 'description' => '酒店名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '天奥酒店',
- ],
+ 'schema' => ['description' => '主问题', 'type' => 'string', 'required' => false, 'example' => '***'],
],
[
- 'name' => 'Remark',
+ 'name' => 'SupplementaryQuestions',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '备注',
- 'description' => '备注',
- 'type' => 'string',
+ 'description' => '附属问题列表',
+ 'type' => 'array',
+ 'items' => ['description' => '附属问题', 'type' => 'string', 'required' => false, 'example' => '***'],
'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'HotelAddress',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店地址',
- 'description' => '酒店地址',
- 'type' => 'string',
- 'required' => true,
- 'example' => '浙江省杭州市xxxxxxxx',
],
],
[
- 'name' => 'HotelEmail',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店联系邮箱',
- 'description' => '酒店联系邮箱',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test@hotel.com',
- ],
- ],
- [
- 'name' => 'PhoneNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店联系电话',
- 'description' => '酒店联系电话',
- 'type' => 'string',
- 'required' => true,
- 'example' => '13xxxxxxxx',
- ],
- ],
- [
- 'name' => 'RelatedPk',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '关联产品',
- 'description' => '关联产品Pk号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'jTO****Rw',
- ],
- ],
- [
- 'name' => 'RelatedPks',
+ 'name' => 'KeyWords',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '酒店关联产品列表',
- 'description' => '酒店关联产品列表',
+ 'description' => '关键字列表',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'items' => ['description' => '关键字', 'type' => 'string', 'required' => false, 'example' => '***'],
'required' => false,
],
],
[
- 'name' => 'RoomNum',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间数',
- 'description' => '房间数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'EstOpenTime',
+ 'name' => 'Answers',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '预计开业时间:yyyy-MM-dd HH:mm:ss 格式字符串',
- 'description' => '预计开业时间:yyyy-MM-dd HH:mm:ss 格式字符串',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-10-1 00:00:00',
+ 'description' => '回答列表',
+ 'type' => 'array',
+ 'items' => ['description' => '回答', 'type' => 'string', 'required' => false, 'example' => '***'],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
'title' => 'Result<Boolean>',
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '酒店ID',
- 'description' => '服务的实际返回结果,酒店ID',
- 'type' => 'string',
- 'example' => '5abfd9***2c38661',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '扩展字段',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7***726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": \\"5abfd9***2c38661\\",\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
- 'title' => '创建酒店',
- 'description' => '创建酒店接口。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
+ 'title' => '新增自定义问答',
],
- 'UpdateHotel' => [
- 'summary' => '酒店信息修改。',
- 'path' => '/v1.0/ip/updateHotel',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddCustomQAV2' => [
+ 'summary' => '添加自定义问答V2版本',
+ 'path' => '/v1.0/ip/addQAV2',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'TbOpenId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '淘宝开放id',
- 'description' => '淘宝开放id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AAEVK***UE3d3Z2ETwh',
- ],
- ],
- [
- 'name' => 'AppKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '开放平台appKey',
- 'description' => '开放平台appKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => '31342884',
- ],
- ],
- [
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f',
- ],
- ],
- [
- 'name' => 'HotelName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店名称',
- 'description' => '酒店名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '天奥酒店',
- ],
- ],
- [
- 'name' => 'Remark',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '备注',
- 'description' => '备注',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'],
],
[
- 'name' => 'HotelAddress',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店地址',
- 'description' => '酒店地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江省杭州市xxxx',
- ],
- ],
- [
- 'name' => 'HotelEmail',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店联系邮箱',
- 'description' => '酒店联系邮箱',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a*****@hotel.com',
- ],
- ],
- [
- 'name' => 'PhoneNumber',
+ 'name' => 'MajorQuestion',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店联系电话',
- 'description' => '酒店联系电话',
- 'type' => 'string',
- 'required' => false,
- 'example' => '130***',
- ],
+ 'schema' => ['description' => '主问题', 'type' => 'string', 'required' => false, 'example' => '今天的天气怎么样'],
],
[
- 'name' => 'RoomNum',
+ 'name' => 'SupplementaryQuestions',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '房间数',
- 'description' => '房间数',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '附属问题列表',
+ 'type' => 'array',
+ 'items' => ['description' => '附属问题列表', 'type' => 'string', 'required' => false, 'example' => '室外温度多少'],
'required' => false,
- 'example' => '4',
],
],
[
- 'name' => 'EstOpenTime',
+ 'name' => 'KeyWords',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '预计发布时间:yyyy-MM-dd HH:mm:ss格式字符串',
- 'description' => '预计发布时间:yyyy-MM-dd HH:mm:ss格式字符串',
- 'type' => 'string',
+ 'description' => '关键字列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '关键字列表', 'type' => 'string', 'required' => false, 'example' => '天气'],
'required' => false,
- 'example' => '2022-02-22 00:00:00',
],
],
[
- 'name' => 'RelatedPks',
+ 'name' => 'Answers',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '关联产品列表',
+ 'description' => '答案列表',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['description' => '答案列表', 'type' => 'string', 'required' => false, 'example' => '你好,您可以再说一遍吗 不好意思我刚才没有听清'],
+ 'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<QAInfoResponse>',
+ 'description' => 'Result<QAInfoResponse>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '扩展信息',
+ 'properties' => [
+ 'QaId' => ['title' => 'qaID', 'description' => 'qaID', 'type' => 'string', 'example' => '1'],
+ 'MajorQuestion' => ['title' => '主要问题', 'description' => '主要问题', 'type' => 'string', 'example' => '今天天气怎么样'],
+ 'SupplementaryQuestion' => ['title' => '辅助问题', 'description' => '辅助问题', 'type' => 'string', 'example' => '室外温度多少'],
+ 'Answers' => ['title' => '回答,多个回答用;隔开', 'description' => '回答,多个回答用;隔开', 'type' => 'string', 'example' => '你好,您可以再说一遍吗 不好意思我刚才没有听清'],
+ 'KeyWords' => ['title' => '关键字', 'description' => '关键字', 'type' => 'string', 'example' => '天气'],
+ 'HotelId' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'example' => 'a7***83'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2023-01-10 10:01:59'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-01-10 10:01:59'],
+ 'Status' => ['title' => '状态:0,使用中, 1:删除', 'description' => '状态:0,使用中, 1:删除', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'LastOperator' => ['title' => '最后操作人', 'description' => '最后操作人', 'type' => 'string', 'example' => '8xxx9'],
],
],
- 'RequestId' => [
- 'description' => 'The ID of the request. ',
- 'type' => 'string',
- 'example' => '46C53AEB-B19C-5C42-B32E-A726979C126F',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"46C53AEB-B19C-5C42-B32E-A726979C126F\\"\\n}","type":"json"}]',
- 'title' => '酒店信息修改',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Result\\": {\\n \\"QaId\\": \\"1\\",\\n \\"MajorQuestion\\": \\"今天天气怎么样\\",\\n \\"SupplementaryQuestion\\": \\"室外温度多少\\",\\n \\"Answers\\": \\"你好,您可以再说一遍吗 不好意思我刚才没有听清\\",\\n \\"KeyWords\\": \\"天气\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0,\\n \\"LastOperator\\": \\"8xxx9\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
+ 'title' => '新增自定义问答V2',
+ 'description' => '返回值有QAId'."\n"
+ .'问答内容和答案是必填内容',
],
- 'RemoveHotel' => [
- 'summary' => '删除酒店信息。',
- 'path' => '/v1.0/ip/removeHotel',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddMessageTemplate' => [
+ 'summary' => '添加酒店消息模板',
+ 'path' => '/v1.0/ip/addMessageTemplate',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'TbOpenId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '淘宝开放id',
- 'description' => '淘宝开放id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AAEVK***UE3d3Z2ETwh',
- ],
- ],
- [
- 'name' => 'AppKey',
+ 'name' => 'TemplateName',
'in' => 'formData',
- 'schema' => [
- 'description' => 'appkey',
- 'type' => 'string',
- 'required' => true,
- 'example' => '30193305',
- ],
+ 'schema' => ['title' => '消息模板名称', 'description' => '消息模板名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试模板'],
],
[
- 'name' => 'HotelId',
+ 'name' => 'TemplateDetail',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f',
- ],
+ 'schema' => ['title' => '消息模板内容', 'description' => '消息模板内容', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '这是${hotel}的一个测试模板'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<Long>',
+ 'description' => 'Result<Long>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '扩展信息',
- 'example' => '{}',
- ],
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '消息模板ID', 'description' => '消息模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '11'],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
- 'title' => '删除酒店',
- 'description' => '删除酒店信息。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": 11,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '添加酒店消息模板',
],
- 'ListHotelInfo' => [
- 'summary' => '查询酒店列表信息,例如酒店名称、地址、授权账号等。',
- 'path' => '/v1.0/ip/listHotelInfo',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddOrUpdateDisPlayModes' => [
+ 'summary' => '仅带屏猫精设备生效,用于设置带屏设备上展示的模式列表',
+ 'path' => '/v1.0/ip/addOrUpdateDisPlayModes',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
- 'parameters' => [],
+ 'parameters' => [
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
+ ],
+ [
+ 'name' => 'HotelDeviceModeList',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '带屏设备展示的模式code列表',
+ 'description' => '带屏设备展示的模式code列表',
+ 'type' => 'array',
+ 'items' => ['description' => '模式编码', 'type' => 'string', 'required' => false, 'example' => 'dndMode'],
+ 'required' => true,
+ ],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelInfoResponse>>',
- 'description' => 'Result<List<HotelInfoResponse>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7',
- ],
- 'HotelName' => [
- 'description' => '酒店名称',
- 'type' => 'string',
- 'example' => '酒店',
- ],
- 'HotelAddress' => [
- 'description' => '酒店地址',
- 'type' => 'string',
- 'example' => '浙江身杭州市',
- ],
- 'AuthAccount' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'UserName' => [
- 'title' => '授权子账号的账号名称',
- 'description' => '用户名称',
- 'type' => 'string',
- 'example' => 'leetest',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- ],
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"HotelName\\": \\"酒店\\",\\n \\"HotelAddress\\": \\"浙江身杭州市\\",\\n \\"AuthAccount\\": [\\n {\\n \\"UserName\\": \\"leetest\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
- 'title' => '查询酒店列表',
- 'description' => '查询酒店列表信息,例如酒店名称、地址、授权账号等',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '设置带屏展示模式列表',
],
- 'ListHotels' => [
- 'summary' => '获取酒店列表(待审批/已拒绝/已通过),可细化至单个酒店',
- 'path' => '/v1.0/ip/listHotels',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddOrUpdateHotelSetting' => [
+ 'summary' => '新增或者更新酒店定制',
+ 'path' => '/v1.0/ip/addOrUpdateHotelSetting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Status',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => false, 'example' => 'a7a3***013'],
+ ],
+ [
+ 'name' => 'SettingType',
'in' => 'formData',
'schema' => [
- 'title' => '审批状态(0:待审批、1:通过、2:拒绝)',
- 'description' => '审批状态(0:待审批、1:通过、2:拒绝)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
+ 'title' => '设置的类型,带屏展示模式(SCENE),'."\n"
+ .'带屏屏保配置(SCREENSAVER),'."\n"
+ .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
+ .'带屏酒店通知(NOTICE),'."\n"
+ .'夜间模式(NIGHT_MODE)',
+ 'description' => '设置的类型,带屏展示模式(SCENE),'."\n"
+ .'带屏屏保配置(SCREENSAVER),'."\n"
+ .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
+ .'带屏酒店通知(NOTICE),'."\n"
+ .'夜间模式(NIGHT_MODE)',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['NOTICE' => '带屏酒店通知', 'NIGHT_MODE' => '夜间模式', 'SCREENSAVER' => '带屏屏保配置', 'SCENE' => '带屏展示模式', 'HOMEPAGE_PIC' => '首页背景图'],
+ 'example' => 'SCREENSAVER',
],
],
[
- 'name' => 'Page',
- 'in' => 'query',
+ 'name' => 'Value',
+ 'in' => 'formData',
+ 'schema' => ['title' => '配置值', 'description' => '首页背景图/酒店通知', 'type' => 'string', 'required' => false, 'example' => '首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店~~'],
+ ],
+ [
+ 'name' => 'HotelScreenSaver',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '分页参数',
- 'description' => '分页参数',
+ 'title' => '屏保',
+ 'description' => '屏保',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条数据',
- 'description' => '每页多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
- ],
+ 'ScreenSaverStyle' => ['title' => '屏保样式code', 'description' => '屏保样式code', 'type' => 'string', 'required' => false, 'example' => 'common-weather'],
+ 'ScreenSaverPicUrl' => ['title' => '屏保图片', 'description' => '屏保图片', 'type' => 'string', 'required' => false, 'example' => 'https://a****jpg'],
],
- 'required' => true,
+ 'required' => false,
],
],
[
- 'name' => 'HotelRequest',
- 'in' => 'query',
+ 'name' => 'HotelDeviceModeList',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '酒店相关信息',
+ 'title' => '模式',
+ 'description' => '模式',
+ 'type' => 'array',
+ 'items' => ['description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'sleep'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'NightMode',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '夜间模式',
+ 'description' => '夜间模式',
'type' => 'object',
'properties' => [
- 'HotelId' => [
- 'description' => ' 酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e02e9c59f35845979418df2ab409a4c4',
- ],
+ 'Enable' => ['title' => '启用、禁用', 'description' => '启用、禁用', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Start' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '7:00'],
+ 'End' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '22:00'],
+ 'DefaultVolume' => ['title' => '夜间模式下的默认音量', 'type' => 'string', 'required' => false],
+ 'DefaultBright' => ['title' => '夜间模式下的默认亮度', 'type' => 'string', 'required' => false],
+ 'StandbyAction' => ['title' => '休眠时执行,息屏(screenoff)、屏保(screensaver)', 'description' => '休眠时执行,息屏(screenoff)、屏保(screensaver)', 'type' => 'string', 'required' => false, 'example' => 'screenoff'],
],
'required' => false,
],
@@ -1071,238 +467,70 @@
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<HotelListResp>',
- 'description' => 'Result<HotelListResp>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'Page' => [
- 'title' => '分页结果',
- 'description' => '分页结果',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条',
- 'description' => '每页多少条',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '共多少条数据',
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'TotalPage' => [
- 'title' => '共多少页',
- 'description' => '共多少页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'HasNext' => [
- 'title' => '是否有下一页',
- 'description' => '是否有下一页',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- ],
- ],
- 'HotelInfoList' => [
- 'description' => '酒店信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '酒店信息列表',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'example' => '73ab1b03018d4da69b5bef17095f569b',
- ],
- 'HotelName' => [
- 'title' => '酒店名称',
- 'description' => '酒店名称',
- 'type' => 'string',
- 'example' => '酒店名称',
- ],
- 'CreateTime' => [
- 'title' => '创建时间(long类型)',
- 'description' => '创建时间(long类型)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1654568802000',
- ],
- 'HotelAddress' => [
- 'title' => '酒店地址',
- 'description' => '酒店地址',
- 'type' => 'string',
- 'example' => '酒店地址',
- ],
- 'PhoneNumber' => [
- 'title' => '联系方式',
- 'description' => '联系方式',
- 'type' => 'string',
- 'example' => '13312340987',
- ],
- 'IndustryType' => [
- 'title' => '行业类型',
- 'description' => '行业类型',
- 'type' => 'string',
- 'example' => '酒店',
- ],
- 'RoomNum' => [
- 'title' => '房间数',
- 'description' => '房间数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'RelatedProductName' => [
- 'title' => '关联产品名称',
- 'description' => '关联产品名称',
- 'type' => 'string',
- 'example' => '测试产品',
- ],
- 'AccountNames' => [
- 'title' => '淘宝账号',
- 'description' => '淘宝账号',
- 'type' => 'array',
- 'items' => [
- 'title' => '',
- 'description' => '账号名称',
- 'type' => 'string',
- 'example' => 'testAccount',
- ],
- ],
- 'Status' => [
- 'title' => '状态(0:待审批、1:通过、2:拒绝)',
- 'description' => '状态(0:待审批、1:通过、2:拒绝)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => 'RequestId',
- 'type' => 'string',
- 'example' => '85789C64-3644-56C0-9C0F-D2E0ECC227EF',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"HotelInfoList\\": [\\n {\\n \\"HotelId\\": \\"73ab1b03018d4da69b5bef17095f569b\\",\\n \\"HotelName\\": \\"酒店名称\\",\\n \\"CreateTime\\": 1654568802000,\\n \\"HotelAddress\\": \\"酒店地址\\",\\n \\"PhoneNumber\\": \\"13312340987\\",\\n \\"IndustryType\\": \\"酒店\\",\\n \\"RoomNum\\": 12,\\n \\"RelatedProductName\\": \\"测试产品\\",\\n \\"AccountNames\\": [\\n \\"testAccount\\"\\n ],\\n \\"Status\\": 1\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"85789C64-3644-56C0-9C0F-D2E0ECC227EF\\"\\n}","type":"json"}]',
- 'title' => '酒店列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '新增或者更新酒店定制',
+ 'description' => '> 根据入参settingType不同,可以新增或者修改不同的酒店定制配置'."\n"
+ .'> - 首页背景-settingType="HOMEPAGE_PIC"'."\n"
+ .'> - 屏保背景-settingType="SCREENSAVER"'."\n"
+ .'> - 带屏展示模式-settingType="SCENE"'."\n"
+ .'> - 带屏酒店通知-settingType="NOTICE"'."\n"
+ .'> - 夜间模式-settingType="NIGHT_MODE"',
],
- 'AuditHotel' => [
- 'summary' => '酒店审批。',
- 'path' => '/v1.0/ip/auditHotel',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddOrUpdateScreenSaver' => [
+ 'summary' => '仅带屏猫精设备生效,设置带屏设备的屏保配置',
+ 'path' => '/v1.0/ip/addOrUpdateScreenSaver',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'AuditHotelReq',
- 'in' => 'query',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'],
+ ],
+ [
+ 'name' => 'HotelScreenSaver',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '审批request',
- 'description' => '审批request',
+ 'title' => '屏保',
+ 'description' => '屏保',
'type' => 'object',
'properties' => [
- 'AuditOpinion' => [
- 'title' => '审批意见',
- 'description' => '审批意见',
- 'type' => 'string',
- 'required' => false,
- 'example' => '同意',
- ],
- 'Status' => [
- 'title' => '审批状态(1:审核通过 2:审核不通过)',
- 'description' => '审批状态(1:审核通过 2:审核不通过)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
- 'HotelId' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
+ 'ScreenSaverStyle' => ['title' => '屏保样式code', 'description' => '屏保样式code', 'type' => 'string', 'required' => false, 'example' => 'common-weather'],
+ 'ScreenSaverPicUrl' => ['title' => '屏保图片', 'description' => '屏保图片', 'type' => 'string', 'required' => false, 'example' => 'xxx.png'],
],
'required' => true,
- 'docRequired' => true,
],
],
],
@@ -1313,193 +541,184 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => 'RequestId',
- 'type' => 'string',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'True'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '4EED***9661'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
- 'title' => '酒店审批',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4EED***9661\\"\\n}","type":"json"}]',
+ 'title' => '设置屏保',
+ 'description' => '- 建议屏保背景图使用深色图片,以保证时间、天气等信息的显示效果',
],
- 'ListHotelRooms' => [
- 'summary' => '获取酒店房间,可细化至房间号',
- 'path' => '/v1.0/ip/listHotelRooms',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'AddOrUpdateWelcomeText' => [
+ 'summary' => '设置欢迎语配置',
+ 'path' => '/v1.0/ip/addOrUpdateWelcomeText',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
+ ],
+ [
+ 'name' => 'WelcomeText',
+ 'in' => 'formData',
+ 'schema' => ['title' => '欢迎语文本,建议150字以内', 'description' => '欢迎语文本,150字以内', 'type' => 'string', 'required' => true, 'example' => '尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。'],
+ ],
+ [
+ 'name' => 'MusicUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '背景音链接'."\n"
+ ."\n"
+ .'上传要求:'."\n"
+ .'1. 仅支持采样率16KHz、单声道 .wav格式的文件。(如果您的背景音不是wav格式,'."\n"
+ .'可使用 ffmpeg将其转为wav格式:ffmpeg -i 输入音频 -acodec pcm_s16le -ac 1 -ar 16000 目标.wav)'."\n"
+ .'2. 大小不超过2MB。'."\n"
+ .'3.合成时长超出背景音时长时,背景音将循环合成播放。', 'description' => '背景音链接'."\n"
+ ."\n"
+ .'上传要求:'."\n"
+ .'1. 仅支持采样率16KHz、单声道 .wav格式的文件。(如果您的背景音不是wav格式,'."\n"
+ .'可使用 ffmpeg将其转为wav格式:ffmpeg -i 输入音频 -acodec pcm_s16le -ac 1 -ar 16000 目标.wav)'."\n"
+ .'2. 大小不超过2MB。'."\n"
+ .'3.合成时长超出背景音时长时,背景音将循环合成播放。', 'type' => 'string', 'required' => true, 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果,这里标识添加或更新是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'description' => ' '."\n"
+ .'扩展信息'],
+ ],
+ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '0EC7*726E'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '设置欢迎语配置',
+ 'description' => '欢迎语配置,包含播报的tts文本以及背景音:'."\n"
+ .'- 播报文本:可配置成”欢迎入住${hotel}“,带占位符的方式,在推送是带上参数映射表替换对应的占位符'."\n"
+ .'- 背景音链接:'."\n"
+ .' - 1. 仅支持采样率16KHz、单声道 .wav格式的文件。(如果您的背景音不是wav格式,'."\n"
+ .'可使用 ffmpeg将其转为wav格式:ffmpeg -i 输入音频 -acodec pcm_s16le -ac '."\n"
+ .' 1 -ar 16000 目标.wav)'."\n"
+ .' - 2. 大小不超过2MB。'."\n"
+ .' - 3.合成时长超出背景音时长时,背景音将循环合成播放。',
+ ],
+ 'AuditHotel' => [
+ 'summary' => '酒店审批。',
+ 'path' => '/v1.0/ip/auditHotel',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
[
- 'name' => 'HotelAdminRoom',
- 'in' => 'formData',
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'AuditHotelReq',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '查询的附加信息',
+ 'title' => '审批request',
+ 'description' => '审批request',
'type' => 'object',
'properties' => [
- 'RoomNo' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1001',
- ],
+ 'AuditOpinion' => ['title' => '审批意见', 'description' => '审批意见', 'type' => 'string', 'required' => false, 'example' => '同意'],
+ 'Status' => ['title' => '审批状态(1:审核通过 2:审核不通过)', 'description' => '审批状态(1:审核通过 2:审核不通过)', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
+ 'HotelId' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
- 'required' => false,
+ 'required' => true,
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelRoomResp>>',
- 'description' => 'Result<List<HotelRoomResp>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '服务返回的房间信息',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f',
- ],
- 'RoomNo' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '102',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'D75D971E-33E8-1C48-A4B7-5FA6CC386146',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean'],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"e6dd44fd16084db8a60d69fd625d9f0f\\",\\n \\"RoomNo\\": \\"102\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D75D971E-33E8-1C48-A4B7-5FA6CC386146\\"\\n}","errorExample":""},{"type":"xml","example":"<ListHotelRoomsResponse>\\n <Code>200</Code>\\n <Result>\\n <HotelId>e6dd44fd16084db8a60d69fd625d9f0f</HotelId>\\n <RoomNo>102</RoomNo>\\n </Result>\\n <Message>success</Message>\\n <RequestId>D75D971E-33E8-1C48-A4B7-5FA6CC386146</RequestId>\\n</ListHotelRoomsResponse>","errorExample":""}]',
- 'title' => '查询酒店房间列表',
- 'requestParamsDescription' => '如果要查询某个房间,则输入房间号'."\n"
- .'如果查询酒店的所有房间,不输入房间号',
- 'responseParamsDescription' => '如果返回的结果为空,则说明没有本次想要查询的房间号',
- 'extraInfo' => '如果出错请检查传入的参数是否正确',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '酒店审批',
],
'BatchAddHotelRoom' => [
'summary' => '批量创建酒店房间',
'path' => '/v1.0/ip/batchAddHotelRoom',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
@@ -1507,14 +726,7 @@
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f',
- ],
+ 'schema' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'],
],
[
'name' => 'RoomNoList',
@@ -1524,14 +736,7 @@
'title' => '房间号List',
'description' => '房间号List(一次调用最多传入10个,否则会拦截)',
'type' => 'array',
- 'items' => [
- 'title' => '房间号List',
- 'description' => '房间号List(一次调用最多传入10个,否则会拦截)',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["101","102"]',
- ],
+ 'items' => ['title' => '房间号List', 'description' => '房间号List(一次调用最多传入10个,否则会拦截)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["101","102"]'],
'required' => true,
'docRequired' => true,
'minItems' => 1,
@@ -1545,40 +750,17 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]',
@@ -1587,24 +769,15 @@
'BatchDeleteHotelRoom' => [
'summary' => '批量删除酒店房间',
'path' => '/v1.0/ip/batchDeleteHotelRoom',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
@@ -1612,14 +785,7 @@
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f',
- ],
+ 'schema' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'],
],
[
'name' => 'RoomNoList',
@@ -1629,14 +795,7 @@
'title' => '房间号List',
'description' => '房间号List',
'type' => 'array',
- 'items' => [
- 'title' => '房间号List',
- 'description' => '房间号List',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["1211","1212"]',
- ],
+ 'items' => ['title' => '房间号List', 'description' => '房间号List', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1211","1212"]'],
'required' => true,
'docRequired' => true,
'minItems' => 1,
@@ -1650,37 +809,17 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean'],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
@@ -1689,48 +828,27 @@
'CheckoutWithAK' => [
'summary' => '退房,清理猫精设备上的定时类服务,例如闹钟、提醒,以及订单信息',
'path' => '/v1.0/ip/checkoutWithAK',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
[
'name' => 'RoomNo',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
],
],
'responses' => [
@@ -1740,963 +858,518 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C6***E6FA',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '73C6***E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
'title' => '退房',
],
- 'QueryHotelRoomDetail' => [
- 'summary' => '房间详情查询,查询包含酒店信息、客控信息、猫精设备信息、客需信息等',
- 'path' => '/v1.0/ip/queryHotelRoomDetail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ChildAccountAuth' => [
+ 'summary' => '酒店子账号授权。',
+ 'path' => '/v1.0/ip/childAccountAuth',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Mac',
+ 'name' => 'Account',
'in' => 'formData',
- 'schema' => [
- 'title' => '设备mac地址'."\n"
- .'注:在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询',
- 'description' => '设备mac地址'."\n"
- .'注:若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n"
- .'传入mac uuid sn其中一个 则酒店id和房间号可不传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '38:c8:**:**:f5:22',
- ],
+ 'schema' => ['title' => '淘宝账号名称', 'description' => '淘宝账号名称', 'type' => 'string', 'required' => true, 'example' => 'lee'],
],
[
- 'name' => 'Uuid',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备uuid,可在App中查看'."\n"
- .'注:在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询',
- 'description' => '设备uuid,可在App中查看'."\n"
- .'注:若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n"
- .'传入mac uuid sn其中一个 则酒店id和房间号可不传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '588***96j5WU',
- ],
- ],
- [
- 'name' => 'HotelId',
+ 'name' => 'TbOpenId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id'."\n"
- .'注:传入设备mac/sn/uuid 可不传酒店id 若都未传 则 酒店id必传',
- 'description' => '酒店id'."\n"
- .'注:使用酒店id 房间号查询 查询优先级低于传入设备sn mac uuid,若sn mac uuid都未传 则酒店id必传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '520a0c0***5eb',
- ],
+ 'schema' => ['title' => '淘宝开放id', 'description' => '淘宝开放id', 'type' => 'string', 'required' => true, 'example' => 'AAEV***E3d3Z2ETwh'],
],
[
- 'name' => 'RoomNo',
+ 'name' => 'AppKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间号'."\n"
- .'注:传入设备mac/sn/uuid 可不传房间号 若都未传 则 房间号必传',
- 'description' => '房间号'."\n"
- .'注:使用酒店id 房间号查询 查询优先级低于传入设备sn mac uuid,若sn mac uuid都未传 则房间号必传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1211',
- ],
+ 'schema' => ['title' => '开放平台appKey', 'description' => '开放平台appKey', 'type' => 'string', 'required' => true, 'example' => '30471753'],
],
[
- 'name' => 'Sn',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '设备sn信息'."\n"
- .'在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询',
- 'description' => '设备sn信息'."\n"
- .'注:若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n"
- .'传入mac uuid sn其中一个 则酒店id和房间号可不传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '280**28',
- ],
+ 'schema' => ['description' => '酒店ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<HotelRoomDetail>',
- 'description' => 'Result<HotelRoomDetail>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'HotelName' => [
- 'title' => '酒店名称',
- 'description' => '酒店名称',
- 'type' => 'string',
- 'example' => 'xx酒店',
- ],
- 'CreatorAccountName' => [
- 'title' => '酒店创建者账号名称',
- 'description' => '酒店创建者账号名称',
- 'type' => 'string',
- 'example' => 'xx淘宝昵称',
- ],
- 'ConnectType' => [
- 'title' => '酒店链接类型,rcu/mesh',
- 'description' => '酒店连接类型,rcu/mesh',
- 'type' => 'string',
- 'example' => 'rcu',
- ],
- 'RoomNo' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '2001',
- ],
- 'RoomControlInfo' => [
- 'title' => '客控信息',
- 'description' => '客控信息',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '房型id',
- 'description' => '房型id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1170',
- ],
- 'TemplateName' => [
- 'title' => '房型名称',
- 'description' => '房型名称',
- 'type' => 'string',
- 'example' => '大床房',
- ],
- 'AppId' => [
- 'title' => '云云对接应用id',
- 'description' => '云云对接应用id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '78',
- ],
- 'AppName' => [
- 'title' => '云云对接应用名称',
- 'description' => '云云对接应用名称',
- 'type' => 'string',
- 'example' => 'app',
- ],
- 'RcuUrl' => [
- 'title' => 'rcu云云调用链接',
- 'description' => 'rcu云云调用链接',
- 'type' => 'string',
- 'example' => 'http://www.xxx.com',
- ],
- 'DeviceInfos' => [
- 'title' => '客控设备信息列表',
- 'description' => '客控设备信息列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '客控设备信息',
- 'description' => '客控设备信息',
- 'type' => 'object',
- 'properties' => [
- 'DeviceName' => [
- 'title' => '设备别名',
- 'description' => '设备别名',
- 'type' => 'string',
- 'example' => '阅读灯',
- ],
- 'CategoryId' => [
- 'title' => '品类id',
- 'description' => '品类id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'CategoryEnName' => [
- 'title' => '品类英文名',
- 'description' => '品类英文名',
- 'type' => 'string',
- 'example' => 'light',
- ],
- 'CategoryName' => [
- 'title' => '品类中文名',
- 'description' => '品类中文名',
- 'type' => 'string',
- 'example' => '灯',
- ],
- 'LocationId' => [
- 'title' => '位置id',
- 'description' => '位置id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'LocationEnName' => [
- 'title' => '位置英文名',
- 'description' => '位置英文名',
- 'type' => 'string',
- 'example' => 'room',
- ],
- 'LocationName' => [
- 'title' => '位置中文名',
- 'description' => '位置中文名',
- 'type' => 'string',
- 'example' => '房间',
- ],
- 'DeviceId' => [
- 'title' => '设备唯一编号',
- 'description' => '设备唯一编号',
- 'type' => 'string',
- 'example' => 'readLight',
- ],
- 'DeviceConnectType' => [
- 'title' => '设备链接类型,rcu/mesh/红外',
- 'description' => '设备链接类型:'."\n"
- .'- rcu:云云对接'."\n"
- .'- mesh:本地直连'."\n"
- .'- infrared:红外对接',
- 'type' => 'string',
- 'example' => 'rcu',
- ],
- 'ProductKey' => [
- 'title' => 'mesh产品pk',
- 'description' => 'mesh产品pk',
- 'type' => 'string',
- 'example' => 'a1ueWGP6W2L',
- ],
- 'DeviceCount' => [
- 'title' => '设备数量',
- 'description' => '设备数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- ],
- ],
- ],
- ],
- ],
- 'AuthAccounts' => [
- 'title' => '授权账号列表',
- 'description' => '授权账号列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AccountName' => [
- 'title' => '账号名称',
- 'description' => '账号名称',
- 'type' => 'string',
- 'example' => 'xx淘宝昵称',
- ],
- 'AuthTime' => [
- 'title' => '授权时间',
- 'description' => '授权时间',
- 'type' => 'string',
- 'example' => '2023-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'DeviceInfos' => [
- 'title' => '猫精设备列表',
- 'description' => '猫精设备列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Uuid' => [
- 'title' => '猫精设备唯一标识uuid',
- 'description' => '猫精设备唯一标识uuid',
- 'type' => 'string',
- 'example' => '41c95c18a0a643bcb58edf438877def5',
- ],
- 'DeviceName' => [
- 'title' => '设备名称',
- 'description' => '设备名称',
- 'type' => 'string',
- 'example' => 'IN糖酒店版',
- ],
- 'OnlineStatus' => [
- 'title' => '设备在线状态,1:在线,0:离线',
- 'description' => '设备在线状态,1:在线,0:离线',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Mac' => [
- 'title' => '设备mac地址',
- 'description' => '设备mac地址',
- 'type' => 'string',
- 'example' => 'fa:03:23:58:c3:00',
- ],
- 'Sn' => [
- 'title' => '设备sn号',
- 'description' => '设备sn号',
- 'type' => 'string',
- 'example' => 'sag42dlz4qf',
- ],
- 'FirmwareVersion' => [
- 'title' => '设备固件版本',
- 'description' => '设备固件版本',
- 'type' => 'string',
- 'example' => '6.1.8-RS-20230425.1806',
- ],
- 'ActiveTime' => [
- 'title' => '设备激活时间',
- 'description' => '设备激活时间',
- 'type' => 'string',
- 'example' => '2023-01-01 12:00:00',
- ],
- ],
- ],
- ],
- 'RoomServiceInfo' => [
- 'title' => '客需服务信息',
- 'description' => '客需服务信息',
- 'type' => 'object',
- 'properties' => [
- 'RoomServiceCnt' => [
- 'title' => '已配置服务数量,如洗衣服务',
- 'description' => '已配置服务数量,如洗衣服务',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'RepairServiceCnt' => [
- 'title' => '已配置维修数量,如电视坏了',
- 'description' => '已配置维修数量,如电视坏了',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'GoodsServiceCnt' => [
- 'title' => '已配置物品数量,如我要包纸巾',
- 'description' => '已配置物品数量,如我要包纸巾',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'BookServiceCnt' => [
- 'title' => '已配置预定数量,如预定个spa',
- 'description' => '已配置预定数量,如预定个spa',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- 'OtherService' => [
- 'title' => '其他信息',
- 'description' => '其他信息',
- 'type' => 'object',
- 'properties' => [
- 'OpenCall' => [
- 'title' => '是否开通通话',
- 'description' => '是否开通通话',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UnhandleTickets' => [
- 'title' => '剩余未处理工单数',
- 'description' => '剩余未处理工单数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'additionalProperties' => ['type' => 'any', 'description' => '扩展字段'],
],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '3DB51A10-327C-58D3-91DF-3A5A471C51E7'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"HotelName\\": \\"xx酒店\\",\\n \\"CreatorAccountName\\": \\"xx淘宝昵称\\",\\n \\"ConnectType\\": \\"rcu\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"RoomControlInfo\\": {\\n \\"TemplateId\\": 1170,\\n \\"TemplateName\\": \\"大床房\\",\\n \\"AppId\\": 78,\\n \\"AppName\\": \\"app\\",\\n \\"RcuUrl\\": \\"http://www.xxx.com\\",\\n \\"DeviceInfos\\": [\\n {\\n \\"DeviceName\\": \\"阅读灯\\",\\n \\"CategoryId\\": 3,\\n \\"CategoryEnName\\": \\"light\\",\\n \\"CategoryName\\": \\"灯\\",\\n \\"LocationId\\": 1,\\n \\"LocationEnName\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"DeviceId\\": \\"readLight\\",\\n \\"DeviceConnectType\\": \\"rcu\\",\\n \\"ProductKey\\": \\"a1ueWGP6W2L\\",\\n \\"DeviceCount\\": 4\\n }\\n ]\\n },\\n \\"AuthAccounts\\": [\\n {\\n \\"AccountName\\": \\"xx淘宝昵称\\",\\n \\"AuthTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"DeviceInfos\\": [\\n {\\n \\"Uuid\\": \\"41c95c18a0a643bcb58edf438877def5\\",\\n \\"DeviceName\\": \\"IN糖酒店版\\",\\n \\"OnlineStatus\\": 1,\\n \\"Mac\\": \\"fa:03:23:58:c3:00\\",\\n \\"Sn\\": \\"sag42dlz4qf\\",\\n \\"FirmwareVersion\\": \\"6.1.8-RS-20230425.1806\\",\\n \\"ActiveTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"RoomServiceInfo\\": {\\n \\"RoomServiceCnt\\": 12,\\n \\"RepairServiceCnt\\": 10,\\n \\"GoodsServiceCnt\\": 10,\\n \\"BookServiceCnt\\": 0\\n },\\n \\"OtherService\\": {\\n \\"OpenCall\\": false,\\n \\"UnhandleTickets\\": 0\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '房间详情查询',
- 'description' => '提供几类查询方式:'."\n"
- .'- 酒店id+房间号:查询酒店相关信息及房间下所有猫精设备信息'."\n"
- .'- 猫精设备uuid:查询单台猫精设备信息及该设备对应的酒店相关信息'."\n"
- .'- 猫精设备mac:查询单台猫精设备信息及该设备对应的酒店相关信息'."\n"
- .'- 猫精设备sn:查询单台猫精设备信息及该设备对应的酒店相关信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"3DB51A10-327C-58D3-91DF-3A5A471C51E7\\"\\n}","type":"json"}]',
+ 'title' => '子账号授权',
+ 'description' => '酒店子账号授权。',
],
- 'ListSceneCategory' => [
- 'summary' => '酒店场景分类',
- 'path' => '/v1.0/ip/listSceneCategory',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ControlRoomDevice' => [
+ 'summary' => '酒店房间内红外或Mesh设备控制。',
+ 'path' => '/v1.0/ip/controlRoomDevice',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'hotelId',
- 'description' => 'hotelId',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
[
- 'name' => 'Type',
+ 'name' => 'RoomNo',
+ 'in' => 'formData',
+ 'schema' => ['description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
+ ],
+ [
+ 'name' => 'Cmd',
+ 'in' => 'formData',
+ 'schema' => ['description' => '指令类型', 'type' => 'string', 'required' => true, 'example' => 'thing.attribute.set'."\n"
+ .'thing.attribute.adjust'],
+ ],
+ [
+ 'name' => 'DeviceNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号', 'type' => 'string', 'required' => true, 'example' => 'INFRARED49122575595'],
+ ],
+ [
+ 'name' => 'DeviceIndex',
'in' => 'formData',
+ 'schema' => ['description' => '多键开关类设备的设备序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'Properties',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '场景分类类型(物品GOODS/服务SERVICE/维修REPAIR)',
- 'description' => '场景分类类型(物品GOODS/服务SERVICE/维修REPAIR)',
- 'type' => 'string',
+ 'description' => '属性信息',
+ 'type' => 'object',
'required' => true,
- 'docRequired' => true,
- 'example' => 'REPAIR',
+ 'additionalProperties' => ['type' => 'string', 'required' => true, 'example' => '1', 'description' => 'powerstate'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<String>>',
- 'description' => 'Result<List<String>>',
+ 'title' => 'Result<ControlResponse>',
+ 'description' => 'Result<ControlResponse>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '分类名称',
- 'type' => 'string',
- 'example' => '[ "电器类", "家具类", "卫生间类" ]',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '控制结果码', 'type' => 'integer', 'format' => 'int32', 'example' => '200表示成功,其它为失败'],
+ 'Message' => ['description' => '控制结果信息', 'type' => 'string', 'example' => 'success'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => 'RequestId',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID', 'type' => 'string', 'example' => '0EC7***726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n \\"[ \\\\\\"电器类\\\\\\", \\\\\\"家具类\\\\\\", \\\\\\"卫生间类\\\\\\" ]\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '酒店场景服务分类',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": 0,\\n \\"Message\\": \\"success\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
+ 'title' => '控制房间客控设备',
+ 'requestParamsDescription' => '<notice>大部分红外设备电源开关是相同的按键码,可能会出现 powerstate 设置为1时,设备实际为关闭动作;红外设备当前仅支持单属性控制 </notice>'."\n"
+ ."\n"
+ .'### 风扇'."\n"
+ .'#### thing.attribute.set'."\n"
+ .'- powerstate: 开关 '."\n"
+ .' - 0: 关闭'."\n"
+ .' - 1: 打开'."\n"
+ ."\n"
+ .'### 空调'."\n"
+ .'#### thing.attribute.set'."\n"
+ .'- powerstate: 开关'."\n"
+ .' - 0: 关闭'."\n"
+ .' - 1: 打开'."\n"
+ .'- windspeed: 风速'."\n"
+ .' - 0~3:风速0级至3级'."\n"
+ .'- targetTemperature: 目标温度'."\n"
+ .' - 16~30:目标温度,单位摄氏度'."\n"
+ .'- mode: 模式'."\n"
+ .' - 2:自动模式'."\n"
+ .' - 9:制冷模式'."\n"
+ .' - 10:制热模式'."\n"
+ .' - 12:送风模式'."\n"
+ .' - 13:除湿模式'."\n"
+ .' - 14:睡眠模式'."\n"
+ .' - 38:强效模式'."\n"
+ .' - 230:节能模式'."\n"
+ .' - 231:预热模式'."\n"
+ ."\n"
+ .'### 电视类(电视、电视盒子、投影仪、机顶盒)'."\n"
+ .'#### thing.attribute.set'."\n"
+ .'- powerstate: 开关'."\n"
+ .' - 0: 关闭'."\n"
+ .' - 1: 打开'."\n"
+ .'- channelNumber:频道号'."\n"
+ .' - 0~999: 频道号'."\n"
+ .'- muteMode: 静音模式'."\n"
+ .' - 0:关闭静音模式'."\n"
+ .' - 1:打开静音模式'."\n"
+ ."\n"
+ .'#### thing.attribute.adjust'."\n"
+ .'- volume: 音量'."\n"
+ .' - 1: 音量加一'."\n"
+ .' - -1:音量减一',
+ 'changeSet' => [],
],
- 'ListDialogueTemplate' => [
- 'summary' => '酒店场景对话模板',
- 'path' => '/v1.0/ip/listDialogueTemplate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'CreateHotel' => [
+ 'summary' => '创建酒店接口。',
+ 'path' => '/v1.0/ip/createHotel',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
+ 'name' => 'TbOpenId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '淘宝开放id', 'description' => '淘宝授权登录后获得,当前登录的淘宝开放user id', 'type' => 'string', 'required' => true, 'example' => 'AAEV***E3d3Z2ETwh'],
+ ],
+ [
+ 'name' => 'AppKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '开放平台appKey', 'description' => '淘宝开放平台申请的用户淘宝授权登录的appKey', 'type' => 'string', 'required' => true, 'example' => '333566791'],
+ ],
+ [
+ 'name' => 'HotelName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店名称', 'description' => '酒店名称', 'type' => 'string', 'required' => true, 'example' => '天奥酒店'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'formData',
+ 'schema' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'HotelAddress',
'in' => 'formData',
+ 'schema' => ['title' => '酒店地址', 'description' => '酒店地址', 'type' => 'string', 'required' => true, 'example' => '浙江省杭州市xxxxxxxx'],
+ ],
+ [
+ 'name' => 'HotelEmail',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店联系邮箱', 'description' => '酒店联系邮箱', 'type' => 'string', 'required' => true, 'example' => 'test@hotel.com'],
+ ],
+ [
+ 'name' => 'PhoneNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店联系电话', 'description' => '酒店联系电话', 'type' => 'string', 'required' => true, 'example' => '13xxxxxxxx'],
+ ],
+ [
+ 'name' => 'RelatedPk',
+ 'in' => 'formData',
+ 'schema' => ['title' => '关联产品', 'description' => '关联产品Pk号', 'type' => 'string', 'required' => true, 'example' => 'jTO****Rw'],
+ ],
+ [
+ 'name' => 'RelatedPks',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'hotelId',
- 'description' => 'hotelId',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
+ 'title' => '酒店关联产品列表',
+ 'description' => '酒店关联产品列表',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false],
+ 'required' => false,
],
],
+ [
+ 'name' => 'RoomNum',
+ 'in' => 'formData',
+ 'schema' => ['title' => '房间数', 'description' => '房间数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'],
+ ],
+ [
+ 'name' => 'EstOpenTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '预计开业时间:yyyy-MM-dd HH:mm:ss 格式字符串', 'description' => '预计开业时间:yyyy-MM-dd HH:mm:ss 格式字符串', 'type' => 'string', 'required' => true, 'example' => '2022-10-1 00:00:00'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<DialogueTemplate>>',
- 'description' => 'Result<List<DialogueTemplate>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'title' => '模板ID',
- 'description' => '模板ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'TemplateName' => [
- 'title' => '模板名称',
- 'description' => '模板名称',
- 'type' => 'string',
- 'example' => '物品多轮模板',
- ],
- 'TemplateDetail' => [
- 'title' => '模板详情(维修只有一轮对话)',
- 'description' => '模板详情(维修只有一轮对话)',
- 'type' => 'object',
- 'properties' => [
- 'FirstDialogueTemplate' => [
- 'title' => '第一轮对话',
- 'description' => '第一轮对话',
- 'type' => 'object',
- 'properties' => [
- 'ZeroPriceYesAnswer' => [
- 'title' => '价格=0 && 肯定回答',
- 'description' => '价格=0 && 肯定回答',
- 'type' => 'string',
- 'example' => '好的,服务员会尽快送来。',
- ],
- 'ZeroPriceNoAnswer' => [
- 'title' => '价格=0 && 否定回答',
- 'description' => '价格=0 && 否定回答',
- 'type' => 'string',
- 'example' => '对不起,暂时不提供此物品。',
- ],
- 'NonzeroPriceYesAnswer' => [
- 'title' => '价格!=0 &&肯定回答',
- 'description' => '价格!=0 &&肯定回答',
- 'type' => 'string',
- 'example' => '${goodsName}${price}元,请问需要服务员送来吗?',
- ],
- ],
- ],
- 'SecondDialogueTemplate' => [
- 'title' => '第二轮对话',
- 'description' => '第二轮对话',
- 'type' => 'object',
- 'properties' => [
- 'NonzeroPriceYesAnswer' => [
- 'title' => '价格!=0 && 肯定回答',
- 'description' => '价格!=0 && 肯定回答',
- 'type' => 'string',
- 'example' => '好的,服务员会尽快送来${goodsName}',
- ],
- 'NonzeroPriceNoAnswer' => [
- 'title' => '价格!=0 && 否定回答',
- 'description' => '价格!=0 && 否定回答',
- 'type' => 'string',
- 'example' => '好的,已取消。',
- ],
- ],
- ],
- ],
- ],
- 'Type' => [
- 'title' => '模板类型',
- 'description' => '模板类型',
- 'type' => 'string',
- 'example' => 'GOODS',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => 'RequestId',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '酒店ID', 'description' => '服务的实际返回结果,酒店ID', 'type' => 'string', 'example' => '5abfd9***2c38661'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'description' => '扩展字段'],
],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 4,\\n \\"TemplateName\\": \\"物品多轮模板\\",\\n \\"TemplateDetail\\": {\\n \\"FirstDialogueTemplate\\": {\\n \\"ZeroPriceYesAnswer\\": \\"好的,服务员会尽快送来。\\",\\n \\"ZeroPriceNoAnswer\\": \\"对不起,暂时不提供此物品。\\",\\n \\"NonzeroPriceYesAnswer\\": \\"${goodsName}${price}元,请问需要服务员送来吗?\\"\\n },\\n \\"SecondDialogueTemplate\\": {\\n \\"NonzeroPriceYesAnswer\\": \\"好的,服务员会尽快送来${goodsName}\\",\\n \\"NonzeroPriceNoAnswer\\": \\"好的,已取消。\\"\\n }\\n },\\n \\"Type\\": \\"GOODS\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '酒店场景服务对话模板',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": \\"5abfd9***2c38661\\",\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
+ 'title' => '创建酒店',
+ 'description' => '创建酒店接口。',
],
- 'InsertHotelSceneBookItem' => [
- 'summary' => '酒店场景预订新增',
- 'path' => '/v1.0/ip/insertHotelSceneBookItem',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'CreateHotelAlarm' => [
+ 'summary' => '批量创建闹钟',
+ 'path' => '/v1.0/ip/createHotelAlarm',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
+ 'schema' => ['description' => '酒店Id', 'type' => 'string', 'required' => true, 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7'],
+ ],
+ [
+ 'name' => 'Rooms',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'hotelID',
- 'description' => 'hotelID',
- 'type' => 'string',
+ 'title' => '批量最多支持10个房间的闹钟设置,此处房间号请控制在10个以内',
+ 'description' => '批量最多支持10个房间的闹钟设置,此处房间号请控制在10个以内',
+ 'type' => 'array',
+ 'items' => ['description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '101'],
'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
],
],
[
- 'name' => 'AddHotelSceneItemReq',
- 'in' => 'query',
+ 'name' => 'ScheduleInfo',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => 'addHotelSceneItemReq',
- 'description' => 'addHotelSceneItemReq',
+ 'description' => '时间调度信息',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'title' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)',
- 'description' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FOOD',
- ],
- 'Name' => [
- 'title' => '酒店场景预订item名称',
- 'description' => '酒店场景预订item名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '青椒肉丝',
- ],
- 'Price' => [
- 'title' => '价格(单位:分)',
- 'description' => '价格(单位:分)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1250',
+ 'Type' => ['title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', 'description' => 'ONCE, WEEKLY', 'type' => 'string', 'required' => true, 'example' => '调度类型'],
+ 'Once' => [
+ 'description' => '单次闹钟',
+ 'type' => 'object',
+ 'properties' => [
+ 'Year' => ['description' => '年', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'],
+ 'Month' => ['description' => '月', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9'],
+ 'Day' => ['description' => '日', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ 'Hour' => ['description' => '时', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '19'],
+ 'Minute' => ['description' => '分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
+ ],
+ 'required' => false,
],
- 'Icon' => [
- 'title' => 'icon',
- 'description' => 'icon',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png',
+ 'Weekly' => [
+ 'description' => '周循环',
+ 'type' => 'object',
+ 'properties' => [
+ 'DaysOfWeek' => [
+ 'description' => '周几触发',
+ 'type' => 'array',
+ 'items' => ['description' => '周几', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ ],
+ 'Hour' => ['description' => '小时', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'Minute' => ['description' => '分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
+ ],
+ 'required' => false,
],
],
'required' => true,
],
],
+ [
+ 'name' => 'MusicType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '目前支持 (DOU_YIN, JING_DIAN)',
+ 'description' => '目前支持 (DOU_YIN, JING_DIAN)',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DOU_YIN',
+ 'enum' => ['DOU_YIN', 'JING_DIAN'],
+ ],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<HotelAlarmResponse>>',
+ 'description' => 'Result<List<HotelAlarmResponse>>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomNo' => ['description' => '房间号', 'type' => 'string', 'example' => '101'],
+ 'AlarmId' => ['description' => '闹钟id', 'type' => 'integer', 'format' => 'int64', 'example' => '94'],
+ 'DeviceOpenId' => ['description' => '开放设备id', 'type' => 'string', 'example' => 'Pvk***TA=='],
+ 'UserOpenId' => ['description' => '开放用户id', 'type' => 'string', 'example' => 'mg***Qd'],
+ 'FailMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => '设备离线,闹钟创建失败'],
+ ],
+ ],
],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => 'RequestId',
- 'type' => 'string',
- 'example' => '36FB***80C2',
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'xx为空'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => '扩展内容'],
],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***86881'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"36FB***80C2\\"\\n}","type":"json"}]',
- 'title' => '新增酒店预订服务项',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"101\\",\\n \\"AlarmId\\": 94,\\n \\"DeviceOpenId\\": \\"Pvk***TA==\\",\\n \\"UserOpenId\\": \\"mg***Qd\\",\\n \\"FailMsg\\": \\"设备离线,闹钟创建失败\\"\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***86881\\"\\n}","type":"json"}]',
+ 'title' => '创建酒店闹钟',
+ 'description' => '批量创建闹钟。',
],
- 'DeleteHotelSceneBookItem' => [
- 'summary' => '酒店场景预订删除',
- 'path' => '/v1.0/ip/deleteHotelSceneBookItem',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'CreateRcuScene' => [
+ 'summary' => '创建rcu自定义场景',
+ 'path' => '/v1.0/ip/createRcuScene',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'hotelID',
- 'description' => 'hotelID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'],
],
[
- 'name' => 'Id',
+ 'name' => 'SceneId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店场景预订itemID'."\n"
- .' 删除条件 id与名称必传一个',
- 'description' => '酒店场景预订itemID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '11823',
- ],
+ 'schema' => ['title' => '场景编码', 'description' => '场景编码', 'type' => 'string', 'required' => true, 'example' => 'yoga'],
],
[
- 'name' => 'Name',
+ 'name' => 'SceneRelationExtDTO',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '名称 删除条件 id与名称必传一个',
- 'description' => '名称 删除条件 id与名称必传一个',
- 'type' => 'string',
- 'required' => false,
- 'example' => '棉签',
+ 'title' => '酒店RCU自定义场景',
+ 'description' => '酒店RCU自定义场景',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'required' => true, 'example' => '瑜伽模式'],
+ 'Icon' => ['title' => '场景图标', 'description' => '场景图标', 'type' => 'string', 'required' => true, 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png'],
+ 'Description' => ['title' => '场景描述信息', 'description' => '场景描述信息', 'type' => 'string', 'required' => true, 'example' => '做瑜伽的酒店场景'],
+ 'CorpusList' => [
+ 'title' => '触发语料',
+ 'description' => '触发语料(支持多语料,根据需求传递list 例:瑜伽模式、开始瑜伽)',
+ 'type' => 'array',
+ 'items' => ['description' => '触发语料', 'type' => 'string', 'required' => false, 'example' => '瑜伽模式'],
+ 'required' => true,
+ ],
+ ],
+ 'required' => true,
],
],
],
@@ -2707,745 +1380,224 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '844BA5CE-E30A-53CB-8A11-DE1F344C846D'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '删除酒店预订服务项',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"844BA5CE-E30A-53CB-8A11-DE1F344C846D\\"\\n}","type":"json"}]',
+ 'title' => '创建rcu自定义场景',
+ 'description' => '创建rcu自定义场景,请根据请求参数完成创建',
],
- 'UpdateHotelSceneBookItem' => [
- 'summary' => '酒店场景预订编辑',
- 'path' => '/v1.0/ip/updateHotelSceneBookItem',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteCartoon' => [
+ 'summary' => '删除已设置动画',
+ 'path' => '/v1.0/ip/deleteCartoon',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'hotelID',
- 'description' => 'hotelID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
- ],
- [
- 'name' => 'UpdateHotelSceneBookReq',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => 'updateHotelSceneBookReq',
- 'description' => 'updateHotelSceneBookReq',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '酒店场景预订itemID'."\n"
- .'id与名称必须传其中一个',
- 'description' => '酒店场景预订itemID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '1',
- ],
- 'Name' => [
- 'title' => '名称 查询条件 id与名称必须传一个',
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '青椒肉丝',
- ],
- 'Icon' => [
- 'title' => 'icon',
- 'description' => 'icon',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png',
- ],
- 'Price' => [
- 'title' => '价格(单位:分)',
- 'description' => '价格(单位:分)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1250',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['title' => ' 酒店id', 'description' => ' 酒店id', 'type' => 'string', 'required' => false, 'example' => 'a7***83'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '',
- 'description' => '',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '链路请求id', 'type' => 'string', 'example' => '0EC7*726E'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '编辑酒店场景预订',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '删除已设置动画',
+ 'description' => '删除已设置动画',
],
- 'ListHotelSceneBookItems' => [
- 'summary' => '酒店场景预订列表(餐饮/SPA休闲/打车)',
- 'path' => '/v1.0/ip/listHotelSceneBookItems',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteCustomQA' => [
+ 'summary' => '自定义问答模块下的删除自定义问答功能。',
+ 'path' => '/v1.0/ip/deleteCustomQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
+ 'name' => 'CustomQAIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'hotelID',
- 'description' => 'hotelID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
+ 'description' => '自定义问答id列表',
+ 'type' => 'array',
+ 'items' => ['description' => '自定义问答id', 'type' => 'string', 'required' => false, 'example' => '11'],
+ 'required' => false,
],
],
[
- 'name' => 'Type',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)',
- 'description' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FOOD',
- ],
- ],
- [
- 'name' => 'Page',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '分页参数',
- 'description' => '分页参数',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条数据',
- 'description' => '每页多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '酒店ID', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<HotelSceneListResp>',
- 'description' => 'Result<HotelSceneListResp>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'Page' => [
- 'title' => '分页结果',
- 'description' => '分页结果',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条数据',
- 'description' => '每页多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '共多少条数据',
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'TotalPage' => [
- 'title' => '共多少页',
- 'description' => '共多少页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'HasNext' => [
- 'title' => '是否有下一页',
- 'description' => '是否有下一页',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- ],
- ],
- 'SceneItemList' => [
- 'description' => '预定项列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '预定项',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)',
- 'description' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)',
- 'type' => 'string',
- 'example' => 'FOOD',
- ],
- 'Id' => [
- 'title' => '酒店场景预订itemID',
- 'description' => '酒店场景预订itemID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '11824',
- ],
- 'Name' => [
- 'title' => '名称',
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '青椒肉丝',
- ],
- 'Status' => [
- 'title' => '状态(已添加)',
- 'description' => '状态(已添加)',
- 'type' => 'string',
- 'example' => '已添加',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666161803',
- ],
- 'Icon' => [
- 'title' => '物品、服务、维修的图标',
- 'description' => '物品、服务、维修的图标',
- 'type' => 'string',
- 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png',
- ],
- 'Price' => [
- 'title' => '价格(单位:分)',
- 'description' => '价格(单位:分)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1850',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '73C6***E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"FOOD\\",\\n \\"Id\\": 11824,\\n \\"Name\\": \\"青椒肉丝\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666161803,\\n \\"Icon\\": \\"https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png\\",\\n \\"Price\\": 1850\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '查询酒店预订列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
+ 'title' => '删除自定义问答',
],
- 'ListHotelSceneItems' => [
- 'summary' => '查询酒店场景服务(物品/服务/维修)',
- 'path' => '/v1.0/ip/listHotelSceneItems',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteHotelAlarm' => [
+ 'summary' => '删除酒店闹钟,支持单个和批量删除',
+ 'path' => '/v1.0/ip/deleteHotelAlarm',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'hotelID',
- 'description' => 'hotelID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
[
- 'name' => 'ListHotelSceneReq',
- 'in' => 'query',
+ 'name' => 'Alarms',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => 'ListHotelSceneReq',
- 'description' => 'ListHotelSceneReq',
- 'type' => 'object',
- 'properties' => [
- 'Page' => [
- 'title' => '分页参数',
- 'description' => '分页参数',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页的大小,默认为10 ',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
- 'Type' => [
- 'title' => '酒店场景类型(物品GOODS/服务SERVICE/维修REPAIR)',
- 'description' => '酒店场景服务类型(物品GOODS/服务SERVICE/维修REPAIR)',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GOODS',
- ],
- 'Category' => [
- 'title' => '酒店场景类型二级分类',
- 'description' => '酒店场景服务类型二级分类',
- 'type' => 'string',
- 'required' => false,
- 'example' => '客用品类',
- ],
- 'Status' => [
- 'title' => '是否添加',
- 'description' => '是否添加',
- 'type' => 'string',
- 'required' => false,
- 'example' => '已添加',
- ],
- 'Keywords' => [
- 'title' => '酒店场景名称',
- 'description' => '酒店场景服务项名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '棉签',
+ 'description' => '闹钟信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomNo' => ['description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '101'],
+ 'AlarmId' => ['description' => '闹钟id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5029'],
+ 'UserOpenId' => ['description' => '开放用户Id', 'type' => 'string', 'required' => true, 'example' => 'mgw/k***HQd'],
+ 'DeviceOpenId' => ['description' => '开放设备id', 'type' => 'string', 'required' => true, 'example' => 'PvkB***TA=='],
],
+ 'required' => false,
],
'required' => true,
- 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<HotelSceneListResp>',
- 'description' => 'Result<HotelSceneListResp>',
+ 'title' => 'Result<Integer>',
+ 'description' => 'Result<Integer>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'xxx为空'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
'type' => 'object',
- 'properties' => [
- 'Page' => [
- 'title' => '分页结果',
- 'description' => '分页结果',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条数据',
- 'description' => '每页多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '共多少条数据',
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'TotalPage' => [
- 'title' => '共多少页',
- 'description' => '共多少页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'HasNext' => [
- 'title' => '是否有下一页',
- 'description' => '是否有下一页',
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- ],
- ],
- 'SceneItemList' => [
- 'description' => '服务项列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '服务项',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '酒店场景类型',
- 'description' => '酒店场景服务类型',
- 'type' => 'string',
- 'example' => 'GOODS',
- ],
- 'Category' => [
- 'title' => '酒店场景类型二级分类',
- 'description' => '酒店场景类型二级分类',
- 'type' => 'string',
- 'example' => '客用品类',
- ],
- 'Id' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10336',
- ],
- 'Name' => [
- 'title' => '名称',
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '棉签',
- ],
- 'Status' => [
- 'title' => '状态(已添加、未添加)',
- 'description' => '状态(已添加、未添加)',
- 'type' => 'string',
- 'example' => '已添加',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666163226',
- ],
- 'Icon' => [
- 'title' => '物品、服务、维修的图标',
- 'description' => '物品、服务、维修的图标',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png',
- ],
- 'Price' => [
- 'title' => '价格(单位:分,eg:160表示1.6元)',
- 'description' => '价格(单位:分,eg:160表示1.6元)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '160',
- ],
- 'DeliveryMethod' => [
- 'title' => '物品配送方式 waiter 服务员 robot 机器人',
- 'description' => '物品配送方式 waiter 服务员 robot 机器人',
- 'type' => 'string',
- 'example' => 'robot',
- ],
- 'RobotName' => [
- 'title' => '机器人名称',
- 'description' => '机器人名称',
- 'type' => 'string',
- 'example' => '测试机器人',
- ],
- 'PaymentMethod' => [
- 'title' => '结算方式:room 房费结算 robot 机器人结算',
- 'description' => '结算方式:room 房费结算 robot 机器人结算',
- 'type' => 'string',
- 'example' => 'robot',
- ],
- 'LimitSwitch' => [
- 'title' => '是否限制数量:0或不传:不限制,1:限制',
- 'description' => '是否限制数量:0或不传:不限制,1:限制',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'LimitNumber' => [
- 'title' => '限制数量',
- 'description' => '限制数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'BeyondLimitReply' => [
- 'title' => '超限回复',
- 'description' => '超限回复',
- 'type' => 'string',
- 'example' => '顾客您好,该物品已超出酒店今日供应限制,请联系前台。',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => '扩展内容'],
],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '43***881'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666163226,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 160,\\n \\"DeliveryMethod\\": \\"robot\\",\\n \\"RobotName\\": \\"测试机器人\\",\\n \\"PaymentMethod\\": \\"robot\\",\\n \\"LimitSwitch\\": 1,\\n \\"LimitNumber\\": 2,\\n \\"BeyondLimitReply\\": \\"顾客您好,该物品已超出酒店今日供应限制,请联系前台。\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '查询酒店场景服务',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"xxx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]',
+ 'title' => '删除酒店闹钟',
+ 'description' => '删除酒店闹钟,支持单个和批量删除。',
],
- 'UpdateHotelSceneItem' => [
- 'summary' => '酒店场景修改(开启/关闭/编辑)',
- 'path' => '/v1.0/ip/updateHotelSceneItem',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteHotelSceneBookItem' => [
+ 'summary' => '酒店场景预订删除',
+ 'path' => '/v1.0/ip/deleteHotelSceneBookItem',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
@@ -3453,212 +1605,18 @@
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'hotelID',
- 'description' => 'hotelID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
+ 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
[
- 'name' => 'UpdateHotelSceneOperateReq',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => 'updateHotelSceneReq',
- 'description' => 'updateHotelSceneReq',
- 'type' => 'object',
- 'properties' => [
- 'OperateType' => [
- 'title' => '操作类型(OPEN开启,CLOSE关闭,EDIT编辑)',
- 'description' => '操作类型(OPEN开启,CLOSE关闭,EDIT编辑)',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'OPEN',
- ],
- 'IsUseTemplateAnswer' => [
- 'title' => '是否使用模板回答(true/false)',
- 'description' => '是否使用模板回答(true/false)',
- 'type' => 'boolean',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'true',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店场景预订itemID'."\n"
+ .' 删除条件 id与名称必传一个', 'description' => '酒店场景预订itemID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '11823'],
],
[
- 'name' => 'UpdateHotelSceneReq',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => 'UpdateHotelSceneReq',
- 'description' => 'UpdateHotelSceneReq',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => 'itemID',
- 'description' => 'itemID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '10337',
- ],
- 'Name' => [
- 'title' => '物品名称 id与name必传一个',
- 'description' => '物品名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '棉签',
- ],
- 'Status' => [
- 'title' => '状态(已添加/未添加)',
- 'description' => '状态(已添加/未添加)',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '已添加',
- ],
- 'Icon' => [
- 'title' => 'icon',
- 'description' => 'icon',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png',
- ],
- 'Price' => [
- 'title' => '价格(单位:分)',
- 'description' => '价格(单位:分)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '165',
- ],
- 'DialogueList' => [
- 'title' => '对话List',
- 'description' => '对话List',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话信息',
- 'type' => 'object',
- 'properties' => [
- 'ServiceId' => [
- 'title' => 'itemId',
- 'description' => 'itemId',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10337',
- ],
- 'Process' => [
- 'title' => '第几轮对话',
- 'description' => '第几轮对话',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'Question' => [
- 'title' => '问题',
- 'description' => '问题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
- 'YesAnswer' => [
- 'title' => '肯定回答',
- 'description' => '肯定回答',
- 'type' => 'string',
- 'required' => false,
- 'example' => '纸巾1.5元,请问需要么?',
- ],
- 'NoAnswer' => [
- 'title' => '否定回答',
- 'description' => '否定回答',
- 'type' => 'string',
- 'required' => false,
- 'example' => '对不起,暂时不提供此物品',
- ],
- 'YesAnswerTemplate' => [
- 'title' => '肯定回答模板ID',
- 'description' => '肯定回答模板ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4',
- ],
- 'NoAnswerTemplate' => [
- 'title' => '否定回答模板ID',
- 'description' => '否定回答模板ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4',
- ],
- 'DialogueId' => [
- 'title' => '对话ID',
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '335',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'DeliveryMethod' => [
- 'title' => '物品配送方式:waiter 服务员(默认) robot 机器人',
- 'description' => '物品配送方式:waiter 服务员 robot 机器人',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'robot',
- ],
- 'RobotName' => [
- 'title' => '机器人名称,物品配送方式为robot时必填',
- 'description' => '机器人名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试机器人',
- ],
- 'PaymentMethod' => [
- 'title' => '结算方式:room 房费结算(默认) robot 机器人结算',
- 'description' => '结算方式:room 房费结算 robot 机器人结算',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'robot',
- ],
- 'LimitSwitch' => [
- 'title' => '是否限制数量:1:限制 其它不限制',
- 'description' => '是否限量 1表示限制 0或空:不限',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'LimitNumber' => [
- 'title' => '限制数量',
- 'description' => '限制数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2',
- ],
- 'BeyondLimitReply' => [
- 'title' => '超限回复',
- 'description' => '超限回复',
- 'type' => 'string',
- 'required' => false,
- 'example' => '尊敬的客户您好,该物品今日已超出酒店供应数量,有需要请联系前台。',
- ],
- ],
- 'required' => true,
- ],
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['title' => '名称 删除条件 id与名称必传一个', 'description' => '名称 删除条件 id与名称必传一个', 'type' => 'string', 'required' => false, 'example' => '棉签'],
],
],
'responses' => [
@@ -3668,401 +1626,113 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0D0C***67DB',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]',
- 'title' => '编辑酒店场景服务',
- 'description' => '- ***影响因素:***'."\n"
- .'> '."\n"
- .'> - `1、价格是否=0;`'."\n"
- .'> - `2、是否使用模板;`'."\n"
- .'> - `3、新增/修改对话;`'."\n"
- ."\n"
- .'- ***修改规则:***'."\n"
- .'> '."\n"
- .'> 1. 1、价格是否为0元'."\n"
- .'> - 等于0:dialogueList.size=1 && 参数内容为process=0(一轮对话,免费服务);'."\n"
- .'> - 大于0:dialogueList.size=2 && 参数内容为process=0 (一轮对话,付费服务,询问是否需要)+ process=1(二轮对话,对是否需要的回答)'."\n"
- .'> 2. 2、是否使用模板'."\n"
- .' - "isUseTemplateAnswer": true/false'."\n"
- .'3. 3、新增/修改对话'."\n"
- ."\n"
- .'1. ***新增对话:***'."\n"
- .'> - 使用模板:yesAnswerTemplate'."\0".' && noAnswerTemplate'."\0".' && process'."\0".' 不为null,其他为null;'."\n"
- .'> - 不使用模板:yesAnswer'."\0\0".' && noAnswer'."\0\0".' && process'."\0".' 不为null,其他为null'."\n"
- ."\n"
- .' 1. ***修改对话***'."\n"
- ."\n"
- .' > - 使用模板:yesAnswerTemplate'."\0".' && noAnswerTemplate'."\0".' && process'."\0".' && dialogueId'."\0".' && serviceId'."\0".' 不为null,其他为null;'."\n"
- .' > - 不使用模板:yesAnswer'."\0\0".' && noAnswer'."\0\0".' && process'."\0".' && dialogueId'."\0".' && serviceId'."\0".' 不为null,其他为null',
- 'extraInfo' => '| <div style="width:250px">场景</div> | 示例参数 |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 1、开启 && 0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
- .'| 2、开启 && 0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"服务员马上给你送来!!!","noAnswer":"对不起没有这个物品!!!"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
- .'| 3、开启 && >0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"},{"process":1,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":33333,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
- .'| 4、开启 && >0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX需要6元!!!","noAnswer":"对不起没有这个物品!!!"},{"process":1,"yesAnswer":"好得服务员给你尽快送来!!!","noAnswer":"好的已取消!!!"}],"price":33322,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
- .'| 5、关闭 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":0,"id":xxx,"status":"未添加"},"updateHotelSceneOperateReq":{"operateType":"CLOSE","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
- .'| 6、编辑 && 0元 **改为** >0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"},{"process":1,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":55656,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
- .'| 7、编辑 && 0元 **改为** >0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX需要6元!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品!!!","serviceId":"166033"},{"process":1,"yesAnswer":"好得服务员给你尽快送来!!!","noAnswer":"好的已取消!!!"}],"price":3322,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
- .'| 8、编辑 && 0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
- .'| 9、编辑 && 0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"","yesAnswer":"服务员马上给你送来!!!!!!!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
- .'| 10、编辑 && >0元 **改为** 0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
- .'| 11、编辑 && >0元 **改为** 0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"服务员马上给你送来!!!!!!!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品!!!","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
- .'| 12、编辑 && >0元 **改为** >0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"},{"process":1,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":5555,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
- .'| 13、编辑 && >0元 **改为** >0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX需要6元!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品!!!","serviceId":"166033"},{"process":1,"yesAnswer":"好的服务员马上给你送来!!!!","dialogueId":"xxx","noAnswer":"好的已取消","serviceId":"166033"}],"price":5555,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '删除酒店预订服务项',
],
- 'GetHotelSceneItemDetail' => [
- 'summary' => '酒店场景详情',
- 'path' => '/v1.0/ip/getHotelSceneItemDetail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteHotelSetting' => [
+ 'summary' => '删除酒店定制 包含首页背景、屏保背景等等',
+ 'path' => '/v1.0/ip/deleteHotelSetting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'hotelID',
- 'description' => 'hotelID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
- ],
- [
- 'name' => 'ItemId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店场景itemID'."\n"
- .'id与物品名称必传其中一个',
- 'description' => '酒店场景itemID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '10336',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => false, 'example' => 'af7***536'],
],
[
- 'name' => 'Name',
+ 'name' => 'SettingType',
'in' => 'formData',
'schema' => [
- 'title' => '物品名称'."\n"
- .'id与物品名称必传其中一个',
- 'description' => '物品名称'."\n"
- .'id与物品名称必传其中一个',
+ 'title' => '设置类型',
+ 'description' => '设置的类型,带屏展示模式(SCENE),'."\n"
+ .'带屏屏保配置(SCREENSAVER)'."\n"
+ .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
+ .'带屏酒店通知(NOTICE)'."\n"
+ .'夜间模式(NIGHT_MODE)',
'type' => 'string',
'required' => false,
- 'example' => '棉签',
+ 'enumValueTitles' => ['NOTICE' => '带屏酒店通知', 'NIGHT_MODE' => '夜间模式', 'SCREENSAVER' => '屏保', 'SCENE' => '带屏展示模式', 'HOMEPAGE_PIC' => '首页背景图'],
+ 'example' => 'SCREENSAVER',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<HotelSceneDetailResp>',
- 'description' => 'Result<HotelSceneDetailResp>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'DialogueList' => [
- 'title' => '酒店场景item对话List',
- 'description' => '酒店场景item对话List',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ServiceId' => [
- 'title' => '酒店场景itemID',
- 'description' => '酒店场景itemID',
- 'type' => 'string',
- 'example' => '10336',
- ],
- 'Process' => [
- 'title' => '第几轮对话',
- 'description' => '第几轮对话',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Question' => [
- 'title' => '问题',
- 'description' => '问题',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'YesAnswer' => [
- 'title' => '肯定回答',
- 'description' => '肯定回答',
- 'type' => 'string',
- 'example' => '纸巾1.5元,请问需要么?',
- ],
- 'NoAnswer' => [
- 'title' => '否定回答',
- 'description' => '否定回答',
- 'type' => 'string',
- 'example' => '对不起,暂时不提供此物品',
- ],
- 'YesAnswerTemplate' => [
- 'title' => '肯定回答模板ID',
- 'description' => '肯定回答模板ID',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'NoAnswerTemplate' => [
- 'title' => '否定回答模板ID',
- 'description' => '否定回答模板ID',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'DialogueId' => [
- 'title' => '对话ID',
- 'description' => '对话ID',
- 'type' => 'string',
- 'example' => '336',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666164774',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666164774',
- ],
- ],
- ],
- ],
- 'Type' => [
- 'title' => '酒店场景类型',
- 'description' => '酒店场景类型',
- 'type' => 'string',
- 'example' => 'GOODS',
- ],
- 'Category' => [
- 'title' => '酒店场景类型二级分类',
- 'description' => '酒店场景类型二级分类',
- 'type' => 'string',
- 'example' => '客用品类',
- ],
- 'Id' => [
- 'title' => '酒店场景itemID',
- 'description' => '酒店场景itemID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10336',
- ],
- 'Name' => [
- 'title' => '名称',
- 'description' => '名称',
- 'type' => 'string',
- 'example' => '擦鞋布',
- ],
- 'Status' => [
- 'title' => '状态',
- 'description' => '状态',
- 'type' => 'string',
- 'example' => '已添加',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666168828',
- ],
- 'Icon' => [
- 'title' => '物品、服务、维修的图标',
- 'description' => '物品、服务、维修的图标',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png',
- ],
- 'Price' => [
- 'title' => '价格(单位:分)',
- 'description' => '价格(单位:分)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '170',
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求链路id', 'type' => 'string', 'example' => '73C67****BB3E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DialogueList\\": [\\n {\\n \\"ServiceId\\": \\"10336\\",\\n \\"Process\\": 0,\\n \\"Question\\": \\"无\\",\\n \\"YesAnswer\\": \\"纸巾1.5元,请问需要么?\\",\\n \\"NoAnswer\\": \\"对不起,暂时不提供此物品\\",\\n \\"YesAnswerTemplate\\": \\"4\\",\\n \\"NoAnswerTemplate\\": \\"4\\",\\n \\"DialogueId\\": \\"336\\",\\n \\"UpdateTime\\": 1666164774,\\n \\"CreateTime\\": 1666164774\\n }\\n ],\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"擦鞋布\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666168828,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png\\",\\n \\"Price\\": 170\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '酒店场景详情',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67****BB3E6FA\\"\\n}","type":"json"}]',
+ 'title' => '删除酒店定制(屏保背景、首页背景等)',
+ 'description' => '> 根据入参settingType不同,可以删除不同的酒店定制配置'."\n"
+ .'> - 如果是删除首页背景-settingType="HOMEPAGE_PIC"'."\n"
+ .'> - 删除屏保背景-settingType="SCREENSAVER"'."\n"
+ .'> - 带屏展示模式-settingType="SCENE"'."\n"
+ .'> - 带屏酒店通知-settingType="NOTICE"'."\n"
+ .'> - 夜间模式-settingType="NIGHT_MODE"',
],
- 'InvokeRobotPush' => [
- 'summary' => '推送机器人通知,可用于机器人送物的放与拿时候的通知',
- 'path' => '/v1.0/ip/invokeRobotPush',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteMessageTemplate' => [
+ 'summary' => '删除消息通知模板',
+ 'path' => '/v1.0/ip/deleteMessageTemplate',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'RoomNo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1211',
- ],
- ],
- [
- 'name' => 'RoomName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '房间名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8022房间',
- ],
- ],
- [
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'PushType',
+ 'name' => 'TemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '推送类型,PUT:放东西、GET:拿东西',
- 'description' => '推送类型,PUT:放东西、GET:拿东西',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'GET',
- ],
+ 'schema' => ['title' => '消息模板id', 'description' => '消息模板id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '234'],
],
],
'responses' => [
@@ -4072,142 +1742,49 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C6***E6FA',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F7E2****B7C94'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
- 'title' => '推送机器人通知',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]',
+ 'title' => '删除通知消息模板',
],
- 'ImportHotelConfig' => [
- 'summary' => '批量导入酒店相关配置。',
- 'path' => '/v1.0/ip/importHotelConfig',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'DeleteRcuScene' => [
+ 'summary' => '删除酒店rcu自定义场景',
+ 'path' => '/v1.0/ip/deleteRcuScene',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'],
],
[
- 'name' => 'ImportHotelConfig',
+ 'name' => 'SceneId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '导入配置',
- 'type' => 'object',
- 'properties' => [
- 'RcuCustomScenes' => [
- 'description' => 'RCU自定义场景',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SceneId' => [
- 'description' => '场景编码',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'yoga',
- ],
- 'Name' => [
- 'description' => '场景名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '瑜伽模式',
- ],
- 'Icon' => [
- 'description' => '场景图标',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx.com/yyy.png',
- ],
- 'Description' => [
- 'description' => '场景描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '做瑜伽的酒店场景',
- ],
- 'CorpusList' => [
- 'description' => '触发语料列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '触发语料',
- 'type' => 'string',
- 'required' => true,
- 'example' => '打开瑜伽模式',
- ],
- 'required' => true,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '场景编码', 'description' => '场景编码', 'type' => 'string', 'required' => true, 'example' => 'yoga'],
],
],
'responses' => [
@@ -4217,678 +1794,152 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4F61A7B7-409C-525D-AFDB-238A4E88925A'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '批量导入酒店配置',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4F61A7B7-409C-525D-AFDB-238A4E88925A\\"\\n}","type":"json"}]',
+ 'title' => '删除酒店rcu自定义场景',
+ 'description' => '删除酒店rcu自定义场景,请按照请求参数执行',
],
- 'ImportRoomControlDevices' => [
- 'summary' => '导入房间的客控设备列表。',
- 'path' => '/v1.0/ip/importRoomControlDevices',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeviceControl' => [
+ 'summary' => '酒店客控设备控制,可控制例如灯、空调、窗帘等房间内的客控设备',
+ 'path' => '/v1.0/ip/deviceControl',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vdgrefds',
- ],
- ],
- [
- 'name' => 'RoomNo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
- ],
- [
- 'name' => 'LocationDevices',
- 'in' => 'formData',
+ 'name' => 'Payload',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '导入的位置、设备列表',
- 'description' => '导入的位置、设备列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '位置信息及设备信息',
- 'type' => 'object',
- 'properties' => [
- 'Location' => [
- 'description' => '位置信息',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'room',
- ],
- 'LocationName' => [
- 'description' => '位置名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '房间',
- ],
- 'Devices' => [
- 'description' => '位置下的设备列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备信息',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '品类英文',
- 'description' => '设备类型,如'."\n"
- ."\n"
- .'- light:灯'."\n"
- .'- aircondition:空调',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'light',
- ],
- 'Number' => [
- 'title' => '序列号'."\n"
- .'rcu试该参数必传',
- 'description' => '设备编号',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'night_light',
- ],
- 'DeviceName' => [
- 'title' => '设备名称',
- 'description' => '设备名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '小夜灯',
- ],
- 'ConnectType' => [
- 'title' => '设备连接类型:rcu、infrared、mesh'."\n"
- .'不填默认rcu',
- 'description' => '设备连接类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'infrared',
- ],
- 'Brand' => [
- 'title' => '品牌',
- 'description' => '品牌。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '百视通',
- ],
- 'Province' => [
- 'title' => '省份',
- 'description' => '省份',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江省',
- ],
- 'City' => [
- 'title' => '城市',
- 'description' => '城市。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '杭州市',
- ],
- 'ServiceProvider' => [
- 'title' => '服务提供商',
- 'description' => '服务提供商',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江华数',
- ],
- 'InfraredIndex' => [
- 'title' => '红外码库Index',
- 'description' => '红外码库index',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- 'InfraredId' => [
- 'title' => '红外码库id',
- 'description' => '红外码库id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1232',
- ],
- 'InfraredVersion' => [
- 'title' => '红外码库版本号',
- 'description' => '红外码库版本号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4.0',
- ],
- 'MultiKeySwitchExt' => [
- 'description' => '多键开关配置信息',
- 'type' => 'object',
- 'properties' => [
- 'SwitchList' => [
- 'description' => '开关按键列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '内容',
- 'type' => 'object',
- 'properties' => [
- 'DeviceIndex' => [
- 'title' => '设备序号',
- 'description' => '设备序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'Category' => [
- 'title' => '关联的设备品类英文名',
- 'description' => '关联的设备品类英文名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'light',
- ],
- 'Location' => [
- 'title' => '关联的设备位置英文',
- 'description' => '关联的设备位置英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'room',
- ],
- 'DeviceName' => [
- 'title' => '关联的设备别名',
- 'description' => '关联的设备别名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '吧台灯',
- ],
- 'AliasList' => [
- 'title' => '设备多别名列表',
- 'description' => '子设备的别名列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '设备自定义别名',
- 'description' => '设备别名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '左灯',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'Dn' => [
- 'title' => '设备dn码',
- 'description' => '设备dn信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3c5****db98',
- ],
- 'Pk' => [
- 'title' => '设备pk',
- 'description' => '设备pk号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '17****26',
- ],
- 'AliasList' => [
- 'title' => '设备多别名列表',
- 'description' => '设备别名列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '设备自定义别名',
- 'description' => '设备别名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '夜灯',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'description' => '业务参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '', 'type' => 'string'],
+ 'Location' => ['description' => '位置,例如room(房间),livingroom(客厅)等', 'type' => 'string', 'required' => true, 'example' => 'room', 'title' => '位置,例如room(房间),livingroom(客厅)等'],
+ 'Category' => ['description' => '客控设备品类,例如aircondition(空调),light(灯)等', 'type' => 'string', 'required' => true, 'example' => 'aircondition', 'title' => '客控设备品类,例如aircondition(空调),light(灯)等'],
+ 'Cmd' => ['description' => '指令名称,例如open,close,详细支持指令见酒店行业对接文档', 'type' => 'string', 'required' => true, 'example' => 'open', 'title' => '指令名称,例如open,close,详细支持指令见酒店行业对接文档'],
+ 'Properties' => [
+ 'description' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'example' => 'value', 'description' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档', 'title' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档'],
+ 'title' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档',
],
- 'required' => false,
+ 'ExtendInfo' => ['description' => '扩展信息,预留字段', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => '扩展信息,预留字段'],
+ 'DeviceNumber' => ['description' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号', 'type' => 'string', 'required' => true, 'example' => 'air_condition', 'title' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号'],
],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'EnableInfraredDeviceImport',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否支持红外 true 支持红外设备 false 不支持红外设备',
- 'description' => 'true:使用接口中传入的红外设备列表覆盖页面配置的红外设备;'."\n"
- .'false:忽略接口中传入的红外红外设备,保留平台页面配置的红外设备。'."\n"
- .'默认值为 false',
- 'type' => 'string',
'required' => false,
- 'example' => 'true',
+ 'title' => '业务参数',
],
],
[
- 'name' => 'EnableMeshDeviceImport',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否支持mesh true/null 支持 走清理逻辑false 不支持 但是会保留Mesh设备 请求参数里面有 Mesh 数据报错',
- 'description' => '是否支持mesh true/null 支持 走清理逻辑false 不支持 但是会保留Mesh设备 请求参数里面有 Mesh 数据报错',
- 'type' => 'string',
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型,此处填写 **HOTEL**。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL', 'title' => '编码类型,此处填写 **HOTEL**。'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。'],
+ 'IdType' => ['description' => '用户Id的类型 '."\n"
+ .'- OPEN_ID:默认的用户ID标识 '."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID', 'title' => '用户Id的类型'."\n"
+ ."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw=', 'title' => '用户标识,设置为userOpenId或userUnionId。'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2', 'title' => '组织ID,如果IdType为UNION_ID时必填。'],
+ ],
'required' => false,
- 'example' => 'true',
+ 'title' => '用户标识信息',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Integer>',
- 'description' => 'Result<Integer>',
+ 'title' => '返回结果对象',
+ 'description' => '返回结果对象',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码,200表示成功', 'description' => '调用返回码,200表示成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '导入成功的设备数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
+ 'description' => '服务的实际返回结果',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => 'xxxx',
- 'description' => '扩展信息内容',
+ 'properties' => [
+ 'Status' => ['description' => '业务执行结果状态,200为执行成功', 'type' => 'string', 'example' => '200', 'title' => '业务执行结果状态,200为执行成功'],
],
],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'fdsfregtre',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881', 'title' => '请求id'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 10,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"xxxx\\"\\n },\\n \\"RequestId\\": \\"fdsfregtre\\"\\n}","type":"json"}]',
- 'title' => '导入房间的客控设备列表',
- 'description' => '批量导入房间被控设备至房间所对应的房型'."\n"
- .'><notice>暂时只支持纯rcu场景,支持的关联产品为:***方糖R酒店版、IN糖酒店版***></notice>',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": \\"200\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<DeviceControlResponse>\\n <Code>200</Code>\\n <Result>\\n <Status>200</Status>\\n </Result>\\n <Message>success</Message>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</DeviceControlResponse>","errorExample":""}]',
+ 'title' => '酒店客控-设备控制',
],
- 'ImportRoomGenieScenes' => [
- 'summary' => '批量导入房间内智能智能场景列表。',
- 'path' => '/v1.0/ip/importRoomGenieScenes',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ExecuteScene' => [
+ 'summary' => '控制房间场景',
+ 'path' => '/v1.0/ip/executeScene',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7a3***013',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
[
'name' => 'RoomNo',
'in' => 'formData',
- 'schema' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
],
[
- 'name' => 'SceneList',
+ 'name' => 'SceneName',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '场景列表',
- 'description' => '场景列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '场景信息。',
- 'type' => 'object',
- 'properties' => [
- 'SceneName' => [
- 'title' => '场景名称',
- 'description' => '场景名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '瑜伽模式',
- ],
- 'Description' => [
- 'title' => '场景描述',
- 'description' => '场景描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '做瑜伽的模式',
- ],
- 'Icon' => [
- 'title' => '场景图标',
- 'description' => '场景图标',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx.com/yyy.png',
- ],
- 'Display' => [
- 'title' => '是否在带屏侧显示',
- 'description' => '是否在带屏侧显示',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'TriggerLogical' => [
- 'title' => '场景触发逻辑(0:条件与,1:条件或)',
- 'description' => '场景触发逻辑(0:条件与,1:条件或)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- 'Triggers' => [
- 'title' => '触发条件',
- 'description' => '触发条件列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '触发条件',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '触发类型',
- 'description' => '触发类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1:语音触发'."\n"
- .'2:设备触发',
- ],
- 'CorpusList' => [
- 'title' => '触发语料',
- 'description' => '触发语料',
- 'type' => 'array',
- 'items' => [
- 'description' => '触发语料',
- 'type' => 'string',
- 'required' => false,
- 'example' => '打开瑜伽模式',
- ],
- 'required' => false,
- ],
- 'Device' => [
- 'description' => '触发设备',
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'description' => '设备品类',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'KeyCardSwitch',
- ],
- 'DeviceNumber' => [
- 'description' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3c5d2ab8f9ec',
- ],
- 'DeviceIndex' => [
- 'description' => '多键开关类设备的设备序号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- ],
- 'AttributeValues' => [
- 'description' => '设备触发属性',
- 'type' => 'array',
- 'items' => [
- 'description' => '触发属性',
- 'type' => 'object',
- 'properties' => [
- 'AttributeName' => [
- 'description' => '属性名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'stateOfMagneticInduction',
- ],
- 'AttributeValue' => [
- 'description' => '属性值',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'Actions' => [
- 'title' => '执行动作',
- 'description' => '执行动作列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '执行动作',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '动作类型',
- 'description' => '执行动作类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1:设备控制'."\n"
- .'2:音箱播报',
- ],
- 'Reply' => [
- 'title' => '音箱回复内容',
- 'description' => '音箱回复内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '欢迎光临',
- ],
- 'Device' => [
- 'title' => '执行设备',
- 'description' => '执行设备',
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'title' => '设备品类',
- 'description' => '设备品类',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'light',
- ],
- 'DeviceNumber' => [
- 'title' => '设备编号',
- 'description' => '设备编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3c5d2ab8f9ec',
- ],
- 'DeviceIndex' => [
- 'title' => '多键开关类设备,传入按键序号',
- 'description' => '多键开关类设备,传入按键序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'Type' => [
- 'description' => '设备类型(已废弃)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '无需填写',
- ],
- ],
- 'required' => false,
- ],
- 'AttributeValues' => [
- 'title' => '设备目标属性',
- 'description' => '设备目标属性',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标属性',
- 'type' => 'object',
- 'properties' => [
- 'AttributeName' => [
- 'title' => '属性名',
- 'description' => '属性名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'powerstate',
- ],
- 'AttributeValue' => [
- 'title' => '属性值',
- 'description' => '属性值',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'required' => true, 'example' => '睡眠模式'],
],
],
'responses' => [
@@ -4898,3115 +1949,1530 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C6***E6FA',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => '调用返回码 pop返回使用', 'description' => '调用返回码 pop返回使用', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
- 'title' => '导入房间内精灵智能场景',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]',
+ 'title' => '房间场景控制',
],
- 'PageGetHotelRoomDevices' => [
- 'summary' => '根据酒店分页查询房间主控设备',
- 'path' => '/v1.0/ip/pageGetHotelRoomDevices',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetBasicInfoQA' => [
+ 'summary' => '通用问答模块下的获取基础信息问答功能。',
+ 'path' => '/v1.0/ip/getBasicInfoQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分页大小',
- 'description' => '分页大小,默认最大限制20',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'PageResult<List<HotelDeviceInfo>>',
- 'description' => 'PageResult<List<HotelDeviceInfo>>',
+ 'title' => 'Result<IntentionQATemplateResponse>',
+ 'description' => 'Result<IntentionQATemplateResponse>',
'type' => 'object',
'properties' => [
- 'Page' => [
- 'title' => '翻页参数',
- 'description' => '翻页参数',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '分页大小',
- 'description' => '分页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'TotalPage' => [
- 'title' => '总页数',
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Start' => [
- 'title' => '起始序号',
- 'description' => '起始序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'End' => [
- 'title' => '末尾序号',
- 'description' => '末尾序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'HasNext' => [
- 'title' => '是否还有下一页',
- 'description' => '是否还有下一页',
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- ],
- ],
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的200标识成功外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的200标识成功外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Mac' => [
- 'title' => '设备mac',
- 'description' => '设备mac',
- 'type' => 'string',
- 'example' => 'b4:xx:xx:xx:65:2b',
- ],
- 'Sn' => [
- 'title' => '设备sn',
- 'description' => '设备sn',
- 'type' => 'string',
- 'example' => '1200xxx048',
- ],
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'RoomNo' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '2001',
- ],
- 'OnlineStatus' => [
- 'title' => '设备在线状态,1:在线;0:离线',
- 'description' => '设备在线状态,1:在线;0:离线',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FirmwareVersion' => [
- 'title' => '设备固件版本号',
- 'description' => '设备固件版本号',
- 'type' => 'string',
- 'example' => 'V21.10.00.313',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
+ 'properties' => [
+ 'HotelAddress' => ['title' => '酒店地址', 'description' => '酒店地址', 'type' => 'string', 'example' => '杭州市***'],
+ 'PhoneNumber' => ['title' => '前台电话', 'description' => '前台电话', 'type' => 'string', 'example' => '123***'],
+ 'CheckInTime' => ['title' => '入住时间 格式xx:xx 时分', 'description' => '入住时间(格式xx:xx 时分)', 'type' => 'string', 'example' => '11:11'],
+ 'CheckOutTime' => ['title' => '退房时间', 'description' => '退房时间(格式xx:xx 时分)', 'type' => 'string', 'example' => '11:11'],
+ 'WifiName' => ['title' => 'wifi名称', 'description' => 'wifi名称', 'type' => 'string', 'example' => '名称***'],
+ 'WifiPassword' => ['title' => 'wifi密码', 'description' => 'wifi密码', 'type' => 'string', 'example' => '密码***'],
+ 'HotelMember' => ['title' => '酒店会员相关介绍', 'description' => '酒店会员相关介绍', 'type' => 'string', 'example' => '会员***'."\n"],
+ 'HotelService' => ['title' => '酒店特色服务相关介绍', 'description' => '酒店特色服务相关介绍', 'type' => 'string', 'example' => '服务***'],
+ 'HotelIntroduction' => ['title' => '酒店介绍', 'description' => '酒店介绍', 'type' => 'string', 'example' => '酒店***'],
+ 'ParkingPosition' => ['title' => '停车场位置', 'description' => '停车场位置', 'type' => 'string', 'example' => '杭州市***'],
+ 'ParkingExpenses' => [
+ 'title' => '停车费用,免费停车/收费停车',
+ 'description' => '停车费用(免费停车/收费停车)',
+ 'type' => 'string',
+ 'enumValueTitles' => ['收费停车' => '收费停车', '免费停车' => '免费停车'],
+ 'example' => '免费停车',
+ 'enum' => [],
+ ],
],
],
- 'RequestId' => [
- 'title' => '请求参数',
- 'description' => '请求参数',
- 'type' => 'string',
- 'example' => '4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7***726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 5,\\n \\"TotalPage\\": 1,\\n \\"Start\\": 0,\\n \\"End\\": 4,\\n \\"HasNext\\": true\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"V21.10.00.313\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE\\"\\n}","type":"json"}]',
- 'title' => '根据酒店分页查询房间主控设备',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelAddress\\": \\"杭州市***\\",\\n \\"PhoneNumber\\": \\"123***\\",\\n \\"CheckInTime\\": \\"11:11\\",\\n \\"CheckOutTime\\": \\"11:11\\",\\n \\"WifiName\\": \\"名称***\\",\\n \\"WifiPassword\\": \\"密码***\\",\\n \\"HotelMember\\": \\"会员***\\\\n\\",\\n \\"HotelService\\": \\"服务***\\",\\n \\"HotelIntroduction\\": \\"酒店***\\",\\n \\"ParkingPosition\\": \\"杭州市***\\",\\n \\"ParkingExpenses\\": \\"免费停车\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
+ 'title' => '获取基础信息问答',
],
- 'QueryRoomControlDevices' => [
- 'summary' => '查询房间客控设备列表,不包含状态等信息',
- 'path' => '/v1.0/ip/queryRoomControlDevices',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetCartoon' => [
+ 'summary' => '查询已设置的动画',
+ 'path' => '/v1.0/ip/getCartoon',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'RoomNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<ListHotelMessageTemplate>>',
- 'description' => '返回结果对象',
+ 'title' => 'Result<HotelCartoonResponse>',
+ 'description' => 'Result<HotelCartoonResponse>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '客控设备列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备信息',
- 'type' => 'object',
- 'properties' => [
- 'Location' => [
- 'description' => '位置信息,如room',
- 'type' => 'string',
- 'example' => 'room',
- ],
- 'LocationName' => [
- 'description' => '位置名称,如"房间"',
- 'type' => 'string',
- 'example' => '房间',
- ],
- 'Devices' => [
- 'description' => '设备列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备信息',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '设备类型,如'."\n"
- ."\n"
- .'- light:灯'."\n"
- .'- aircondition:空调',
- 'type' => 'string',
- 'example' => 'light',
- ],
- 'Number' => [
- 'description' => '设备编号',
- 'type' => 'string',
- 'example' => 'night_light',
- ],
- 'DeviceName' => [
- 'description' => '设备名称,如"小夜灯"',
- 'type' => 'string',
- 'example' => '小夜灯',
- ],
- 'ConnectType' => [
- 'title' => '设备连接类型:rcu/infrared',
- 'description' => '设备连接类型',
- 'type' => 'string',
- 'example' => 'rcu:RCU设备'."\n"
- .'infrared:红外设备',
- ],
- 'PK' => [
- 'description' => 'Mesh设备三元组的 pid',
- 'type' => 'string',
- 'example' => '50255129',
- ],
- 'DN' => [
- 'description' => 'Mesh设备三元组的 deviceName',
- 'type' => 'string',
- 'example' => '3c5d2ab8f9ec',
- ],
- 'DeviceStatus' => [
- 'description' => '设备状态',
- 'type' => 'string',
- 'example' => '{"powerstate": "1"}',
- ],
- 'AliasList' => [
- 'description' => '设备别名列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备别名',
- 'type' => 'string',
- 'example' => '卫生间灯',
- ],
- ],
- 'MultiKeySwitchExt' => [
- 'description' => '多键开关类设备信息',
- 'type' => 'object',
- 'properties' => [
- 'SwitchList' => [
- 'description' => '开关列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DeviceIndex' => [
- 'description' => '多键开关类设备的设备序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ElementCode' => [
- 'description' => '多 element 设备对应的 elementCode',
- 'type' => 'string',
- 'example' => 'e2',
- ],
- 'Category' => [
- 'description' => '设备品类',
- 'type' => 'string',
- 'example' => 'light',
- ],
- 'Location' => [
- 'description' => '位置信息',
- 'type' => 'string',
- 'example' => 'room',
- ],
- 'DeviceName' => [
- 'description' => '设备别名',
- 'type' => 'string',
- 'example' => '廊灯',
- ],
- 'DeviceStatus' => [
- 'description' => '设备状态',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "powerstate": "0"'."\n"
- .'}',
- ],
- 'AliasList' => [
- 'description' => '子设备的别名列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备别名',
- 'type' => 'string',
- 'example' => '卫生间灯',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'description' => '服务的实际返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'StartVideoUrl' => ['title' => '开机启动视频', 'description' => '开机启动视频', 'type' => 'string', 'example' => '40c8***97'],
+ 'StartVideoMd5' => ['title' => '开机视频md5', 'description' => '开机视频md5', 'type' => 'string', 'example' => 'https://ai***.mp4'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'fdsgfdscvre',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求requestId', 'type' => 'string', 'example' => '0EC7*726E'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"ConnectType\\": \\"rcu:RCU设备\\\\ninfrared:红外设备\\",\\n \\"PK\\": \\"50255129\\",\\n \\"DN\\": \\"3c5d2ab8f9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"fdsgfdscvre\\"\\n}","type":"json"}]',
- 'title' => '查询房间客控设备',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"StartVideoUrl\\": \\"40c8***97\\",\\n \\"StartVideoMd5\\": \\"https://ai***.mp4\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '查询已设置的动画',
+ 'description' => '查询已设置的动画',
],
- 'GetHotelRoomDevice' => [
- 'summary' => '查询房间猫精设备信息,如设备mac、sn、在线状态等',
- 'path' => '/v1.0/ip/getHotelRoomDevice',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetHotelContactByGenieDevice' => [
+ 'summary' => '获取当前设备的通话信息',
+ 'path' => '/v1.0/ip/getHotelContactByGenieDevice',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
+ 'name' => 'UserInfo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
+ 'description' => '用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['title' => '编码类型,此处填写HOTEL。', 'description' => '编码类型,此处填写HOTEL。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'."\n"],
+ 'IdType' => ['title' => '用户Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'description' => '用户Id的类型'."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['title' => '用户标识,设置为userOpenId或userUnionId。', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1***2'],
+ ],
+ 'required' => false,
],
],
[
- 'name' => 'RoomNo',
+ 'name' => 'DeviceInfo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
+ 'description' => '设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['title' => '编码类型,此处填写HOTEL。', 'description' => '编码类型,此处填写HOTEL。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'IdType' => ['title' => '用户标识,设置为userOpenId或userUnionId。', 'description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['title' => '用户Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'description' => '用户Id的类型'."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<ListHotelMessageTemplate>>',
- 'description' => '返回结果对象',
+ 'title' => 'Result<HotelCallContact>',
+ 'description' => 'Result<HotelCallContact>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '猫精设备列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '猫精设备信息',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'af7***536',
- ],
- 'RoomNo' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '1211',
- ],
- 'Mac' => [
- 'description' => '设备mac信息',
- 'type' => 'string',
- 'example' => 'aa:aa:aa:aa:aa:aa',
- ],
- 'Sn' => [
- 'description' => '设备sn信息',
- 'type' => 'string',
- 'example' => 'dsfdsfrgreg',
- ],
- 'OnlineStatus' => [
- 'description' => '设备在线状态'."\n"
- ."\n"
- .'- 1:在线'."\n"
- .'- 0:离线',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FirmwareVersion' => [
- 'description' => '设备固件版本',
- 'type' => 'string',
- 'example' => '1.0.0-release',
- ],
- ],
+ 'description' => '服务的实际返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'a7***83'],
+ 'Type' => ['title' => '联系人类型,device:设备,group:分组', 'description' => '联系人类型,device:设备,group:分组', 'type' => 'string', 'example' => 'group'],
+ 'Uuid' => ['title' => '唯一标识', 'description' => '唯一标识', 'type' => 'string', 'example' => '2E57***D45F9'],
+ 'Number' => ['title' => '号码', 'description' => '号码', 'type' => 'string', 'example' => '101'],
+ 'Name' => ['title' => '联系人名称', 'description' => '联系人名称', 'type' => 'string', 'example' => '前台'],
+ 'Icon' => ['title' => '图标', 'description' => '图标', 'type' => 'string', 'example' => 'xxx.icon'],
+ 'Status' => ['title' => '状态,1:可用,0:不可用', 'description' => '状态,1:可用,0:不可用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ExpireAt' => ['title' => '失效时间', 'description' => '失效时间', 'type' => 'string', 'example' => '1649472283046'],
+ 'Id' => ['title' => '联系人id', 'description' => '联系人id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'GmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-07-21 20:02:12'],
+ 'GmtModified' => ['title' => '最后修改时间', 'description' => '最后修改时间', 'type' => 'string', 'example' => '2022-07-27 14:06:27'."\n"],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'vrehvuifdsgrts',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '73C6***E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"Mac\\": \\"aa:aa:aa:aa:aa:aa\\",\\n \\"Sn\\": \\"dsfdsfrgreg\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"1.0.0-release\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"vrehvuifdsgrts\\"\\n}","type":"json"}]',
- 'title' => '查询房间猫精设备信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\",\\n \\"Id\\": 1,\\n \\"GmtCreate\\": \\"2022-07-21 20:02:12\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
+ 'title' => '获取设备通话联系人信息',
],
- 'ControlRoomDevice' => [
- 'summary' => '酒店房间内红外或Mesh设备控制。',
- 'path' => '/v1.0/ip/controlRoomDevice',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelContactByNumber' => [
+ 'summary' => '根据号码查询联系人信息',
+ 'path' => '/v1.0/ip/getHotelContactByNumber',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
- ],
- [
- 'name' => 'RoomNo',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
- ],
- [
- 'name' => 'Cmd',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '指令类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'thing.attribute.set'."\n"
- .'thing.attribute.adjust',
- ],
- ],
- [
- 'name' => 'DeviceNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'INFRARED49122575595',
- ],
- ],
- [
- 'name' => 'DeviceIndex',
+ 'name' => 'Number',
'in' => 'formData',
- 'schema' => [
- 'description' => '多键开关类设备的设备序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '号码', 'description' => '号码,房间号或者部门自定义的号码', 'type' => 'string', 'required' => true, 'example' => '101'],
],
[
- 'name' => 'Properties',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '属性信息',
+ 'title' => '用户信息',
+ 'description' => '用户信息',
'type' => 'object',
- 'required' => true,
- 'additionalProperties' => [
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- 'description' => 'powerstate',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型,此处填写 HOTEL。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<ControlResponse>',
- 'description' => 'Result<ControlResponse>',
+ 'title' => 'Result<HotelCallContact>',
+ 'description' => 'Result<HotelCallContact>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,200标识成功', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '控制结果码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200表示成功,其它为失败',
- ],
- 'Message' => [
- 'description' => '控制结果信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'a7***83'],
+ 'Type' => ['title' => '联系人类型,device:设备,group:分组', 'description' => '联系人类型,device:设备,group:分组', 'type' => 'string', 'example' => 'group'],
+ 'Uuid' => ['title' => '唯一标识', 'description' => '唯一标识', 'type' => 'string', 'example' => '2E57***D45F9'],
+ 'Number' => ['title' => '号码', 'description' => '号码', 'type' => 'string', 'example' => '101'],
+ 'Name' => ['title' => '联系人名称', 'description' => '联系人名称', 'type' => 'string', 'example' => '前台'],
+ 'Icon' => ['title' => '图标', 'description' => '图标', 'type' => 'string', 'example' => 'xxx.icon'],
+ 'Status' => ['title' => '状态,1:可用,0:不可用', 'description' => '状态,1:可用,0:不可用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ExpireAt' => ['title' => '失效时间', 'description' => '失效时间', 'type' => 'string', 'example' => '1649316479098'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0EC7***726E',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": 0,\\n \\"Message\\": \\"success\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
- 'title' => '控制房间客控设备',
- 'requestParamsDescription' => '<notice>大部分红外设备电源开关是相同的按键码,可能会出现 powerstate 设置为1时,设备实际为关闭动作;红外设备当前仅支持单属性控制 </notice>'."\n"
- ."\n"
- .'### 风扇'."\n"
- .'#### thing.attribute.set'."\n"
- .'- powerstate: 开关 '."\n"
- .' - 0: 关闭'."\n"
- .' - 1: 打开'."\n"
- ."\n"
- .'### 空调'."\n"
- .'#### thing.attribute.set'."\n"
- .'- powerstate: 开关'."\n"
- .' - 0: 关闭'."\n"
- .' - 1: 打开'."\n"
- .'- windspeed: 风速'."\n"
- .' - 0~3:风速0级至3级'."\n"
- .'- targetTemperature: 目标温度'."\n"
- .' - 16~30:目标温度,单位摄氏度'."\n"
- .'- mode: 模式'."\n"
- .' - 2:自动模式'."\n"
- .' - 9:制冷模式'."\n"
- .' - 10:制热模式'."\n"
- .' - 12:送风模式'."\n"
- .' - 13:除湿模式'."\n"
- .' - 14:睡眠模式'."\n"
- .' - 38:强效模式'."\n"
- .' - 230:节能模式'."\n"
- .' - 231:预热模式'."\n"
- ."\n"
- .'### 电视类(电视、电视盒子、投影仪、机顶盒)'."\n"
- .'#### thing.attribute.set'."\n"
- .'- powerstate: 开关'."\n"
- .' - 0: 关闭'."\n"
- .' - 1: 打开'."\n"
- .'- channelNumber:频道号'."\n"
- .' - 0~999: 频道号'."\n"
- .'- muteMode: 静音模式'."\n"
- .' - 0:关闭静音模式'."\n"
- .' - 1:打开静音模式'."\n"
- ."\n"
- .'#### thing.attribute.adjust'."\n"
- .'- volume: 音量'."\n"
- .' - 1: 音量加一'."\n"
- .' - -1:音量减一',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649316479098\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '根据号码查询联系人',
],
- 'PushVoiceBoxCommands' => [
- 'summary' => '推送音箱指令',
- 'path' => '/v1.0/ip/pushVoiceBoxCommands',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetHotelContacts' => [
+ 'summary' => '获取酒店联系人',
+ 'path' => '/v1.0/ip/getHotelContacts',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a4d9a9cfcdef4c39b2b1a9724eae906b',
- ],
- ],
- [
- 'name' => 'RoomNo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '111',
- ],
- ],
- [
- 'name' => 'Commands',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '命令列表',
- 'description' => '命令列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '',
- 'type' => 'object',
- 'properties' => [
- 'CommandDomain' => [
- 'title' => '命名空间',
- 'description' => '命名空间',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AliGenie.Video.Control',
- ],
- 'CommandName' => [
- 'title' => '指令名称',
- 'description' => '指令名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Pause',
- ],
- 'Payload' => [
- 'title' => '指令参数',
- 'description' => '指令参数',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => '可为空',
- ],
- ],
- 'required' => true,
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型,此处填写 HOTEL。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
- 'required' => true,
- 'minItems' => 1,
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<HotelCallContact>>',
+ 'description' => 'Result<List<HotelCallContact>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '调用返回码 pop返回使用',
- 'description' => '调用返回码 pop返回使用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,200标识成功', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'RequestId' => [
- 'title' => '',
- 'description' => '无',
- 'type' => 'string',
- 'example' => 'null',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '联系人信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'cf24***96e7'],
+ 'Type' => ['title' => '联系人类型,device:设备,group:分组', 'description' => '联系人类型,device:设备,group:分组', 'type' => 'string', 'example' => 'group'],
+ 'Uuid' => ['title' => '唯一标识', 'description' => '唯一标识', 'type' => 'string', 'example' => '0862***A809'],
+ 'Number' => ['title' => '号码', 'description' => '号码', 'type' => 'string', 'example' => '101'],
+ 'Name' => ['title' => '联系人名称', 'description' => '联系人名称', 'type' => 'string', 'example' => '前台'],
+ 'Icon' => ['title' => '图标', 'description' => '图标', 'type' => 'string', 'example' => 'xxx.icon'],
+ 'Status' => ['title' => '状态,1:可用,0:不可用', 'description' => '状态,1:可用,0:不可用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ExpireAt' => ['title' => '失效时间', 'description' => '失效时间', 'type' => 'string', 'example' => '1649472283046'],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"null\\"\\n}","type":"json"}]',
- 'title' => '推送音箱指令',
- 'requestParamsDescription' => '**commands:**'."\n"
- ."\n"
- .'当前支持的指令'."\n"
- .'| / | commandDomain | commandName | payload |'."\n"
- .'| ---- | ---- | ---- | ---- |'."\n"
- .'| 带屏设备暂停指令 | AliGenie.Video.Control | Pause | 可为空 |'."\n"
- .'| 无屏设备暂停指令 | AliGenie.System.Control | Pause | 可为空 |'."\n"
- .'| 息屏指令 | AliGenie.Screen | UnlitScreen | 可为空 |'."\n"
- .'| 亮屏指令 | AliGenie.Screen | LightScreen | 可为空 |',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf24***96e7\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"0862***A809\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '获取酒店联系人',
],
- 'SyncDeviceStatusWithAk' => [
- 'summary' => '用于云云RCU对接的客控设备状态同步至猫精侧,猫精侧存储状态信息或者通知设备端更新状态显示',
- 'path' => '/v1.0/ip/syncDeviceStatusWithAk',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelHomeBackImageAndModes' => [
+ 'summary' => '获取首页背景图和场景模式',
+ 'path' => '/v1.0/ip/getHotelHomeBackImageAndModes',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'RoomNo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
- ],
- [
- 'name' => 'DeviceName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备名称',
- 'description' => '设备名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '床头灯',
- ],
- ],
- [
- 'name' => 'Switch',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '开关值,0:关,1:开',
- 'description' => '开关值,0:关,1:开',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'CategoryEnName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备的品类英文名称',
- 'description' => '设备的品类英文名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'light',
- ],
- ],
- [
- 'name' => 'CategoryCnName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备的品类英文名称,选填',
- 'description' => '设备的品类英文名称,选填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '灯',
- ],
- ],
- [
- 'name' => 'Number',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备序号',
- 'description' => '设备序号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'bedLight',
- ],
- ],
- [
- 'name' => 'Location',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '位置',
- 'description' => '位置',
- 'type' => 'string',
+ 'title' => '用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955'],
+ 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA=='],
+ 'OrganizationId' => ['type' => 'string'],
+ ],
'required' => true,
- 'example' => 'room',
- ],
- ],
- [
- 'name' => 'LocationCnName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '位置中文名称,选填',
- 'description' => '位置中文名称,选填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '房间',
- ],
- ],
- [
- 'name' => 'mode',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '空调参数,例如制冷、制热模式',
- 'description' => '空调模式'."\n"
- .'- auto:自动'."\n"
- .'- cold:制冷'."\n"
- .'- hot:制热',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'auto',
- ],
- ],
- [
- 'name' => 'fanSpeed',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '空调字段,风速',
- 'description' => '空调风速,1,2,3分别对应低速、中速、高速',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3',
- ],
- ],
- [
- 'name' => 'temperature',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '空调字段,温度',
- 'description' => '空调温度',
- 'type' => 'string',
- 'required' => false,
- 'example' => '22',
- ],
- ],
- [
- 'name' => 'roomTemperature',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '空调字段,当前室温',
- 'description' => '室温',
- 'type' => 'string',
- 'required' => false,
- 'example' => '21',
- ],
- ],
- [
- 'name' => 'value',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '窗帘、纱帘字段,开合度',
- 'description' => '窗帘开合度,仅窗帘品类使用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<HomePageBackImageAndModes>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果,是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'requestId' => [
- 'description' => '请求id'."\n",
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
+ 'type' => 'object',
+ 'properties' => [
+ 'BackgroundImage' => ['title' => '背景图URL', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhn.jpg'],
+ 'HotelName' => ['title' => '酒店名称', 'type' => 'string', 'example' => '宣雍测试橙蜂酒店'],
+ 'ModeList' => [
+ 'title' => '模式list',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '模式code', 'type' => 'string', 'example' => 'romantic'],
+ 'CnName' => ['title' => '模式名称', 'type' => 'string', 'example' => '浪漫模式'],
+ 'Icon' => ['title' => '模式icon', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/langman.png'],
+ ],
+ ],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'type' => 'string', 'example' => '394450FC-9035-1B7C-8829-BC88832473FC'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => ' AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","type":"json"}]',
- 'title' => '客控设备状态同步',
],
- 'CreateRcuScene' => [
- 'summary' => '创建rcu自定义场景',
- 'path' => '/v1.0/ip/createRcuScene',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelNotice' => [
+ 'summary' => '获取酒店通知',
+ 'path' => '/v1.0/ip/getHotelNotice',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '520a0c0***5eb',
- ],
- ],
- [
- 'name' => 'SceneId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '场景编码',
- 'description' => '场景编码',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'yoga',
- ],
- ],
- [
- 'name' => 'SceneRelationExtDTO',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '酒店RCU自定义场景',
- 'description' => '酒店RCU自定义场景',
+ 'title' => '用户信息',
+ 'description' => '用户信息',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '场景名称',
- 'description' => '场景名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '瑜伽模式',
- ],
- 'Icon' => [
- 'title' => '场景图标',
- 'description' => '场景图标',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png',
- ],
- 'Description' => [
- 'title' => '场景描述信息',
- 'description' => '场景描述信息',
- 'type' => 'string',
- 'required' => true,
- 'example' => '做瑜伽的酒店场景',
- ],
- 'CorpusList' => [
- 'title' => '触发语料',
- 'description' => '触发语料(支持多语料,根据需求传递list 例:瑜伽模式、开始瑜伽)',
- 'type' => 'array',
- 'items' => [
- 'description' => '触发语料',
- 'type' => 'string',
- 'required' => false,
- 'example' => '瑜伽模式',
- ],
- 'required' => true,
- ],
+ 'EncodeType' => ['description' => '编码类型,此处填写PROJECT_ID。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'IdType' => ['description' => '设备Id的类型 :'."\n"
+ .'OPENID:默认的设备ID标识。'."\n"
+ .'UNIONID: 组织维度的设备ID标识,需要提前在开放平台申请组织。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,填写userOpenId或userUnionId的值。', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => true,
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<String>',
+ 'description' => 'Result<String>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '844BA5CE-E30A-53CB-8A11-DE1F344C846D',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'string', 'example' => 'test notice...'],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"844BA5CE-E30A-53CB-8A11-DE1F344C846D\\"\\n}","type":"json"}]',
- 'title' => '创建rcu自定义场景',
- 'description' => '创建rcu自定义场景,请根据请求参数完成创建',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"test notice...\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
+ 'title' => '获取酒店通知',
],
- 'DeleteRcuScene' => [
- 'summary' => '删除酒店rcu自定义场景',
- 'path' => '/v1.0/ip/deleteRcuScene',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelNoticeV2' => [
+ 'summary' => '获取酒店通知信息,包含通知标题和内容',
+ 'path' => '/v1.0/ip/getHotelNoticeV2',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7a3***013',
- ],
- ],
- [
- 'name' => 'SceneId',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '场景编码',
- 'description' => '场景编码',
- 'type' => 'string',
+ 'title' => '用户信息',
+ 'description' => '用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型,此处填写 HOTEL。', 'type' => 'string', 'required' => false, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => false, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => false, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
'required' => true,
- 'example' => 'yoga',
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<HotelNotice>',
+ 'description' => 'Result<HotelNotice>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,200标识成功', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '4F61A7B7-409C-525D-AFDB-238A4E88925A',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'a7***83'],
+ 'Title' => ['title' => '酒店通知标题', 'description' => '酒店通知标题', 'type' => 'string', 'example' => '欢迎入住智能酒店'],
+ 'Content' => ['title' => '酒店通知内容', 'description' => '酒店通知内容', 'type' => 'string', 'example' => '欢迎入住,我是您的智能语音助手'],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求Id', 'description' => '请求Id', 'type' => 'string', 'example' => '0D0C***67DB'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4F61A7B7-409C-525D-AFDB-238A4E88925A\\"\\n}","type":"json"}]',
- 'title' => '删除酒店rcu自定义场景',
- 'description' => '删除酒店rcu自定义场景,请按照请求参数执行',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Title\\": \\"欢迎入住智能酒店\\",\\n \\"Content\\": \\"欢迎入住,我是您的智能语音助手\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]',
+ 'title' => '获取酒店通知-包含标题',
],
- 'UpdateRcuScene' => [
- 'summary' => '修改rcu自定义场景',
- 'path' => '/v1.0/ip/updateRcuScene',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelOrderDetail' => [
+ 'summary' => '获取酒店订单详情,例如无屏、维修、餐饮等',
+ 'path' => '/v1.0/ip/getHotelOrderDetail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '520a0c0***5eb',
- ],
- ],
- [
- 'name' => 'SceneId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '场景编码',
- 'description' => '场景编码',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'yoga',
- ],
- ],
- [
- 'name' => 'SceneRelationExtDTO',
- 'in' => 'formData',
+ 'name' => 'Payload',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '酒店RCU自定义场景',
- 'description' => '酒店RCU自定义场景',
+ 'title' => '订单详情payload',
+ 'description' => '订单详情payload',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '场景名称',
- 'description' => '场景名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '瑜伽模式',
- ],
- 'Icon' => [
- 'title' => '场景图标',
- 'description' => '场景图标',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png',
- ],
- 'Description' => [
- 'title' => '场景描述信息',
- 'description' => '场景描述信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '做做瑜伽',
- ],
- 'CorpusList' => [
- 'title' => '触发语料',
- 'description' => '触发语料(支持多场景,根据需求传递list,会覆盖之前配的触发语料,若都需要配,修改时需都传 例:瑜伽模式、开始瑜伽)',
- 'type' => 'array',
- 'items' => [
- 'description' => '触发语料',
- 'type' => 'string',
- 'required' => false,
- 'example' => '开始瑜伽',
- ],
- 'required' => false,
- ],
+ 'OrderNo' => ['title' => '订单号', 'description' => '订单号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20220714150702000168270112410630'],
],
'required' => true,
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<HotelOrderDetail>>',
+ 'description' => 'Result<List<HotelOrderDetail>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '3A680F3A-6672-5A47-AB28-12BBCD80C679',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '物品名称', 'description' => '物品名称', 'type' => 'string', 'example' => '窗帘'],
+ 'ApplyAmt' => ['title' => '物品金额', 'description' => '物品金额', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Quantity' => ['title' => '物品数量', 'description' => '物品数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ItemUrl' => ['title' => '物品icon', 'description' => '物品icon', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png'],
+ 'GmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1659952892000'],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6F579407-13C4-1708-AFA2-B657BE5FE8F5'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3A680F3A-6672-5A47-AB28-12BBCD80C679\\"\\n}","type":"json"}]',
- 'title' => '修改rcu自定义场景',
- 'description' => '修改rcu自定义场景,请根据请求参数修改',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"窗帘\\",\\n \\"ApplyAmt\\": 200,\\n \\"Quantity\\": 1,\\n \\"ItemUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png\\",\\n \\"GmtCreate\\": 1659952892000\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6F579407-13C4-1708-AFA2-B657BE5FE8F5\\"\\n}","type":"json"}]',
+ 'title' => '获取订单详情',
+ 'description' => '获取酒店订单详情,例如无屏、维修、餐饮等',
],
- 'ExecuteScene' => [
- 'summary' => '控制房间场景',
- 'path' => '/v1.0/ip/executeScene',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetHotelRoomDevice' => [
+ 'summary' => '查询房间猫精设备信息,如设备mac、sn、在线状态等',
+ 'path' => '/v1.0/ip/getHotelRoomDevice',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '80d84ea8ed9e422fbad52715c8fc56f1',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
],
[
'name' => 'RoomNo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
- ],
- [
- 'name' => 'SceneName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '场景名称',
- 'description' => '场景名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '睡眠模式',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<ListHotelMessageTemplate>>',
+ 'description' => '返回结果对象',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '调用返回码 pop返回使用',
- 'description' => '调用返回码 pop返回使用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920',
+ 'description' => '猫精设备列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '猫精设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['description' => '酒店id', 'type' => 'string', 'example' => 'af7***536'],
+ 'RoomNo' => ['description' => '房间号', 'type' => 'string', 'example' => '1211'],
+ 'Mac' => ['description' => '设备mac信息', 'type' => 'string', 'example' => 'aa:aa:aa:aa:aa:aa'],
+ 'Sn' => ['description' => '设备sn信息', 'type' => 'string', 'example' => 'dsfdsfrgreg'],
+ 'OnlineStatus' => ['description' => '设备在线状态'."\n"
+ ."\n"
+ .'- 1:在线'."\n"
+ .'- 0:离线', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FirmwareVersion' => ['description' => '设备固件版本', 'type' => 'string', 'example' => '1.0.0-release'],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'vrehvuifdsgrts'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]',
- 'title' => '房间场景控制',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"Mac\\": \\"aa:aa:aa:aa:aa:aa\\",\\n \\"Sn\\": \\"dsfdsfrgreg\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"1.0.0-release\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"vrehvuifdsgrts\\"\\n}","type":"json"}]',
+ 'title' => '查询房间猫精设备信息',
],
- 'QuerySceneList' => [
- 'summary' => '查询酒店场景列表',
- 'path' => '/v1.0/ip/querySceneList',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelSampleUtterances' => [
+ 'summary' => '获取推荐语料',
+ 'path' => '/v1.0/ip/getHotelSampleUtterances',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'SceneTypes',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '场景集合传递(公共:common;自定义:custom)',
- 'description' => '场景集合传递(公共:common;自定义:custom)',
- 'type' => 'array',
- 'items' => [
- 'description' => 'common 或 custom',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'common',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'SceneStates',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '场景状态集合传递(1-已关联,0-未关联)',
- 'description' => '场景状态集合传递(1-已关联,0-未关联)',
- 'type' => 'array',
- 'items' => [
- 'description' => '0 或 1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'TemplateInfoIds',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '房型id',
- 'description' => '房型id',
- 'type' => 'array',
- 'items' => [
- 'description' => '房型id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '999',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['type' => 'string', 'required' => true],
+ 'EncodeKey' => ['type' => 'string', 'required' => true],
+ 'IdType' => ['type' => 'string', 'required' => true],
+ 'Id' => ['type' => 'string', 'required' => true],
+ 'OrganizationId' => ['type' => 'string'],
],
- 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelSceneWrapperResp>>',
- 'description' => 'Result<List<HotelSceneWrapperResp>>',
+ 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Results' => [
+ 'Code' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32'],
+ 'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
'type' => 'array',
- 'items' => [
- 'description' => '结果列表。',
- 'type' => 'object',
- 'properties' => [
- 'SceneId' => [
- 'title' => '场景id',
- 'description' => '场景id',
- 'type' => 'string',
- 'example' => '73',
- ],
- 'SceneName' => [
- 'title' => '场景名称',
- 'description' => '场景名称',
- 'type' => 'string',
- 'example' => '睡眠模式',
- ],
- 'Icon' => [
- 'title' => '场景图标',
- 'description' => '场景图标',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png',
- ],
- 'SceneSource' => [
- 'title' => '场景来源;场景来源;精灵(genie)、外部(external)',
- 'description' => '场景来源;场景来源;精灵(genie)、外部(external)',
- 'type' => 'string',
- 'example' => 'external',
- ],
- 'SceneType' => [
- 'title' => '场景类型:公共:common;自定义:custom',
- 'description' => '场景类型:公共:common;自定义:custom',
- 'type' => 'string',
- 'example' => 'common',
- ],
- 'SceneState' => [
- 'title' => '场景与房型的关联状态(1-已关联,0-未关联,-1-不可关联)',
- 'description' => '场景与房型的关联状态(1-已关联,0-未关联,-1-不可关联)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UnavailableReason' => [
- 'title' => '场景与房型的关联状态为-1(不可关联)的原因',
- 'description' => '场景与房型的关联状态为-1(不可关联)的原因',
- 'type' => 'string',
- 'example' => '不可关联',
- ],
- 'TemplateInfoDTOList' => [
- 'title' => '关联的房型',
- 'description' => '关联的房型',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '房型id',
- 'description' => '房型id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '6962',
- ],
- 'Name' => [
- 'title' => '房型名称',
- 'description' => '房型名称',
- 'type' => 'string',
- 'example' => '101',
- ],
- 'Description' => [
- 'title' => '描述',
- 'description' => '描述',
- 'type' => 'string',
- 'example' => '房型描述',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B',
+ 'items' => ['type' => 'string'],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Results\\": [\\n {\\n \\"SceneId\\": \\"73\\",\\n \\"SceneName\\": \\"睡眠模式\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png\\",\\n \\"SceneSource\\": \\"external\\",\\n \\"SceneType\\": \\"common\\",\\n \\"SceneState\\": 1,\\n \\"UnavailableReason\\": \\"不可关联\\",\\n \\"TemplateInfoDTOList\\": [\\n {\\n \\"Id\\": 6962,\\n \\"Name\\": \\"101\\",\\n \\"Description\\": \\"房型描述\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]',
- 'title' => '查询酒店场景列表',
- 'description' => '查询酒店场景列表,请根据请求参数查询',
],
- 'QueryRoomStatus' => [
- 'summary' => '查询房态信息',
- 'path' => '/v1.0/ip/queryRoomStatus',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetHotelSceneItemDetail' => [
+ 'summary' => '酒店场景详情',
+ 'path' => '/v1.0/ip/getHotelSceneItemDetail',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7',
- ],
+ 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
[
- 'name' => 'RoomNo',
+ 'name' => 'ItemId',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1211',
- ],
+ 'schema' => ['title' => '酒店场景itemID'."\n"
+ .'id与物品名称必传其中一个', 'description' => '酒店场景itemID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10336'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['title' => '物品名称'."\n"
+ .'id与物品名称必传其中一个', 'description' => '物品名称'."\n"
+ .'id与物品名称必传其中一个', 'type' => 'string', 'required' => false, 'example' => '棉签'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<OpenRoomStatusDetailResponse>',
- 'description' => 'Result<OpenRoomStatusDetailResponse>',
+ 'title' => 'Result<HotelSceneDetailResp>',
+ 'description' => 'Result<HotelSceneDetailResp>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '调用返回码 pop返回使用',
- 'description' => '调用返回码 pop返回使用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7',
- ],
- 'RoomNo' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '1211',
- ],
- 'StatusList' => [
- 'title' => '房态属性内容',
- 'description' => '房态属性内容',
+ 'DialogueList' => [
+ 'title' => '酒店场景item对话List',
+ 'description' => '酒店场景item对话List',
'type' => 'array',
'items' => [
- 'description' => '状态内容',
'type' => 'object',
'properties' => [
- 'StatusName' => [
- 'description' => '状态名称',
- 'type' => 'string',
- 'example' => '清理模式:mur'."\n"
- .'勿扰模式:dnd '."\n"
- .'sos呼叫:sos'."\n"
- .'doorStatus:门状态'."\n"
- .'stateOfMagneticInduction:插卡取电状态'."\n"
- .'wifiStatus:房间联网状态'."\n"
- .'roomPowerState:房间上电状态 1上电 0断电'."\n"
- .'roomEcoMode:房间节能模式 1节能模式下 0非节能模式',
- ],
- 'StatusValue' => [
- 'description' => '状态内容',
- 'type' => 'string',
- 'example' => 'true 打开'."\n"
- .'false 关闭',
- ],
- 'UpdateTime' => [
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => 'Thu Jan 09 13:56:51 CST 2025',
- ],
- ],
- ],
- ],
- 'SceneList' => [
- 'title' => '房间场景',
- 'description' => '房间场景',
- 'type' => 'array',
- 'items' => [
- 'description' => '场景列表',
- 'type' => 'object',
- 'properties' => [
- 'SceneName' => [
- 'description' => '场景名称',
- 'type' => 'string',
- 'example' => '睡眠模式',
- ],
+ 'ServiceId' => ['title' => '酒店场景itemID', 'description' => '酒店场景itemID', 'type' => 'string', 'example' => '10336'],
+ 'Process' => ['title' => '第几轮对话', 'description' => '第几轮对话', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Question' => ['title' => '问题', 'description' => '问题', 'type' => 'string', 'example' => '无'],
+ 'YesAnswer' => ['title' => '肯定回答', 'description' => '肯定回答', 'type' => 'string', 'example' => '纸巾1.5元,请问需要么?'],
+ 'NoAnswer' => ['title' => '否定回答', 'description' => '否定回答', 'type' => 'string', 'example' => '对不起,暂时不提供此物品'],
+ 'YesAnswerTemplate' => ['title' => '肯定回答模板ID', 'description' => '肯定回答模板ID', 'type' => 'string', 'example' => '4'],
+ 'NoAnswerTemplate' => ['title' => '否定回答模板ID', 'description' => '否定回答模板ID', 'type' => 'string', 'example' => '4'],
+ 'DialogueId' => ['title' => '对话ID', 'description' => '对话ID', 'type' => 'string', 'example' => '336'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1666164774'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1666164774'],
],
],
],
+ 'Type' => ['title' => '酒店场景类型', 'description' => '酒店场景类型', 'type' => 'string', 'example' => 'GOODS'],
+ 'Category' => ['title' => '酒店场景类型二级分类', 'description' => '酒店场景类型二级分类', 'type' => 'string', 'example' => '客用品类'],
+ 'Id' => ['title' => '酒店场景itemID', 'description' => '酒店场景itemID', 'type' => 'integer', 'format' => 'int64', 'example' => '10336'],
+ 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => '擦鞋布'],
+ 'Status' => ['title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => '已添加'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1666168828'],
+ 'Icon' => ['title' => '物品、服务、维修的图标', 'description' => '物品、服务、维修的图标', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png'],
+ 'Price' => ['title' => '价格(单位:分)', 'description' => '价格(单位:分)', 'type' => 'integer', 'format' => 'int64', 'example' => '170'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"StatusList\\": [\\n {\\n \\"StatusName\\": \\"清理模式:mur\\\\n勿扰模式:dnd \\\\nsos呼叫:sos\\\\ndoorStatus:门状态\\\\nstateOfMagneticInduction:插卡取电状态\\\\nwifiStatus:房间联网状态\\\\nroomPowerState:房间上电状态 1上电 0断电\\\\nroomEcoMode:房间节能模式 1节能模式下 0非节能模式\\",\\n \\"StatusValue\\": \\"true 打开\\\\nfalse 关闭\\",\\n \\"UpdateTime\\": \\"Thu Jan 09 13:56:51 CST 2025\\"\\n }\\n ],\\n \\"SceneList\\": [\\n {\\n \\"SceneName\\": \\"睡眠模式\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]',
- 'title' => '查询房态信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DialogueList\\": [\\n {\\n \\"ServiceId\\": \\"10336\\",\\n \\"Process\\": 0,\\n \\"Question\\": \\"无\\",\\n \\"YesAnswer\\": \\"纸巾1.5元,请问需要么?\\",\\n \\"NoAnswer\\": \\"对不起,暂时不提供此物品\\",\\n \\"YesAnswerTemplate\\": \\"4\\",\\n \\"NoAnswerTemplate\\": \\"4\\",\\n \\"DialogueId\\": \\"336\\",\\n \\"UpdateTime\\": 1666164774,\\n \\"CreateTime\\": 1666164774\\n }\\n ],\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"擦鞋布\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666168828,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/zhijin.png\\",\\n \\"Price\\": 170\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '酒店场景详情',
],
- 'QueryRoomControlDevicesAndStatus' => [
- 'summary' => '查询房间被控设备包含设备状态。',
- 'path' => '/v1.0/ip/queryRoomControlDevicesAndStatus',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetHotelScreenSaver' => [
+ 'summary' => '获取屏保信息,如屏保样式等信息',
+ 'path' => '/v1.0/ip/getHotelScreenSaver',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => ' '."\n"
- .'af7***536'."\n",
- ],
- ],
- [
- 'name' => 'RoomNo',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1211'."\n",
+ 'title' => '用户信息',
+ 'description' => '用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955'],
+ 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA=='],
+ 'OrganizationId' => ['type' => 'string', 'required' => false],
+ ],
+ 'required' => true,
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<LocationDevices>>',
- 'description' => 'Result<List<LocationDevices>>',
+ 'title' => 'Result<HotelScreenSaver>',
+ 'description' => 'Result<HotelScreenSaver>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '调用返回码 pop返回使用',
- 'description' => '调用返回码 pop返回使用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备内容',
- 'type' => 'object',
- 'properties' => [
- 'RoomNo' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '1211',
- ],
- 'Location' => [
- 'title' => '*',
- 'description' => '位置信息,如room',
- 'type' => 'string',
- 'example' => 'room',
- ],
- 'LocationName' => [
- 'title' => '位置中文',
- 'description' => '位置中文',
- 'type' => 'string',
- 'example' => '房间',
- ],
- 'Devices' => [
- 'description' => '设备列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备信息',
- 'type' => 'object',
- 'properties' => [
- 'ConnectType' => [
- 'title' => '设备连接类型',
- 'description' => '设备连接类型',
- 'type' => 'string',
- 'example' => 'rcu',
- ],
- 'Name' => [
- 'title' => '品类英文',
- 'description' => '设备类型,如'."\n"
- ."\n"
- .'light:灯'."\n"
- .'aircondition:空调',
- 'type' => 'string',
- 'example' => 'light',
- ],
- 'Number' => [
- 'title' => '设备唯一标识',
- 'description' => '设备唯一标识',
- 'type' => 'string',
- 'example' => 'night_light',
- ],
- 'DeviceName' => [
- 'description' => '设备名称,如"小夜灯"',
- 'type' => 'string',
- 'example' => '小夜灯',
- ],
- 'Brand' => [
- 'title' => '红外参数',
- 'description' => '红外参数',
- 'type' => 'string',
- 'example' => '奥*斯',
- ],
- 'ServiceProvider' => [
- 'description' => '服务提供商(红外设备信息)',
- 'type' => 'string',
- 'example' => '吉视传媒****',
- ],
- 'Province' => [
- 'description' => '省份(红外设备信息)',
- 'type' => 'string',
- 'example' => '吉林省',
- ],
- 'City' => [
- 'description' => '城市(红外设备信息)',
- 'type' => 'string',
- 'example' => '松原市',
- ],
- 'InfraredIndex' => [
- 'description' => '红外码库index',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'InfraredId' => [
- 'description' => '红外码库id',
- 'type' => 'string',
- 'example' => '9**7',
- ],
- 'InfraredVersion' => [
- 'description' => '红外码库版本号',
- 'type' => 'string',
- 'example' => '3.0',
- ],
- 'Pk' => [
- 'title' => 'mesh 设备参数',
- 'description' => 'Mesh设备三元组的 pid',
- 'type' => 'string',
- 'example' => '50255129',
- ],
- 'Dn' => [
- 'description' => 'Mesh设备三元组的 deviceName',
- 'type' => 'string',
- 'example' => '3c5d***9ec',
- ],
- 'DeviceStatus' => [
- 'title' => '设备状态',
- 'description' => '设备状态',
- 'type' => 'string',
- 'example' => '{"powerstate": "1"}',
- ],
- 'MultiKeySwitchExt' => [
- 'title' => '多键开关子设备信息',
- 'description' => '多键开关子设备信息',
- 'type' => 'object',
- 'properties' => [
- 'SwitchList' => [
- 'title' => '开关按键列表',
- 'description' => '开关按键列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'title' => '关联的设备品类英文名',
- 'description' => '关联的设备品类英文名',
- 'type' => 'string',
- 'example' => 'light',
- ],
- 'Location' => [
- 'title' => '关联的设备位置',
- 'description' => '关联的设备位置',
- 'type' => 'string',
- 'example' => 'room',
- ],
- 'DeviceName' => [
- 'title' => '关联的设备别名',
- 'description' => '设备名称',
- 'type' => 'string',
- 'example' => '廊灯',
- ],
- 'AliasList' => [
- 'title' => '设备别名',
- 'description' => '设备别名列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备别名',
- 'type' => 'string',
- 'example' => '卫生间灯',
- ],
- ],
- 'DeviceIndex' => [
- 'title' => '设备序号',
- 'description' => '设备序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ElementCode' => [
- 'title' => 'iot 多 element 设备的序号',
- 'description' => 'iot 多 element 设备的序号',
- 'type' => 'string',
- 'example' => 'e2',
- ],
- 'DeviceStatus' => [
- 'title' => '子设备状态',
- 'description' => '子设备状态',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "powerstate": "0"'."\n"
- .'}',
- ],
- 'Tags' => [
- 'title' => '子设备标签',
- 'description' => '子设备标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'SOS',
- ],
- ],
- 'Status' => [
- 'title' => '设备物模型状态',
- 'description' => '设备物模型状态'."\n"
- .'物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157',
- 'example' => '"doorStatus":{"time":1725347306741,"value":"0"}',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'AliasList' => [
- 'title' => '设备别名',
- 'description' => '设备别名列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '设备别名',
- 'type' => 'string',
- 'example' => '卫生间灯',
- ],
- ],
- 'Status' => [
- 'title' => '设备物模型状态',
- 'description' => '设备物模型状态'."\n"
- .'物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'onlinestate":{"time":1725347364693,"value":"online"}',
- 'description' => '物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'type' => 'object',
+ 'properties' => [
+ 'StyleCode' => ['title' => '屏保样式code', 'description' => '屏保样式code', 'type' => 'string', 'example' => 'common-weather'],
+ 'PicUrl' => ['title' => '屏保图片', 'description' => '屏保图片', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C67***6FA'."\n",
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '5F0467E1-19F2-1757-B6D0-B79917BA2E81'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"1211\\",\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"ConnectType\\": \\"rcu\\",\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"Brand\\": \\"奥*斯\\",\\n \\"ServiceProvider\\": \\"吉视传媒****\\",\\n \\"Province\\": \\"吉林省\\",\\n \\"City\\": \\"松原市\\",\\n \\"InfraredIndex\\": \\"2\\",\\n \\"InfraredId\\": \\"9**7\\",\\n \\"InfraredVersion\\": \\"3.0\\",\\n \\"Pk\\": \\"50255129\\",\\n \\"Dn\\": \\"3c5d***9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"Tags\\": [\\n \\"SOS\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"\\\\\\"doorStatus\\\\\\":{\\\\\\"time\\\\\\":1725347306741,\\\\\\"value\\\\\\":\\\\\\"0\\\\\\"}\\"\\n }\\n }\\n ]\\n },\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"onlinestate\\\\\\":{\\\\\\"time\\\\\\":1725347364693,\\\\\\"value\\\\\\":\\\\\\"online\\\\\\"}\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]',
- 'title' => '查询房间客控设备及设备状态',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"StyleCode\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5F0467E1-19F2-1757-B6D0-B79917BA2E81\\"\\n}","type":"json"}]',
+ 'title' => '获取屏保信息',
+ 'description' => '获取屏保信息,如屏保样式等信息',
],
- 'ListAllProvinces' => [
- 'summary' => '查询红外使用的省份信息',
- 'path' => '/v1.0/ip/listAllProvinces',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelScreenSaverStyle' => [
+ 'summary' => '查询酒店屏保背景的可选样式',
+ 'path' => '/v1.0/ip/getHotelScreenSaverStyle',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
- 'parameters' => [],
+ 'parameters' => [
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => false, 'example' => 'af7***536'."\n"],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<String>>',
- 'description' => 'Result<List<String>>',
+ 'title' => 'Result<List<HotelScreenSaverStyle>>',
+ 'description' => 'Result<List<HotelScreenSaverStyle>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'array',
'items' => [
'description' => '服务的实际返回结果',
- 'type' => 'string',
- 'example' => '浙江省',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '编码code', 'description' => '编码code', 'type' => 'string', 'example' => 'common-weather'],
+ 'CnName' => ['title' => '中文名称', 'description' => '中文名称', 'type' => 'string', 'example' => '天气'],
+ 'EnName' => ['title' => '英文名称', 'description' => '英文名称', 'type' => 'string', 'example' => 'common-weather'],
+ 'PicUrl' => ['title' => '图片链接', 'description' => '图片链接', 'type' => 'string', 'example' => 'https://img.***.png'],
+ ],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '00534880-4397-5134-B212-1030B7A37C27',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '73C67**6FA'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"浙江省\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"00534880-4397-5134-B212-1030B7A37C27\\"\\n}","type":"json"}]',
- 'title' => '查询省份',
- 'description' => '查询红外使用的省份信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"common-weather\\",\\n \\"CnName\\": \\"天气\\",\\n \\"EnName\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://img.***.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67**6FA\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店屏保背景的可选样式',
+ 'description' => '新增屏保的时候有个screenSaverStyle字段,要用这接口里查出来的code作为基本样式',
],
- 'ListCitiesByProvince' => [
- 'summary' => '根据省份查询红外使用的城市列表',
- 'path' => '/v1.0/ip/listCitiesByProvince',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetHotelSetting' => [
+ 'summary' => '查询酒店定制(包含屏保背景、首页背景等等)',
+ 'path' => '/v1.0/ip/getHotelSetting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Province',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => false, 'example' => 'af7***536'."\n"],
+ ],
+ [
+ 'name' => 'SettingType',
'in' => 'formData',
'schema' => [
- 'title' => '省份',
- 'description' => '省份',
+ 'title' => '设置的类型,带屏展示模式(SCENE),'."\n"
+ .'带屏屏保配置(SCREENSAVER),'."\n"
+ .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
+ .'带屏酒店通知(NOTICE),'."\n"
+ .'夜间模式(NIGHT_MODE)',
+ 'description' => '设置的类型,带屏展示模式(SCENE),'."\n"
+ .'带屏屏保配置(SCREENSAVER),'."\n"
+ .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
+ .'带屏酒店通知(NOTICE),'."\n"
+ .'夜间模式(NIGHT_MODE)',
'type' => 'string',
- 'required' => true,
- 'example' => '北京市',
+ 'required' => false,
+ 'enumValueTitles' => ['NOTICE' => '带屏酒店通知', 'NIGHT_MODE' => '夜间模式', 'SCREENSAVER' => '屏保背景', 'SCENE' => '带屏展示模式', 'HOMEPAGE_PIC' => '首页背景图'],
+ 'example' => 'SCREENSAVER',
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<List<String>>',
- 'description' => 'Result<List<String>>',
+ 'title' => 'Result<HotelSettingInfo>',
+ 'description' => 'Result<HotelSettingInfo>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => [
+ 'title' => '服务的实际返回结果',
+ 'description' => '服务的实际返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'af7***536'],
+ 'SettingType' => [
+ 'title' => '设置类型',
+ 'description' => '设置类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['SCREENSAVER' => '屏保', 'HOMEPAGE_PIC' => '首页背景图'],
+ 'example' => 'SCREENSAVER',
+ ],
+ 'Value' => ['title' => '对应的值', 'description' => '首页背景图/酒店通知', 'type' => 'string', 'example' => '首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店~~'],
+ 'DeleteToken' => ['title' => '是否删除', 'description' => '是否删除', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'ExtInfo' => ['title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'example' => '{}'],
+ 'HotelScreenSaver' => [
+ 'title' => '屏保对象',
+ 'description' => '屏保对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'ScreenSaverStyle' => ['title' => '屏保样式code', 'description' => '屏保样式code', 'type' => 'string', 'example' => 'common-weather'],
+ 'ScreenSaverPicUrl' => ['title' => '屏保图片', 'description' => '屏保图片', 'type' => 'string', 'example' => 'https://a***png'],
+ ],
+ ],
+ 'HotelDeviceModeList' => [
+ 'title' => '设备模式',
+ 'description' => '设备模式',
+ 'type' => 'array',
+ 'items' => ['description' => '场景值', 'type' => 'string', 'example' => 'sweet'],
+ ],
+ 'NightMode' => [
+ 'title' => '夜间模式',
+ 'description' => '夜间模式',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enable' => ['title' => '启用、禁用', 'description' => '启用、禁用', 'type' => 'boolean', 'example' => 'true'],
+ 'Start' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'example' => '07:00'],
+ 'End' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'example' => '22:00'],
+ 'DefaultVolume' => ['title' => '夜间模式下的默认音量', 'description' => '夜间模式下的默认音量', 'type' => 'string'],
+ 'DefaultBright' => ['title' => '夜间模式下的默认亮度', 'description' => '夜间模式下的默认亮度', 'type' => 'string'],
+ 'StandbyAction' => ['title' => '休眠时执行,息屏(screenoff)、屏保(screensaver)', 'description' => '休眠时执行,息屏(screenoff)、屏保(screensaver)', 'type' => 'string', 'example' => 'screenoff'],
+ ],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F7E2****B7C94'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"SettingType\\": \\"SCREENSAVER\\",\\n \\"Value\\": \\"首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店~~\\",\\n \\"DeleteToken\\": 0,\\n \\"ExtInfo\\": \\"{}\\",\\n \\"HotelScreenSaver\\": {\\n \\"ScreenSaverStyle\\": \\"common-weather\\",\\n \\"ScreenSaverPicUrl\\": \\"https://a***png\\"\\n },\\n \\"HotelDeviceModeList\\": [\\n \\"sweet\\"\\n ],\\n \\"NightMode\\": {\\n \\"Enable\\": true,\\n \\"Start\\": \\"07:00\\",\\n \\"End\\": \\"22:00\\",\\n \\"DefaultVolume\\": \\"\\",\\n \\"DefaultBright\\": \\"\\",\\n \\"StandbyAction\\": \\"screenoff\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店定制',
+ 'description' => '> 根据入参settingType不同,可以查询不同的酒店定制配置'."\n"
+ .'> - 首页背景-settingType="HOMEPAGE_PIC"'."\n"
+ .'> - 屏保背景-settingType="SCREENSAVER"'."\n"
+ .'> - 带屏展示模式-settingType="SCENE"'."\n"
+ .'> - 带屏酒店通知-settingType="NOTICE"'."\n"
+ .'> - 夜间模式-settingType="NIGHT_MODE"',
+ ],
+ 'GetRelationProductList' => [
+ 'summary' => '获得创建酒店使用的关联产品列表。',
+ 'path' => '/v1.0/ip/getRelationProductList',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Result<List<ProductInfo>>',
+ 'description' => 'Result<List<ProductInfo>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'array',
'items' => [
- 'description' => '信息列表',
- 'type' => 'string',
- 'example' => '北京市',
+ 'description' => '返回的详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '产品名称', 'description' => '产品名称', 'type' => 'string', 'example' => '橙蜂中控面板'],
+ 'Pk' => ['title' => '产品pk', 'description' => '产品pk', 'type' => 'string', 'example' => 'jTOSl***l1odxImRw'],
+ ],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00',
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'description' => '扩展信息', 'example' => 'any'],
],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"北京市\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]',
- 'title' => '查询城市',
- 'description' => '根据省份查询红外使用的城市列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"橙蜂中控面板\\",\\n \\"Pk\\": \\"jTOSl***l1odxImRw\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"any\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '获得关联产品列表',
+ 'description' => '获得创建酒店使用的关联产品列表。',
],
- 'ListSTBServiceProviders' => [
- 'summary' => '查询服务提供商',
- 'path' => '/v1.0/ip/listSTBServiceProviders',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetUnionId' => [
+ 'summary' => '使用open id换取跨域的union id',
+ 'path' => '/v1.0/ip/getUnionId',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Province',
+ 'name' => 'EncodeType',
'in' => 'formData',
- 'schema' => [
- 'title' => '省份',
- 'description' => '省份',
- 'type' => 'string',
- 'required' => true,
- 'example' => '浙江省',
- ],
+ 'schema' => ['title' => '编码类型,从天猫精灵开放平台中获取', 'description' => '编码类型,从天猫精灵开放平台中获取', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
],
[
- 'name' => 'City',
+ 'name' => 'EncodeKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '城市',
- 'description' => '城市',
- 'type' => 'string',
- 'required' => true,
- 'example' => '杭州市',
- ],
+ 'schema' => ['title' => '编码Key,从天猫精灵开放平台中获取', 'description' => '编码Key,从天猫精灵开放平台中获取', 'type' => 'string', 'required' => true, 'example' => '125****0946'],
+ ],
+ [
+ 'name' => 'IdType',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'open id类型,可为用户id或设备id;'."\n"
+ .'USER_ID: 用户id'."\n"
+ .'DEVICE_ID: 设备id', 'description' => 'open id类型,可为用户id或设备id'."\n"
+ .'- USER_ID: 用户id'."\n"
+ .'- DEVICE_ID: 设备id', 'type' => 'string', 'required' => true, 'example' => 'DEVICE_ID'],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'id类型对应的open id值', 'description' => 'id类型对应的open id值', 'type' => 'string', 'required' => true, 'example' => '62a319****abdc'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<Map<String, List<String>>>',
- 'description' => 'Result<Map<String, List<String>>>',
+ 'title' => 'Result<List<UnionInfo>>',
+ 'description' => 'Result<List<UnionInfo>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'description' => '返回内容',
- 'example' => '"Z":["浙江华数"]',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrganizationId' => ['title' => '组织id,可在天猫精灵开放平台管理', 'description' => '组织id,可在天猫精灵开放平台管理', 'type' => 'string', 'example' => '4325***765'],
+ 'UnionId' => ['title' => '请求参数的open id在该组织下的唯一id值', 'description' => '请求参数的open id在该组织下的唯一id值', 'type' => 'string', 'example' => '8bh2****8s8'],
],
- 'description' => '服务的实际返回结果',
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '1036C376-7A37-5A73-BE8B-C6DB40107EC1',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"Z\\\\\\":[\\\\\\"浙江华数\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1036C376-7A37-5A73-BE8B-C6DB40107EC1\\"\\n}","type":"json"}]',
- 'title' => '查询服务提供商',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"OrganizationId\\": \\"4325***765\\",\\n \\"UnionId\\": \\"8bh2****8s8\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '换取unionId',
+ 'description' => '当前天猫精灵开放体系下有多个域,例如天猫精灵AI平台、技能应用平台、行业开放平台,各个域的open信息自成闭环,而跨多域的请求交互需要先创建组织,并在组织下将各域的实体(例如酒店应用appid或者技能应用平台创建的应用)关联到组织下,关联后可以使用该接口根据酒店的open id换取到酒店所属组织下的union id,使用union id可在各域调用相应的接口'."\n"
+ .'![](https://img.alicdn.com/imgextra/i3/O1CN01EVSThl1txqw0eFOIb_!!6000000005969-0-tps-1024-274.jpg)',
],
- 'ListInfraredDeviceBrands' => [
- 'summary' => '查询红外品牌列表',
- 'path' => '/v1.0/ip/listInfraredDeviceBrands',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'GetWelcomeTextAndMusic' => [
+ 'summary' => '获取欢迎语配置',
+ 'path' => '/v1.0/ip/getWelcomeTextAndMusic',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Category',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备名称',
- 'description' => '设备名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '机顶盒',
- ],
- ],
- [
- 'name' => 'ServiceProvider',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '服务提供商(品类为机顶盒时必传)',
- 'description' => '服务提供商(品类为机顶盒时必传)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江省电信IPTV',
- ],
+ 'schema' => ['title' => '酒店 id', 'description' => '酒店 id', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Map<String, List<String>>>',
- 'description' => 'Result<Map<String, List<String>>>',
+ 'title' => 'Result<WelcomeResp>',
+ 'description' => 'Result<WelcomeResp>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'description' => '集合内容',
- 'example' => '"A":["Addsion", "Ambassador"]',
- ],
- 'description' => '返回的详细信息列表。',
+ 'properties' => [
+ 'HotelId' => ['description' => '酒店id', 'type' => 'string', 'example' => 'a7***83'],
+ 'Text' => ['description' => '欢迎语文本', 'type' => 'string', 'example' => '尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。'],
+ 'MusicUrl' => ['description' => '背景音链接', 'type' => 'string', 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00',
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'description' => '扩展信息'],
],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"A\\\\\\":[\\\\\\"Addsion\\\\\\", \\\\\\"Ambassador\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]',
- 'title' => '查询红外品牌列表',
+ 'staticInfo' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Text\\": \\"尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。\\",\\n \\"MusicUrl\\": \\"http://ailabsaicloudservice.alicdn.com/tmp/a.wav\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '获取欢迎语配置',
+ 'description' => '获取欢迎语配置',
],
- 'ListInfraredRemoteControllers' => [
- 'summary' => '查询红外码库列表',
- 'path' => '/v1.0/ip/listInfraredRemoteControllers',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'HotelQrBind' => [
+ 'summary' => '酒店带屏设备扫码绑定。',
+ 'path' => '/v1.0/ip/hotelQrBind',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
+ 'schema' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
[
- 'name' => 'Province',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '省份'."\n"
- .'品类为机顶盒时必传',
- 'description' => '省份'."\n"
- .'品类为机顶盒时必传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江省',
- ],
- ],
- [
- 'name' => 'City',
+ 'name' => 'RoomNo',
'in' => 'formData',
- 'schema' => [
- 'title' => '城市'."\n"
- .'品类为机顶盒时必传',
- 'description' => '城市'."\n"
- .'品类为机顶盒时必传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '杭州市',
- ],
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
],
[
- 'name' => 'Category',
+ 'name' => 'Code',
'in' => 'formData',
- 'schema' => [
- 'title' => '品类',
- 'description' => '品类',
- 'type' => 'string',
- 'required' => true,
- 'example' => '机顶盒',
- ],
+ 'schema' => ['title' => '带屏设备绑定二维码中的code参数', 'description' => '带屏设备绑定二维码中的code参数', 'type' => 'string', 'required' => true, 'example' => 'freuisghrtiesnvfkdsvbfuidslnvfs'],
],
[
- 'name' => 'Brand',
+ 'name' => 'ClientId',
'in' => 'formData',
- 'schema' => [
- 'title' => '品牌'."\n"
- .'品类非机顶盒必填,为机顶盒同时供应商为IPTV时必传',
- 'description' => '品牌'."\n"
- .'品类非机顶盒必填,为机顶盒同时供应商为IPTV时必传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '奥图码',
- ],
+ 'schema' => ['title' => '带屏设备绑定二维码中的clientId参数', 'description' => '带屏设备绑定二维码中的clientId参数', 'type' => 'string', 'required' => true, 'example' => 'xxxxxx'],
],
[
- 'name' => 'ServiceProvider',
+ 'name' => 'ExtInfo',
'in' => 'formData',
- 'schema' => [
- 'title' => '服务提供商'."\n"
- .'品类为机顶盒时必传',
- 'description' => '服务提供商'."\n"
- .'品类为机顶盒时必传',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江省移动IPTV',
- ],
+ 'schema' => ['title' => '额外信息jsonString', 'description' => '额外信息jsonString', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<List<InfraredControlCodeResp>>',
- 'description' => 'Result<List<InfraredControlCodeResp>>',
+ 'title' => 'Result<UserAndDeviceInfo>',
+ 'description' => 'Result<UserAndDeviceInfo>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,200标识为成功', 'description' => '调用返回码,200标识为成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'Index' => [
- 'title' => '当前索引',
- 'description' => '当前索引',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Rid' => [
- 'title' => '遥控器编号',
- 'description' => '遥控器编号',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3747',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenUserInfo' => [
+ 'title' => '开放用户信息',
+ 'description' => '开放用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['title' => '编码类型,从天猫精灵开放平台中获取', 'description' => '编码类型,从天猫精灵开放平台中获取', 'type' => 'string', 'example' => 'HOTEL'],
+ 'EncodeKey' => ['title' => '编码Key,从天猫精灵开放平台中获取', 'description' => '编码Key,从天猫精灵开放平台中获取', 'type' => 'string', 'example' => '123'],
+ 'IdType' => ['title' => '编码信息,从天猫精灵开放平台中获取', 'description' => '编码信息,从天猫精灵开放平台中获取', 'type' => 'string', 'example' => 'OPEN_ID'],
+ 'Id' => ['title' => '用户唯一标识', 'description' => '用户唯一标识', 'type' => 'string', 'example' => 'xxxxxx'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时返回', 'description' => '组织ID,如果IdType为UNION_ID时返回', 'type' => 'string', 'example' => 'aaaaaaaa'],
],
- 'Version' => [
- 'title' => '版本信息',
- 'description' => '版本信息',
- 'type' => 'string',
- 'example' => '4',
+ ],
+ 'OpenDeviceInfo' => [
+ 'title' => '开放设备信息',
+ 'description' => '开放设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['title' => '编码类型,从天猫精灵开放平台中获取', 'description' => '编码类型,从天猫精灵开放平台中获取', 'type' => 'string', 'example' => 'HOTEL'],
+ 'EncodeKey' => ['title' => '编码Key,从天猫精灵开放平台中获取', 'description' => '编码Key,从天猫精灵开放平台中获取', 'type' => 'string', 'example' => '123'],
+ 'IdType' => ['title' => '编码信息,从天猫精灵开放平台中获取', 'description' => '编码信息,从天猫精灵开放平台中获取', 'type' => 'string', 'example' => 'OPEN_ID'],
+ 'Id' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'xxxxxxx'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时返回', 'description' => '组织ID,如果IdType为UNION_ID时返回', 'type' => 'string', 'example' => 'aaaaaaaa'],
],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0C90A059-3653-5356-A78E-8A6BDA606155',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '73****9-175A-1324-8202-9FAAB*****A'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Index\\": 1,\\n \\"Rid\\": 3747,\\n \\"Version\\": \\"4\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0C90A059-3653-5356-A78E-8A6BDA606155\\"\\n}","type":"json"}]',
- 'title' => '查询红外码库列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"OpenUserInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n },\\n \\"OpenDeviceInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\"\\n}","type":"json"}]',
+ 'title' => '酒店扫码绑定',
+ 'description' => '酒店带屏设备扫码绑定,可用于自建app管理设备',
],
- 'ListCustomQA' => [
- 'summary' => '自定义问答模块下的查询自定义问答列表功能。',
- 'path' => '/v1.0/ip/listCustomQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ImportHotelConfig' => [
+ 'summary' => '批量导入酒店相关配置。',
+ 'path' => '/v1.0/ip/importHotelConfig',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '520a0c0***5eb',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
[
- 'name' => 'Keyword',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '关键字(用于模糊查询主问题、附属问题、回答、关键字)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
- ],
- [
- 'name' => 'Page',
+ 'name' => 'ImportHotelConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '分页参数',
+ 'description' => '导入配置',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页size大小',
- 'description' => '每页size大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
+ 'RcuCustomScenes' => [
+ 'description' => 'RCU自定义场景',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SceneId' => ['description' => '场景编码', 'type' => 'string', 'required' => true, 'example' => 'yoga'],
+ 'Name' => ['description' => '场景名称', 'type' => 'string', 'required' => true, 'example' => '瑜伽模式'],
+ 'Icon' => ['description' => '场景图标', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com/yyy.png'],
+ 'Description' => ['description' => '场景描述', 'type' => 'string', 'required' => false, 'example' => '做瑜伽的酒店场景'],
+ 'CorpusList' => [
+ 'description' => '触发语料列表',
+ 'type' => 'array',
+ 'items' => ['description' => '触发语料', 'type' => 'string', 'required' => true, 'example' => '打开瑜伽模式'],
+ 'required' => true,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
],
'required' => true,
@@ -8015,1184 +3481,600 @@
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'PageResult<List<QAInfoResponse>>',
- 'description' => 'PageResult<List<QAInfoResponse>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Page' => [
- 'title' => '翻页参数',
- 'description' => '翻页参数',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页size大小',
- 'description' => '每页size大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '21',
- ],
- ],
- ],
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'CustomQAId' => [
- 'title' => 'qaID',
- 'description' => '自定义问答id',
- 'type' => 'string',
- 'example' => '111',
- ],
- 'MajorQuestion' => [
- 'title' => '主要问题',
- 'description' => '主问题',
- 'type' => 'string',
- 'example' => '***',
- ],
- 'SupplementaryQuestion' => [
- 'title' => '辅助问题',
- 'description' => '附属问题,多个用;隔开',
- 'type' => 'string',
- 'example' => '22;11',
- ],
- 'Answers' => [
- 'title' => '回答,多个回答用;隔开',
- 'description' => '回答,多个回答用;隔开',
- 'type' => 'string',
- 'example' => '22;11',
- ],
- 'KeyWords' => [
- 'title' => '关键字',
- 'description' => '关键字,多个用;隔开',
- 'type' => 'string',
- 'example' => '22;11',
- ],
- 'HotelId' => [
- 'title' => '酒店ID',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2023-01-10 10:01:59',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-01-10 10:01:59',
- ],
- 'Status' => [
- 'title' => '状态:0,使用中, 1:删除',
- 'description' => '状态(0:使用中, 1:删除)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '使用中',
- '删除',
- ],
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7***726E'."\n",
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"CustomQAId\\": \\"111\\",\\n \\"MajorQuestion\\": \\"***\\",\\n \\"SupplementaryQuestion\\": \\"22;11\\",\\n \\"Answers\\": \\"22;11\\",\\n \\"KeyWords\\": \\"22;11\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]',
- 'title' => '查询自定义问答列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '批量导入酒店配置',
],
- 'AddCustomQA' => [
- 'summary' => '自定义问答模块下的新增自定义问答功能。',
- 'path' => '/v1.0/ip/addCustomQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ImportRoomControlDevices' => [
+ 'summary' => '导入房间的客控设备列表',
+ 'path' => '/v1.0/ip/importRoomControlDevices',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7a3***013',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'vdgrefds'],
],
[
- 'name' => 'MajorQuestion',
+ 'name' => 'RoomNo',
'in' => 'formData',
- 'schema' => [
- 'description' => '主问题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
],
[
- 'name' => 'SupplementaryQuestions',
+ 'name' => 'LocationDevices',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '附属问题列表',
+ 'title' => '导入的位置、设备列表',
+ 'description' => '导入的位置、设备列表',
'type' => 'array',
'items' => [
- 'description' => '附属问题',
- 'type' => 'string',
+ 'description' => '位置信息及设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Location' => ['description' => '位置信息', 'type' => 'string', 'required' => true, 'example' => 'room'],
+ 'LocationName' => ['description' => '位置名称', 'type' => 'string', 'required' => false, 'example' => '房间'],
+ 'Devices' => [
+ 'description' => '位置下的设备列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '品类英文', 'description' => '设备类型,如'."\n"
+ ."\n"
+ .'- light:灯'."\n"
+ .'- aircondition:空调', 'type' => 'string', 'required' => true, 'example' => 'light'],
+ 'Number' => ['title' => '序列号'."\n"
+ .'rcu试该参数必传', 'description' => '设备编号', 'type' => 'string', 'required' => false, 'example' => 'night_light'],
+ 'DeviceName' => ['title' => '设备名称', 'description' => '设备名称', 'type' => 'string', 'required' => true, 'example' => '小夜灯'],
+ 'ConnectType' => ['title' => '设备连接类型:rcu、infrared、mesh'."\n"
+ .'不填默认rcu', 'description' => '设备连接类型', 'type' => 'string', 'required' => false, 'example' => 'infrared'],
+ 'Brand' => ['title' => '品牌', 'description' => '品牌。', 'type' => 'string', 'required' => false, 'example' => '百视通'],
+ 'Province' => ['title' => '省份', 'description' => '省份', 'type' => 'string', 'required' => false, 'example' => '浙江省'],
+ 'City' => ['title' => '城市', 'description' => '城市。', 'type' => 'string', 'required' => false, 'example' => '杭州市'],
+ 'ServiceProvider' => ['title' => '服务提供商', 'description' => '服务提供商', 'type' => 'string', 'required' => false, 'example' => '浙江华数'],
+ 'InfraredIndex' => ['title' => '红外码库Index', 'description' => '红外码库index', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'InfraredId' => ['title' => '红外码库id', 'description' => '红外码库id', 'type' => 'string', 'required' => false, 'example' => '1232'],
+ 'InfraredVersion' => ['title' => '红外码库版本号', 'description' => '红外码库版本号', 'type' => 'string', 'required' => false, 'example' => '4.0'],
+ 'MultiKeySwitchExt' => [
+ 'description' => '多键开关配置信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'SwitchList' => [
+ 'description' => '开关按键列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceIndex' => ['title' => '设备序号', 'description' => '设备序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'Category' => ['title' => '关联的设备品类英文名', 'description' => '关联的设备品类英文名', 'type' => 'string', 'required' => false, 'example' => 'light'],
+ 'Location' => ['title' => '关联的设备位置英文', 'description' => '关联的设备位置英文', 'type' => 'string', 'required' => false, 'example' => 'room'],
+ 'DeviceName' => ['title' => '关联的设备别名', 'description' => '关联的设备别名', 'type' => 'string', 'required' => false, 'example' => '吧台灯'],
+ 'AliasList' => [
+ 'title' => '设备多别名列表',
+ 'description' => '子设备的别名列表',
+ 'type' => 'array',
+ 'items' => ['title' => '设备自定义别名', 'description' => '设备别名', 'type' => 'string', 'required' => false, 'example' => '左灯'],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'Dn' => ['title' => '设备dn码', 'description' => '设备dn信息', 'type' => 'string', 'required' => false, 'example' => '3c5****db98'],
+ 'Pk' => ['title' => '设备pk', 'description' => '设备pk号', 'type' => 'string', 'required' => false, 'example' => '17****26'],
+ 'AliasList' => [
+ 'title' => '设备多别名列表',
+ 'description' => '设备别名列表',
+ 'type' => 'array',
+ 'items' => ['title' => '设备自定义别名', 'description' => '设备别名', 'type' => 'string', 'required' => false, 'example' => '夜灯'],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => false,
- 'example' => '***',
],
- 'required' => false,
+ 'required' => true,
],
],
[
- 'name' => 'KeyWords',
+ 'name' => 'EnableInfraredDeviceImport',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '关键字列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '是否支持红外 true 支持红外设备 false 不支持红外设备', 'description' => 'true:使用接口中传入的红外设备列表覆盖页面配置的红外设备;'."\n"
+ .'false:忽略接口中传入的红外红外设备,保留平台页面配置的红外设备。'."\n"
+ .'默认值为 false', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Answers',
+ 'name' => 'EnableMeshDeviceImport',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '回答列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '回答',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '是否支持mesh true/null 支持 走清理逻辑false 不支持 但是会保留Mesh设备 请求参数里面有 Mesh 数据报错', 'description' => '是否支持mesh true/null 支持 走清理逻辑false 不支持 但是会保留Mesh设备 请求参数里面有 Mesh 数据报错', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<Integer>',
+ 'description' => 'Result<Integer>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7***726E',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '导入成功的设备数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'example' => 'xxxx', 'description' => '扩展信息内容'],
],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'fdsfregtre'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 10,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"xxxx\\"\\n },\\n \\"RequestId\\": \\"fdsfregtre\\"\\n}","type":"json"}]',
+ 'title' => '导入房间的客控设备列表',
+ 'description' => '批量导入房间被控设备至房间所对应的房型'."\n"
+ .'><notice>暂时只支持纯rcu场景,支持的关联产品为:***方糖R酒店版、IN糖酒店版***></notice>',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-29T10:47:10.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
- 'title' => '新增自定义问答',
],
- 'AddCustomQAV2' => [
- 'summary' => '添加自定义问答V2版本',
- 'path' => '/v1.0/ip/addQAV2',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ImportRoomGenieScenes' => [
+ 'summary' => '批量导入房间内智能智能场景列表。',
+ 'path' => '/v1.0/ip/importRoomGenieScenes',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '520a0c0***5eb',
- ],
- ],
- [
- 'name' => 'MajorQuestion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '主问题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '今天的天气怎么样',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7a3***013'],
],
[
- 'name' => 'SupplementaryQuestions',
+ 'name' => 'RoomNo',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '附属问题列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '附属问题列表',
- 'type' => 'string',
- 'required' => false,
- 'example' => '室外温度多少',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
],
[
- 'name' => 'KeyWords',
+ 'name' => 'SceneList',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '关键字列表。',
+ 'title' => '场景列表',
+ 'description' => '场景列表',
'type' => 'array',
'items' => [
- 'description' => '关键字列表',
- 'type' => 'string',
+ 'description' => '场景信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SceneName' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'required' => true, 'example' => '瑜伽模式'],
+ 'Description' => ['title' => '场景描述', 'description' => '场景描述', 'type' => 'string', 'required' => false, 'example' => '做瑜伽的模式'],
+ 'Icon' => ['title' => '场景图标', 'description' => '场景图标', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com/yyy.png'],
+ 'Display' => ['title' => '是否在带屏侧显示', 'description' => '是否在带屏侧显示', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ 'TriggerLogical' => ['title' => '场景触发逻辑(0:条件与,1:条件或)', 'description' => '场景触发逻辑(0:条件与,1:条件或)', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ 'Triggers' => [
+ 'title' => '触发条件',
+ 'description' => '触发条件列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '触发条件',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => '触发类型', 'description' => '触发类型', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1:语音触发'."\n"
+ .'2:设备触发'],
+ 'CorpusList' => [
+ 'title' => '触发语料',
+ 'description' => '触发语料',
+ 'type' => 'array',
+ 'items' => ['description' => '触发语料', 'type' => 'string', 'required' => false, 'example' => '打开瑜伽模式'],
+ 'required' => false,
+ ],
+ 'Device' => [
+ 'description' => '触发设备',
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['description' => '设备品类', 'type' => 'string', 'required' => true, 'example' => 'KeyCardSwitch'],
+ 'DeviceNumber' => ['description' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号', 'type' => 'string', 'required' => true, 'example' => '3c5d2ab8f9ec'],
+ 'DeviceIndex' => ['description' => '多键开关类设备的设备序号', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ 'required' => false,
+ ],
+ 'AttributeValues' => [
+ 'description' => '设备触发属性',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '触发属性',
+ 'type' => 'object',
+ 'properties' => [
+ 'AttributeName' => ['description' => '属性名', 'type' => 'string', 'required' => true, 'example' => 'stateOfMagneticInduction'],
+ 'AttributeValue' => ['description' => '属性值', 'type' => 'string', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'Actions' => [
+ 'title' => '执行动作',
+ 'description' => '执行动作列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '执行动作',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => '动作类型', 'description' => '执行动作类型', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1:设备控制'."\n"
+ .'2:音箱播报'],
+ 'Reply' => ['title' => '音箱回复内容', 'description' => '音箱回复内容', 'type' => 'string', 'required' => false, 'example' => '欢迎光临'],
+ 'Device' => [
+ 'title' => '执行设备',
+ 'description' => '执行设备',
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['title' => '设备品类', 'description' => '设备品类', 'type' => 'string', 'required' => true, 'example' => 'light'],
+ 'DeviceNumber' => ['title' => '设备编号', 'description' => '设备编号', 'type' => 'string', 'required' => true, 'example' => '3c5d2ab8f9ec'],
+ 'DeviceIndex' => ['title' => '多键开关类设备,传入按键序号', 'description' => '多键开关类设备,传入按键序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'Type' => ['description' => '设备类型(已废弃)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '无需填写'],
+ ],
+ 'required' => false,
+ ],
+ 'AttributeValues' => [
+ 'title' => '设备目标属性',
+ 'description' => '设备目标属性',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '目标属性',
+ 'type' => 'object',
+ 'properties' => [
+ 'AttributeName' => ['title' => '属性名', 'description' => '属性名', 'type' => 'string', 'required' => true, 'example' => 'powerstate'],
+ 'AttributeValue' => ['title' => '属性值', 'description' => '属性值', 'type' => 'string', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
'required' => false,
- 'example' => '天气',
],
'required' => false,
],
],
- [
- 'name' => 'Answers',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '答案列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '答案列表',
- 'type' => 'string',
- 'required' => false,
- 'example' => '你好,您可以再说一遍吗 不好意思我刚才没有听清',
- ],
- 'required' => true,
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<QAInfoResponse>',
- 'description' => 'Result<QAInfoResponse>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'QaId' => [
- 'title' => 'qaID',
- 'description' => 'qaID',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'MajorQuestion' => [
- 'title' => '主要问题',
- 'description' => '主要问题',
- 'type' => 'string',
- 'example' => '今天天气怎么样',
- ],
- 'SupplementaryQuestion' => [
- 'title' => '辅助问题',
- 'description' => '辅助问题',
- 'type' => 'string',
- 'example' => '室外温度多少',
- ],
- 'Answers' => [
- 'title' => '回答,多个回答用;隔开',
- 'description' => '回答,多个回答用;隔开',
- 'type' => 'string',
- 'example' => '你好,您可以再说一遍吗 不好意思我刚才没有听清',
- ],
- 'KeyWords' => [
- 'title' => '关键字',
- 'description' => '关键字',
- 'type' => 'string',
- 'example' => '天气',
- ],
- 'HotelId' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2023-01-10 10:01:59',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-01-10 10:01:59',
- ],
- 'Status' => [
- 'title' => '状态:0,使用中, 1:删除',
- 'description' => '状态:0,使用中, 1:删除',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'LastOperator' => [
- 'title' => '最后操作人',
- 'description' => '最后操作人',
- 'type' => 'string',
- 'example' => '8xxx9',
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '73C6***E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Result\\": {\\n \\"QaId\\": \\"1\\",\\n \\"MajorQuestion\\": \\"今天天气怎么样\\",\\n \\"SupplementaryQuestion\\": \\"室外温度多少\\",\\n \\"Answers\\": \\"你好,您可以再说一遍吗 不好意思我刚才没有听清\\",\\n \\"KeyWords\\": \\"天气\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0,\\n \\"LastOperator\\": \\"8xxx9\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
- 'title' => '新增自定义问答V2',
- 'description' => '返回值有QAId'."\n"
- .'问答内容和答案是必填内容',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
+ 'title' => '导入房间内精灵智能场景',
],
- 'UpdateCustomQA' => [
- 'summary' => '自定义问答模块下的修改自定义问答功能。',
- 'path' => '/v1.0/ip/updateCustomQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'InsertHotelSceneBookItem' => [
+ 'summary' => '酒店场景预订新增',
+ 'path' => '/v1.0/ip/insertHotelSceneBookItem',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'CustomQAId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '自定义问答id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'MajorQuestion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '主问题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
+ 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
[
- 'name' => 'SupplementaryQuestions',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '附属问题列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '附属问题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'KeyWords',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '关键字列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Answers',
- 'in' => 'formData',
+ 'name' => 'AddHotelSceneItemReq',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '回答列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '回答',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
+ 'title' => 'addHotelSceneItemReq',
+ 'description' => 'addHotelSceneItemReq',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)', 'description' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FOOD'],
+ 'Name' => ['title' => '酒店场景预订item名称', 'description' => '酒店场景预订item名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '青椒肉丝'],
+ 'Price' => ['title' => '价格(单位:分)', 'description' => '价格(单位:分)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1250'],
+ 'Icon' => ['title' => 'icon', 'description' => 'icon', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png'],
],
- 'required' => false,
+ 'required' => true,
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Result<Boolean>',
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C6***BB3E6FA',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '36FB***80C2'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***BB3E6FA\\"\\n}","type":"json"}]',
- 'title' => '修改自定义问答',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"36FB***80C2\\"\\n}","type":"json"}]',
+ 'title' => '新增酒店预订服务项',
],
- 'DeleteCustomQA' => [
- 'summary' => '自定义问答模块下的删除自定义问答功能。',
- 'path' => '/v1.0/ip/deleteCustomQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'InvokeRobotPush' => [
+ 'summary' => '推送机器人通知,可用于机器人送物的放与拿时候的通知',
+ 'path' => '/v1.0/ip/invokeRobotPush',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'CustomQAIds',
+ 'name' => 'RoomNo',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '自定义问答id列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义问答id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '11',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '1211'],
+ ],
+ [
+ 'name' => 'RoomName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '房间名', 'type' => 'string', 'required' => false, 'example' => '8022房间'],
],
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7a3***013',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
+ ],
+ [
+ 'name' => 'PushType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '推送类型,PUT:放东西、GET:拿东西', 'description' => '推送类型,PUT:放东西、GET:拿东西', 'type' => 'string', 'required' => true, 'example' => 'GET'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
'title' => 'Result<Boolean>',
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C6***E6FA',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '73C6***E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
- 'title' => '删除自定义问答',
+ 'title' => '推送机器人通知',
],
- 'GetBasicInfoQA' => [
- 'summary' => '通用问答模块下的获取基础信息问答功能。',
- 'path' => '/v1.0/ip/getBasicInfoQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListAllProvinces' => [
+ 'summary' => '查询红外使用的省份信息',
+ 'path' => '/v1.0/ip/listAllProvinces',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
- ],
- ],
+ 'parameters' => [],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<IntentionQATemplateResponse>',
- 'description' => 'Result<IntentionQATemplateResponse>',
+ 'title' => 'Result<List<String>>',
+ 'description' => 'Result<List<String>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'HotelAddress' => [
- 'title' => '酒店地址',
- 'description' => '酒店地址',
- 'type' => 'string',
- 'example' => '杭州市***',
- ],
- 'PhoneNumber' => [
- 'title' => '前台电话',
- 'description' => '前台电话',
- 'type' => 'string',
- 'example' => '123***',
- ],
- 'CheckInTime' => [
- 'title' => '入住时间 格式xx:xx 时分',
- 'description' => '入住时间(格式xx:xx 时分)',
- 'type' => 'string',
- 'example' => '11:11',
- ],
- 'CheckOutTime' => [
- 'title' => '退房时间',
- 'description' => '退房时间(格式xx:xx 时分)',
- 'type' => 'string',
- 'example' => '11:11',
- ],
- 'WifiName' => [
- 'title' => 'wifi名称',
- 'description' => 'wifi名称',
- 'type' => 'string',
- 'example' => '名称***',
- ],
- 'WifiPassword' => [
- 'title' => 'wifi密码',
- 'description' => 'wifi密码',
- 'type' => 'string',
- 'example' => '密码***',
- ],
- 'HotelMember' => [
- 'title' => '酒店会员相关介绍',
- 'description' => '酒店会员相关介绍',
- 'type' => 'string',
- 'example' => '会员***'."\n",
- ],
- 'HotelService' => [
- 'title' => '酒店特色服务相关介绍',
- 'description' => '酒店特色服务相关介绍',
- 'type' => 'string',
- 'example' => '服务***',
- ],
- 'HotelIntroduction' => [
- 'title' => '酒店介绍',
- 'description' => '酒店介绍',
- 'type' => 'string',
- 'example' => '酒店***',
- ],
- 'ParkingPosition' => [
- 'title' => '停车场位置',
- 'description' => '停车场位置',
- 'type' => 'string',
- 'example' => '杭州市***',
- ],
- 'ParkingExpenses' => [
- 'title' => '停车费用,免费停车/收费停车',
- 'description' => '停车费用(免费停车/收费停车)',
- 'type' => 'string',
- 'enumValueTitles' => [
- '收费停车' => '收费停车',
- '免费停车' => '免费停车',
- ],
- 'example' => '免费停车',
- 'enum' => [],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7***726E',
+ 'type' => 'array',
+ 'items' => ['description' => '服务的实际返回结果', 'type' => 'string', 'example' => '浙江省'],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '00534880-4397-5134-B212-1030B7A37C27'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelAddress\\": \\"杭州市***\\",\\n \\"PhoneNumber\\": \\"123***\\",\\n \\"CheckInTime\\": \\"11:11\\",\\n \\"CheckOutTime\\": \\"11:11\\",\\n \\"WifiName\\": \\"名称***\\",\\n \\"WifiPassword\\": \\"密码***\\",\\n \\"HotelMember\\": \\"会员***\\\\n\\",\\n \\"HotelService\\": \\"服务***\\",\\n \\"HotelIntroduction\\": \\"酒店***\\",\\n \\"ParkingPosition\\": \\"杭州市***\\",\\n \\"ParkingExpenses\\": \\"免费停车\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
- 'title' => '获取基础信息问答',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"浙江省\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"00534880-4397-5134-B212-1030B7A37C27\\"\\n}","type":"json"}]',
+ 'title' => '查询省份',
+ 'description' => '查询红外使用的省份信息',
],
- 'UpdateBasicInfoQA' => [
- 'summary' => '通用问答模块下的修改基础信息问答功能。',
- 'path' => '/v1.0/ip/updateBasicInfoQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListCitiesByProvince' => [
+ 'summary' => '根据省份查询红外使用的城市列表',
+ 'path' => '/v1.0/ip/listCitiesByProvince',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536'."\n",
- ],
- ],
- [
- 'name' => 'HotelAddress',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店地址',
- 'description' => '酒店地址',
- 'type' => 'string',
- 'required' => true,
- 'example' => '浙江省杭州市xxxx',
- ],
- ],
- [
- 'name' => 'PhoneNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '前台电话',
- 'description' => '前台电话',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123***',
- ],
- ],
- [
- 'name' => 'CheckInTime',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '入住时间 格式xx:xx 时分',
- 'description' => '入住时间(格式xx:xx 时分)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '11:11'."\n",
- ],
- ],
- [
- 'name' => 'CheckOutTime',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '退房时间',
- 'description' => '退房时间(格式xx:xx 时分)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '11:11',
- ],
- ],
- [
- 'name' => 'WifiName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'wifi名称',
- 'description' => 'wifi名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '名称***',
- ],
- ],
- [
- 'name' => 'WifiPassword',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'wifi密码',
- 'description' => 'wifi密码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '密码***',
- ],
- ],
- [
- 'name' => 'HotelMember',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店会员相关介绍',
- 'description' => '酒店会员相关介绍',
- 'type' => 'string',
- 'required' => false,
- 'example' => '会员***',
- ],
- ],
- [
- 'name' => 'HotelService',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店特色服务相关介绍',
- 'description' => '酒店特色服务相关介绍',
- 'type' => 'string',
- 'required' => false,
- 'example' => '服务***',
- ],
- ],
- [
- 'name' => 'HotelIntroduction',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店介绍',
- 'description' => '酒店介绍',
- 'type' => 'string',
- 'required' => false,
- 'example' => '酒店***',
- ],
- ],
- [
- 'name' => 'ParkingPosition',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '停车场位置',
- 'description' => '停车场位置',
- 'type' => 'string',
- 'required' => true,
- 'example' => '杭州市xx',
- ],
- ],
- [
- 'name' => 'ParkingExpenses',
+ 'name' => 'Province',
'in' => 'formData',
- 'schema' => [
- 'title' => '停车费用,免费停车/收费停车',
- 'description' => '停车费用(免费停车/收费停车)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '免费停车',
- 'enum' => [
- '免费停车',
- '收费停车',
- ],
- ],
+ 'schema' => ['title' => '省份', 'description' => '省份', 'type' => 'string', 'required' => true, 'example' => '北京市'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<String>>',
+ 'description' => 'Result<List<String>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7***726E'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => '信息列表', 'type' => 'string', 'example' => '北京市'],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]',
- 'title' => '修改基础信息问答',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n \\"北京市\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]',
+ 'title' => '查询城市',
+ 'description' => '根据省份查询红外使用的城市列表',
],
- 'ListServiceQA' => [
- 'summary' => '通用问答模块下的查询服务设施问答列表功能。',
- 'path' => '/v1.0/ip/listServiceQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListCustomQA' => [
+ 'summary' => '自定义问答模块下的查询自定义问答列表功能。',
+ 'path' => '/v1.0/ip/listCustomQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
@@ -9200,38 +4082,12 @@
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
- ],
- [
- 'name' => 'Active',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否激活',
- 'description' => '是否启用(true:开启、false:关闭)',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '开启',
- 'false' => '关闭',
- ],
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'],
],
[
'name' => 'Keyword',
'in' => 'formData',
- 'schema' => [
- 'description' => '关键字(用于模糊查询问题、例句、回答)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***',
- ],
+ 'schema' => ['description' => '关键字(用于模糊查询主问题、附属问题、回答、关键字)', 'type' => 'string', 'required' => false, 'example' => '***'],
],
[
'name' => 'Page',
@@ -9241,22 +4097,10 @@
'description' => '分页参数',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页多少条',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'PageNumber' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ 'PageSize' => ['title' => '每页size大小', 'description' => '每页size大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
- 'required' => false,
+ 'required' => true,
],
],
],
@@ -9264,8 +4108,8 @@
200 => [
'headers' => [],
'schema' => [
- 'title' => 'PageResult<List<IntentionQAResponse>>',
- 'description' => 'PageResult<List<IntentionQAResponse>>',
+ 'title' => 'PageResult<List<QAInfoResponse>>',
+ 'description' => 'PageResult<List<QAInfoResponse>>',
'type' => 'object',
'properties' => [
'Page' => [
@@ -9273,35 +4117,12 @@
'description' => '翻页参数',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页size大小',
- 'description' => '每页size大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
+ 'PageNumber' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页size大小', 'description' => '每页size大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '21'],
],
],
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
@@ -9310,2381 +4131,1570 @@
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'ServiceQAId' => [
- 'title' => '通用问答信息',
- 'description' => '服务设施问答id',
+ 'CustomQAId' => ['title' => 'qaID', 'description' => '自定义问答id', 'type' => 'string', 'example' => '111'],
+ 'MajorQuestion' => ['title' => '主要问题', 'description' => '主问题', 'type' => 'string', 'example' => '***'],
+ 'SupplementaryQuestion' => ['title' => '辅助问题', 'description' => '附属问题,多个用;隔开', 'type' => 'string', 'example' => '22;11'],
+ 'Answers' => ['title' => '回答,多个回答用;隔开', 'description' => '回答,多个回答用;隔开', 'type' => 'string', 'example' => '22;11'],
+ 'KeyWords' => ['title' => '关键字', 'description' => '关键字,多个用;隔开', 'type' => 'string', 'example' => '22;11'],
+ 'HotelId' => ['title' => '酒店ID', 'description' => '酒店id', 'type' => 'string', 'example' => 'a7***83'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2023-01-10 10:01:59'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-01-10 10:01:59'],
+ 'Status' => [
+ 'title' => '状态:0,使用中, 1:删除',
+ 'description' => '状态(0:使用中, 1:删除)',
'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Question' => [
- 'title' => '问题',
- 'description' => '问题',
- 'type' => 'string',
- 'example' => '测试文本'."\n",
- ],
- 'Answer' => [
- 'title' => '答案',
- 'description' => '回答',
- 'type' => 'string',
- 'example' => '***',
- ],
- 'GmtModified' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2022-07-27 14:06:27'."\n",
- ],
- 'Active' => [
- 'title' => '是否启用',
- 'description' => '是否启用(true:开启、false:关闭)',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Templates' => [
- 'title' => '例句列表',
- 'description' => '例句列表',
- 'type' => 'string',
- 'example' => '酒店有提供送餐服务吗;酒店能送餐吗;酒店送餐怎么收费'."\n",
+ 'format' => 'int32',
+ 'enumValueTitles' => ['使用中', '删除'],
+ 'example' => '0',
],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7***726E',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7***726E'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"ServiceQAId\\": 1,\\n \\"Question\\": \\"测试文本\\\\n\\",\\n \\"Answer\\": \\"***\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\",\\n \\"Active\\": true,\\n \\"Templates\\": \\"酒店有提供送餐服务吗;酒店能送餐吗;酒店送餐怎么收费\\\\n\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
- 'title' => '查询服务设施问答列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"CustomQAId\\": \\"111\\",\\n \\"MajorQuestion\\": \\"***\\",\\n \\"SupplementaryQuestion\\": \\"22;11\\",\\n \\"Answers\\": \\"22;11\\",\\n \\"KeyWords\\": \\"22;11\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"UpdateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"CreateTime\\": \\"2023-01-10 10:01:59\\",\\n \\"Status\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '查询自定义问答列表',
],
- 'UpdateServiceQA' => [
- 'summary' => '通用问答模块下的修改服务设施问答功能。',
- 'path' => '/v1.0/ip/updateServiceQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListDialogueTemplate' => [
+ 'summary' => '酒店场景对话模板',
+ 'path' => '/v1.0/ip/listDialogueTemplate',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'ServiceQAId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '通用问答信息',
- 'description' => '服务设施问答id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Answer',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '答案',
- 'description' => '回答',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试',
- ],
- ],
- [
- 'name' => 'isActive',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否启用',
- 'description' => '是否启用(true:开启、false:关闭)',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => '开启',
- 'false' => '关闭',
- ],
- 'example' => 'true',
- ],
+ 'schema' => ['title' => 'hotelId', 'description' => 'hotelId', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<DialogueTemplate>>',
+ 'description' => 'Result<List<DialogueTemplate>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C67***6FA'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['title' => '模板ID', 'description' => '模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'TemplateName' => ['title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'example' => '物品多轮模板'],
+ 'TemplateDetail' => [
+ 'title' => '模板详情(维修只有一轮对话)',
+ 'description' => '模板详情(维修只有一轮对话)',
+ 'type' => 'object',
+ 'properties' => [
+ 'FirstDialogueTemplate' => [
+ 'title' => '第一轮对话',
+ 'description' => '第一轮对话',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZeroPriceYesAnswer' => ['title' => '价格=0 && 肯定回答', 'description' => '价格=0 && 肯定回答', 'type' => 'string', 'example' => '好的,服务员会尽快送来。'],
+ 'ZeroPriceNoAnswer' => ['title' => '价格=0 && 否定回答', 'description' => '价格=0 && 否定回答', 'type' => 'string', 'example' => '对不起,暂时不提供此物品。'],
+ 'NonzeroPriceYesAnswer' => ['title' => '价格!=0 &&肯定回答', 'description' => '价格!=0 &&肯定回答', 'type' => 'string', 'example' => '${goodsName}${price}元,请问需要服务员送来吗?'],
+ ],
+ ],
+ 'SecondDialogueTemplate' => [
+ 'title' => '第二轮对话',
+ 'description' => '第二轮对话',
+ 'type' => 'object',
+ 'properties' => [
+ 'NonzeroPriceYesAnswer' => ['title' => '价格!=0 && 肯定回答', 'description' => '价格!=0 && 肯定回答', 'type' => 'string', 'example' => '好的,服务员会尽快送来${goodsName}'],
+ 'NonzeroPriceNoAnswer' => ['title' => '价格!=0 && 否定回答', 'description' => '价格!=0 && 否定回答', 'type' => 'string', 'example' => '好的,已取消。'],
+ ],
+ ],
+ ],
+ ],
+ 'Type' => ['title' => '模板类型', 'description' => '模板类型', 'type' => 'string', 'example' => 'GOODS'],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]',
- 'title' => '修改服务设施问答',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 4,\\n \\"TemplateName\\": \\"物品多轮模板\\",\\n \\"TemplateDetail\\": {\\n \\"FirstDialogueTemplate\\": {\\n \\"ZeroPriceYesAnswer\\": \\"好的,服务员会尽快送来。\\",\\n \\"ZeroPriceNoAnswer\\": \\"对不起,暂时不提供此物品。\\",\\n \\"NonzeroPriceYesAnswer\\": \\"${goodsName}${price}元,请问需要服务员送来吗?\\"\\n },\\n \\"SecondDialogueTemplate\\": {\\n \\"NonzeroPriceYesAnswer\\": \\"好的,服务员会尽快送来${goodsName}\\",\\n \\"NonzeroPriceNoAnswer\\": \\"好的,已取消。\\"\\n }\\n },\\n \\"Type\\": \\"GOODS\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '酒店场景服务对话模板',
],
- 'AddCartoon' => [
- 'summary' => '增加或者编辑动画',
- 'path' => '/v1.0/ip/addCartoon',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelAlarm' => [
+ 'summary' => '查询酒店闹钟信息',
+ 'path' => '/v1.0/ip/getHotelAlarmList',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '520a0***eb',
- ],
- ],
- [
- 'name' => 'StartVideoUrl',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '开机动画url',
- 'description' => '开机动画url',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://***.mp4',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => false, 'example' => 'a7a3***013'],
],
[
- 'name' => 'StartVideoMd5',
+ 'name' => 'Rooms',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '开机动画md5',
- 'description' => '开机动画md5',
- 'type' => 'string',
- 'required' => true,
- 'example' => '40c804***697',
+ 'description' => '房间号',
+ 'type' => 'array',
+ 'items' => ['description' => '房间', 'type' => 'string', 'required' => false, 'example' => '101'],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<HotelAlarmDetailResponse>>',
+ 'description' => 'Result<List<HotelAlarmDetailResponse>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'AlarmId' => ['title' => '闹钟id', 'description' => '闹钟id', 'type' => 'integer', 'format' => 'int64', 'example' => '5039'],
+ 'UserOpenId' => ['title' => '用户Id', 'description' => '开放用户Id', 'type' => 'string', 'example' => 'mgw/k***HQd'],
+ 'DeviceOpenId' => ['title' => 'uuid', 'description' => '开放设备id', 'type' => 'string', 'example' => 'PvkB****VVTA=='],
+ 'ScheduleInfo' => [
+ 'title' => '设置的闹钟信息',
+ 'description' => '设置的闹钟信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', 'description' => 'ONCE, WEEKLY', 'type' => 'string', 'example' => 'ONCE'],
+ 'Once' => [
+ 'description' => '单次闹钟',
+ 'type' => 'object',
+ 'properties' => [
+ 'Year' => ['description' => '年', 'type' => 'integer', 'format' => 'int32', 'example' => '2022'],
+ 'Month' => ['description' => '月', 'type' => 'integer', 'format' => 'int32', 'example' => '9'],
+ 'Day' => ['description' => '日', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Hour' => ['description' => '时', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Minute' => ['description' => '分', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ ],
+ ],
+ 'Weekly' => [
+ 'description' => '周循环:循环类型为WEEKLY时,该属性可用'."\n"
+ ."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DaysOfWeek' => [
+ 'description' => '周几触发集合',
+ 'type' => 'array',
+ 'items' => ['description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'Hour' => ['description' => '触发时间:时', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Minute' => ['description' => '触发时间:分', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'RequestId' => [
- 'description' => '链路请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E'."\n",
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'xx为空'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => '扩展内容'],
],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '43***881'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]',
- 'title' => '新增或者编辑动画',
- 'description' => '请上传MP4格式视频⽂件编解码器:AAC,H.264,分辨率:1280*800,视频时⻓不超过10s,⽂件⼤⼩不超过10MB。上传开机动画文件,完成后下次开机重启两次后生效。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"AlarmId\\": 5039,\\n \\"UserOpenId\\": \\"mgw/k***HQd\\",\\n \\"DeviceOpenId\\": \\"PvkB****VVTA==\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 9,\\n \\"Day\\": 20,\\n \\"Hour\\": 10,\\n \\"Minute\\": 30\\n },\\n \\"Weekly\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n }\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店闹钟信息列表',
+ 'description' => '查询酒店闹钟信息。',
],
- 'GetCartoon' => [
- 'summary' => '查询已设置的动画',
- 'path' => '/v1.0/ip/getCartoon',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelControlDevice' => [
+ 'summary' => '酒店设备列表',
+ 'path' => '/v1.0/ip/listHotelControlDevice',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '520a0c0***5eb',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['type' => 'string', 'required' => true],
+ 'EncodeKey' => ['type' => 'string', 'required' => true],
+ 'IdType' => ['type' => 'string', 'required' => true],
+ 'Id' => ['type' => 'string', 'required' => true],
+ 'OrganizationId' => ['type' => 'string'],
+ ],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<HotelCartoonResponse>',
- 'description' => 'Result<HotelCartoonResponse>',
+ 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'StartVideoUrl' => [
- 'title' => '开机启动视频',
- 'description' => '开机启动视频',
- 'type' => 'string',
- 'example' => '40c8***97',
- ],
- 'StartVideoMd5' => [
- 'title' => '开机视频md5',
- 'description' => '开机视频md5',
- 'type' => 'string',
- 'example' => 'https://ai***.mp4',
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求requestId',
- 'type' => 'string',
- 'example' => '0EC7*726E'."\n",
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"StartVideoUrl\\": \\"40c8***97\\",\\n \\"StartVideoMd5\\": \\"https://ai***.mp4\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]',
- 'title' => '查询已设置的动画',
- 'description' => '查询已设置的动画',
],
- 'DeleteCartoon' => [
- 'summary' => '删除已设置动画',
- 'path' => '/v1.0/ip/deleteCartoon',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelInfo' => [
+ 'summary' => '查询酒店列表信息,例如酒店名称、地址、授权账号等。',
+ 'path' => '/v1.0/ip/listHotelInfo',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => ' 酒店id',
- 'description' => ' 酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a7***83'."\n",
- ],
- ],
- ],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<HotelInfoResponse>>',
+ 'description' => 'Result<List<HotelInfoResponse>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['description' => '酒店id', 'type' => 'string', 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7'],
+ 'HotelName' => ['description' => '酒店名称', 'type' => 'string', 'example' => '酒店'],
+ 'HotelAddress' => ['description' => '酒店地址', 'type' => 'string', 'example' => '浙江身杭州市'],
+ 'AuthAccount' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserName' => ['title' => '授权子账号的账号名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'leetest'],
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'RequestId' => [
- 'description' => '链路请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E'."\n",
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any'],
],
+ 'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\\\n\\"\\n}","type":"json"}]',
- 'title' => '删除已设置动画',
- 'description' => '删除已设置动画',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"HotelName\\": \\"酒店\\",\\n \\"HotelAddress\\": \\"浙江身杭州市\\",\\n \\"AuthAccount\\": [\\n {\\n \\"UserName\\": \\"leetest\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店列表',
+ 'description' => '查询酒店列表信息,例如酒店名称、地址、授权账号等',
],
- 'GetHotelScreenSaverStyle' => [
- 'summary' => '查询酒店屏保背景的可选样式',
- 'path' => '/v1.0/ip/getHotelScreenSaverStyle',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelMessageTemplate' => [
+ 'summary' => '获取酒店消息模板',
+ 'path' => '/v1.0/ip/listHotelMessageTemplate',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'af7***536'."\n",
- ],
- ],
- ],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelScreenSaverStyle>>',
- 'description' => 'Result<List<HotelScreenSaverStyle>>',
+ 'title' => 'Result<List<ListHotelMessageTemplate>>',
+ 'description' => 'Result<List<ListHotelMessageTemplate>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'array',
'items' => [
- 'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '编码code',
- 'description' => '编码code',
- 'type' => 'string',
- 'example' => 'common-weather',
- ],
- 'CnName' => [
- 'title' => '中文名称',
- 'description' => '中文名称',
- 'type' => 'string',
- 'example' => '天气',
- ],
- 'EnName' => [
- 'title' => '英文名称',
- 'description' => '英文名称',
- 'type' => 'string',
- 'example' => 'common-weather',
- ],
- 'PicUrl' => [
- 'title' => '图片链接',
- 'description' => '图片链接',
- 'type' => 'string',
- 'example' => 'https://img.***.png',
- ],
+ 'TemplateId' => ['title' => '消息模板ID', 'description' => '消息模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TemplateDetail' => ['title' => '消息模板内容', 'description' => '消息模板内容', 'type' => 'string', 'example' => '这是${hotel}的一个测试模板'],
+ 'TemplateName' => ['title' => '消息模板名称', 'description' => '消息模板名称', 'type' => 'string', 'example' => '测试模板'],
+ 'AuditMark' => ['title' => '审核备注', 'description' => '审核备注', 'type' => 'string', 'example' => '不通过'],
+ 'AuditStatus' => ['title' => '审核状态', 'description' => '审核状态', 'type' => 'string', 'example' => 'COMMIT'],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C67**6FA'."\n",
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"common-weather\\",\\n \\"CnName\\": \\"天气\\",\\n \\"EnName\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://img.***.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67**6FA\\\\n\\"\\n}","type":"json"}]',
- 'title' => '查询酒店屏保背景的可选样式',
- 'description' => '新增屏保的时候有个screenSaverStyle字段,要用这接口里查出来的code作为基本样式',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 1,\\n \\"TemplateDetail\\": \\"这是${hotel}的一个测试模板\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"AuditMark\\": \\"不通过\\",\\n \\"AuditStatus\\": \\"COMMIT\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '获取酒店消息模板',
],
- 'AddOrUpdateHotelSetting' => [
- 'summary' => '新增或者更新酒店定制',
- 'path' => '/v1.0/ip/addOrUpdateHotelSetting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelOrder' => [
+ 'summary' => '查询设备上的订单列表',
+ 'path' => '/v1.0/ip/listHotelOrder',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a7a3***013',
- ],
- ],
- [
- 'name' => 'SettingType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设置的类型,带屏展示模式(SCENE),'."\n"
- .'带屏屏保配置(SCREENSAVER),'."\n"
- .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
- .'带屏酒店通知(NOTICE),'."\n"
- .'夜间模式(NIGHT_MODE)',
- 'description' => '设置的类型,带屏展示模式(SCENE),'."\n"
- .'带屏屏保配置(SCREENSAVER),'."\n"
- .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
- .'带屏酒店通知(NOTICE),'."\n"
- .'夜间模式(NIGHT_MODE)',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NOTICE' => '带屏酒店通知',
- 'NIGHT_MODE' => '夜间模式',
- 'SCREENSAVER' => '带屏屏保配置',
- 'SCENE' => '带屏展示模式',
- 'HOMEPAGE_PIC' => '首页背景图',
- ],
- 'example' => 'SCREENSAVER',
- ],
- ],
- [
- 'name' => 'Value',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '配置值',
- 'description' => '首页背景图/酒店通知',
- 'type' => 'string',
- 'required' => false,
- 'example' => '首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店~~',
- ],
- ],
- [
- 'name' => 'HotelScreenSaver',
- 'in' => 'formData',
+ 'name' => 'Payload',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '屏保',
- 'description' => '屏保',
+ 'title' => '酒店订单列表payload',
+ 'description' => '酒店订单列表payload',
'type' => 'object',
'properties' => [
- 'ScreenSaverStyle' => [
- 'title' => '屏保样式code',
- 'description' => '屏保样式code',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'common-weather',
- ],
- 'ScreenSaverPicUrl' => [
- 'title' => '屏保图片',
- 'description' => '屏保图片',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://a****jpg',
+ 'UserId' => ['title' => '用户ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1345480696877233314'],
+ 'Page' => [
+ 'title' => '分页参数',
+ 'description' => '分页参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条数据', 'description' => '每页多少条数据', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10'],
+ ],
+ 'required' => true,
+ 'docRequired' => true,
],
],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'HotelDeviceModeList',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '模式',
- 'description' => '模式',
- 'type' => 'array',
- 'items' => [
- 'description' => '参数值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sleep',
- ],
- 'required' => false,
+ 'required' => true,
+ 'docRequired' => true,
],
],
[
- 'name' => 'NightMode',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '夜间模式',
- 'description' => '夜间模式',
+ 'title' => '用户信息',
+ 'description' => '用户信息',
'type' => 'object',
'properties' => [
- 'Enable' => [
- 'title' => '启用、禁用',
- 'description' => '启用、禁用',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Start' => [
- 'title' => '开始时间',
- 'description' => '开始时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7:00',
- ],
- 'End' => [
- 'title' => '结束时间',
- 'description' => '结束时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '22:00',
- ],
- 'DefaultVolume' => [
- 'title' => '夜间模式下的默认音量',
- 'type' => 'string',
- 'required' => false,
- ],
- 'DefaultBright' => [
- 'title' => '夜间模式下的默认亮度',
- 'type' => 'string',
- 'required' => false,
- ],
- 'StandbyAction' => [
- 'title' => '休眠时执行,息屏(screenoff)、屏保(screensaver)',
- 'description' => '休眠时执行,息屏(screenoff)、屏保(screensaver)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'screenoff',
- ],
+ 'EncodeType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955'],
+ 'IdType' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA=='],
+ 'OrganizationId' => ['type' => 'string', 'required' => false],
],
- 'required' => false,
+ 'required' => true,
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'PageResult<List<HotelOrderListResp>>',
+ 'description' => 'PageResult<List<HotelOrderListResp>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'Page' => [
+ 'title' => '分页结果',
+ 'description' => '分页结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条数据', 'description' => '每页多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['title' => '共多少条数据', 'description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '21'],
+ 'TotalPage' => ['title' => '共多少页', 'description' => '共多少页', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
+ 'HasNext' => ['title' => '是否有下一页', 'description' => '是否有下一页', 'type' => 'boolean'],
+ ],
],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomNo' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'example' => '2001'],
+ 'OrderNo' => ['title' => '订单号', 'description' => '订单号', 'type' => 'string', 'example' => '20220808180132000114508555527711'],
+ 'Quantity' => ['title' => '共多少个物品', 'description' => '共多少个物品', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'ApplyAmt' => ['title' => '共需要多少钱', 'description' => '共需要多少钱', 'type' => 'integer', 'format' => 'int64', 'example' => '21.5'],
+ 'Status' => ['title' => '订单状态', 'description' => '订单状态', 'type' => 'string', 'example' => 'INIT'],
+ 'GmtCreate' => ['title' => '订单创建时间', 'description' => '订单创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1659952892000'],
+ 'Type' => ['title' => '订单商品所属分类', 'description' => '订单商品所属分类', 'type' => 'string', 'example' => 'REPAIR'],
+ 'TypeName' => ['title' => '订单物品所属分类名称', 'description' => '订单物品所属分类名称', 'type' => 'string', 'example' => '设备维修'],
+ 'TypeIconUrl' => ['title' => '订单物品所属分类icon', 'description' => '订单物品所属分类icon', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png'],
+ 'Amt' => ['title' => '单价', 'description' => '单价', 'type' => 'integer', 'format' => 'int64'],
+ 'Icon' => ['title' => '商品图片', 'description' => '商品图片', 'type' => 'string'],
+ 'Name' => ['title' => '商品名称', 'description' => '商品名称', 'type' => 'string'],
+ 'ItemType' => ['title' => '商品类型', 'description' => '商品类型', 'type' => 'string'],
+ 'ItemId' => ['title' => '商品id', 'description' => '商品id', 'type' => 'integer', 'format' => 'int64'],
+ 'DeliveryTime' => ['title' => '商品预计送达时间', 'description' => '商品预计送达时间', 'type' => 'integer', 'format' => 'int64'],
+ 'PaymentMethod' => ['title' => '商品结算方式', 'description' => '商品结算方式', 'type' => 'string'],
+ 'StartTime' => ['title' => '数据查询开始时间', 'description' => '数据查询开始时间', 'type' => 'integer', 'format' => 'int64'],
+ 'SumAmt' => ['title' => '当前入住下单汇总金额', 'description' => '当前入住下单汇总金额', 'type' => 'integer', 'format' => 'int64'],
+ 'OrderStatus' => ['title' => '订单状态', 'description' => '订单状态', 'type' => 'string'],
+ 'DeliveryRoomName' => ['title' => '配送房间名称', 'description' => '配送房间名称', 'type' => 'string'],
+ 'DeliveryMethod' => ['type' => 'string'],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '07F61FDA-606F-10A0-8ED0-C6CE62710A48'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '新增或者更新酒店定制',
- 'description' => '> 根据入参settingType不同,可以新增或者修改不同的酒店定制配置'."\n"
- .'> - 首页背景-settingType="HOMEPAGE_PIC"'."\n"
- .'> - 屏保背景-settingType="SCREENSAVER"'."\n"
- .'> - 带屏展示模式-settingType="SCENE"'."\n"
- .'> - 带屏酒店通知-settingType="NOTICE"'."\n"
- .'> - 夜间模式-settingType="NIGHT_MODE"',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21,\\n \\"TotalPage\\": 7,\\n \\"HasNext\\": true\\n },\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"2001\\",\\n \\"OrderNo\\": \\"20220808180132000114508555527711\\",\\n \\"Quantity\\": 12,\\n \\"ApplyAmt\\": 21.5,\\n \\"Status\\": \\"INIT\\",\\n \\"GmtCreate\\": 1659952892000,\\n \\"Type\\": \\"REPAIR\\",\\n \\"TypeName\\": \\"设备维修\\",\\n \\"TypeIconUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png\\",\\n \\"Amt\\": 0,\\n \\"Icon\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ItemType\\": \\"\\",\\n \\"ItemId\\": 0,\\n \\"DeliveryTime\\": 0,\\n \\"PaymentMethod\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"SumAmt\\": 0,\\n \\"OrderStatus\\": \\"\\",\\n \\"DeliveryRoomName\\": \\"\\",\\n \\"DeliveryMethod\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"07F61FDA-606F-10A0-8ED0-C6CE62710A48\\"\\n}","type":"json"}]',
+ 'title' => '查询订单',
+ 'description' => '查询设备上的订单列表',
],
- 'GetHotelSetting' => [
- 'summary' => '查询酒店定制(包含屏保背景、首页背景等等)',
- 'path' => '/v1.0/ip/getHotelSetting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelRooms' => [
+ 'summary' => '获取酒店房间,可细化至房间号',
+ 'path' => '/v1.0/ip/listHotelRooms',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'af7***536'."\n",
- ],
+ 'schema' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'],
],
[
- 'name' => 'SettingType',
+ 'name' => 'HotelAdminRoom',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '设置的类型,带屏展示模式(SCENE),'."\n"
- .'带屏屏保配置(SCREENSAVER),'."\n"
- .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
- .'带屏酒店通知(NOTICE),'."\n"
- .'夜间模式(NIGHT_MODE)',
- 'description' => '设置的类型,带屏展示模式(SCENE),'."\n"
- .'带屏屏保配置(SCREENSAVER),'."\n"
- .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
- .'带屏酒店通知(NOTICE),'."\n"
- .'夜间模式(NIGHT_MODE)',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NOTICE' => '带屏酒店通知',
- 'NIGHT_MODE' => '夜间模式',
- 'SCREENSAVER' => '屏保背景',
- 'SCENE' => '带屏展示模式',
- 'HOMEPAGE_PIC' => '首页背景图',
+ 'description' => '查询的附加信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomNo' => ['description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '1001'],
],
- 'example' => 'SCREENSAVER',
+ 'required' => false,
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<HotelSettingInfo>',
- 'description' => 'Result<HotelSettingInfo>',
+ 'title' => 'Result<List<HotelRoomResp>>',
+ 'description' => 'Result<List<HotelRoomResp>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'af7***536',
- ],
- 'SettingType' => [
- 'title' => '设置类型',
- 'description' => '设置类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'SCREENSAVER' => '屏保',
- 'HOMEPAGE_PIC' => '首页背景图',
- ],
- 'example' => 'SCREENSAVER',
- ],
- 'Value' => [
- 'title' => '对应的值',
- 'description' => '首页背景图/酒店通知',
- 'type' => 'string',
- 'example' => '首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店~~',
- ],
- 'DeleteToken' => [
- 'title' => '是否删除',
- 'description' => '是否删除',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ExtInfo' => [
- 'title' => '扩展信息',
- 'description' => '扩展信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'HotelScreenSaver' => [
- 'title' => '屏保对象',
- 'description' => '屏保对象',
- 'type' => 'object',
- 'properties' => [
- 'ScreenSaverStyle' => [
- 'title' => '屏保样式code',
- 'description' => '屏保样式code',
- 'type' => 'string',
- 'example' => 'common-weather',
- ],
- 'ScreenSaverPicUrl' => [
- 'title' => '屏保图片',
- 'description' => '屏保图片',
- 'type' => 'string',
- 'example' => 'https://a***png',
- ],
- ],
- ],
- 'HotelDeviceModeList' => [
- 'title' => '设备模式',
- 'description' => '设备模式',
- 'type' => 'array',
- 'items' => [
- 'description' => '场景值',
- 'type' => 'string',
- 'example' => 'sweet',
- ],
- ],
- 'NightMode' => [
- 'title' => '夜间模式',
- 'description' => '夜间模式',
- 'type' => 'object',
- 'properties' => [
- 'Enable' => [
- 'title' => '启用、禁用',
- 'description' => '启用、禁用',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Start' => [
- 'title' => '开始时间',
- 'description' => '开始时间',
- 'type' => 'string',
- 'example' => '07:00',
- ],
- 'End' => [
- 'title' => '结束时间',
- 'description' => '结束时间',
- 'type' => 'string',
- 'example' => '22:00',
- ],
- 'DefaultVolume' => [
- 'title' => '夜间模式下的默认音量',
- 'description' => '夜间模式下的默认音量',
- 'type' => 'string',
- ],
- 'DefaultBright' => [
- 'title' => '夜间模式下的默认亮度',
- 'description' => '夜间模式下的默认亮度',
- 'type' => 'string',
- ],
- 'StandbyAction' => [
- 'title' => '休眠时执行,息屏(screenoff)、屏保(screensaver)',
- 'description' => '休眠时执行,息屏(screenoff)、屏保(screensaver)',
- 'type' => 'string',
- 'example' => 'screenoff',
- ],
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '服务返回的房间信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'],
+ 'RoomNo' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'example' => '102'],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F7E2****B7C94',
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D75D971E-33E8-1C48-A4B7-5FA6CC386146'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"af7***536\\",\\n \\"SettingType\\": \\"SCREENSAVER\\",\\n \\"Value\\": \\"首页背景图-https://****.jpg 酒店通知-欢迎入住**酒店~~\\",\\n \\"DeleteToken\\": 0,\\n \\"ExtInfo\\": \\"{}\\",\\n \\"HotelScreenSaver\\": {\\n \\"ScreenSaverStyle\\": \\"common-weather\\",\\n \\"ScreenSaverPicUrl\\": \\"https://a***png\\"\\n },\\n \\"HotelDeviceModeList\\": [\\n \\"sweet\\"\\n ],\\n \\"NightMode\\": {\\n \\"Enable\\": true,\\n \\"Start\\": \\"07:00\\",\\n \\"End\\": \\"22:00\\",\\n \\"DefaultVolume\\": \\"\\",\\n \\"DefaultBright\\": \\"\\",\\n \\"StandbyAction\\": \\"screenoff\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]',
- 'title' => '查询酒店定制',
- 'description' => '> 根据入参settingType不同,可以查询不同的酒店定制配置'."\n"
- .'> - 首页背景-settingType="HOMEPAGE_PIC"'."\n"
- .'> - 屏保背景-settingType="SCREENSAVER"'."\n"
- .'> - 带屏展示模式-settingType="SCENE"'."\n"
- .'> - 带屏酒店通知-settingType="NOTICE"'."\n"
- .'> - 夜间模式-settingType="NIGHT_MODE"',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"e6dd44fd16084db8a60d69fd625d9f0f\\",\\n \\"RoomNo\\": \\"102\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D75D971E-33E8-1C48-A4B7-5FA6CC386146\\"\\n}","errorExample":""},{"type":"xml","example":"<ListHotelRoomsResponse>\\n <Code>200</Code>\\n <Result>\\n <HotelId>e6dd44fd16084db8a60d69fd625d9f0f</HotelId>\\n <RoomNo>102</RoomNo>\\n </Result>\\n <Message>success</Message>\\n <RequestId>D75D971E-33E8-1C48-A4B7-5FA6CC386146</RequestId>\\n</ListHotelRoomsResponse>","errorExample":""}]',
+ 'title' => '查询酒店房间列表',
+ 'requestParamsDescription' => '如果要查询某个房间,则输入房间号'."\n"
+ .'如果查询酒店的所有房间,不输入房间号',
+ 'responseParamsDescription' => '如果返回的结果为空,则说明没有本次想要查询的房间号',
+ 'extraInfo' => '如果出错请检查传入的参数是否正确',
],
- 'DeleteHotelSetting' => [
- 'summary' => '删除酒店定制 包含首页背景、屏保背景等等',
- 'path' => '/v1.0/ip/deleteHotelSetting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelSceneBookItems' => [
+ 'summary' => '酒店场景预订列表(餐饮/SPA休闲/打车)',
+ 'path' => '/v1.0/ip/listHotelSceneBookItems',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'af7***536',
- ],
+ 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
[
- 'name' => 'SettingType',
+ 'name' => 'Type',
'in' => 'formData',
+ 'schema' => ['title' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)', 'description' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FOOD'],
+ ],
+ [
+ 'name' => 'Page',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '设置类型',
- 'description' => '设置的类型,带屏展示模式(SCENE),'."\n"
- .'带屏屏保配置(SCREENSAVER)'."\n"
- .'带屏首页背景图(HOMEPAGE_PIC)'."\n"
- .'带屏酒店通知(NOTICE)'."\n"
- .'夜间模式(NIGHT_MODE)',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NOTICE' => '带屏酒店通知',
- 'NIGHT_MODE' => '夜间模式',
- 'SCREENSAVER' => '屏保',
- 'SCENE' => '带屏展示模式',
- 'HOMEPAGE_PIC' => '首页背景图',
+ 'title' => '分页参数',
+ 'description' => '分页参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条数据', 'description' => '每页多少条数据', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
- 'example' => 'SCREENSAVER',
+ 'required' => true,
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<HotelSceneListResp>',
+ 'description' => 'Result<HotelSceneListResp>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求链路id',
- 'type' => 'string',
- 'example' => '73C67****BB3E6FA',
+ 'type' => 'object',
+ 'properties' => [
+ 'Page' => [
+ 'title' => '分页结果',
+ 'description' => '分页结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条数据', 'description' => '每页多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['title' => '共多少条数据', 'description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
+ 'TotalPage' => ['title' => '共多少页', 'description' => '共多少页', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'HasNext' => ['title' => '是否有下一页', 'description' => '是否有下一页', 'type' => 'boolean', 'example' => 'True'],
+ ],
+ ],
+ 'SceneItemList' => [
+ 'description' => '预定项列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '预定项',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)', 'description' => '酒店场景预订类型(FOOD:餐饮、LEISURE:SPA休闲、CAR_SERVICE:打车)', 'type' => 'string', 'example' => 'FOOD'],
+ 'Id' => ['title' => '酒店场景预订itemID', 'description' => '酒店场景预订itemID', 'type' => 'integer', 'format' => 'int64', 'example' => '11824'],
+ 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => '青椒肉丝'],
+ 'Status' => ['title' => '状态(已添加)', 'description' => '状态(已添加)', 'type' => 'string', 'example' => '已添加'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1666161803'],
+ 'Icon' => ['title' => '物品、服务、维修的图标', 'description' => '物品、服务、维修的图标', 'type' => 'string', 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png'],
+ 'Price' => ['title' => '价格(单位:分)', 'description' => '价格(单位:分)', 'type' => 'integer', 'format' => 'int64', 'example' => '1850'],
+ ],
+ ],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67****BB3E6FA\\"\\n}","type":"json"}]',
- 'title' => '删除酒店定制(屏保背景、首页背景等)',
- 'description' => '> 根据入参settingType不同,可以删除不同的酒店定制配置'."\n"
- .'> - 如果是删除首页背景-settingType="HOMEPAGE_PIC"'."\n"
- .'> - 删除屏保背景-settingType="SCREENSAVER"'."\n"
- .'> - 带屏展示模式-settingType="SCENE"'."\n"
- .'> - 带屏酒店通知-settingType="NOTICE"'."\n"
- .'> - 夜间模式-settingType="NIGHT_MODE"',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"FOOD\\",\\n \\"Id\\": 11824,\\n \\"Name\\": \\"青椒肉丝\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666161803,\\n \\"Icon\\": \\"https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png\\",\\n \\"Price\\": 1850\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店预订列表',
],
- 'AddOrUpdateWelcomeText' => [
- 'summary' => '设置欢迎语配置',
- 'path' => '/v1.0/ip/addOrUpdateWelcomeText',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelSceneItem' => [
+ 'summary' => '查询酒店场景服务项列表,如物品服务的服务项列表',
+ 'path' => '/v1.0/ip/listHotelSceneItem',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'WelcomeText',
- 'in' => 'formData',
+ 'name' => 'Payload',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '欢迎语文本,建议150字以内',
- 'description' => '欢迎语文本,150字以内',
- 'type' => 'string',
+ 'title' => '场景服务payload',
+ 'description' => '场景服务payload',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['title' => '用户ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1345480696877233314'],
+ 'Type' => ['title' => '场景服务分类', 'description' => '场景服务分类', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GOODS'],
+ ],
'required' => true,
- 'example' => '尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。',
+ 'docRequired' => true,
],
],
[
- 'name' => 'MusicUrl',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '背景音链接'."\n"
- ."\n"
- .'上传要求:'."\n"
- .'1. 仅支持采样率16KHz、单声道 .wav格式的文件。(如果您的背景音不是wav格式,'."\n"
- .'可使用 ffmpeg将其转为wav格式:ffmpeg -i 输入音频 -acodec pcm_s16le -ac 1 -ar 16000 目标.wav)'."\n"
- .'2. 大小不超过2MB。'."\n"
- .'3.合成时长超出背景音时长时,背景音将循环合成播放。',
- 'description' => '背景音链接'."\n"
- ."\n"
- .'上传要求:'."\n"
- .'1. 仅支持采样率16KHz、单声道 .wav格式的文件。(如果您的背景音不是wav格式,'."\n"
- .'可使用 ffmpeg将其转为wav格式:ffmpeg -i 输入音频 -acodec pcm_s16le -ac 1 -ar 16000 目标.wav)'."\n"
- .'2. 大小不超过2MB。'."\n"
- .'3.合成时长超出背景音时长时,背景音将循环合成播放。',
- 'type' => 'string',
+ 'title' => '用户信息',
+ 'description' => '用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码Key', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955'],
+ 'IdType' => ['description' => 'id类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => 'id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA=='],
+ 'OrganizationId' => ['description' => '组织id', 'type' => 'string', 'required' => false, 'example' => '""'],
+ ],
'required' => true,
- 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav',
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'PageResult<ListItemResponse>',
+ 'description' => 'PageResult<ListItemResponse>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'Page' => [
+ 'title' => '分页结果',
+ 'description' => '分页结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条', 'description' => '每页多少条', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['title' => '共多少条数据', 'description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'TotalPage' => ['title' => '共多少页', 'description' => '共多少页', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
+ 'HasNext' => ['title' => '是否有下一页', 'description' => '是否有下一页', 'type' => 'boolean'],
+ ],
],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果,这里标识添加或更新是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
+ 'description' => '服务的实际返回结果',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => ' '."\n"
- .'扩展信息',
+ 'properties' => [
+ 'SecondCategoryList' => [
+ 'title' => '服务分类list',
+ 'description' => '服务分类list',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '服务对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'SecondCategoryName' => ['title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'example' => '客用品类'],
+ 'ItemList' => [
+ 'description' => '物品list',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '物品对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '物品ID', 'description' => '物品ID', 'type' => 'string', 'example' => '152860'],
+ 'Type' => ['title' => '物品分类', 'description' => '物品分类', 'type' => 'string', 'example' => 'GOODS'],
+ 'Category' => ['title' => '物品二级分类', 'description' => '物品二级分类', 'type' => 'string', 'example' => '客用品类'],
+ 'Name' => ['title' => '物品名称', 'description' => '物品名称', 'type' => 'string', 'example' => '棉签'],
+ 'Status' => ['title' => '物品状态', 'description' => '物品状态', 'type' => 'string', 'example' => '已添加'],
+ 'Icon' => ['title' => '物品icon', 'description' => '物品icon', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png'],
+ 'Price' => ['title' => '物品价格', 'description' => '物品价格', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ResidueLimit' => ['title' => '剩余下单数量'."\n"
+ .' -1表示 不限制 0表示无剩余下单量 >0为可下单的数量', 'description' => '剩余下单数量'."\n"
+ .' -1表示 不限制 0表示无剩余下单量 >0为可下单的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
- 'RequestId' => [
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'staticInfo' => [],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '设置欢迎语配置',
- 'description' => '欢迎语配置,包含播报的tts文本以及背景音:'."\n"
- .'- 播报文本:可配置成”欢迎入住${hotel}“,带占位符的方式,在推送是带上参数映射表替换对应的占位符'."\n"
- .'- 背景音链接:'."\n"
- .' - 1. 仅支持采样率16KHz、单声道 .wav格式的文件。(如果您的背景音不是wav格式,'."\n"
- .'可使用 ffmpeg将其转为wav格式:ffmpeg -i 输入音频 -acodec pcm_s16le -ac '."\n"
- .' 1 -ar 16000 目标.wav)'."\n"
- .' - 2. 大小不超过2MB。'."\n"
- .' - 3.合成时长超出背景音时长时,背景音将循环合成播放。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"TotalPage\\": 6,\\n \\"HasNext\\": true\\n },\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"SecondCategoryList\\": [\\n {\\n \\"SecondCategoryName\\": \\"客用品类\\",\\n \\"ItemList\\": [\\n {\\n \\"Id\\": \\"152860\\",\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 1,\\n \\"ResidueLimit\\": 2\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CEADB586-51CB-1B6B-95BD-AB85A7A08E97\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店场景服务项列表',
+ 'description' => '查询酒店场景服务项列表,如物品服务的服务项列表',
],
- 'GetWelcomeTextAndMusic' => [
- 'summary' => '获取欢迎语配置',
- 'path' => '/v1.0/ip/getWelcomeTextAndMusic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelSceneItems' => [
+ 'summary' => '查询酒店场景服务(物品/服务/维修)',
+ 'path' => '/v1.0/ip/listHotelSceneItems',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
+ 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
+ ],
+ [
+ 'name' => 'ListHotelSceneReq',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '酒店 id',
- 'description' => '酒店 id',
- 'type' => 'string',
+ 'title' => 'ListHotelSceneReq',
+ 'description' => 'ListHotelSceneReq',
+ 'type' => 'object',
+ 'properties' => [
+ 'Page' => [
+ 'title' => '分页参数',
+ 'description' => '分页参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
+ 'PageSize' => ['description' => '每页的大小,默认为10 ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ ],
+ 'Type' => ['title' => '酒店场景类型(物品GOODS/服务SERVICE/维修REPAIR)', 'description' => '酒店场景服务类型(物品GOODS/服务SERVICE/维修REPAIR)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GOODS'],
+ 'Category' => ['title' => '酒店场景类型二级分类', 'description' => '酒店场景服务类型二级分类', 'type' => 'string', 'required' => false, 'example' => '客用品类'],
+ 'Status' => ['title' => '是否添加', 'description' => '是否添加', 'type' => 'string', 'required' => false, 'example' => '已添加'],
+ 'Keywords' => ['title' => '酒店场景名称', 'description' => '酒店场景服务项名称', 'type' => 'string', 'required' => false, 'example' => '棉签'],
+ ],
'required' => true,
- 'example' => 'a7a3***013',
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<WelcomeResp>',
- 'description' => 'Result<WelcomeResp>',
+ 'title' => 'Result<HotelSceneListResp>',
+ 'description' => 'Result<HotelSceneListResp>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'HotelId' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'Text' => [
- 'description' => '欢迎语文本',
- 'type' => 'string',
- 'example' => '尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。',
+ 'Page' => [
+ 'title' => '分页结果',
+ 'description' => '分页结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条数据', 'description' => '每页多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['title' => '共多少条数据', 'description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
+ 'TotalPage' => ['title' => '共多少页', 'description' => '共多少页', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'HasNext' => ['title' => '是否有下一页', 'description' => '是否有下一页', 'type' => 'boolean', 'example' => 'False'],
+ ],
],
- 'MusicUrl' => [
- 'description' => '背景音链接',
- 'type' => 'string',
- 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav',
+ 'SceneItemList' => [
+ 'description' => '服务项列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '服务项',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => '酒店场景类型', 'description' => '酒店场景服务类型', 'type' => 'string', 'example' => 'GOODS'],
+ 'Category' => ['title' => '酒店场景类型二级分类', 'description' => '酒店场景类型二级分类', 'type' => 'string', 'example' => '客用品类'],
+ 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '10336'],
+ 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => '棉签'],
+ 'Status' => ['title' => '状态(已添加、未添加)', 'description' => '状态(已添加、未添加)', 'type' => 'string', 'example' => '已添加'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1666163226'],
+ 'Icon' => ['title' => '物品、服务、维修的图标', 'description' => '物品、服务、维修的图标', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png'],
+ 'Price' => ['title' => '价格(单位:分,eg:160表示1.6元)', 'description' => '价格(单位:分,eg:160表示1.6元)', 'type' => 'integer', 'format' => 'int64', 'example' => '160'],
+ 'DeliveryMethod' => ['title' => '物品配送方式 waiter 服务员 robot 机器人', 'description' => '物品配送方式 waiter 服务员 robot 机器人', 'type' => 'string', 'example' => 'robot'],
+ 'RobotName' => ['title' => '机器人名称', 'description' => '机器人名称', 'type' => 'string', 'example' => '测试机器人'],
+ 'PaymentMethod' => ['title' => '结算方式:room 房费结算 robot 机器人结算', 'description' => '结算方式:room 房费结算 robot 机器人结算', 'type' => 'string', 'example' => 'robot'],
+ 'LimitSwitch' => ['title' => '是否限制数量:0或不传:不限制,1:限制', 'description' => '是否限制数量:0或不传:不限制,1:限制', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'LimitNumber' => ['title' => '限制数量', 'description' => '限制数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'BeyondLimitReply' => ['title' => '超限回复', 'description' => '超限回复', 'type' => 'string', 'example' => '顾客您好,该物品已超出酒店今日供应限制,请联系前台。'],
+ ],
+ ],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '扩展信息',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Text\\": \\"尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。\\",\\n \\"MusicUrl\\": \\"http://ailabsaicloudservice.alicdn.com/tmp/a.wav\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '获取欢迎语配置',
- 'description' => '获取欢迎语配置',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"SceneItemList\\": [\\n {\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Id\\": 10336,\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"UpdateTime\\": 1666163226,\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 160,\\n \\"DeliveryMethod\\": \\"robot\\",\\n \\"RobotName\\": \\"测试机器人\\",\\n \\"PaymentMethod\\": \\"robot\\",\\n \\"LimitSwitch\\": 1,\\n \\"LimitNumber\\": 2,\\n \\"BeyondLimitReply\\": \\"顾客您好,该物品已超出酒店今日供应限制,请联系前台。\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店场景服务',
],
- 'ResetWelcomeTextAndMusic' => [
- 'summary' => '重置欢迎语配置',
- 'path' => '/v1.0/ip/resetWelcomeTextAndMusic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListHotelServiceCategory' => [
+ 'summary' => '获取酒店服务分类,例如酒店服务于酒店预定下的各个分类',
+ 'path' => '/v1.0/ip/listHotelServiceCategory',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
+ 'name' => 'Payload',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
+ 'title' => '服务分类',
+ 'description' => '服务分类',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => '服务分类类型', 'description' => '服务分类类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOTEL_SERVICE'],
+ ],
'required' => true,
- 'example' => 'af7***536',
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<SceneServiceCategory>>',
+ 'description' => 'Result<List<SceneServiceCategory>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '扩展信息',
- 'example' => ' ',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => '服务分类类型', 'description' => '服务分类类型', 'type' => 'string', 'example' => 'HOTEL_SERVICE'],
+ 'Code' => ['title' => '服务分类code', 'description' => '服务分类code', 'type' => 'string', 'example' => 'GOODS'],
+ 'Name' => ['title' => '服务分类名称', 'description' => '服务分类名称', 'type' => 'string', 'example' => '物品添加'],
+ 'Desc' => ['title' => '服务分类描述', 'description' => '服务分类描述', 'type' => 'string', 'example' => '生活及洗漱用品'],
+ 'Icon' => ['title' => '服务分类icon', 'description' => '服务分类icon', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png'],
+ ],
],
],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '5373C821-65D2-1764-B9F9-951914937FF5'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'staticInfo' => [],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" \\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '重置欢迎语配置',
- 'description' => '重置欢迎语配置到默认的配置:'."\n"
- .'- 欢迎语文本:尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。'."\n"
- .'- 背景音链接:http://ailabsaicloudservice.alicdn.com/tmp/a.wav',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Type\\": \\"HOTEL_SERVICE\\",\\n \\"Code\\": \\"GOODS\\",\\n \\"Name\\": \\"物品添加\\",\\n \\"Desc\\": \\"生活及洗漱用品\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5373C821-65D2-1764-B9F9-951914937FF5\\"\\n}","type":"json"}]',
+ 'title' => '获取酒店服务分类',
+ 'description' => '获取酒店服务分类,例如酒店服务于酒店预定下的各个分类',
],
- 'PushWelcomeTextAndMusic' => [
- 'summary' => '推送欢迎语播报',
- 'path' => '/v1.0/ip/pushWelcomeTextAndMusic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListHotels' => [
+ 'summary' => '获取酒店列表(待审批/已拒绝/已通过),可细化至单个酒店',
+ 'path' => '/v1.0/ip/listHotels',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'RoomNo',
+ 'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1211',
- ],
+ 'schema' => ['title' => '审批状态(0:待审批、1:通过、2:拒绝)', 'description' => '审批状态(0:待审批、1:通过、2:拒绝)', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
- 'name' => 'RoomName',
- 'in' => 'formData',
+ 'name' => 'Page',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '房间名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8022房间',
+ 'title' => '分页参数',
+ 'description' => '分页参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条数据', 'description' => '每页多少条数据', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
+ ],
+ 'required' => true,
],
],
[
- 'name' => 'TemplateVariable',
- 'in' => 'formData',
+ 'name' => 'HotelRequest',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '参数映射表,例如欢迎语文本中的表达式:${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”',
- 'description' => '参数映射表,例如欢迎语文本中的表达式:${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”',
+ 'description' => '酒店相关信息',
'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '模板变量',
- 'example' => '{"name": "李先生"}',
+ 'properties' => [
+ 'HotelId' => ['description' => ' 酒店id', 'type' => 'string', 'required' => false, 'example' => 'e02e9c59f35845979418df2ab409a4c4'],
],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<HotelListResp>',
+ 'description' => 'Result<HotelListResp>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识为成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => ' *',
- 'description' => '扩展信息',
+ 'properties' => [
+ 'Page' => [
+ 'title' => '分页结果',
+ 'description' => '分页结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '第几页', 'description' => '第几页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页多少条', 'description' => '每页多少条', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['title' => '共多少条数据', 'description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
+ 'TotalPage' => ['title' => '共多少页', 'description' => '共多少页', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'HasNext' => ['title' => '是否有下一页', 'description' => '是否有下一页', 'type' => 'boolean', 'example' => 'True'],
+ ],
+ ],
+ 'HotelInfoList' => [
+ 'description' => '酒店信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '酒店信息列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'example' => '73ab1b03018d4da69b5bef17095f569b'],
+ 'HotelName' => ['title' => '酒店名称', 'description' => '酒店名称', 'type' => 'string', 'example' => '酒店名称'],
+ 'CreateTime' => ['title' => '创建时间(long类型)', 'description' => '创建时间(long类型)', 'type' => 'integer', 'format' => 'int64', 'example' => '1654568802000'],
+ 'HotelAddress' => ['title' => '酒店地址', 'description' => '酒店地址', 'type' => 'string', 'example' => '酒店地址'],
+ 'PhoneNumber' => ['title' => '联系方式', 'description' => '联系方式', 'type' => 'string', 'example' => '13312340987'],
+ 'IndustryType' => ['title' => '行业类型', 'description' => '行业类型', 'type' => 'string', 'example' => '酒店'],
+ 'RoomNum' => ['title' => '房间数', 'description' => '房间数', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'RelatedProductName' => ['title' => '关联产品名称', 'description' => '关联产品名称', 'type' => 'string', 'example' => '测试产品'],
+ 'AccountNames' => [
+ 'title' => '淘宝账号',
+ 'description' => '淘宝账号',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => '账号名称', 'type' => 'string', 'example' => 'testAccount'],
+ ],
+ 'Status' => ['title' => '状态(0:待审批、1:通过、2:拒绝)', 'description' => '状态(0:待审批、1:通过、2:拒绝)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ ],
],
],
- 'RequestId' => [
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'F7E2****B7C94',
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '85789C64-3644-56C0-9C0F-D2E0ECC227EF'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" *\\"\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]',
- 'title' => '推送欢迎语播报',
- 'description' => '推送欢迎语播报:'."\n"
- .'- 欢迎语文本:'."\n"
- .' - 未配置欢迎语时会直接使用默认的:”尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。“'."\n"
- .' - 如欢迎语文本中的表达式:${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”'."\n"
- ."\n"
- .'- 背景音链接:未配置时会使用默认的:http://ailabsaicloudservice.alicdn.com/tmp/a.wav',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 23,\\n \\"TotalPage\\": 3,\\n \\"HasNext\\": true\\n },\\n \\"HotelInfoList\\": [\\n {\\n \\"HotelId\\": \\"73ab1b03018d4da69b5bef17095f569b\\",\\n \\"HotelName\\": \\"酒店名称\\",\\n \\"CreateTime\\": 1654568802000,\\n \\"HotelAddress\\": \\"酒店地址\\",\\n \\"PhoneNumber\\": \\"13312340987\\",\\n \\"IndustryType\\": \\"酒店\\",\\n \\"RoomNum\\": 12,\\n \\"RelatedProductName\\": \\"测试产品\\",\\n \\"AccountNames\\": [\\n \\"testAccount\\"\\n ],\\n \\"Status\\": 1\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"85789C64-3644-56C0-9C0F-D2E0ECC227EF\\"\\n}","type":"json"}]',
+ 'title' => '酒店列表',
],
- 'PushWelcome' => [
- 'summary' => '直接推送欢迎语',
- 'path' => '/v1.0/ip/pushWelcome',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListInfraredDeviceBrands' => [
+ 'summary' => '查询红外品牌列表',
+ 'path' => '/v1.0/ip/listInfraredDeviceBrands',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- [
- 'name' => 'WelcomeText',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '配置信息 欢迎语文本',
- 'description' => '配置信息 欢迎语文本',
- 'type' => 'string',
- 'required' => true,
- 'example' => '尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。',
- ],
- ],
- [
- 'name' => 'WelcomeMusicUrl',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '配置信息 欢迎语音乐url',
- 'description' => '配置信息 欢迎语音乐url',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav',
- ],
- ],
- [
- 'name' => 'RoomNo',
+ 'name' => 'Category',
'in' => 'formData',
- 'schema' => [
- 'title' => '欢迎语推送 房间号',
- 'description' => '欢迎语推送 房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1211',
- ],
+ 'schema' => ['title' => '设备名称', 'description' => '设备名称', 'type' => 'string', 'required' => true, 'example' => '机顶盒'],
],
[
- 'name' => 'RoomName',
+ 'name' => 'ServiceProvider',
'in' => 'formData',
- 'schema' => [
- 'description' => '房间名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8022房间',
- ],
+ 'schema' => ['title' => '服务提供商(品类为机顶盒时必传)', 'description' => '服务提供商(品类为机顶盒时必传)', 'type' => 'string', 'required' => false, 'example' => '浙江省电信IPTV'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<Map<String, List<String>>>',
+ 'description' => 'Result<Map<String, List<String>>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '集合内容', 'example' => '"A":["Addsion", "Ambassador"]'],
+ 'description' => '返回的详细信息列表。',
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '直接推送欢迎语到房间设备',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"A\\\\\\":[\\\\\\"Addsion\\\\\\", \\\\\\"Ambassador\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\"\\n}","type":"json"}]',
+ 'title' => '查询红外品牌列表',
],
- 'AddMessageTemplate' => [
- 'summary' => '添加酒店消息模板',
- 'path' => '/v1.0/ip/addMessageTemplate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListInfraredRemoteControllers' => [
+ 'summary' => '查询红外码库列表',
+ 'path' => '/v1.0/ip/listInfraredRemoteControllers',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'TemplateName',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '消息模板名称',
- 'description' => '消息模板名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '测试模板',
- ],
+ 'schema' => ['description' => '酒店ID', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
],
[
- 'name' => 'TemplateDetail',
+ 'name' => 'Province',
'in' => 'formData',
- 'schema' => [
- 'title' => '消息模板内容',
- 'description' => '消息模板内容',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '这是${hotel}的一个测试模板',
- ],
+ 'schema' => ['title' => '省份'."\n"
+ .'品类为机顶盒时必传', 'description' => '省份'."\n"
+ .'品类为机顶盒时必传', 'type' => 'string', 'required' => false, 'example' => '浙江省'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Result<Long>',
- 'description' => 'Result<Long>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '消息模板ID',
- 'description' => '消息模板ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '11',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- ],
- ],
+ [
+ 'name' => 'City',
+ 'in' => 'formData',
+ 'schema' => ['title' => '城市'."\n"
+ .'品类为机顶盒时必传', 'description' => '城市'."\n"
+ .'品类为机顶盒时必传', 'type' => 'string', 'required' => false, 'example' => '杭州市'],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ [
+ 'name' => 'Category',
+ 'in' => 'formData',
+ 'schema' => ['title' => '品类', 'description' => '品类', 'type' => 'string', 'required' => true, 'example' => '机顶盒'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": 11,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
- 'title' => '添加酒店消息模板',
- ],
- 'ListHotelMessageTemplate' => [
- 'summary' => '获取酒店消息模板',
- 'path' => '/v1.0/ip/listHotelMessageTemplate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'name' => 'Brand',
+ 'in' => 'formData',
+ 'schema' => ['title' => '品牌'."\n"
+ .'品类非机顶盒必填,为机顶盒同时供应商为IPTV时必传', 'description' => '品牌'."\n"
+ .'品类非机顶盒必填,为机顶盒同时供应商为IPTV时必传', 'type' => 'string', 'required' => false, 'example' => '奥图码'],
+ ],
+ [
+ 'name' => 'ServiceProvider',
+ 'in' => 'formData',
+ 'schema' => ['title' => '服务提供商'."\n"
+ .'品类为机顶盒时必传', 'description' => '服务提供商'."\n"
+ .'品类为机顶盒时必传', 'type' => 'string', 'required' => false, 'example' => '浙江省移动IPTV'],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<ListHotelMessageTemplate>>',
- 'description' => 'Result<List<ListHotelMessageTemplate>>',
+ 'title' => 'Result<List<InfraredControlCodeResp>>',
+ 'description' => 'Result<List<InfraredControlCodeResp>>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'array',
'items' => [
+ 'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'TemplateId' => [
- 'title' => '消息模板ID',
- 'description' => '消息模板ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TemplateDetail' => [
- 'title' => '消息模板内容',
- 'description' => '消息模板内容',
- 'type' => 'string',
- 'example' => '这是${hotel}的一个测试模板',
- ],
- 'TemplateName' => [
- 'title' => '消息模板名称',
- 'description' => '消息模板名称',
- 'type' => 'string',
- 'example' => '测试模板',
- ],
- 'AuditMark' => [
- 'title' => '审核备注',
- 'description' => '审核备注',
- 'type' => 'string',
- 'example' => '不通过',
- ],
- 'AuditStatus' => [
- 'title' => '审核状态',
- 'description' => '审核状态',
- 'type' => 'string',
- 'example' => 'COMMIT',
- ],
+ 'Index' => ['title' => '当前索引', 'description' => '当前索引', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Rid' => ['title' => '遥控器编号', 'description' => '遥控器编号', 'type' => 'integer', 'format' => 'int64', 'example' => '3747'],
+ 'Version' => ['title' => '版本信息', 'description' => '版本信息', 'type' => 'string', 'example' => '4'],
],
],
],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '0C90A059-3653-5356-A78E-8A6BDA606155'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"TemplateId\\": 1,\\n \\"TemplateDetail\\": \\"这是${hotel}的一个测试模板\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"AuditMark\\": \\"不通过\\",\\n \\"AuditStatus\\": \\"COMMIT\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
- 'title' => '获取酒店消息模板',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Index\\": 1,\\n \\"Rid\\": 3747,\\n \\"Version\\": \\"4\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0C90A059-3653-5356-A78E-8A6BDA606155\\"\\n}","type":"json"}]',
+ 'title' => '查询红外码库列表',
],
- 'DeleteMessageTemplate' => [
- 'summary' => '删除消息通知模板',
- 'path' => '/v1.0/ip/deleteMessageTemplate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListSTBServiceProviders' => [
+ 'summary' => '查询服务提供商',
+ 'path' => '/v1.0/ip/listSTBServiceProviders',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'Province',
'in' => 'formData',
- 'schema' => [
- 'title' => '消息模板id',
- 'description' => '消息模板id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '234',
- ],
+ 'schema' => ['title' => '省份', 'description' => '省份', 'type' => 'string', 'required' => true, 'example' => '浙江省'],
+ ],
+ [
+ 'name' => 'City',
+ 'in' => 'formData',
+ 'schema' => ['title' => '城市', 'description' => '城市', 'type' => 'string', 'required' => true, 'example' => '杭州市'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<Map<String, List<String>>>',
+ 'description' => 'Result<Map<String, List<String>>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'F7E2****B7C94',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '返回内容', 'example' => '"Z":["浙江华数"]'],
+ 'description' => '服务的实际返回结果',
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '1036C376-7A37-5A73-BE8B-C6DB40107EC1'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]',
- 'title' => '删除通知消息模板',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"key\\": [\\n \\"\\\\\\"Z\\\\\\":[\\\\\\"浙江华数\\\\\\"]\\"\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1036C376-7A37-5A73-BE8B-C6DB40107EC1\\"\\n}","type":"json"}]',
+ 'title' => '查询服务提供商',
],
- 'UpdateMessageTemplate' => [
- 'summary' => '修改编辑消息通知模板',
- 'path' => '/v1.0/ip/updateMessageTemplate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListSceneCategory' => [
+ 'summary' => '酒店场景分类',
+ 'path' => '/v1.0/ip/listSceneCategory',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'TemplateId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模板主键id',
- 'description' => '模板主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123123',
- ],
- ],
- [
- 'name' => 'TemplateName',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模板名称',
- 'description' => '模板名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试一下',
- ],
+ 'schema' => ['title' => 'hotelId', 'description' => 'hotelId', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
[
- 'name' => 'TemplateDetail',
+ 'name' => 'Type',
'in' => 'formData',
- 'schema' => [
- 'title' => '模板详情',
- 'description' => '模板详情',
- 'type' => 'string',
- 'required' => false,
- 'example' => '模板的详情',
- ],
+ 'schema' => ['title' => '场景分类类型(物品GOODS/服务SERVICE/维修REPAIR)', 'description' => '场景分类类型(物品GOODS/服务SERVICE/维修REPAIR)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'REPAIR'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<List<String>>',
+ 'description' => 'Result<List<String>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '返回的请求id',
- 'description' => '返回的请求id',
- 'type' => 'string',
- 'example' => '43***881',
+ 'type' => 'array',
+ 'items' => ['description' => '分类名称', 'type' => 'string', 'example' => '[ "电器类", "家具类", "卫生间类" ]'],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]',
- 'title' => '修改消息通知模板',
- 'description' => '> 修改消息通知模板'."\n"
- .'> - 需要查询出模板的templateId 根据templateId然后修改其他参数',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n \\"[ \\\\\\"电器类\\\\\\", \\\\\\"家具类\\\\\\", \\\\\\"卫生间类\\\\\\" ]\\"\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '酒店场景服务分类',
],
- 'PushHotelMessage' => [
- 'summary' => '推送酒店消息',
- 'path' => '/v1.0/ip/pushHotelMessage',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListServiceQA' => [
+ 'summary' => '通用问答模块下的查询服务设施问答列表功能。',
+ 'path' => '/v1.0/ip/listServiceQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'PushHotelMessageReq',
- 'in' => 'query',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
+ ],
+ [
+ 'name' => 'Active',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '是否激活',
+ 'description' => '是否启用(true:开启、false:关闭)',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'],
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'formData',
+ 'schema' => ['description' => '关键字(用于模糊查询问题、例句、回答)', 'type' => 'string', 'required' => false, 'example' => '***'],
+ ],
+ [
+ 'name' => 'Page',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => 'pushHotelMessageReq',
- 'description' => 'pushHotelMessageReq',
+ 'description' => '分页参数',
'type' => 'object',
'properties' => [
- 'TemplateId' => [
- 'title' => '消息模板ID',
- 'description' => '消息模板ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
- 'HotelId' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f',
- ],
- 'RoomNo' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '102',
- ],
- 'ParamMap' => [
- 'title' => '消息内容参数Map',
- 'description' => '消息内容参数Map',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"hotel": "aaaa测试酒店"}',
- ],
- ],
+ 'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'PageSize' => ['description' => '每页多少条', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
- 'required' => true,
+ 'required' => false,
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'PageResult<List<IntentionQAResponse>>',
+ 'description' => 'PageResult<List<IntentionQAResponse>>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'Page' => [
+ 'title' => '翻页参数',
+ 'description' => '翻页参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页size大小', 'description' => '每页size大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ ],
],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceQAId' => ['title' => '通用问答信息', 'description' => '服务设施问答id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Question' => ['title' => '问题', 'description' => '问题', 'type' => 'string', 'example' => '测试文本'."\n"],
+ 'Answer' => ['title' => '答案', 'description' => '回答', 'type' => 'string', 'example' => '***'],
+ 'GmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2022-07-27 14:06:27'."\n"],
+ 'Active' => ['title' => '是否启用', 'description' => '是否启用(true:开启、false:关闭)', 'type' => 'boolean', 'example' => 'true'],
+ 'Templates' => ['title' => '例句列表', 'description' => '例句列表', 'type' => 'string', 'example' => '酒店有提供送餐服务吗;酒店能送餐吗;酒店送餐怎么收费'."\n"],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7***726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
- 'title' => '推送酒店自定义消息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"ServiceQAId\\": 1,\\n \\"Question\\": \\"测试文本\\\\n\\",\\n \\"Answer\\": \\"***\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\",\\n \\"Active\\": true,\\n \\"Templates\\": \\"酒店有提供送餐服务吗;酒店能送餐吗;酒店送餐怎么收费\\\\n\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
+ 'title' => '查询服务设施问答列表',
],
'ListTickets' => [
'summary' => '查询工单列表。',
'path' => '/v1.0/ip/listTickets',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
@@ -11692,12 +5702,7 @@
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
],
[
'name' => 'Page',
@@ -11707,22 +5712,8 @@
'description' => '分页参数',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页size大小',
- 'description' => '每页size大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'PageNumber' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'PageSize' => ['title' => '每页size大小', 'description' => '每页size大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
@@ -11730,22 +5721,12 @@
[
'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '开始时间,字符串格式:yyyy-mm-dd hh24:mm:ss。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-04-08 09:39:00',
- ],
+ 'schema' => ['description' => '开始时间,字符串格式:yyyy-mm-dd hh24:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2022-04-08 09:39:00'],
],
[
'name' => 'EndTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '结束时间,字符串格式:yyyy-mm-dd hh24:mm:ss。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-09-14 14:23:00',
- ],
+ 'schema' => ['description' => '结束时间,字符串格式:yyyy-mm-dd hh24:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2022-09-14 14:23:00'],
],
[
'name' => 'Status',
@@ -11754,24 +5735,14 @@
'description' => '状态:handled: 已处理, waiting:待处理, delayed:延迟处理',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'waiting' => '待处理',
- 'handled' => '已处理',
- 'delayed' => '延迟处理',
- ],
+ 'enumValueTitles' => ['waiting' => '待处理', 'handled' => '已处理', 'delayed' => '延迟处理'],
'example' => 'waiting',
],
],
[
'name' => 'RoomNo',
'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1211',
- ],
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '1211'],
],
[
'name' => 'Type',
@@ -11781,57 +5752,29 @@
'description' => '类型1:""(全部) 2:酒店服务(酒店服务) 3:酒店维修(酒店维修)',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- '""' => '全部',
- '酒店服务' => '酒店服务',
- '酒店维修' => '酒店维修',
- ],
+ 'enumValueTitles' => ['""' => '全部', '酒店服务' => '酒店服务', '酒店维修' => '酒店维修'],
'example' => '""',
],
],
[
'name' => 'IsNeedCallback',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否需要回电',
- 'description' => '是否需要回电',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '是否需要回电', 'description' => '是否需要回电', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'IsNeedCharges',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否需要收费',
- 'description' => '是否需要收费',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '是否需要收费', 'description' => '是否需要收费', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'SortField',
'in' => 'formData',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '排序字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gmtCalled',
- ],
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'gmtCalled'],
],
[
'name' => 'IsDesc',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否为降序',
- 'description' => '是否为降序',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否为降序', 'description' => '是否为降序', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -11847,35 +5790,12 @@
'description' => '翻页参数',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页size大小',
- 'description' => '每页size大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'PageNumber' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页size大小', 'description' => '每页size大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '共多少条数据', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
],
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
@@ -11884,25 +5804,9 @@
'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '主键',
- 'description' => '主键',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '45',
- ],
- 'GmtCreate' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-01-09 00:00:00',
- ],
- 'GmtModified' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '2023-01-09 00:00:00',
- ],
+ 'Id' => ['title' => '主键', 'description' => '主键', 'type' => 'integer', 'format' => 'int64', 'example' => '45'],
+ 'GmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-01-09 00:00:00'],
+ 'GmtModified' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2023-01-09 00:00:00'],
'Dialogs' => [
'title' => '单轮对话',
'description' => '单轮对话',
@@ -11911,75 +5815,29 @@
'description' => '对话',
'type' => 'object',
'properties' => [
- 'Question' => [
- 'description' => '问题。',
- 'type' => 'string',
- 'example' => '我要1份***',
- ],
- 'Answer' => [
- 'description' => '答案。',
- 'type' => 'string',
- 'example' => '好的,服务员会尽快送来。',
- ],
+ 'Question' => ['description' => '问题。', 'type' => 'string', 'example' => '我要1份***'],
+ 'Answer' => ['description' => '答案。', 'type' => 'string', 'example' => '好的,服务员会尽快送来。'],
],
],
],
- 'RoomNo' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '101',
- ],
+ 'RoomNo' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'example' => '101'],
'Type' => [
'title' => '类型',
'description' => '类型1:""(全部) 2:酒店服务(酒店服务) 3:酒店维修(酒店维修)',
'type' => 'string',
- 'enumValueTitles' => [
- '""' => '全部',
- '酒店服务' => '酒店服务',
- '酒店维修' => '酒店维修',
- ],
+ 'enumValueTitles' => ['""' => '全部', '酒店服务' => '酒店服务', '酒店维修' => '酒店维修'],
'example' => '""',
],
- 'IsNeedCallback' => [
- 'title' => '是否需要回电',
- 'description' => '是否需要回电',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'IsNeedCharges' => [
- 'title' => '是否需要收费',
- 'description' => '是否需要收费',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'IsAcceptedCharges' => [
- 'title' => '客户是否接受收费',
- 'description' => '客户是否接受收费',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'AssignedHandler' => [
- 'title' => '指派人',
- 'description' => '指派人',
- 'type' => 'string',
- 'example' => '***',
- ],
- 'Remark' => [
- 'title' => '备注',
- 'description' => '备注',
- 'type' => 'string',
- 'example' => '***',
- ],
+ 'IsNeedCallback' => ['title' => '是否需要回电', 'description' => '是否需要回电', 'type' => 'boolean', 'example' => 'false'],
+ 'IsNeedCharges' => ['title' => '是否需要收费', 'description' => '是否需要收费', 'type' => 'boolean', 'example' => 'false'],
+ 'IsAcceptedCharges' => ['title' => '客户是否接受收费', 'description' => '客户是否接受收费', 'type' => 'boolean', 'example' => 'false'],
+ 'AssignedHandler' => ['title' => '指派人', 'description' => '指派人', 'type' => 'string', 'example' => '***'],
+ 'Remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => '***'],
'Status' => [
'title' => '状态',
'description' => '状态:handled: 已处理, waiting:待处理, delayed:延迟处理',
'type' => 'string',
- 'enumValueTitles' => [
- 'waiting' => '待处理',
- 'handled' => '已处理',
- 'delayed' => '延迟处理',
- ],
+ 'enumValueTitles' => ['waiting' => '待处理', 'handled' => '已处理', 'delayed' => '延迟处理'],
'example' => 'waiting',
],
'Operations' => [
@@ -11989,1139 +5847,408 @@
'items' => [
'description' => '键值对',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => 'isOperable:是否可操作'."\n"
- .'nextStatus:下个状态'."\n"
- .'name:名称'."\n"
- .'currStatus:当前状态',
- 'example' => '"isOperable":true,'."\n"
- .'"nextStatus":"handled",'."\n"
- .'"name":"处理完成",'."\n"
- .'"currStatus":"delayed"',
- ],
+ 'additionalProperties' => ['type' => 'any', 'description' => 'isOperable:是否可操作'."\n"
+ .'nextStatus:下个状态'."\n"
+ .'name:名称'."\n"
+ .'currStatus:当前状态', 'example' => '"isOperable":true,'."\n"
+ .'"nextStatus":"handled",'."\n"
+ .'"name":"处理完成",'."\n"
+ .'"currStatus":"delayed"'],
],
],
- 'IsDelayed' => [
- 'title' => '是否延时处理',
- 'description' => '是否延时处理',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'GmtDelayed' => [
- 'title' => '延时处理时间',
- 'description' => '延时处理时间',
- 'type' => 'string',
- 'example' => '2023-01-09 00:00:00',
- ],
- 'ChargesRemark' => [
- 'title' => '收费信息备注',
- 'description' => '收费信息备注',
- 'type' => 'string',
- 'example' => '***',
- ],
- 'CompleteRemark' => [
- 'title' => '完成情况备注',
- 'description' => '完成情况备注',
- 'type' => 'string',
- 'example' => '***',
- ],
- 'GmtCalled' => [
- 'title' => '呼叫时间',
- 'description' => '呼叫时间',
- 'type' => 'string',
- 'example' => '2023-01-09 00:00:00',
- ],
- 'GroupKey' => [
- 'title' => '分组键',
- 'description' => '分组键,代表了一次对话或者一次下单操作,多轮对话使用一个groupkey,会自动合并成一条工单多条对话的形式',
- 'type' => 'string',
- 'example' => '2023***93975',
- ],
- 'Action' => [
- 'title' => '是否是操作',
- 'description' => '是否已操作',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'IsDelayed' => ['title' => '是否延时处理', 'description' => '是否延时处理', 'type' => 'boolean', 'example' => 'true'],
+ 'GmtDelayed' => ['title' => '延时处理时间', 'description' => '延时处理时间', 'type' => 'string', 'example' => '2023-01-09 00:00:00'],
+ 'ChargesRemark' => ['title' => '收费信息备注', 'description' => '收费信息备注', 'type' => 'string', 'example' => '***'],
+ 'CompleteRemark' => ['title' => '完成情况备注', 'description' => '完成情况备注', 'type' => 'string', 'example' => '***'],
+ 'GmtCalled' => ['title' => '呼叫时间', 'description' => '呼叫时间', 'type' => 'string', 'example' => '2023-01-09 00:00:00'],
+ 'GroupKey' => ['title' => '分组键', 'description' => '分组键,代表了一次对话或者一次下单操作,多轮对话使用一个groupkey,会自动合并成一条工单多条对话的形式', 'type' => 'string', 'example' => '2023***93975'],
+ 'Action' => ['title' => '是否是操作', 'description' => '是否已操作', 'type' => 'boolean', 'example' => 'false'],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7***726E',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7***726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 5\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Id\\": 45,\\n \\"GmtCreate\\": \\"2023-01-09 00:00:00\\",\\n \\"GmtModified\\": \\"2023-01-09 00:00:00\\",\\n \\"Dialogs\\": [\\n {\\n \\"Question\\": \\"我要1份***\\",\\n \\"Answer\\": \\"好的,服务员会尽快送来。\\"\\n }\\n ],\\n \\"RoomNo\\": \\"101\\",\\n \\"Type\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IsNeedCallback\\": false,\\n \\"IsNeedCharges\\": false,\\n \\"IsAcceptedCharges\\": false,\\n \\"AssignedHandler\\": \\"***\\",\\n \\"Remark\\": \\"***\\",\\n \\"Status\\": \\"waiting\\",\\n \\"Operations\\": [\\n {\\n \\"key\\": \\"\\\\\\"isOperable\\\\\\":true,\\\\n\\\\\\"nextStatus\\\\\\":\\\\\\"handled\\\\\\",\\\\n\\\\\\"name\\\\\\":\\\\\\"处理完成\\\\\\",\\\\n\\\\\\"currStatus\\\\\\":\\\\\\"delayed\\\\\\"\\"\\n }\\n ],\\n \\"IsDelayed\\": true,\\n \\"GmtDelayed\\": \\"2023-01-09 00:00:00\\",\\n \\"ChargesRemark\\": \\"***\\",\\n \\"CompleteRemark\\": \\"***\\",\\n \\"GmtCalled\\": \\"2023-01-09 00:00:00\\",\\n \\"GroupKey\\": \\"2023***93975\\",\\n \\"Action\\": false\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
'title' => '查询工单列表',
],
- 'UpdateTicket' => [
- 'summary' => '修改工单。',
- 'path' => '/v1.0/ip/updateTicket',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PageGetHotelRoomDevices' => [
+ 'summary' => '根据酒店分页查询房间主控设备',
+ 'path' => '/v1.0/ip/pageGetHotelRoomDevices',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '520a0c0***5eb',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'a7***83'],
],
[
- 'name' => 'Status',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '状态',
- 'description' => '状态:handled: 已处理, waiting:待处理, delayed:延迟处理',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'waiting' => '待处理',
- 'handled' => '已处理',
- 'delayed' => '延迟处理',
- ],
- 'example' => 'waiting',
- ],
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'GroupKey',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '分组键',
- 'description' => '分组键,代表了一次对话或者一次下单操作,多轮对话使用一个groupkey,会自动合并成一条工单多条对话的形式',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023***93975',
- ],
+ 'schema' => ['title' => '分页大小', 'description' => '分页大小,默认最大限制20', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'PageResult<List<HotelDeviceInfo>>',
+ 'description' => 'PageResult<List<HotelDeviceInfo>>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7***726E',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
- 'title' => '修改工单',
- ],
- 'DeleteHotelAlarm' => [
- 'summary' => '删除酒店闹钟,支持单个和批量删除',
- 'path' => '/v1.0/ip/deleteHotelAlarm',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AliGenie_Auth_SPI' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
- ],
- [
- 'name' => 'Alarms',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '闹钟信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '对象',
- 'type' => 'object',
- 'properties' => [
- 'RoomNo' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '101',
- ],
- 'AlarmId' => [
- 'description' => '闹钟id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5029',
- ],
- 'UserOpenId' => [
- 'description' => '开放用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'mgw/k***HQd',
- ],
- 'DeviceOpenId' => [
- 'description' => '开放设备id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PvkB***TA==',
+ 'Page' => [
+ 'title' => '翻页参数',
+ 'description' => '翻页参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'TotalPage' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Start' => ['title' => '起始序号', 'description' => '起始序号', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'End' => ['title' => '末尾序号', 'description' => '末尾序号', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'HasNext' => ['title' => '是否还有下一页', 'description' => '是否还有下一页', 'type' => 'boolean', 'example' => 'False'],
],
],
- 'required' => false,
- ],
- 'required' => true,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Result<Integer>',
- 'description' => 'Result<Integer>',
- 'type' => 'object',
- 'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的200标识成功外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的200标识成功外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'xxx为空',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Mac' => ['title' => '设备mac', 'description' => '设备mac', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'],
+ 'Sn' => ['title' => '设备sn', 'description' => '设备sn', 'type' => 'string', 'example' => '1200xxx048'],
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'a7***83'],
+ 'RoomNo' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'example' => '2001'],
+ 'OnlineStatus' => ['title' => '设备在线状态,1:在线;0:离线', 'description' => '设备在线状态,1:在线;0:离线', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FirmwareVersion' => ['title' => '设备固件版本号', 'description' => '设备固件版本号', 'type' => 'string', 'example' => 'V21.10.00.313'],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
'Extentions' => [
'title' => '扩展字段',
'description' => '扩展字段',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '""',
- 'description' => '扩展内容',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '43***881',
+ 'additionalProperties' => ['type' => 'any'],
],
+ 'RequestId' => ['title' => '请求参数', 'description' => '请求参数', 'type' => 'string', 'example' => '4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"xxx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]',
- 'title' => '删除酒店闹钟',
- 'description' => '删除酒店闹钟,支持单个和批量删除。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 5,\\n \\"TotalPage\\": 1,\\n \\"Start\\": 0,\\n \\"End\\": 4,\\n \\"HasNext\\": true\\n },\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\",\\n \\"HotelId\\": \\"a7***83\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"OnlineStatus\\": 1,\\n \\"FirmwareVersion\\": \\"V21.10.00.313\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"4EFBDDF4-B19D-526C-8C3D-CD8AB51974EE\\"\\n}","type":"json"}]',
+ 'title' => '根据酒店分页查询房间主控设备',
],
- 'ListHotelAlarm' => [
- 'summary' => '查询酒店闹钟信息',
- 'path' => '/v1.0/ip/getHotelAlarmList',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PmsEventReport' => [
+ 'summary' => 'pms事件上报',
+ 'path' => '/v1.0/ip/pmsEventReport',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a7a3***013',
- ],
- ],
- [
- 'name' => 'Rooms',
+ 'name' => 'Payload',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '房间号',
- 'type' => 'array',
- 'items' => [
- 'description' => '房间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '101',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'pms事件上报内容', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "eventId": "123342",'."\n"
+ .' "eventType": 2,'."\n"
+ .' "hotelId": "95fc******4f7b",'."\n"
+ .' "pmsPartnerName": "XX科技",'."\n"
+ .' "orderItemList": ['."\n"
+ .' {'."\n"
+ .' "orderItemId": "12345",'."\n"
+ .' "channelName": "飞猪",'."\n"
+ .' "checkinTime": "2023-04-15 12:03:20",'."\n"
+ .' "checkoutTime": "2023-04-16 11:12:04",'."\n"
+ .' "guests": ['."\n"
+ .' {'."\n"
+ .' "name": "张*",'."\n"
+ .' "familyName": "张",'."\n"
+ .' "phone": "187***0967",'."\n"
+ .' "email": "****@qq.com",'."\n"
+ .' "telephone": "0571-433**343",'."\n"
+ .' "gender": 1,'."\n"
+ .' "identityType": "idCard",'."\n"
+ .' "identityNo": "330**********3538"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "price": "318",'."\n"
+ .' "lastRoomNo": "119",'."\n"
+ .' "roomNo": "210",'."\n"
+ .' "roomTypeCode": "1023",'."\n"
+ .' "roomTypeName": "大床房",'."\n"
+ .' "status": 2'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelAlarmDetailResponse>>',
- 'description' => 'Result<List<HotelAlarmDetailResponse>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '对象',
- 'type' => 'object',
- 'properties' => [
- 'AlarmId' => [
- 'title' => '闹钟id',
- 'description' => '闹钟id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5039',
- ],
- 'UserOpenId' => [
- 'title' => '用户Id',
- 'description' => '开放用户Id',
- 'type' => 'string',
- 'example' => 'mgw/k***HQd',
- ],
- 'DeviceOpenId' => [
- 'title' => 'uuid',
- 'description' => '开放设备id',
- 'type' => 'string',
- 'example' => 'PvkB****VVTA==',
- ],
- 'ScheduleInfo' => [
- 'title' => '设置的闹钟信息',
- 'description' => '设置的闹钟信息',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY',
- 'description' => 'ONCE, WEEKLY',
- 'type' => 'string',
- 'example' => 'ONCE',
- ],
- 'Once' => [
- 'description' => '单次闹钟',
- 'type' => 'object',
- 'properties' => [
- 'Year' => [
- 'description' => '年',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2022',
- ],
- 'Month' => [
- 'description' => '月',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '9',
- ],
- 'Day' => [
- 'description' => '日',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Hour' => [
- 'description' => '时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Minute' => [
- 'description' => '分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- ],
- ],
- 'Weekly' => [
- 'description' => '周循环:循环类型为WEEKLY时,该属性可用'."\n"
- ."\n",
- 'type' => 'object',
- 'properties' => [
- 'DaysOfWeek' => [
- 'description' => '周几触发集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- 'Hour' => [
- 'description' => '触发时间:时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Minute' => [
- 'description' => '触发时间:分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'xx为空',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '""',
- 'description' => '扩展内容',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '43***881',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"AlarmId\\": 5039,\\n \\"UserOpenId\\": \\"mgw/k***HQd\\",\\n \\"DeviceOpenId\\": \\"PvkB****VVTA==\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 9,\\n \\"Day\\": 20,\\n \\"Hour\\": 10,\\n \\"Minute\\": 30\\n },\\n \\"Weekly\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n }\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]',
- 'title' => '查询酒店闹钟信息列表',
- 'description' => '查询酒店闹钟信息。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => 'pms事件同步',
],
- 'CreateHotelAlarm' => [
- 'summary' => '批量创建闹钟',
- 'path' => '/v1.0/ip/createHotelAlarm',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PushHotelMessage' => [
+ 'summary' => '推送酒店消息',
+ 'path' => '/v1.0/ip/pushHotelMessage',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '酒店Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7',
- ],
- ],
- [
- 'name' => 'Rooms',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '批量最多支持10个房间的闹钟设置,此处房间号请控制在10个以内',
- 'description' => '批量最多支持10个房间的闹钟设置,此处房间号请控制在10个以内',
- 'type' => 'array',
- 'items' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '101',
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'ScheduleInfo',
- 'in' => 'formData',
+ 'name' => 'PushHotelMessageReq',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '时间调度信息',
+ 'title' => 'pushHotelMessageReq',
+ 'description' => 'pushHotelMessageReq',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY',
- 'description' => 'ONCE, WEEKLY',
- 'type' => 'string',
- 'required' => true,
- 'example' => '调度类型',
- ],
- 'Once' => [
- 'description' => '单次闹钟',
- 'type' => 'object',
- 'properties' => [
- 'Year' => [
- 'description' => '年',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2022',
- ],
- 'Month' => [
- 'description' => '月',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '9',
- ],
- 'Day' => [
- 'description' => '日',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- 'Hour' => [
- 'description' => '时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '19',
- ],
- 'Minute' => [
- 'description' => '分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
- ],
- 'required' => false,
- ],
- 'Weekly' => [
- 'description' => '周循环',
+ 'TemplateId' => ['title' => '消息模板ID', 'description' => '消息模板ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'],
+ 'HotelId' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'],
+ 'RoomNo' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '102'],
+ 'ParamMap' => [
+ 'title' => '消息内容参数Map',
+ 'description' => '消息内容参数Map',
'type' => 'object',
- 'properties' => [
- 'DaysOfWeek' => [
- 'description' => '周几触发',
- 'type' => 'array',
- 'items' => [
- 'description' => '周几',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
- 'Hour' => [
- 'description' => '小时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'Minute' => [
- 'description' => '分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
- ],
'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'example' => '{"hotel": "aaaa测试酒店"}'],
],
],
'required' => true,
],
],
- [
- 'name' => 'MusicType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '目前支持 (DOU_YIN, JING_DIAN)',
- 'description' => '目前支持 (DOU_YIN, JING_DIAN)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DOU_YIN',
- 'enum' => [
- 'DOU_YIN',
- 'JING_DIAN',
- ],
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelAlarmResponse>>',
- 'description' => 'Result<List<HotelAlarmResponse>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'RoomNo' => [
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '101',
- ],
- 'AlarmId' => [
- 'description' => '闹钟id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '94',
- ],
- 'DeviceOpenId' => [
- 'description' => '开放设备id',
- 'type' => 'string',
- 'example' => 'Pvk***TA==',
- ],
- 'UserOpenId' => [
- 'description' => '开放用户id',
- 'type' => 'string',
- 'example' => 'mg***Qd',
- ],
- 'FailMsg' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '设备离线,闹钟创建失败',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'xx为空',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '""',
- 'description' => '扩展内容',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***86881',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean'],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"101\\",\\n \\"AlarmId\\": 94,\\n \\"DeviceOpenId\\": \\"Pvk***TA==\\",\\n \\"UserOpenId\\": \\"mg***Qd\\",\\n \\"FailMsg\\": \\"设备离线,闹钟创建失败\\"\\n }\\n ],\\n \\"Message\\": \\"xx为空\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"43***86881\\"\\n}","type":"json"}]',
- 'title' => '创建酒店闹钟',
- 'description' => '批量创建闹钟。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => '推送酒店自定义消息',
],
- 'UpdateHotelAlarm' => [
- 'summary' => '修改酒店闹钟',
- 'path' => '/v1.0/ip/updateHotelAlarm',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PushVoiceBoxCommands' => [
+ 'summary' => '推送音箱指令',
+ 'path' => '/v1.0/ip/pushVoiceBoxCommands',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7a381a668bc485980bed3876a75e013',
- ],
+ 'schema' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'example' => 'a4d9a9cfcdef4c39b2b1a9724eae906b'],
],
[
- 'name' => 'Alarms',
+ 'name' => 'RoomNo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '111'],
+ ],
+ [
+ 'name' => 'Commands',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '闹钟信息',
+ 'title' => '命令列表',
+ 'description' => '命令列表',
'type' => 'array',
'items' => [
+ 'title' => '',
'type' => 'object',
'properties' => [
- 'RoomNo' => [
- 'description' => '房间号',
+ 'CommandDomain' => ['title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'required' => true, 'example' => 'AliGenie.Video.Control'],
+ 'CommandName' => ['title' => '指令名称', 'description' => '指令名称', 'type' => 'string', 'required' => true, 'example' => 'Pause'],
+ 'Payload' => [
+ 'title' => '指令参数',
+ 'description' => '指令参数',
'type' => 'string',
'required' => false,
- 'example' => '101',
- ],
- 'AlarmId' => [
- 'description' => '闹钟ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1234567',
- ],
- 'UserOpenId' => [
- 'description' => '开放用户ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'mgw/***dHQd',
- ],
- 'DeviceOpenId' => [
- 'description' => '开放设备ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Pvk***VTA==',
+ 'enumValueTitles' => [],
+ 'example' => '可为空',
],
],
- 'required' => false,
+ 'required' => true,
],
'required' => true,
- ],
- ],
- [
- 'name' => 'ScheduleInfo',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '闹钟定时信息',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY',
- 'description' => 'ONCE, WEEKLY',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ONCE',
- ],
- 'Once' => [
- 'description' => '一次',
- 'type' => 'object',
- 'properties' => [
- 'Year' => [
- 'description' => '年',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2022',
- ],
- 'Month' => [
- 'description' => '月',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '9',
- ],
- 'Day' => [
- 'description' => '日',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- 'Hour' => [
- 'description' => '时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'Minute' => [
- 'description' => '分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- ],
- 'Weekly' => [
- 'description' => '周循环:循环类型为WEEKLY时,该属性可用'."\n"
- ."\n",
- 'type' => 'object',
- 'properties' => [
- 'DaysOfWeek' => [
- 'description' => '周几触发集合'."\n"
- ."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
- 'Hour' => [
- 'description' => '时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'Minute' => [
- 'description' => '分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
+ 'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Integer>',
- 'description' => 'Result<Integer>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => '""',
- 'description' => '扩展内容',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => '调用返回码 pop返回使用', 'description' => '调用返回码 pop返回使用', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'null'],
+ 'RequestId' => ['title' => '', 'description' => '无', 'type' => 'string', 'example' => 'null'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
- 'title' => '修改酒店闹钟',
- 'description' => '修改酒店闹钟。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"null\\"\\n}","type":"json"}]',
+ 'title' => '推送音箱指令',
+ 'requestParamsDescription' => '**commands:**'."\n"
+ ."\n"
+ .'当前支持的指令'."\n"
+ .'| / | commandDomain | commandName | payload |'."\n"
+ .'| ---- | ---- | ---- | ---- |'."\n"
+ .'| 带屏设备暂停指令 | AliGenie.Video.Control | Pause | 可为空 |'."\n"
+ .'| 无屏设备暂停指令 | AliGenie.System.Control | Pause | 可为空 |'."\n"
+ .'| 息屏指令 | AliGenie.Screen | UnlitScreen | 可为空 |'."\n"
+ .'| 亮屏指令 | AliGenie.Screen | LightScreen | 可为空 |',
],
- 'ChildAccountAuth' => [
- 'summary' => '酒店子账号授权。',
- 'path' => '/v1.0/ip/childAccountAuth',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PushWelcome' => [
+ 'summary' => '直接推送欢迎语',
+ 'path' => '/v1.0/ip/pushWelcome',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Account',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '淘宝账号名称',
- 'description' => '淘宝账号名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'lee',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
],
[
- 'name' => 'TbOpenId',
+ 'name' => 'WelcomeText',
'in' => 'formData',
- 'schema' => [
- 'title' => '淘宝开放id',
- 'description' => '淘宝开放id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AAEV***E3d3Z2ETwh',
- ],
+ 'schema' => ['title' => '配置信息 欢迎语文本', 'description' => '配置信息 欢迎语文本', 'type' => 'string', 'required' => true, 'example' => '尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。'],
],
[
- 'name' => 'AppKey',
+ 'name' => 'WelcomeMusicUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '开放平台appKey',
- 'description' => '开放平台appKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => '30471753',
- ],
+ 'schema' => ['title' => '配置信息 欢迎语音乐url', 'description' => '配置信息 欢迎语音乐url', 'type' => 'string', 'required' => false, 'example' => 'http://ailabsaicloudservice.alicdn.com/tmp/a.wav'],
],
[
- 'name' => 'HotelId',
+ 'name' => 'RoomNo',
'in' => 'formData',
- 'schema' => [
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
+ 'schema' => ['title' => '欢迎语推送 房间号', 'description' => '欢迎语推送 房间号', 'type' => 'string', 'required' => false, 'example' => '1211'],
+ ],
+ [
+ 'name' => 'RoomName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '房间名', 'type' => 'string', 'required' => false, 'example' => '8022房间'],
],
],
'responses' => [
@@ -13131,251 +6258,66 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Extentions' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'description' => '扩展字段',
- ],
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '3DB51A10-327C-58D3-91DF-3A5A471C51E7',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"3DB51A10-327C-58D3-91DF-3A5A471C51E7\\"\\n}","type":"json"}]',
- 'title' => '子账号授权',
- 'description' => '酒店子账号授权。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '直接推送欢迎语到房间设备',
],
- 'RemoveChildAccountAuth' => [
- 'summary' => '删除子账号授权',
- 'path' => '/v1.0/ip/removeChildAccountAuth',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PushWelcomeTextAndMusic' => [
+ 'summary' => '推送欢迎语播报',
+ 'path' => '/v1.0/ip/pushWelcomeTextAndMusic',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'TbOpenId',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '授权人(平台登录用户)淘宝开放id',
- 'description' => '授权人(平台登录用户)淘宝开放id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AAEV***E3d3Z2ETwh',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
],
[
- 'name' => 'AppKey',
+ 'name' => 'RoomNo',
'in' => 'formData',
- 'schema' => [
- 'title' => 'top开放平台appKey',
- 'description' => 'top开放平台appKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => '30**53',
- ],
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '1211'],
],
[
- 'name' => 'ChildAccountName',
+ 'name' => 'RoomName',
'in' => 'formData',
- 'schema' => [
- 'title' => '被授权账号的淘宝账号名称',
- 'description' => '被授权账号的淘宝账号名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tbxxxx',
- ],
+ 'schema' => ['description' => '房间名', 'type' => 'string', 'required' => false, 'example' => '8022房间'],
],
[
- 'name' => 'HotelId',
+ 'name' => 'TemplateVariable',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'af7***536',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => '参数映射表,例如欢迎语文本中的表达式:${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”',
+ 'description' => '参数映射表,例如欢迎语文本中的表达式:${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”',
'type' => 'object',
- 'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,200标识为成功,非200详细见错误码表',
- 'description' => '调用返回码,200标识为成功,非200详细见错误码表',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'F12B***F34E',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B***F34E\\"\\n}","type":"json"}]',
- 'title' => '删除子账号授权',
- ],
- 'PmsEventReport' => [
- 'summary' => 'pms事件上报',
- 'path' => '/v1.0/ip/pmsEventReport',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AliGenie_Auth_SPI' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'Payload',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'pms事件上报内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{'."\n"
- .' "eventId": "123342",'."\n"
- .' "eventType": 2,'."\n"
- .' "hotelId": "95fc******4f7b",'."\n"
- .' "pmsPartnerName": "XX科技",'."\n"
- .' "orderItemList": ['."\n"
- .' {'."\n"
- .' "orderItemId": "12345",'."\n"
- .' "channelName": "飞猪",'."\n"
- .' "checkinTime": "2023-04-15 12:03:20",'."\n"
- .' "checkoutTime": "2023-04-16 11:12:04",'."\n"
- .' "guests": ['."\n"
- .' {'."\n"
- .' "name": "张*",'."\n"
- .' "familyName": "张",'."\n"
- .' "phone": "187***0967",'."\n"
- .' "email": "****@qq.com",'."\n"
- .' "telephone": "0571-433**343",'."\n"
- .' "gender": 1,'."\n"
- .' "identityType": "idCard",'."\n"
- .' "identityNo": "330**********3538"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "price": "318",'."\n"
- .' "lastRoomNo": "119",'."\n"
- .' "roomNo": "210",'."\n"
- .' "roomTypeCode": "1023",'."\n"
- .' "roomTypeName": "大床房",'."\n"
- .' "status": 2'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
+ 'required' => false,
+ 'additionalProperties' => ['type' => 'string', 'description' => '模板变量', 'example' => '{"name": "李先生"}'],
],
],
],
@@ -13383,83 +6325,55 @@
200 => [
'schema' => [
'title' => 'Result<Boolean>',
- 'description' => 'Schema of Response',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识为成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'example' => ' *', 'description' => '扩展信息'],
],
+ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'F7E2****B7C94'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => 'pms事件同步',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" *\\"\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","type":"json"}]',
+ 'title' => '推送欢迎语播报',
+ 'description' => '推送欢迎语播报:'."\n"
+ .'- 欢迎语文本:'."\n"
+ .' - 未配置欢迎语时会直接使用默认的:”尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。“'."\n"
+ .' - 如欢迎语文本中的表达式:${hotelName} 可通过参数映射表的{"hotelName":"智慧酒店"}替换成“智慧酒店”'."\n"
+ ."\n"
+ .'- 背景音链接:未配置时会使用默认的:http://ailabsaicloudservice.alicdn.com/tmp/a.wav',
],
'QueryDeviceStatus' => [
'summary' => '查询客控设备状态,例如灯的开关状态,空调当前设定的温度等,也可查询部分模式的状态,例如勿扰模式(需ISV提前支持)',
'path' => '/v1.0/ip/queryDeviceStatus',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Payload',
@@ -13476,49 +6390,27 @@
'description' => '位置设备信息',
'type' => 'object',
'properties' => [
- 'Location' => [
- 'description' => '位置信息,如'."\n"
- ."\n"
- .'- room:房间'."\n"
- .'- livingroom:客厅',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'room',
- ],
- 'DeviceNumber' => [
- 'description' => '设备编号',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'night_light',
- ],
- 'DeviceType' => [
- 'description' => '设备类型,如'."\n"
- ."\n"
- .'- light:灯'."\n"
- .'- aircondition:空调',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'light',
- ],
+ 'Location' => ['description' => '位置信息,如'."\n"
+ ."\n"
+ .'- room:房间'."\n"
+ .'- livingroom:客厅', 'type' => 'string', 'required' => false, 'example' => 'room'],
+ 'DeviceNumber' => ['description' => '设备编号', 'type' => 'string', 'required' => false, 'example' => 'night_light'],
+ 'DeviceType' => ['description' => '设备类型,如'."\n"
+ ."\n"
+ .'- light:灯'."\n"
+ .'- aircondition:空调', 'type' => 'string', 'required' => false, 'example' => 'light'],
],
'required' => false,
],
'required' => false,
],
- 'UserId' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'UserId' => ['type' => 'string', 'required' => true],
'Properties' => [
'description' => '额外信息,如模式相关数据',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'mode',
- 'description' => '例如模式等查询场景传参:'."\n"
- .'mode: dnd',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'mode', 'description' => '例如模式等查询场景传参:'."\n"
+ .'mode: dnd'],
],
],
'required' => false,
@@ -13532,39 +6424,14 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写 **HOTEL**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'EncodeType' => ['description' => '编码类型,此处填写 **HOTEL**。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => false,
],
@@ -13577,13 +6444,7 @@
'description' => '返回结果对象',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200表示成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200表示成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
@@ -13591,1267 +6452,977 @@
'items' => [
'description' => '设备状态信息',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value',
- 'description' => '设备状态信息',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'value', 'description' => '设备状态信息'],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'fdsgrefds',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'fdsgrefds'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"key\\": \\"value\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"fdsgrefds\\"\\n}","type":"json"}]',
'title' => '查询客控设备状态',
],
- 'ListHotelControlDevice' => [
- 'summary' => '酒店设备列表',
- 'path' => '/v1.0/ip/listHotelControlDevice',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'QueryHotelRoomDetail' => [
+ 'summary' => '房间详情查询,查询包含酒店信息、客控信息、猫精设备信息、客需信息等',
+ 'path' => '/v1.0/ip/queryHotelRoomDetail',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'EncodeKey' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'IdType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'Id' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'OrganizationId' => [
- 'type' => 'string',
- ],
- ],
- ],
+ 'name' => 'Mac',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备mac地址'."\n"
+ .'注:在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', 'description' => '设备mac地址'."\n"
+ .'注:若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n"
+ .'传入mac uuid sn其中一个 则酒店id和房间号可不传', 'type' => 'string', 'required' => false, 'example' => '38:c8:**:**:f5:22'],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备uuid,可在App中查看'."\n"
+ .'注:在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', 'description' => '设备uuid,可在App中查看'."\n"
+ .'注:若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n"
+ .'传入mac uuid sn其中一个 则酒店id和房间号可不传', 'type' => 'string', 'required' => false, 'example' => '588***96j5WU'],
+ ],
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id'."\n"
+ .'注:传入设备mac/sn/uuid 可不传酒店id 若都未传 则 酒店id必传', 'description' => '酒店id'."\n"
+ .'注:使用酒店id 房间号查询 查询优先级低于传入设备sn mac uuid,若sn mac uuid都未传 则酒店id必传', 'type' => 'string', 'required' => false, 'example' => '520a0c0***5eb'],
+ ],
+ [
+ 'name' => 'RoomNo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '房间号'."\n"
+ .'注:传入设备mac/sn/uuid 可不传房间号 若都未传 则 房间号必传', 'description' => '房间号'."\n"
+ .'注:使用酒店id 房间号查询 查询优先级低于传入设备sn mac uuid,若sn mac uuid都未传 则房间号必传', 'type' => 'string', 'required' => false, 'example' => '1211'],
+ ],
+ [
+ 'name' => 'Sn',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备sn信息'."\n"
+ .'在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询', 'description' => '设备sn信息'."\n"
+ .'注:若在mac uuid sn全都输入的情况下 按照输入正确的内容查询 若全输入都是正确的 则 按照 uuid > mac > sn 优先级查询'."\n"
+ .'传入mac uuid sn其中一个 则酒店id和房间号可不传', 'type' => 'string', 'required' => false, 'example' => '280**28'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>',
+ 'title' => 'Result<HotelRoomDetail>',
+ 'description' => 'Result<HotelRoomDetail>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
+ 'description' => '服务的实际返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'a7***83'],
+ 'HotelName' => ['title' => '酒店名称', 'description' => '酒店名称', 'type' => 'string', 'example' => 'xx酒店'],
+ 'CreatorAccountName' => ['title' => '酒店创建者账号名称', 'description' => '酒店创建者账号名称', 'type' => 'string', 'example' => 'xx淘宝昵称'],
+ 'ConnectType' => ['title' => '酒店链接类型,rcu/mesh', 'description' => '酒店连接类型,rcu/mesh', 'type' => 'string', 'example' => 'rcu'],
+ 'RoomNo' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'example' => '2001'],
+ 'RoomControlInfo' => [
+ 'title' => '客控信息',
+ 'description' => '客控信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['title' => '房型id', 'description' => '房型id', 'type' => 'integer', 'format' => 'int64', 'example' => '1170'],
+ 'TemplateName' => ['title' => '房型名称', 'description' => '房型名称', 'type' => 'string', 'example' => '大床房'],
+ 'AppId' => ['title' => '云云对接应用id', 'description' => '云云对接应用id', 'type' => 'integer', 'format' => 'int64', 'example' => '78'],
+ 'AppName' => ['title' => '云云对接应用名称', 'description' => '云云对接应用名称', 'type' => 'string', 'example' => 'app'],
+ 'RcuUrl' => ['title' => 'rcu云云调用链接', 'description' => 'rcu云云调用链接', 'type' => 'string', 'example' => 'http://www.xxx.com'],
+ 'DeviceInfos' => [
+ 'title' => '客控设备信息列表',
+ 'description' => '客控设备信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '客控设备信息',
+ 'description' => '客控设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceName' => ['title' => '设备别名', 'description' => '设备别名', 'type' => 'string', 'example' => '阅读灯'],
+ 'CategoryId' => ['title' => '品类id', 'description' => '品类id', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'CategoryEnName' => ['title' => '品类英文名', 'description' => '品类英文名', 'type' => 'string', 'example' => 'light'],
+ 'CategoryName' => ['title' => '品类中文名', 'description' => '品类中文名', 'type' => 'string', 'example' => '灯'],
+ 'LocationId' => ['title' => '位置id', 'description' => '位置id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'LocationEnName' => ['title' => '位置英文名', 'description' => '位置英文名', 'type' => 'string', 'example' => 'room'],
+ 'LocationName' => ['title' => '位置中文名', 'description' => '位置中文名', 'type' => 'string', 'example' => '房间'],
+ 'DeviceId' => ['title' => '设备唯一编号', 'description' => '设备唯一编号', 'type' => 'string', 'example' => 'readLight'],
+ 'DeviceConnectType' => ['title' => '设备链接类型,rcu/mesh/红外', 'description' => '设备链接类型:'."\n"
+ .'- rcu:云云对接'."\n"
+ .'- mesh:本地直连'."\n"
+ .'- infrared:红外对接', 'type' => 'string', 'example' => 'rcu'],
+ 'ProductKey' => ['title' => 'mesh产品pk', 'description' => 'mesh产品pk', 'type' => 'string', 'example' => 'a1ueWGP6W2L'],
+ 'DeviceCount' => ['title' => '设备数量', 'description' => '设备数量', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AuthAccounts' => [
+ 'title' => '授权账号列表',
+ 'description' => '授权账号列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountName' => ['title' => '账号名称', 'description' => '账号名称', 'type' => 'string', 'example' => 'xx淘宝昵称'],
+ 'AuthTime' => ['title' => '授权时间', 'description' => '授权时间', 'type' => 'string', 'example' => '2023-01-01 12:00:00'],
+ ],
+ ],
+ ],
+ 'DeviceInfos' => [
+ 'title' => '猫精设备列表',
+ 'description' => '猫精设备列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Uuid' => ['title' => '猫精设备唯一标识uuid', 'description' => '猫精设备唯一标识uuid', 'type' => 'string', 'example' => '41c95c18a0a643bcb58edf438877def5'],
+ 'DeviceName' => ['title' => '设备名称', 'description' => '设备名称', 'type' => 'string', 'example' => 'IN糖酒店版'],
+ 'OnlineStatus' => ['title' => '设备在线状态,1:在线,0:离线', 'description' => '设备在线状态,1:在线,0:离线', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Mac' => ['title' => '设备mac地址', 'description' => '设备mac地址', 'type' => 'string', 'example' => 'fa:03:23:58:c3:00'],
+ 'Sn' => ['title' => '设备sn号', 'description' => '设备sn号', 'type' => 'string', 'example' => 'sag42dlz4qf'],
+ 'FirmwareVersion' => ['title' => '设备固件版本', 'description' => '设备固件版本', 'type' => 'string', 'example' => '6.1.8-RS-20230425.1806'],
+ 'ActiveTime' => ['title' => '设备激活时间', 'description' => '设备激活时间', 'type' => 'string', 'example' => '2023-01-01 12:00:00'],
+ ],
+ ],
+ ],
+ 'RoomServiceInfo' => [
+ 'title' => '客需服务信息',
+ 'description' => '客需服务信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomServiceCnt' => ['title' => '已配置服务数量,如洗衣服务', 'description' => '已配置服务数量,如洗衣服务', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'RepairServiceCnt' => ['title' => '已配置维修数量,如电视坏了', 'description' => '已配置维修数量,如电视坏了', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'GoodsServiceCnt' => ['title' => '已配置物品数量,如我要包纸巾', 'description' => '已配置物品数量,如我要包纸巾', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'BookServiceCnt' => ['title' => '已配置预定数量,如预定个spa', 'description' => '已配置预定数量,如预定个spa', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ ],
+ 'OtherService' => [
+ 'title' => '其他信息',
+ 'description' => '其他信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenCall' => ['title' => '是否开通通话', 'description' => '是否开通通话', 'type' => 'boolean', 'example' => 'false'],
+ 'UnhandleTickets' => ['title' => '剩余未处理工单数', 'description' => '剩余未处理工单数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"HotelName\\": \\"xx酒店\\",\\n \\"CreatorAccountName\\": \\"xx淘宝昵称\\",\\n \\"ConnectType\\": \\"rcu\\",\\n \\"RoomNo\\": \\"2001\\",\\n \\"RoomControlInfo\\": {\\n \\"TemplateId\\": 1170,\\n \\"TemplateName\\": \\"大床房\\",\\n \\"AppId\\": 78,\\n \\"AppName\\": \\"app\\",\\n \\"RcuUrl\\": \\"http://www.xxx.com\\",\\n \\"DeviceInfos\\": [\\n {\\n \\"DeviceName\\": \\"阅读灯\\",\\n \\"CategoryId\\": 3,\\n \\"CategoryEnName\\": \\"light\\",\\n \\"CategoryName\\": \\"灯\\",\\n \\"LocationId\\": 1,\\n \\"LocationEnName\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"DeviceId\\": \\"readLight\\",\\n \\"DeviceConnectType\\": \\"rcu\\",\\n \\"ProductKey\\": \\"a1ueWGP6W2L\\",\\n \\"DeviceCount\\": 4\\n }\\n ]\\n },\\n \\"AuthAccounts\\": [\\n {\\n \\"AccountName\\": \\"xx淘宝昵称\\",\\n \\"AuthTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"DeviceInfos\\": [\\n {\\n \\"Uuid\\": \\"41c95c18a0a643bcb58edf438877def5\\",\\n \\"DeviceName\\": \\"IN糖酒店版\\",\\n \\"OnlineStatus\\": 1,\\n \\"Mac\\": \\"fa:03:23:58:c3:00\\",\\n \\"Sn\\": \\"sag42dlz4qf\\",\\n \\"FirmwareVersion\\": \\"6.1.8-RS-20230425.1806\\",\\n \\"ActiveTime\\": \\"2023-01-01 12:00:00\\"\\n }\\n ],\\n \\"RoomServiceInfo\\": {\\n \\"RoomServiceCnt\\": 12,\\n \\"RepairServiceCnt\\": 10,\\n \\"GoodsServiceCnt\\": 10,\\n \\"BookServiceCnt\\": 0\\n },\\n \\"OtherService\\": {\\n \\"OpenCall\\": false,\\n \\"UnhandleTickets\\": 0\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '房间详情查询',
+ 'description' => '提供几类查询方式:'."\n"
+ .'- 酒店id+房间号:查询酒店相关信息及房间下所有猫精设备信息'."\n"
+ .'- 猫精设备uuid:查询单台猫精设备信息及该设备对应的酒店相关信息'."\n"
+ .'- 猫精设备mac:查询单台猫精设备信息及该设备对应的酒店相关信息'."\n"
+ .'- 猫精设备sn:查询单台猫精设备信息及该设备对应的酒店相关信息',
],
- 'DeviceControl' => [
- 'summary' => '酒店客控设备控制,可控制例如灯、空调、窗帘等房间内的客控设备',
- 'path' => '/v1.0/ip/deviceControl',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'QueryRoomControlDevices' => [
+ 'summary' => '查询房间客控设备列表,不包含状态等信息',
+ 'path' => '/v1.0/ip/queryRoomControlDevices',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
+ 'name' => 'HotelId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '业务参数',
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'title' => '',
- 'type' => 'string',
- ],
- 'Location' => [
- 'description' => '位置,例如room(房间),livingroom(客厅)等',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'room',
- 'title' => '位置,例如room(房间),livingroom(客厅)等',
- ],
- 'Category' => [
- 'description' => '客控设备品类,例如aircondition(空调),light(灯)等',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aircondition',
- 'title' => '客控设备品类,例如aircondition(空调),light(灯)等',
- ],
- 'Cmd' => [
- 'description' => '指令名称,例如open,close,详细支持指令见酒店行业对接文档',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'open',
- 'title' => '指令名称,例如open,close,详细支持指令见酒店行业对接文档',
- ],
- 'Properties' => [
- 'description' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value',
- 'description' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档',
- 'title' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档',
- ],
- 'title' => '可选配置,执行部分指令时需要附加的参数,例如设置空调温度时,需要附加需要调到的温度值,详细参数见酒店行业对接文档',
- ],
- 'ExtendInfo' => [
- 'description' => '扩展信息,预留字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- 'title' => '扩展信息,预留字段',
- ],
- 'DeviceNumber' => [
- 'description' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'air_condition',
- 'title' => '设备编号,即在天猫精灵行业管理平台房型客控品类设置下设备的序列号',
- ],
- ],
- 'required' => false,
- 'title' => '业务参数',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
],
[
- 'name' => 'UserInfo',
+ 'name' => 'RoomNo',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '用户标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写 **HOTEL**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- 'title' => '编码类型,此处填写 **HOTEL**。',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- 'title' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型 '."\n"
- .'- OPEN_ID:默认的用户ID标识 '."\n"
- .'- UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'title' => '用户Id的类型'."\n"
- ."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- 'title' => '用户标识,设置为userOpenId或userUnionId。',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- ],
- ],
- 'required' => false,
- 'title' => '用户标识信息',
- ],
+ 'schema' => ['description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果对象',
+ 'title' => 'Result<List<ListHotelMessageTemplate>>',
'description' => '返回结果对象',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,200表示成功',
- 'description' => '调用返回码,200表示成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '业务执行结果状态,200为执行成功',
- 'type' => 'string',
- 'example' => '200',
- 'title' => '业务执行结果状态,200为执行成功',
+ 'description' => '客控设备列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Location' => ['description' => '位置信息,如room', 'type' => 'string', 'example' => 'room'],
+ 'LocationName' => ['description' => '位置名称,如"房间"', 'type' => 'string', 'example' => '房间'],
+ 'Devices' => [
+ 'description' => '设备列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '设备类型,如'."\n"
+ ."\n"
+ .'- light:灯'."\n"
+ .'- aircondition:空调', 'type' => 'string', 'example' => 'light'],
+ 'Number' => ['description' => '设备编号', 'type' => 'string', 'example' => 'night_light'],
+ 'DeviceName' => ['description' => '设备名称,如"小夜灯"', 'type' => 'string', 'example' => '小夜灯'],
+ 'ConnectType' => ['title' => '设备连接类型:rcu/infrared', 'description' => '设备连接类型', 'type' => 'string', 'example' => 'rcu:RCU设备'."\n"
+ .'infrared:红外设备'],
+ 'PK' => ['description' => 'Mesh设备三元组的 pid', 'type' => 'string', 'example' => '50255129'],
+ 'DN' => ['description' => 'Mesh设备三元组的 deviceName', 'type' => 'string', 'example' => '3c5d2ab8f9ec'],
+ 'DeviceStatus' => ['description' => '设备状态', 'type' => 'string', 'example' => '{"powerstate": "1"}'],
+ 'AliasList' => [
+ 'description' => '设备别名列表',
+ 'type' => 'array',
+ 'items' => ['description' => '设备别名', 'type' => 'string', 'example' => '卫生间灯'],
+ ],
+ 'MultiKeySwitchExt' => [
+ 'description' => '多键开关类设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'SwitchList' => [
+ 'description' => '开关列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceIndex' => ['description' => '多键开关类设备的设备序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ElementCode' => ['description' => '多 element 设备对应的 elementCode', 'type' => 'string', 'example' => 'e2'],
+ 'Category' => ['description' => '设备品类', 'type' => 'string', 'example' => 'light'],
+ 'Location' => ['description' => '位置信息', 'type' => 'string', 'example' => 'room'],
+ 'DeviceName' => ['description' => '设备别名', 'type' => 'string', 'example' => '廊灯'],
+ 'DeviceStatus' => ['description' => '设备状态', 'type' => 'string', 'example' => '{'."\n"
+ .' "powerstate": "0"'."\n"
+ .'}'],
+ 'AliasList' => [
+ 'description' => '子设备的别名列表',
+ 'type' => 'array',
+ 'items' => ['description' => '设备别名', 'type' => 'string', 'example' => '卫生间灯'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
- 'title' => '请求id',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'fdsgfdscvre'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Status\\": \\"200\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<DeviceControlResponse>\\n <Code>200</Code>\\n <Result>\\n <Status>200</Status>\\n </Result>\\n <Message>success</Message>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</DeviceControlResponse>","errorExample":""}]',
- 'title' => '酒店客控-设备控制',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"ConnectType\\": \\"rcu:RCU设备\\\\ninfrared:红外设备\\",\\n \\"PK\\": \\"50255129\\",\\n \\"DN\\": \\"3c5d2ab8f9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"fdsgfdscvre\\"\\n}","type":"json"}]',
+ 'title' => '查询房间客控设备',
],
- 'ListHotelSceneItem' => [
- 'summary' => '查询酒店场景服务项列表,如物品服务的服务项列表',
- 'path' => '/v1.0/ip/listHotelSceneItem',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'QueryRoomControlDevicesAndStatus' => [
+ 'summary' => '查询房间被控设备包含设备状态',
+ 'path' => '/v1.0/ip/queryRoomControlDevicesAndStatus',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'Payload',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '场景服务payload',
- 'description' => '场景服务payload',
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'title' => '用户ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1345480696877233314',
- ],
- 'Type' => [
- 'title' => '场景服务分类',
- 'description' => '场景服务分类',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GOODS',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => false, 'example' => ' '."\n"
+ .'af7***536'."\n"],
],
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
+ 'name' => 'RoomNo',
+ 'in' => 'formData',
+ 'schema' => ['description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '1211'."\n"],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '用户信息',
- 'description' => '用户信息',
+ 'title' => 'Result<List<LocationDevices>>',
+ 'description' => 'Result<List<LocationDevices>>',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码Key',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1248494721591392955',
- ],
- 'IdType' => [
- 'description' => 'id类型',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => 'id',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => '调用返回码 pop返回使用', 'description' => '调用返回码 pop返回使用', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => [
+ 'title' => '服务的实际返回结果',
+ 'description' => '服务的实际返回结果',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '设备内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomNo' => ['description' => '房间号', 'type' => 'string', 'example' => '1211'],
+ 'Location' => ['title' => '*', 'description' => '位置信息,如room', 'type' => 'string', 'example' => 'room'],
+ 'LocationName' => ['title' => '位置中文', 'description' => '位置中文', 'type' => 'string', 'example' => '房间'],
+ 'Devices' => [
+ 'description' => '设备列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnectType' => ['title' => '设备连接类型', 'description' => '设备连接类型', 'type' => 'string', 'example' => 'rcu'],
+ 'Name' => ['title' => '品类英文', 'description' => '设备类型,如'."\n"
+ ."\n"
+ .'light:灯'."\n"
+ .'aircondition:空调', 'type' => 'string', 'example' => 'light'],
+ 'Number' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'night_light'],
+ 'DeviceName' => ['description' => '设备名称,如"小夜灯"', 'type' => 'string', 'example' => '小夜灯'],
+ 'Brand' => ['title' => '红外参数', 'description' => '红外参数', 'type' => 'string', 'example' => '奥*斯'],
+ 'ServiceProvider' => ['description' => '服务提供商(红外设备信息)', 'type' => 'string', 'example' => '吉视传媒****'],
+ 'Province' => ['description' => '省份(红外设备信息)', 'type' => 'string', 'example' => '吉林省'],
+ 'City' => ['description' => '城市(红外设备信息)', 'type' => 'string', 'example' => '松原市'],
+ 'InfraredIndex' => ['description' => '红外码库index', 'type' => 'string', 'example' => '2'],
+ 'InfraredId' => ['description' => '红外码库id', 'type' => 'string', 'example' => '9**7'],
+ 'InfraredVersion' => ['description' => '红外码库版本号', 'type' => 'string', 'example' => '3.0'],
+ 'Pk' => ['title' => 'mesh 设备参数', 'description' => 'Mesh设备三元组的 pid', 'type' => 'string', 'example' => '50255129'],
+ 'Dn' => ['description' => 'Mesh设备三元组的 deviceName', 'type' => 'string', 'example' => '3c5d***9ec'],
+ 'DeviceStatus' => ['title' => '设备状态', 'description' => '设备状态', 'type' => 'string', 'example' => '{"powerstate": "1"}'],
+ 'MultiKeySwitchExt' => [
+ 'title' => '多键开关子设备信息',
+ 'description' => '多键开关子设备信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'SwitchList' => [
+ 'title' => '开关按键列表',
+ 'description' => '开关按键列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['title' => '关联的设备品类英文名', 'description' => '关联的设备品类英文名', 'type' => 'string', 'example' => 'light'],
+ 'Location' => ['title' => '关联的设备位置', 'description' => '关联的设备位置', 'type' => 'string', 'example' => 'room'],
+ 'DeviceName' => ['title' => '关联的设备别名', 'description' => '设备名称', 'type' => 'string', 'example' => '廊灯'],
+ 'AliasList' => [
+ 'title' => '设备别名',
+ 'description' => '设备别名列表',
+ 'type' => 'array',
+ 'items' => ['description' => '设备别名', 'type' => 'string', 'example' => '卫生间灯'],
+ ],
+ 'DeviceIndex' => ['title' => '设备序号', 'description' => '设备序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ElementCode' => ['title' => 'iot 多 element 设备的序号', 'description' => 'iot 多 element 设备的序号', 'type' => 'string', 'example' => 'e2'],
+ 'DeviceStatus' => ['title' => '子设备状态', 'description' => '子设备状态', 'type' => 'string', 'example' => '{'."\n"
+ .' "powerstate": "0"'."\n"
+ .'}'],
+ 'Tags' => [
+ 'title' => '子设备标签',
+ 'description' => '子设备标签',
+ 'type' => 'array',
+ 'items' => ['description' => '标签', 'type' => 'string', 'example' => 'SOS'],
+ ],
+ 'Status' => [
+ 'title' => '设备物模型状态',
+ 'description' => '设备物模型状态'."\n"
+ .'物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => '物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157', 'example' => '"doorStatus":{"time":1725347306741,"value":"0"}'],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'AliasList' => [
+ 'title' => '设备别名',
+ 'description' => '设备别名列表',
+ 'type' => 'array',
+ 'items' => ['description' => '设备别名', 'type' => 'string', 'example' => '卫生间灯'],
+ ],
+ 'Status' => [
+ 'title' => '设备物模型状态',
+ 'description' => '设备物模型状态'."\n"
+ .'物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => 'onlinestate":{"time":1725347364693,"value":"online"}', 'description' => '物模型信息,详见以下文档链接:https://www.aligenie.com/docs/business/5189157'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '73C67***6FA'."\n"],
],
- 'required' => true,
- 'docRequired' => true,
],
],
],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"1211\\",\\n \\"Location\\": \\"room\\",\\n \\"LocationName\\": \\"房间\\",\\n \\"Devices\\": [\\n {\\n \\"ConnectType\\": \\"rcu\\",\\n \\"Name\\": \\"light\\",\\n \\"Number\\": \\"night_light\\",\\n \\"DeviceName\\": \\"小夜灯\\",\\n \\"Brand\\": \\"奥*斯\\",\\n \\"ServiceProvider\\": \\"吉视传媒****\\",\\n \\"Province\\": \\"吉林省\\",\\n \\"City\\": \\"松原市\\",\\n \\"InfraredIndex\\": \\"2\\",\\n \\"InfraredId\\": \\"9**7\\",\\n \\"InfraredVersion\\": \\"3.0\\",\\n \\"Pk\\": \\"50255129\\",\\n \\"Dn\\": \\"3c5d***9ec\\",\\n \\"DeviceStatus\\": \\"{\\\\\\"powerstate\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"MultiKeySwitchExt\\": {\\n \\"SwitchList\\": [\\n {\\n \\"Category\\": \\"light\\",\\n \\"Location\\": \\"room\\",\\n \\"DeviceName\\": \\"廊灯\\",\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"DeviceIndex\\": 1,\\n \\"ElementCode\\": \\"e2\\",\\n \\"DeviceStatus\\": \\"{\\\\n \\\\\\"powerstate\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"Tags\\": [\\n \\"SOS\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"\\\\\\"doorStatus\\\\\\":{\\\\\\"time\\\\\\":1725347306741,\\\\\\"value\\\\\\":\\\\\\"0\\\\\\"}\\"\\n }\\n }\\n ]\\n },\\n \\"AliasList\\": [\\n \\"卫生间灯\\"\\n ],\\n \\"Status\\": {\\n \\"key\\": \\"onlinestate\\\\\\":{\\\\\\"time\\\\\\":1725347364693,\\\\\\"value\\\\\\":\\\\\\"online\\\\\\"}\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '查询房间客控设备及设备状态',
+ 'changeSet' => [],
+ ],
+ 'QueryRoomStatus' => [
+ 'summary' => '查询房态信息',
+ 'path' => '/v1.0/ip/queryRoomStatus',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none'],
+ 'parameters' => [
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => false, 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7'],
+ ],
+ [
+ 'name' => 'RoomNo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '1211'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PageResult<ListItemResponse>',
- 'description' => 'PageResult<ListItemResponse>',
+ 'title' => 'Result<OpenRoomStatusDetailResponse>',
+ 'description' => 'Result<OpenRoomStatusDetailResponse>',
'type' => 'object',
'properties' => [
- 'Page' => [
- 'title' => '分页结果',
- 'description' => '分页结果',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条',
- 'description' => '每页多少条',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '共多少条数据',
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'TotalPage' => [
- 'title' => '共多少页',
- 'description' => '共多少页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'HasNext' => [
- 'title' => '是否有下一页',
- 'description' => '是否有下一页',
- 'type' => 'boolean',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => '调用返回码 pop返回使用', 'description' => '调用返回码 pop返回使用', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'SecondCategoryList' => [
- 'title' => '服务分类list',
- 'description' => '服务分类list',
+ 'HotelId' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'example' => 'cf2446fc9d144c85aaee4f9ae20a96e7'],
+ 'RoomNo' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'example' => '1211'],
+ 'StatusList' => [
+ 'title' => '房态属性内容',
+ 'description' => '房态属性内容',
'type' => 'array',
'items' => [
- 'description' => '服务对象',
+ 'description' => '状态内容',
'type' => 'object',
'properties' => [
- 'SecondCategoryName' => [
- 'title' => '分类名称',
- 'description' => '分类名称',
- 'type' => 'string',
- 'example' => '客用品类',
- ],
- 'ItemList' => [
- 'description' => '物品list',
- 'type' => 'array',
- 'items' => [
- 'description' => '物品对象',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '物品ID',
- 'description' => '物品ID',
- 'type' => 'string',
- 'example' => '152860',
- ],
- 'Type' => [
- 'title' => '物品分类',
- 'description' => '物品分类',
- 'type' => 'string',
- 'example' => 'GOODS',
- ],
- 'Category' => [
- 'title' => '物品二级分类',
- 'description' => '物品二级分类',
- 'type' => 'string',
- 'example' => '客用品类',
- ],
- 'Name' => [
- 'title' => '物品名称',
- 'description' => '物品名称',
- 'type' => 'string',
- 'example' => '棉签',
- ],
- 'Status' => [
- 'title' => '物品状态',
- 'description' => '物品状态',
- 'type' => 'string',
- 'example' => '已添加',
- ],
- 'Icon' => [
- 'title' => '物品icon',
- 'description' => '物品icon',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png',
- ],
- 'Price' => [
- 'title' => '物品价格',
- 'description' => '物品价格',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ResidueLimit' => [
- 'title' => '剩余下单数量'."\n"
- .' -1表示 不限制 0表示无剩余下单量 >0为可下单的数量',
- 'description' => '剩余下单数量'."\n"
- .' -1表示 不限制 0表示无剩余下单量 >0为可下单的数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
- ],
+ 'StatusName' => ['description' => '状态名称', 'type' => 'string', 'example' => '清理模式:mur'."\n"
+ .'勿扰模式:dnd '."\n"
+ .'sos呼叫:sos'."\n"
+ .'doorStatus:门状态'."\n"
+ .'stateOfMagneticInduction:插卡取电状态'."\n"
+ .'wifiStatus:房间联网状态'."\n"
+ .'roomPowerState:房间上电状态 1上电 0断电'."\n"
+ .'roomEcoMode:房间节能模式 1节能模式下 0非节能模式'],
+ 'StatusValue' => ['description' => '状态内容', 'type' => 'string', 'example' => 'true 打开'."\n"
+ .'false 关闭'],
+ 'UpdateTime' => ['description' => '更新时间', 'type' => 'string', 'example' => 'Thu Jan 09 13:56:51 CST 2025'],
+ ],
+ ],
+ ],
+ 'SceneList' => [
+ 'title' => '房间场景',
+ 'description' => '房间场景',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '场景列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'SceneName' => ['description' => '场景名称', 'type' => 'string', 'example' => '睡眠模式'],
],
],
],
],
],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"TotalPage\\": 6,\\n \\"HasNext\\": true\\n },\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"SecondCategoryList\\": [\\n {\\n \\"SecondCategoryName\\": \\"客用品类\\",\\n \\"ItemList\\": [\\n {\\n \\"Id\\": \\"152860\\",\\n \\"Type\\": \\"GOODS\\",\\n \\"Category\\": \\"客用品类\\",\\n \\"Name\\": \\"棉签\\",\\n \\"Status\\": \\"已添加\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png\\",\\n \\"Price\\": 1,\\n \\"ResidueLimit\\": 2\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CEADB586-51CB-1B6B-95BD-AB85A7A08E97\\"\\n}","type":"json"}]',
- 'title' => '查询酒店场景服务项列表',
- 'description' => '查询酒店场景服务项列表,如物品服务的服务项列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"cf2446fc9d144c85aaee4f9ae20a96e7\\",\\n \\"RoomNo\\": \\"1211\\",\\n \\"StatusList\\": [\\n {\\n \\"StatusName\\": \\"清理模式:mur\\\\n勿扰模式:dnd \\\\nsos呼叫:sos\\\\ndoorStatus:门状态\\\\nstateOfMagneticInduction:插卡取电状态\\\\nwifiStatus:房间联网状态\\\\nroomPowerState:房间上电状态 1上电 0断电\\\\nroomEcoMode:房间节能模式 1节能模式下 0非节能模式\\",\\n \\"StatusValue\\": \\"true 打开\\\\nfalse 关闭\\",\\n \\"UpdateTime\\": \\"Thu Jan 09 13:56:51 CST 2025\\"\\n }\\n ],\\n \\"SceneList\\": [\\n {\\n \\"SceneName\\": \\"睡眠模式\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]',
+ 'title' => '查询房态信息',
],
- 'ListHotelServiceCategory' => [
- 'summary' => '获取酒店服务分类,例如酒店服务于酒店预定下的各个分类',
- 'path' => '/v1.0/ip/listHotelServiceCategory',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'QuerySceneList' => [
+ 'summary' => '查询酒店场景列表',
+ 'path' => '/v1.0/ip/querySceneList',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
- 'in' => 'query',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
+ ],
+ [
+ 'name' => 'SceneTypes',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '服务分类',
- 'description' => '服务分类',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '服务分类类型',
- 'description' => '服务分类类型',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HOTEL_SERVICE',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
+ 'title' => '场景集合传递(公共:common;自定义:custom)',
+ 'description' => '场景集合传递(公共:common;自定义:custom)',
+ 'type' => 'array',
+ 'items' => ['description' => 'common 或 custom', 'type' => 'string', 'required' => false, 'example' => 'common'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'SceneStates',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '场景状态集合传递(1-已关联,0-未关联)',
+ 'description' => '场景状态集合传递(1-已关联,0-未关联)',
+ 'type' => 'array',
+ 'items' => ['description' => '0 或 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'TemplateInfoIds',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '房型id',
+ 'description' => '房型id',
+ 'type' => 'array',
+ 'items' => ['description' => '房型id', 'type' => 'string', 'required' => false, 'example' => '999'],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<SceneServiceCategory>>',
- 'description' => 'Result<List<SceneServiceCategory>>',
+ 'title' => 'Result<List<HotelSceneWrapperResp>>',
+ 'description' => 'Result<List<HotelSceneWrapperResp>>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Results' => [
'title' => '服务的实际返回结果',
'description' => '服务的实际返回结果',
'type' => 'array',
'items' => [
+ 'description' => '结果列表。',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'title' => '服务分类类型',
- 'description' => '服务分类类型',
- 'type' => 'string',
- 'example' => 'HOTEL_SERVICE',
- ],
- 'Code' => [
- 'title' => '服务分类code',
- 'description' => '服务分类code',
- 'type' => 'string',
- 'example' => 'GOODS',
- ],
- 'Name' => [
- 'title' => '服务分类名称',
- 'description' => '服务分类名称',
- 'type' => 'string',
- 'example' => '物品添加',
- ],
- 'Desc' => [
- 'title' => '服务分类描述',
- 'description' => '服务分类描述',
- 'type' => 'string',
- 'example' => '生活及洗漱用品',
- ],
- 'Icon' => [
- 'title' => '服务分类icon',
- 'description' => '服务分类icon',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png',
+ 'SceneId' => ['title' => '场景id', 'description' => '场景id', 'type' => 'string', 'example' => '73'],
+ 'SceneName' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'example' => '睡眠模式'],
+ 'Icon' => ['title' => '场景图标', 'description' => '场景图标', 'type' => 'string', 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png'],
+ 'SceneSource' => ['title' => '场景来源;场景来源;精灵(genie)、外部(external)', 'description' => '场景来源;场景来源;精灵(genie)、外部(external)', 'type' => 'string', 'example' => 'external'],
+ 'SceneType' => ['title' => '场景类型:公共:common;自定义:custom', 'description' => '场景类型:公共:common;自定义:custom', 'type' => 'string', 'example' => 'common'],
+ 'SceneState' => ['title' => '场景与房型的关联状态(1-已关联,0-未关联,-1-不可关联)', 'description' => '场景与房型的关联状态(1-已关联,0-未关联,-1-不可关联)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'UnavailableReason' => ['title' => '场景与房型的关联状态为-1(不可关联)的原因', 'description' => '场景与房型的关联状态为-1(不可关联)的原因', 'type' => 'string', 'example' => '不可关联'],
+ 'TemplateInfoDTOList' => [
+ 'title' => '关联的房型',
+ 'description' => '关联的房型',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '房型id', 'description' => '房型id', 'type' => 'integer', 'format' => 'int64', 'example' => '6962'],
+ 'Name' => ['title' => '房型名称', 'description' => '房型名称', 'type' => 'string', 'example' => '101'],
+ 'Description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '房型描述'],
+ ],
+ ],
],
],
],
],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '5373C821-65D2-1764-B9F9-951914937FF5',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Type\\": \\"HOTEL_SERVICE\\",\\n \\"Code\\": \\"GOODS\\",\\n \\"Name\\": \\"物品添加\\",\\n \\"Desc\\": \\"生活及洗漱用品\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/wupintianjia.png\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5373C821-65D2-1764-B9F9-951914937FF5\\"\\n}","type":"json"}]',
- 'title' => '获取酒店服务分类',
- 'description' => '获取酒店服务分类,例如酒店服务于酒店预定下的各个分类',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Results\\": [\\n {\\n \\"SceneId\\": \\"73\\",\\n \\"SceneName\\": \\"睡眠模式\\",\\n \\"Icon\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png\\",\\n \\"SceneSource\\": \\"external\\",\\n \\"SceneType\\": \\"common\\",\\n \\"SceneState\\": 1,\\n \\"UnavailableReason\\": \\"不可关联\\",\\n \\"TemplateInfoDTOList\\": [\\n {\\n \\"Id\\": 6962,\\n \\"Name\\": \\"101\\",\\n \\"Description\\": \\"房型描述\\"\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\"\\n}","type":"json"}]',
+ 'title' => '查询酒店场景列表',
+ 'description' => '查询酒店场景列表,请根据请求参数查询',
],
- 'GetHotelOrderDetail' => [
- 'summary' => '获取酒店订单详情,例如无屏、维修、餐饮等',
- 'path' => '/v1.0/ip/getHotelOrderDetail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RemoveChildAccountAuth' => [
+ 'summary' => '删除子账号授权',
+ 'path' => '/v1.0/ip/removeChildAccountAuth',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
+ [
+ 'name' => 'TbOpenId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '授权人(平台登录用户)淘宝开放id', 'description' => '授权人(平台登录用户)淘宝开放id', 'type' => 'string', 'required' => true, 'example' => 'AAEV***E3d3Z2ETwh'],
+ ],
+ [
+ 'name' => 'AppKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'top开放平台appKey', 'description' => 'top开放平台appKey', 'type' => 'string', 'required' => true, 'example' => '30**53'],
+ ],
+ [
+ 'name' => 'ChildAccountName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '被授权账号的淘宝账号名称', 'description' => '被授权账号的淘宝账号名称', 'type' => 'string', 'required' => true, 'example' => 'tbxxxx'],
+ ],
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'StatusCode' => ['title' => '调用返回码,200标识为成功,非200详细见错误码表', 'description' => '调用返回码,200标识为成功,非200详细见错误码表', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'True'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'F12B***F34E'],
+ ],
+ ],
+ ],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B***F34E\\"\\n}","type":"json"}]',
+ 'title' => '删除子账号授权',
+ ],
+ 'RemoveHotel' => [
+ 'summary' => '删除酒店信息。',
+ 'path' => '/v1.0/ip/removeHotel',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
- 'in' => 'query',
- 'style' => 'json',
+ 'name' => 'TbOpenId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '淘宝开放id', 'description' => '淘宝开放id', 'type' => 'string', 'required' => true, 'example' => 'AAEVK***UE3d3Z2ETwh'],
+ ],
+ [
+ 'name' => 'AppKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'appkey', 'type' => 'string', 'required' => true, 'example' => '30193305'],
+ ],
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '订单详情payload',
- 'description' => '订单详情payload',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'OrderNo' => [
- 'title' => '订单号',
- 'description' => '订单号',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '20220714150702000168270112410630',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'description' => '扩展信息', 'example' => '{}'],
],
+ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'],
],
- 'required' => true,
- 'docRequired' => true,
],
],
],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
+ 'title' => '删除酒店',
+ 'description' => '删除酒店信息。',
+ ],
+ 'ResetWelcomeTextAndMusic' => [
+ 'summary' => '重置欢迎语配置',
+ 'path' => '/v1.0/ip/resetWelcomeTextAndMusic',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelOrderDetail>>',
- 'description' => 'Result<List<HotelOrderDetail>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '物品名称',
- 'description' => '物品名称',
- 'type' => 'string',
- 'example' => '窗帘',
- ],
- 'ApplyAmt' => [
- 'title' => '物品金额',
- 'description' => '物品金额',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Quantity' => [
- 'title' => '物品数量',
- 'description' => '物品数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ItemUrl' => [
- 'title' => '物品icon',
- 'description' => '物品icon',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png',
- ],
- 'GmtCreate' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1659952892000',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '6F579407-13C4-1708-AFA2-B657BE5FE8F5',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'description' => '扩展信息', 'example' => ' '],
],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"窗帘\\",\\n \\"ApplyAmt\\": 200,\\n \\"Quantity\\": 1,\\n \\"ItemUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/weixiu/dianqilei/chuanglian.png\\",\\n \\"GmtCreate\\": 1659952892000\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6F579407-13C4-1708-AFA2-B657BE5FE8F5\\"\\n}","type":"json"}]',
- 'title' => '获取订单详情',
- 'description' => '获取酒店订单详情,例如无屏、维修、餐饮等',
+ 'staticInfo' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\" \\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '重置欢迎语配置',
+ 'description' => '重置欢迎语配置到默认的配置:'."\n"
+ .'- 欢迎语文本:尊贵的客人,您好,欢迎入住,我是您的房间智能助理,我可以播放音乐,控制空调、灯光等,也能提供酒店的各种服务,回答酒店相关问题。只需要唤醒后,就能和我开始互动,我的更多能力,可以参考我旁边的立牌使用哦,祝您在本酒店度过一段愉快的入住时光。'."\n"
+ .'- 背景音链接:http://ailabsaicloudservice.alicdn.com/tmp/a.wav',
],
- 'ListHotelOrder' => [
- 'summary' => '查询设备上的订单列表',
- 'path' => '/v1.0/ip/listHotelOrder',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RoomCheckOut' => [
+ 'summary' => '设备面板点击退房,非正式退房,仅发送工单并给用户提示去前台退房',
+ 'path' => '/v1.0/ip/roomCheckOut',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Payload',
+ 'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '酒店订单列表payload',
- 'description' => '酒店订单列表payload',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'title' => '用户ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1345480696877233314',
- ],
- 'Page' => [
- 'title' => '分页参数',
- 'description' => '分页参数',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条数据',
- 'description' => '每页多少条数据',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'EncodeType' => ['description' => '编码类型,此处填写 **HOTEL**。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'- OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
- 'required' => true,
- 'docRequired' => true,
+ 'required' => false,
],
],
[
- 'name' => 'UserInfo',
+ 'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户信息',
- 'description' => '用户信息',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1248494721591392955',
- ],
- 'IdType' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==',
- ],
- 'OrganizationId' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'EncodeType' => ['description' => '编码类型,此处填写 **HOTEL**。', 'type' => 'string', 'required' => true, 'example' => 'HOTEL'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
- 'required' => true,
- 'docRequired' => true,
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PageResult<List<HotelOrderListResp>>',
- 'description' => 'PageResult<List<HotelOrderListResp>>',
+ 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>',
+ 'description' => '返回结果对象',
'type' => 'object',
'properties' => [
- 'Page' => [
- 'title' => '分页结果',
- 'description' => '分页结果',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'title' => '第几页',
- 'description' => '第几页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页多少条数据',
- 'description' => '每页多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '共多少条数据',
- 'description' => '共多少条数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '21',
- ],
- 'TotalPage' => [
- 'title' => '共多少页',
- 'description' => '共多少页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'HasNext' => [
- 'title' => '是否有下一页',
- 'description' => '是否有下一页',
- 'type' => 'boolean',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RoomNo' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'example' => '2001',
- ],
- 'OrderNo' => [
- 'title' => '订单号',
- 'description' => '订单号',
- 'type' => 'string',
- 'example' => '20220808180132000114508555527711',
- ],
- 'Quantity' => [
- 'title' => '共多少个物品',
- 'description' => '共多少个物品',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'ApplyAmt' => [
- 'title' => '共需要多少钱',
- 'description' => '共需要多少钱',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21.5',
- ],
- 'Status' => [
- 'title' => '订单状态',
- 'description' => '订单状态',
- 'type' => 'string',
- 'example' => 'INIT',
- ],
- 'GmtCreate' => [
- 'title' => '订单创建时间',
- 'description' => '订单创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1659952892000',
- ],
- 'Type' => [
- 'title' => '订单商品所属分类',
- 'description' => '订单商品所属分类',
- 'type' => 'string',
- 'example' => 'REPAIR',
- ],
- 'TypeName' => [
- 'title' => '订单物品所属分类名称',
- 'description' => '订单物品所属分类名称',
- 'type' => 'string',
- 'example' => '设备维修',
- ],
- 'TypeIconUrl' => [
- 'title' => '订单物品所属分类icon',
- 'description' => '订单物品所属分类icon',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png',
- ],
- 'Amt' => [
- 'title' => '单价',
- 'description' => '单价',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Icon' => [
- 'title' => '商品图片',
- 'description' => '商品图片',
- 'type' => 'string',
- ],
- 'Name' => [
- 'title' => '商品名称',
- 'description' => '商品名称',
- 'type' => 'string',
- ],
- 'ItemType' => [
- 'title' => '商品类型',
- 'description' => '商品类型',
- 'type' => 'string',
- ],
- 'ItemId' => [
- 'title' => '商品id',
- 'description' => '商品id',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'DeliveryTime' => [
- 'title' => '商品预计送达时间',
- 'description' => '商品预计送达时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'PaymentMethod' => [
- 'title' => '商品结算方式',
- 'description' => '商品结算方式',
- 'type' => 'string',
- ],
- 'StartTime' => [
- 'title' => '数据查询开始时间',
- 'description' => '数据查询开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'SumAmt' => [
- 'title' => '当前入住下单汇总金额',
- 'description' => '当前入住下单汇总金额',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'OrderStatus' => [
- 'title' => '订单状态',
- 'description' => '订单状态',
- 'type' => 'string',
- ],
- 'DeliveryRoomName' => [
- 'title' => '配送房间名称',
- 'description' => '配送房间名称',
- 'type' => 'string',
- ],
- 'DeliveryMethod' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '07F61FDA-606F-10A0-8ED0-C6CE62710A48',
- ],
+ 'Code' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200表示成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['description' => '执行成功或失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'dsvrevd'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Page\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 21,\\n \\"TotalPage\\": 7,\\n \\"HasNext\\": true\\n },\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RoomNo\\": \\"2001\\",\\n \\"OrderNo\\": \\"20220808180132000114508555527711\\",\\n \\"Quantity\\": 12,\\n \\"ApplyAmt\\": 21.5,\\n \\"Status\\": \\"INIT\\",\\n \\"GmtCreate\\": 1659952892000,\\n \\"Type\\": \\"REPAIR\\",\\n \\"TypeName\\": \\"设备维修\\",\\n \\"TypeIconUrl\\": \\"https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingfenlei/shebeiweixiu.png\\",\\n \\"Amt\\": 0,\\n \\"Icon\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ItemType\\": \\"\\",\\n \\"ItemId\\": 0,\\n \\"DeliveryTime\\": 0,\\n \\"PaymentMethod\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"SumAmt\\": 0,\\n \\"OrderStatus\\": \\"\\",\\n \\"DeliveryRoomName\\": \\"\\",\\n \\"DeliveryMethod\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"07F61FDA-606F-10A0-8ED0-C6CE62710A48\\"\\n}","type":"json"}]',
- 'title' => '查询订单',
- 'description' => '查询设备上的订单列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"dsvrevd\\"\\n}","type":"json"}]',
+ 'title' => '退房',
],
'SubmitHotelOrder' => [
'summary' => '提交订单,例如物品、预定餐饮等订单的提交',
'path' => '/v1.0/ip/submitHotelOrder',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Payload',
@@ -14862,21 +7433,8 @@
'description' => '提交订单payload',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'title' => '用户ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1345480696877233314',
- ],
- 'Type' => [
- 'title' => '物品所属分类',
- 'description' => '物品所属分类',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GOODS',
- ],
+ 'UserId' => ['title' => '用户ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1345480696877233314'],
+ 'Type' => ['title' => '物品所属分类', 'description' => '物品所属分类', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GOODS'],
'ItemList' => [
'title' => '物品list',
'description' => '物品list',
@@ -14885,31 +7443,9 @@
'description' => '物品信息',
'type' => 'object',
'properties' => [
- 'ItemId' => [
- 'title' => '物品ID',
- 'description' => '物品ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '152860',
- ],
- 'Quantity' => [
- 'title' => '物品数量',
- 'description' => '物品数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
- 'Remark' => [
- 'title' => '备注',
- 'description' => '备注',
- 'type' => 'string',
- 'required' => false,
- 'example' => '备注信息',
- ],
+ 'ItemId' => ['title' => '物品ID', 'description' => '物品ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '152860'],
+ 'Quantity' => ['title' => '物品数量', 'description' => '物品数量', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2'],
+ 'Remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => '备注信息'],
],
'required' => false,
],
@@ -14929,40 +7465,11 @@
'description' => '用户信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码键',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1248494721591392955',
- ],
- 'IdType' => [
- 'description' => 'id类型',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => 'id',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
+ 'EncodeType' => ['description' => '编码类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码键', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1248494721591392955'],
+ 'IdType' => ['description' => 'id类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => 'id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA=='],
+ 'OrganizationId' => ['description' => '组织id', 'type' => 'string', 'required' => false, 'example' => '""'],
],
'required' => true,
'docRequired' => true,
@@ -14976,939 +7483,535 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '订单号',
- 'description' => '订单号',
- 'type' => 'string',
- 'example' => '20220809104752000114671478353329',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'CCCF2E86-D9B5-12A6-AD25-8A06933D2B0F',
- ],
- 'StatusCode' => [
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '订单号', 'description' => '订单号', 'type' => 'string', 'example' => '20220809104752000114671478353329'],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'CCCF2E86-D9B5-12A6-AD25-8A06933D2B0F'],
+ 'StatusCode' => ['description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"20220809104752000114671478353329\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CCCF2E86-D9B5-12A6-AD25-8A06933D2B0F\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]',
'title' => '提交订单',
'description' => '提交订单,例如物品、预定餐饮等订单的提交',
],
- 'GetHotelNotice' => [
- 'summary' => '获取酒店通知',
- 'path' => '/v1.0/ip/getHotelNotice',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'SyncDeviceStatusWithAk' => [
+ 'summary' => '用于云云RCU对接的客控设备状态同步至猫精侧,猫精侧存储状态信息或者通知设备端更新状态显示',
+ 'path' => '/v1.0/ip/syncDeviceStatusWithAk',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '用户信息',
- 'description' => '用户信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写PROJECT_ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型 :'."\n"
- .'OPENID:默认的设备ID标识。'."\n"
- .'UNIONID: 组织维度的设备ID标识,需要提前在开放平台申请组织。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,填写userOpenId或userUnionId的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
+ ],
+ [
+ 'name' => 'RoomNo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '房间号', 'description' => '房间号', 'type' => 'string', 'required' => true, 'example' => '1211'],
+ ],
+ [
+ 'name' => 'DeviceName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备名称', 'description' => '设备名称', 'type' => 'string', 'required' => false, 'example' => '床头灯'],
+ ],
+ [
+ 'name' => 'Switch',
+ 'in' => 'formData',
+ 'schema' => ['title' => '开关值,0:关,1:开', 'description' => '开关值,0:关,1:开', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'CategoryEnName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备的品类英文名称', 'description' => '设备的品类英文名称', 'type' => 'string', 'required' => true, 'example' => 'light'],
+ ],
+ [
+ 'name' => 'CategoryCnName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备的品类英文名称,选填', 'description' => '设备的品类英文名称,选填', 'type' => 'string', 'required' => false, 'example' => '灯'],
+ ],
+ [
+ 'name' => 'Number',
+ 'in' => 'formData',
+ 'schema' => ['title' => '设备序号', 'description' => '设备序号', 'type' => 'string', 'required' => true, 'example' => 'bedLight'],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'formData',
+ 'schema' => ['title' => '位置', 'description' => '位置', 'type' => 'string', 'required' => true, 'example' => 'room'],
+ ],
+ [
+ 'name' => 'LocationCnName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '位置中文名称,选填', 'description' => '位置中文名称,选填', 'type' => 'string', 'required' => false, 'example' => '房间'],
+ ],
+ [
+ 'name' => 'mode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '空调参数,例如制冷、制热模式', 'description' => '空调模式'."\n"
+ .'- auto:自动'."\n"
+ .'- cold:制冷'."\n"
+ .'- hot:制热', 'type' => 'string', 'required' => false, 'example' => 'auto'],
+ ],
+ [
+ 'name' => 'fanSpeed',
+ 'in' => 'formData',
+ 'schema' => ['title' => '空调字段,风速', 'description' => '空调风速,1,2,3分别对应低速、中速、高速', 'type' => 'string', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'temperature',
+ 'in' => 'formData',
+ 'schema' => ['title' => '空调字段,温度', 'description' => '空调温度', 'type' => 'string', 'required' => false, 'example' => '22'],
+ ],
+ [
+ 'name' => 'roomTemperature',
+ 'in' => 'formData',
+ 'schema' => ['title' => '空调字段,当前室温', 'description' => '室温', 'type' => 'string', 'required' => false, 'example' => '21'],
+ ],
+ [
+ 'name' => 'value',
+ 'in' => 'formData',
+ 'schema' => ['title' => '窗帘、纱帘字段,开合度', 'description' => '窗帘开合度,仅窗帘品类使用', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<String>',
- 'description' => 'Result<String>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'string',
- 'example' => 'test notice...',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => 'RequestId',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,200标识成功', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果,是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'requestId' => ['description' => '请求id'."\n", 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": \\"test notice...\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
- 'title' => '获取酒店通知',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\"\\n}","type":"json"}]',
+ 'title' => '客控设备状态同步',
],
- 'GetHotelNoticeV2' => [
- 'summary' => '获取酒店通知信息,包含通知标题和内容',
- 'path' => '/v1.0/ip/getHotelNoticeV2',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateBasicInfoQA' => [
+ 'summary' => '通用问答模块下的修改基础信息问答功能。',
+ 'path' => '/v1.0/ip/updateBasicInfoQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'."\n"],
+ ],
+ [
+ 'name' => 'HotelAddress',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店地址', 'description' => '酒店地址', 'type' => 'string', 'required' => true, 'example' => '浙江省杭州市xxxx'],
+ ],
+ [
+ 'name' => 'PhoneNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '前台电话', 'description' => '前台电话', 'type' => 'string', 'required' => true, 'example' => '123***'],
+ ],
+ [
+ 'name' => 'CheckInTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '入住时间 格式xx:xx 时分', 'description' => '入住时间(格式xx:xx 时分)', 'type' => 'string', 'required' => true, 'example' => '11:11'."\n"],
+ ],
+ [
+ 'name' => 'CheckOutTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '退房时间', 'description' => '退房时间(格式xx:xx 时分)', 'type' => 'string', 'required' => true, 'example' => '11:11'],
+ ],
+ [
+ 'name' => 'WifiName',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'wifi名称', 'description' => 'wifi名称', 'type' => 'string', 'required' => true, 'example' => '名称***'],
+ ],
+ [
+ 'name' => 'WifiPassword',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'wifi密码', 'description' => 'wifi密码', 'type' => 'string', 'required' => true, 'example' => '密码***'],
+ ],
+ [
+ 'name' => 'HotelMember',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店会员相关介绍', 'description' => '酒店会员相关介绍', 'type' => 'string', 'required' => false, 'example' => '会员***'],
+ ],
+ [
+ 'name' => 'HotelService',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店特色服务相关介绍', 'description' => '酒店特色服务相关介绍', 'type' => 'string', 'required' => false, 'example' => '服务***'],
+ ],
+ [
+ 'name' => 'HotelIntroduction',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店介绍', 'description' => '酒店介绍', 'type' => 'string', 'required' => false, 'example' => '酒店***'],
+ ],
+ [
+ 'name' => 'ParkingPosition',
+ 'in' => 'formData',
+ 'schema' => ['title' => '停车场位置', 'description' => '停车场位置', 'type' => 'string', 'required' => true, 'example' => '杭州市xx'],
+ ],
+ [
+ 'name' => 'ParkingExpenses',
+ 'in' => 'formData',
'schema' => [
- 'title' => '用户信息',
- 'description' => '用户信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写 HOTEL。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
+ 'title' => '停车费用,免费停车/收费停车',
+ 'description' => '停车费用(免费停车/收费停车)',
+ 'type' => 'string',
'required' => true,
- 'docRequired' => true,
+ 'example' => '免费停车',
+ 'enum' => ['免费停车', '收费停车'],
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<HotelNotice>',
- 'description' => 'Result<HotelNotice>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,200标识成功',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'Title' => [
- 'title' => '酒店通知标题',
- 'description' => '酒店通知标题',
- 'type' => 'string',
- 'example' => '欢迎入住智能酒店',
- ],
- 'Content' => [
- 'title' => '酒店通知内容',
- 'description' => '酒店通知内容',
- 'type' => 'string',
- 'example' => '欢迎入住,我是您的智能语音助手',
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求Id',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '0D0C***67DB',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7***726E'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Title\\": \\"欢迎入住智能酒店\\",\\n \\"Content\\": \\"欢迎入住,我是您的智能语音助手\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]',
- 'title' => '获取酒店通知-包含标题',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '修改基础信息问答',
],
- 'GetHotelHomeBackImageAndModes' => [
- 'summary' => '获取首页背景图和场景模式',
- 'path' => '/v1.0/ip/getHotelHomeBackImageAndModes',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateCustomQA' => [
+ 'summary' => '自定义问答模块下的修改自定义问答功能。',
+ 'path' => '/v1.0/ip/updateCustomQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
+ 'name' => 'CustomQAId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '自定义问答id', 'type' => 'string', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
+ ],
+ [
+ 'name' => 'MajorQuestion',
+ 'in' => 'formData',
+ 'schema' => ['description' => '主问题', 'type' => 'string', 'required' => false, 'example' => '***'],
+ ],
+ [
+ 'name' => 'SupplementaryQuestions',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '用户信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1248494721591392955',
- ],
- 'IdType' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==',
- ],
- 'OrganizationId' => [
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
+ 'description' => '附属问题列表',
+ 'type' => 'array',
+ 'items' => ['description' => '附属问题', 'type' => 'string', 'required' => false, 'example' => '***'],
+ 'required' => false,
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'KeyWords',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Result<HomePageBackImageAndModes>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'BackgroundImage' => [
- 'title' => '背景图URL',
- 'type' => 'string',
- 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhn.jpg',
- ],
- 'HotelName' => [
- 'title' => '酒店名称',
- 'type' => 'string',
- 'example' => '宣雍测试橙蜂酒店',
- ],
- 'ModeList' => [
- 'title' => '模式list',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '模式code',
- 'type' => 'string',
- 'example' => 'romantic',
- ],
- 'CnName' => [
- 'title' => '模式名称',
- 'type' => 'string',
- 'example' => '浪漫模式',
- ],
- 'Icon' => [
- 'title' => '模式icon',
- 'type' => 'string',
- 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/langman.png',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'type' => 'string',
- 'example' => '394450FC-9035-1B7C-8829-BC88832473FC',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => ' AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
+ 'description' => '关键字列表',
+ 'type' => 'array',
+ 'items' => ['description' => '关键字', 'type' => 'string', 'required' => false, 'example' => '***'],
+ 'required' => false,
],
],
- ],
- 'responseDemo' => '',
- ],
- 'GetHotelSampleUtterances' => [
- 'summary' => '获取推荐语料',
- 'path' => '/v1.0/ip/getHotelSampleUtterances',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
[
- 'AliGenie_Auth_SPI' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'UserInfo',
- 'in' => 'query',
+ 'name' => 'Answers',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'EncodeKey' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'IdType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'Id' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'OrganizationId' => [
- 'type' => 'string',
- ],
- ],
+ 'description' => '回答列表',
+ 'type' => 'array',
+ 'items' => ['description' => '回答', 'type' => 'string', 'required' => false, 'example' => '***'],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '73C6***BB3E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***BB3E6FA\\"\\n}","type":"json"}]',
+ 'title' => '修改自定义问答',
],
- 'GetHotelScreenSaver' => [
- 'summary' => '获取屏保信息,如屏保样式等信息',
- 'path' => '/v1.0/ip/getHotelScreenSaver',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateHotel' => [
+ 'summary' => '酒店信息修改。',
+ 'path' => '/v1.0/ip/updateHotel',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '用户信息',
- 'description' => '用户信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1248494721591392955',
- ],
- 'IdType' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'mFU6VtVU+pgA8lx6rYMo7SPl11t+8b+8ALrn10MIPEdpK/HI9wELAEppYhPI1cYRDa4og8AMjAEBZKbLUwFjFA==',
- ],
- 'OrganizationId' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'TbOpenId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '淘宝开放id', 'description' => '淘宝开放id', 'type' => 'string', 'required' => true, 'example' => 'AAEVK***UE3d3Z2ETwh'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Result<HotelScreenSaver>',
- 'description' => 'Result<HotelScreenSaver>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'StyleCode' => [
- 'title' => '屏保样式code',
- 'description' => '屏保样式code',
- 'type' => 'string',
- 'example' => 'common-weather',
- ],
- 'PicUrl' => [
- 'title' => '屏保图片',
- 'description' => '屏保图片',
- 'type' => 'string',
- 'example' => 'https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg',
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '5F0467E1-19F2-1757-B6D0-B79917BA2E81',
- ],
- ],
- ],
+ [
+ 'name' => 'AppKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '开放平台appKey', 'description' => '开放平台appKey', 'type' => 'string', 'required' => true, 'example' => '31342884'],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ [
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店ID', 'description' => '酒店ID', 'type' => 'string', 'required' => true, 'example' => 'e6dd44fd16084db8a60d69fd625d9f0f'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"StyleCode\\": \\"common-weather\\",\\n \\"PicUrl\\": \\"https://ailabs.alibabausercontent.com/platform/3d4fe6d66ec49d9789635f66627f0339/welcome_audios/976210a6532150f49c2677a8b7dbc105/l6fspbhd.jpg\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5F0467E1-19F2-1757-B6D0-B79917BA2E81\\"\\n}","type":"json"}]',
- 'title' => '获取屏保信息',
- 'description' => '获取屏保信息,如屏保样式等信息',
- ],
- 'RoomCheckOut' => [
- 'summary' => '设备面板点击退房,非正式退房,仅发送工单并给用户提示去前台退房',
- 'path' => '/v1.0/ip/roomCheckOut',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'name' => 'HotelName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店名称', 'description' => '酒店名称', 'type' => 'string', 'required' => false, 'example' => '天奥酒店'],
],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
- 'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '用户标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写 **HOTEL**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'Remark',
+ 'in' => 'formData',
+ 'schema' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => '测试'],
],
[
- 'name' => 'DeviceInfo',
- 'in' => 'query',
+ 'name' => 'HotelAddress',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店地址', 'description' => '酒店地址', 'type' => 'string', 'required' => false, 'example' => '浙江省杭州市xxxx'],
+ ],
+ [
+ 'name' => 'HotelEmail',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店联系邮箱', 'description' => '酒店联系邮箱', 'type' => 'string', 'required' => false, 'example' => 'a*****@hotel.com'],
+ ],
+ [
+ 'name' => 'PhoneNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '酒店联系电话', 'description' => '酒店联系电话', 'type' => 'string', 'required' => false, 'example' => '130***'],
+ ],
+ [
+ 'name' => 'RoomNum',
+ 'in' => 'formData',
+ 'schema' => ['title' => '房间数', 'description' => '房间数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'],
+ ],
+ [
+ 'name' => 'EstOpenTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '预计发布时间:yyyy-MM-dd HH:mm:ss格式字符串', 'description' => '预计发布时间:yyyy-MM-dd HH:mm:ss格式字符串', 'type' => 'string', 'required' => false, 'example' => '2022-02-22 00:00:00'],
+ ],
+ [
+ 'name' => 'RelatedPks',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '设备标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写 **HOTEL**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => false,
+ 'title' => '关联产品列表',
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelControlTemplateLocationCategoryResp>>',
- 'description' => '返回结果对象',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200表示成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'description' => '执行成功或失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'dsvrevd',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'description' => '扩展信息'],
],
+ 'RequestId' => ['description' => 'The ID of the request. ', 'type' => 'string', 'example' => '46C53AEB-B19C-5C42-B32E-A726979C126F'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"dsvrevd\\"\\n}","type":"json"}]',
- 'title' => '退房',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RequestId\\": \\"46C53AEB-B19C-5C42-B32E-A726979C126F\\"\\n}","type":"json"}]',
+ 'title' => '酒店信息修改',
],
- 'GetHotelContacts' => [
- 'summary' => '获取酒店联系人',
- 'path' => '/v1.0/ip/getHotelContacts',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateHotelAlarm' => [
+ 'summary' => '修改酒店闹钟',
+ 'path' => '/v1.0/ip/updateHotelAlarm',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '酒店ID', 'type' => 'string', 'required' => true, 'example' => 'a7a381a668bc485980bed3876a75e013'],
+ ],
+ [
+ 'name' => 'Alarms',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '用户标识信息',
+ 'description' => '闹钟信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RoomNo' => ['description' => '房间号', 'type' => 'string', 'required' => false, 'example' => '101'],
+ 'AlarmId' => ['description' => '闹钟ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'],
+ 'UserOpenId' => ['description' => '开放用户ID', 'type' => 'string', 'required' => true, 'example' => 'mgw/***dHQd'],
+ 'DeviceOpenId' => ['description' => '开放设备ID', 'type' => 'string', 'required' => true, 'example' => 'Pvk***VTA=='],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'ScheduleInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '闹钟定时信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写 HOTEL。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
+ 'Type' => ['title' => 'ONCE, WEEKLY, STATUTORY_WORKING_DAY', 'description' => 'ONCE, WEEKLY', 'type' => 'string', 'required' => false, 'example' => 'ONCE'],
+ 'Once' => [
+ 'description' => '一次',
+ 'type' => 'object',
+ 'properties' => [
+ 'Year' => ['description' => '年', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2022'],
+ 'Month' => ['description' => '月', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9'],
+ 'Day' => ['description' => '日', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ 'Hour' => ['description' => '时', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'Minute' => ['description' => '分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ 'required' => false,
],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
+ 'Weekly' => [
+ 'description' => '周循环:循环类型为WEEKLY时,该属性可用'."\n"
+ ."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DaysOfWeek' => [
+ 'description' => '周几触发集合'."\n"
+ ."\n",
+ 'type' => 'array',
+ 'items' => ['description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ ],
+ 'Hour' => ['description' => '时', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'Minute' => ['description' => '分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
'required' => false,
- 'example' => '123',
],
],
'required' => false,
@@ -15918,608 +8021,279 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<List<HotelCallContact>>',
- 'description' => 'Result<List<HotelCallContact>>',
+ 'title' => 'Result<Integer>',
+ 'description' => 'Result<Integer>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,200标识成功',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '联系人信息',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'cf24***96e7',
- ],
- 'Type' => [
- 'title' => '联系人类型,device:设备,group:分组',
- 'description' => '联系人类型,device:设备,group:分组',
- 'type' => 'string',
- 'example' => 'group',
- ],
- 'Uuid' => [
- 'title' => '唯一标识',
- 'description' => '唯一标识',
- 'type' => 'string',
- 'example' => '0862***A809',
- ],
- 'Number' => [
- 'title' => '号码',
- 'description' => '号码',
- 'type' => 'string',
- 'example' => '101',
- ],
- 'Name' => [
- 'title' => '联系人名称',
- 'description' => '联系人名称',
- 'type' => 'string',
- 'example' => '前台',
- ],
- 'Icon' => [
- 'title' => '图标',
- 'description' => '图标',
- 'type' => 'string',
- 'example' => 'xxx.icon',
- ],
- 'Status' => [
- 'title' => '状态,1:可用,0:不可用',
- 'description' => '状态,1:可用,0:不可用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ExpireAt' => [
- 'title' => '失效时间',
- 'description' => '失效时间',
- 'type' => 'string',
- 'example' => '1649472283046',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'Extentions' => [
+ 'title' => '扩展字段',
+ 'description' => '扩展字段',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any', 'example' => '""', 'description' => '扩展内容'],
],
+ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"HotelId\\": \\"cf24***96e7\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"0862***A809\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '获取酒店联系人',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"Extentions\\": {\\n \\"key\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\"\\n}","type":"json"}]',
+ 'title' => '修改酒店闹钟',
+ 'description' => '修改酒店闹钟。',
],
- 'GetHotelContactByNumber' => [
- 'summary' => '根据号码查询联系人信息',
- 'path' => '/v1.0/ip/getHotelContactByNumber',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateHotelSceneBookItem' => [
+ 'summary' => '酒店场景预订编辑',
+ 'path' => '/v1.0/ip/updateHotelSceneBookItem',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Number',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '号码',
- 'description' => '号码,房间号或者部门自定义的号码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '101',
- ],
+ 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
],
[
- 'name' => 'UserInfo',
+ 'name' => 'UpdateHotelSceneBookReq',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户信息',
- 'description' => '用户信息',
+ 'title' => 'updateHotelSceneBookReq',
+ 'description' => 'updateHotelSceneBookReq',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写 HOTEL。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '酒店场景预订itemID'."\n"
+ .'id与名称必须传其中一个', 'description' => '酒店场景预订itemID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1'],
+ 'Name' => ['title' => '名称 查询条件 id与名称必须传一个', 'description' => '名称', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '青椒肉丝'],
+ 'Icon' => ['title' => 'icon', 'description' => 'icon', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ailabs.alibabausercontent.com/platform/28d7a91e3c05db3855725fc39e0387e7/welcome_audios/aa918294b6ca3aa115c51135bf9b80cb/l9f996sq.png'],
+ 'Price' => ['title' => '价格(单位:分)', 'description' => '价格(单位:分)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1250'],
],
- 'required' => false,
+ 'required' => true,
+ 'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<HotelCallContact>',
- 'description' => 'Result<HotelCallContact>',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,200标识成功',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'Type' => [
- 'title' => '联系人类型,device:设备,group:分组',
- 'description' => '联系人类型,device:设备,group:分组',
- 'type' => 'string',
- 'example' => 'group',
- ],
- 'Uuid' => [
- 'title' => '唯一标识',
- 'description' => '唯一标识',
- 'type' => 'string',
- 'example' => '2E57***D45F9',
- ],
- 'Number' => [
- 'title' => '号码',
- 'description' => '号码',
- 'type' => 'string',
- 'example' => '101',
- ],
- 'Name' => [
- 'title' => '联系人名称',
- 'description' => '联系人名称',
- 'type' => 'string',
- 'example' => '前台',
- ],
- 'Icon' => [
- 'title' => '图标',
- 'description' => '图标',
- 'type' => 'string',
- 'example' => 'xxx.icon',
- ],
- 'Status' => [
- 'title' => '状态,1:可用,0:不可用',
- 'description' => '状态,1:可用,0:不可用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ExpireAt' => [
- 'title' => '失效时间',
- 'description' => '失效时间',
- 'type' => 'string',
- 'example' => '1649316479098',
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求Id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649316479098\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '根据号码查询联系人',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '编辑酒店场景预订',
],
- 'GetHotelContactByGenieDevice' => [
- 'summary' => '获取当前设备的通话信息',
- 'path' => '/v1.0/ip/getHotelContactByGenieDevice',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateHotelSceneItem' => [
+ 'summary' => '酒店场景修改(开启/关闭/编辑)',
+ 'path' => '/v1.0/ip/updateHotelSceneItem',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
+ 'name' => 'HotelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'hotelID', 'description' => 'hotelID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '80d84ea8ed9e422fbad52715c8fc56f1'],
+ ],
+ [
+ 'name' => 'UpdateHotelSceneOperateReq',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '用户信息',
+ 'title' => 'updateHotelSceneReq',
+ 'description' => 'updateHotelSceneReq',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写HOTEL。',
- 'description' => '编码类型,此处填写HOTEL。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45'."\n",
- ],
- 'IdType' => [
- 'title' => '用户Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'description' => '用户Id的类型'."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'title' => '用户标识,设置为userOpenId或userUnionId。',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1***2',
- ],
+ 'OperateType' => ['title' => '操作类型(OPEN开启,CLOSE关闭,EDIT编辑)', 'description' => '操作类型(OPEN开启,CLOSE关闭,EDIT编辑)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN'],
+ 'IsUseTemplateAnswer' => ['title' => '是否使用模板回答(true/false)', 'description' => '是否使用模板回答(true/false)', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
- 'required' => false,
+ 'required' => true,
+ 'docRequired' => true,
],
],
[
- 'name' => 'DeviceInfo',
+ 'name' => 'UpdateHotelSceneReq',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '设备信息',
+ 'title' => 'UpdateHotelSceneReq',
+ 'description' => 'UpdateHotelSceneReq',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写HOTEL。',
- 'description' => '编码类型,此处填写HOTEL。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'description' => '编码类型对应的值,此处填写该酒店应用ID。请在天猫精灵行业管理平台查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'IdType' => [
- 'title' => '用户标识,设置为userOpenId或userUnionId。',
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'title' => '用户Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'description' => '用户Id的类型'."\n"
- .'- OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
+ 'Id' => ['title' => 'itemID', 'description' => 'itemID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10337'],
+ 'Name' => ['title' => '物品名称 id与name必传一个', 'description' => '物品名称', 'type' => 'string', 'required' => false, 'example' => '棉签'],
+ 'Status' => ['title' => '状态(已添加/未添加)', 'description' => '状态(已添加/未添加)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '已添加'],
+ 'Icon' => ['title' => 'icon', 'description' => 'icon', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/jiudianmianban_fuwushangpintu/wupin/keyongpinlei/mianqian.png'],
+ 'Price' => ['title' => '价格(单位:分)', 'description' => '价格(单位:分)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '165'],
+ 'DialogueList' => [
+ 'title' => '对话List',
+ 'description' => '对话List',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceId' => ['title' => 'itemId', 'description' => 'itemId', 'type' => 'string', 'required' => false, 'example' => '10337'],
+ 'Process' => ['title' => '第几轮对话', 'description' => '第几轮对话', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'Question' => ['title' => '问题', 'description' => '问题', 'type' => 'string', 'required' => false, 'example' => '无'],
+ 'YesAnswer' => ['title' => '肯定回答', 'description' => '肯定回答', 'type' => 'string', 'required' => false, 'example' => '纸巾1.5元,请问需要么?'],
+ 'NoAnswer' => ['title' => '否定回答', 'description' => '否定回答', 'type' => 'string', 'required' => false, 'example' => '对不起,暂时不提供此物品'],
+ 'YesAnswerTemplate' => ['title' => '肯定回答模板ID', 'description' => '肯定回答模板ID', 'type' => 'string', 'required' => false, 'example' => '4'],
+ 'NoAnswerTemplate' => ['title' => '否定回答模板ID', 'description' => '否定回答模板ID', 'type' => 'string', 'required' => false, 'example' => '4'],
+ 'DialogueId' => ['title' => '对话ID', 'description' => '对话ID', 'type' => 'string', 'required' => false, 'example' => '335'],
+ ],
+ 'required' => false,
+ ],
'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
],
+ 'DeliveryMethod' => ['title' => '物品配送方式:waiter 服务员(默认) robot 机器人', 'description' => '物品配送方式:waiter 服务员 robot 机器人', 'type' => 'string', 'required' => false, 'example' => 'robot'],
+ 'RobotName' => ['title' => '机器人名称,物品配送方式为robot时必填', 'description' => '机器人名称。', 'type' => 'string', 'required' => false, 'example' => '测试机器人'],
+ 'PaymentMethod' => ['title' => '结算方式:room 房费结算(默认) robot 机器人结算', 'description' => '结算方式:room 房费结算 robot 机器人结算', 'type' => 'string', 'required' => false, 'example' => 'robot'],
+ 'LimitSwitch' => ['title' => '是否限制数量:1:限制 其它不限制', 'description' => '是否限量 1表示限制 0或空:不限', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'LimitNumber' => ['title' => '限制数量', 'description' => '限制数量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
+ 'BeyondLimitReply' => ['title' => '超限回复', 'description' => '超限回复', 'type' => 'string', 'required' => false, 'example' => '尊敬的客户您好,该物品今日已超出酒店供应数量,有需要请联系前台。'],
],
- 'required' => false,
+ 'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<HotelCallContact>',
- 'description' => 'Result<HotelCallContact>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'HotelId' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'example' => 'a7***83',
- ],
- 'Type' => [
- 'title' => '联系人类型,device:设备,group:分组',
- 'description' => '联系人类型,device:设备,group:分组',
- 'type' => 'string',
- 'example' => 'group',
- ],
- 'Uuid' => [
- 'title' => '唯一标识',
- 'description' => '唯一标识',
- 'type' => 'string',
- 'example' => '2E57***D45F9',
- ],
- 'Number' => [
- 'title' => '号码',
- 'description' => '号码',
- 'type' => 'string',
- 'example' => '101',
- ],
- 'Name' => [
- 'title' => '联系人名称',
- 'description' => '联系人名称',
- 'type' => 'string',
- 'example' => '前台',
- ],
- 'Icon' => [
- 'title' => '图标',
- 'description' => '图标',
- 'type' => 'string',
- 'example' => 'xxx.icon',
- ],
- 'Status' => [
- 'title' => '状态,1:可用,0:不可用',
- 'description' => '状态,1:可用,0:不可用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ExpireAt' => [
- 'title' => '失效时间',
- 'description' => '失效时间',
- 'type' => 'string',
- 'example' => '1649472283046',
- ],
- 'Id' => [
- 'title' => '联系人id',
- 'description' => '联系人id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'GmtCreate' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2022-07-21 20:02:12',
- ],
- 'GmtModified' => [
- 'title' => '最后修改时间',
- 'description' => '最后修改时间',
- 'type' => 'string',
- 'example' => '2022-07-27 14:06:27'."\n",
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73C6***E6FA',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求id', 'type' => 'string', 'example' => '0D0C***67DB'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"HotelId\\": \\"a7***83\\",\\n \\"Type\\": \\"group\\",\\n \\"Uuid\\": \\"2E57***D45F9\\",\\n \\"Number\\": \\"101\\",\\n \\"Name\\": \\"前台\\",\\n \\"Icon\\": \\"xxx.icon\\",\\n \\"Status\\": 1,\\n \\"ExpireAt\\": \\"1649472283046\\",\\n \\"Id\\": 1,\\n \\"GmtCreate\\": \\"2022-07-21 20:02:12\\",\\n \\"GmtModified\\": \\"2022-07-27 14:06:27\\\\n\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C6***E6FA\\"\\n}","type":"json"}]',
- 'title' => '获取设备通话联系人信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0D0C***67DB\\"\\n}","type":"json"}]',
+ 'title' => '编辑酒店场景服务',
+ 'description' => '- ***影响因素:***'."\n"
+ .'> '."\n"
+ .'> - `1、价格是否=0;`'."\n"
+ .'> - `2、是否使用模板;`'."\n"
+ .'> - `3、新增/修改对话;`'."\n"
+ ."\n"
+ .'- ***修改规则:***'."\n"
+ .'> '."\n"
+ .'> 1. 1、价格是否为0元'."\n"
+ .'> - 等于0:dialogueList.size=1 && 参数内容为process=0(一轮对话,免费服务);'."\n"
+ .'> - 大于0:dialogueList.size=2 && 参数内容为process=0 (一轮对话,付费服务,询问是否需要)+ process=1(二轮对话,对是否需要的回答)'."\n"
+ .'> 2. 2、是否使用模板'."\n"
+ .' - "isUseTemplateAnswer": true/false'."\n"
+ .'3. 3、新增/修改对话'."\n"
+ ."\n"
+ .'1. ***新增对话:***'."\n"
+ .'> - 使用模板:yesAnswerTemplate'."\0".' && noAnswerTemplate'."\0".' && process'."\0".' 不为null,其他为null;'."\n"
+ .'> - 不使用模板:yesAnswer'."\0\0".' && noAnswer'."\0\0".' && process'."\0".' 不为null,其他为null'."\n"
+ ."\n"
+ .' 1. ***修改对话***'."\n"
+ ."\n"
+ .' > - 使用模板:yesAnswerTemplate'."\0".' && noAnswerTemplate'."\0".' && process'."\0".' && dialogueId'."\0".' && serviceId'."\0".' 不为null,其他为null;'."\n"
+ .' > - 不使用模板:yesAnswer'."\0\0".' && noAnswer'."\0\0".' && process'."\0".' && dialogueId'."\0".' && serviceId'."\0".' 不为null,其他为null',
+ 'extraInfo' => '| <div style="width:250px">场景</div> | 示例参数 |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 1、开启 && 0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
+ .'| 2、开启 && 0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"服务员马上给你送来!!!","noAnswer":"对不起没有这个物品!!!"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
+ .'| 3、开启 && >0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"},{"process":1,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":33333,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
+ .'| 4、开启 && >0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX需要6元!!!","noAnswer":"对不起没有这个物品!!!"},{"process":1,"yesAnswer":"好得服务员给你尽快送来!!!","noAnswer":"好的已取消!!!"}],"price":33322,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"OPEN","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
+ .'| 5、关闭 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":0,"id":xxx,"status":"未添加"},"updateHotelSceneOperateReq":{"operateType":"CLOSE","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
+ .'| 6、编辑 && 0元 **改为** >0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"},{"process":1,"noAnswerTemplate":"5","yesAnswerTemplate":"5"}],"price":55656,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
+ .'| 7、编辑 && 0元 **改为** >0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX需要6元!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品!!!","serviceId":"166033"},{"process":1,"yesAnswer":"好得服务员给你尽快送来!!!","noAnswer":"好的已取消!!!"}],"price":3322,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
+ .'| 8、编辑 && 0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
+ .'| 9、编辑 && 0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"","yesAnswer":"服务员马上给你送来!!!!!!!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
+ .'| 10、编辑 && >0元 **改为** 0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
+ .'| 11、编辑 && >0元 **改为** 0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"服务员马上给你送来!!!!!!!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品!!!","serviceId":"166033"}],"price":0,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |'."\n"
+ .'| 12、编辑 && >0元 **改为** >0元 && 模板回答 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"},{"process":1,"noAnswerTemplate":"5","dialogueId":"xxx","yesAnswerTemplate":"5","serviceId":"166033"}],"price":5555,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":true},"hotelId":"****"} |'."\n"
+ .'| 13、编辑 && >0元 **改为** >0元 && 不使用模板 | {"updateHotelSceneReq":{"icon":"xxx.png","dialogueList":[{"process":0,"yesAnswer":"XXX需要6元!!!","dialogueId":"xxx","noAnswer":"对不起没有这个物品!!!","serviceId":"166033"},{"process":1,"yesAnswer":"好的服务员马上给你送来!!!!","dialogueId":"xxx","noAnswer":"好的已取消","serviceId":"166033"}],"price":5555,"id":xxx,"status":"已添加"},"updateHotelSceneOperateReq":{"operateType":"EDIT","isUseTemplateAnswer":false},"hotelId":"****"} |',
],
- 'AddOrUpdateScreenSaver' => [
- 'summary' => '仅带屏猫精设备生效,设置带屏设备的屏保配置',
- 'path' => '/v1.0/ip/addOrUpdateScreenSaver',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateMessageTemplate' => [
+ 'summary' => '修改编辑消息通知模板',
+ 'path' => '/v1.0/ip/updateMessageTemplate',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'HotelId',
+ 'name' => 'TemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7a3***013',
- ],
+ 'schema' => ['title' => '模板主键id', 'description' => '模板主键id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123'],
],
[
- 'name' => 'HotelScreenSaver',
+ 'name' => 'TemplateName',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '屏保',
- 'description' => '屏保',
- 'type' => 'object',
- 'properties' => [
- 'ScreenSaverStyle' => [
- 'title' => '屏保样式code',
- 'description' => '屏保样式code',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'common-weather',
- ],
- 'ScreenSaverPicUrl' => [
- 'title' => '屏保图片',
- 'description' => '屏保图片',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx.png',
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'required' => false, 'example' => '测试一下'],
+ ],
+ [
+ 'name' => 'TemplateDetail',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模板详情', 'description' => '模板详情', 'type' => 'string', 'required' => false, 'example' => '模板的详情'],
],
],
'responses' => [
@@ -16529,100 +8303,71 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '4EED***9661',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '返回的请求id', 'description' => '返回的请求id', 'type' => 'string', 'example' => '43***881'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4EED***9661\\"\\n}","type":"json"}]',
- 'title' => '设置屏保',
- 'description' => '- 建议屏保背景图使用深色图片,以保证时间、天气等信息的显示效果',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"43***881\\"\\n}","type":"json"}]',
+ 'title' => '修改消息通知模板',
+ 'description' => '> 修改消息通知模板'."\n"
+ .'> - 需要查询出模板的templateId 根据templateId然后修改其他参数',
],
- 'AddOrUpdateDisPlayModes' => [
- 'summary' => '仅带屏猫精设备生效,用于设置带屏设备上展示的模式列表',
- 'path' => '/v1.0/ip/addOrUpdateDisPlayModes',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateRcuScene' => [
+ 'summary' => '修改rcu自定义场景',
+ 'path' => '/v1.0/ip/updateRcuScene',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店id',
- 'description' => '酒店id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
+ 'schema' => ['title' => '酒店id', 'description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'],
],
[
- 'name' => 'HotelDeviceModeList',
+ 'name' => 'SceneId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '场景编码', 'description' => '场景编码', 'type' => 'string', 'required' => true, 'example' => 'yoga'],
+ ],
+ [
+ 'name' => 'SceneRelationExtDTO',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '带屏设备展示的模式code列表',
- 'description' => '带屏设备展示的模式code列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '模式编码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dndMode',
+ 'title' => '酒店RCU自定义场景',
+ 'description' => '酒店RCU自定义场景',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'required' => false, 'example' => '瑜伽模式'],
+ 'Icon' => ['title' => '场景图标', 'description' => '场景图标', 'type' => 'string', 'required' => false, 'example' => 'https://ailabsaicloudservice.alicdn.com/hotel/icon/changjingmoshi/shuimian.png'],
+ 'Description' => ['title' => '场景描述信息', 'description' => '场景描述信息', 'type' => 'string', 'required' => false, 'example' => '做做瑜伽'],
+ 'CorpusList' => [
+ 'title' => '触发语料',
+ 'description' => '触发语料(支持多场景,根据需求传递list,会覆盖之前配的触发语料,若都需要配,修改时需都传 例:瑜伽模式、开始瑜伽)',
+ 'type' => 'array',
+ 'items' => ['description' => '触发语料', 'type' => 'string', 'required' => false, 'example' => '开始瑜伽'],
+ 'required' => false,
+ ],
],
'required' => true,
],
@@ -16635,121 +8380,68 @@
'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,200标识成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '3A680F3A-6672-5A47-AB28-12BBCD80C679'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '设置带屏展示模式列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3A680F3A-6672-5A47-AB28-12BBCD80C679\\"\\n}","type":"json"}]',
+ 'title' => '修改rcu自定义场景',
+ 'description' => '修改rcu自定义场景,请根据请求参数修改',
],
- 'GetUnionId' => [
- 'summary' => '使用open id换取跨域的union id',
- 'path' => '/v1.0/ip/getUnionId',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateServiceQA' => [
+ 'summary' => '通用问答模块下的修改服务设施问答功能。',
+ 'path' => '/v1.0/ip/updateServiceQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'EncodeType',
+ 'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '编码类型,从天猫精灵开放平台中获取',
- 'description' => '编码类型,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOTEL',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => 'af7***536'],
],
[
- 'name' => 'EncodeKey',
+ 'name' => 'ServiceQAId',
'in' => 'formData',
- 'schema' => [
- 'title' => '编码Key,从天猫精灵开放平台中获取',
- 'description' => '编码Key,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'required' => true,
- 'example' => '125****0946',
- ],
+ 'schema' => ['title' => '通用问答信息', 'description' => '服务设施问答id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'IdType',
+ 'name' => 'Answer',
'in' => 'formData',
- 'schema' => [
- 'title' => 'open id类型,可为用户id或设备id;'."\n"
- .'USER_ID: 用户id'."\n"
- .'DEVICE_ID: 设备id',
- 'description' => 'open id类型,可为用户id或设备id'."\n"
- .'- USER_ID: 用户id'."\n"
- .'- DEVICE_ID: 设备id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DEVICE_ID',
- ],
+ 'schema' => ['title' => '答案', 'description' => '回答', 'type' => 'string', 'required' => false, 'example' => '测试'],
],
[
- 'name' => 'Id',
+ 'name' => 'isActive',
'in' => 'formData',
'schema' => [
- 'title' => 'id类型对应的open id值',
- 'description' => 'id类型对应的open id值',
- 'type' => 'string',
- 'required' => true,
- 'example' => '62a319****abdc',
+ 'title' => '是否启用',
+ 'description' => '是否启用(true:开启、false:关闭)',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => ['true' => '开启', 'false' => '关闭'],
+ 'example' => 'true',
],
],
],
@@ -16757,95 +8449,42 @@
200 => [
'headers' => [],
'schema' => [
- 'title' => 'Result<List<UnionInfo>>',
- 'description' => 'Result<List<UnionInfo>>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'OrganizationId' => [
- 'title' => '组织id,可在天猫精灵开放平台管理',
- 'description' => '组织id,可在天猫精灵开放平台管理',
- 'type' => 'string',
- 'example' => '4325***765',
- ],
- 'UnionId' => [
- 'title' => '请求参数的open id在该组织下的唯一id值',
- 'description' => '请求参数的open id在该组织下的唯一id值',
- 'type' => 'string',
- 'example' => '8bh2****8s8',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '73C67***6FA'."\n"],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": [\\n {\\n \\"OrganizationId\\": \\"4325***765\\",\\n \\"UnionId\\": \\"8bh2****8s8\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '换取unionId',
- 'description' => '当前天猫精灵开放体系下有多个域,例如天猫精灵AI平台、技能应用平台、行业开放平台,各个域的open信息自成闭环,而跨多域的请求交互需要先创建组织,并在组织下将各域的实体(例如酒店应用appid或者技能应用平台创建的应用)关联到组织下,关联后可以使用该接口根据酒店的open id换取到酒店所属组织下的union id,使用union id可在各域调用相应的接口'."\n"
- .'![](https://img.alicdn.com/imgextra/i3/O1CN01EVSThl1txqw0eFOIb_!!6000000005969-0-tps-1024-274.jpg)',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73C67***6FA\\\\n\\"\\n}","type":"json"}]',
+ 'title' => '修改服务设施问答',
],
- 'HotelQrBind' => [
- 'summary' => '酒店带屏设备扫码绑定。',
- 'path' => '/v1.0/ip/hotelQrBind',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateTicket' => [
+ 'summary' => '修改工单。',
+ 'path' => '/v1.0/ip/updateTicket',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
@@ -16853,197 +8492,109 @@
[
'name' => 'HotelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '酒店ID',
- 'description' => '酒店ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a7***83',
- ],
+ 'schema' => ['description' => '酒店id', 'type' => 'string', 'required' => true, 'example' => '520a0c0***5eb'],
],
[
- 'name' => 'RoomNo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '房间号',
- 'description' => '房间号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1211',
- ],
- ],
- [
- 'name' => 'Code',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '带屏设备绑定二维码中的code参数',
- 'description' => '带屏设备绑定二维码中的code参数',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'freuisghrtiesnvfkdsvbfuidslnvfs',
- ],
- ],
- [
- 'name' => 'ClientId',
+ 'name' => 'Status',
'in' => 'formData',
'schema' => [
- 'title' => '带屏设备绑定二维码中的clientId参数',
- 'description' => '带屏设备绑定二维码中的clientId参数',
+ 'title' => '状态',
+ 'description' => '状态:handled: 已处理, waiting:待处理, delayed:延迟处理',
'type' => 'string',
'required' => true,
- 'example' => 'xxxxxx',
+ 'enumValueTitles' => ['waiting' => '待处理', 'handled' => '已处理', 'delayed' => '延迟处理'],
+ 'example' => 'waiting',
],
],
[
- 'name' => 'ExtInfo',
+ 'name' => 'GroupKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息jsonString',
- 'description' => '额外信息jsonString',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['title' => '分组键', 'description' => '分组键,代表了一次对话或者一次下单操作,多轮对话使用一个groupkey,会自动合并成一条工单多条对话的形式', 'type' => 'string', 'required' => true, 'example' => '2023***93975'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
- 'title' => 'Result<UserAndDeviceInfo>',
- 'description' => 'Result<UserAndDeviceInfo>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'StatusCode' => [
- 'title' => '调用返回码,200标识为成功',
- 'description' => '调用返回码,200标识为成功',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'OpenUserInfo' => [
- 'title' => '开放用户信息',
- 'description' => '开放用户信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,从天猫精灵开放平台中获取',
- 'description' => '编码类型,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'title' => '编码Key,从天猫精灵开放平台中获取',
- 'description' => '编码Key,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'IdType' => [
- 'title' => '编码信息,从天猫精灵开放平台中获取',
- 'description' => '编码信息,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'title' => '用户唯一标识',
- 'description' => '用户唯一标识',
- 'type' => 'string',
- 'example' => 'xxxxxx',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时返回',
- 'description' => '组织ID,如果IdType为UNION_ID时返回',
- 'type' => 'string',
- 'example' => 'aaaaaaaa',
- ],
- ],
- ],
- 'OpenDeviceInfo' => [
- 'title' => '开放设备信息',
- 'description' => '开放设备信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,从天猫精灵开放平台中获取',
- 'description' => '编码类型,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'example' => 'HOTEL',
- ],
- 'EncodeKey' => [
- 'title' => '编码Key,从天猫精灵开放平台中获取',
- 'description' => '编码Key,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'IdType' => [
- 'title' => '编码信息,从天猫精灵开放平台中获取',
- 'description' => '编码信息,从天猫精灵开放平台中获取',
- 'type' => 'string',
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'title' => '设备唯一标识',
- 'description' => '设备唯一标识',
- 'type' => 'string',
- 'example' => 'xxxxxxx',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时返回',
- 'description' => '组织ID,如果IdType为UNION_ID时返回',
- 'type' => 'string',
- 'example' => 'aaaaaaaa',
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '73****9-175A-1324-8202-9FAAB*****A',
- ],
+ 'StatusCode' => ['title' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'description' => '调用返回码,除约定的SUCCESS_CODE外,其余由服务提供者自定义', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '服务的实际返回结果', 'description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '0EC7***726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The request parameter is invalid', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'ServerError',
- 'errorMessage' => 'internal server error',
- ],
+ ['errorCode' => 'ServerError', 'errorMessage' => 'internal server error', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": {\\n \\"OpenUserInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n },\\n \\"OpenDeviceInfo\\": {\\n \\"EncodeType\\": \\"HOTEL\\",\\n \\"EncodeKey\\": \\"123\\",\\n \\"IdType\\": \\"OPEN_ID\\",\\n \\"Id\\": \\"xxxxxxx\\",\\n \\"OrganizationId\\": \\"aaaaaaaa\\"\\n }\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\"\\n}","type":"json"}]',
- 'title' => '酒店扫码绑定',
- 'description' => '酒店带屏设备扫码绑定,可用于自建app管理设备',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StatusCode\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0EC7***726E\\"\\n}","type":"json"}]',
+ 'title' => '修改工单',
],
],
- 'endpoints' => [
+ 'endpoints' => [],
+ 'errorCodes' => [
+ ['code' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.GetPhoneNumber.BizError', 'message' => 'The user has no phoneNumber.', 'http_code' => 400, 'description' => '用户未绑定手机号'],
+ ['code' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', 'message' => 'The user information does not exist.', 'http_code' => 400, 'description' => '用户信息不存在'],
+ ['code' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '参数错误'],
+ ['code' => 'AliGenie.Notifications.Application.Invalid', 'message' => 'The AliGenie app info is invalid.', 'http_code' => 400, 'description' => '应用信息缺失'],
+ ['code' => 'AliGenie.Notifications.Application.Status', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => '应用未发布'],
+ ['code' => 'AliGenie.Notifications.Application.Url', 'message' => 'The AliGenie app awaken url is missing.', 'http_code' => 400, 'description' => '应用唤起链接未配置'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'The device not bind user.', 'http_code' => 400, 'description' => '设备未绑定用户'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'Failed to identify device.', 'http_code' => 400, 'description' => '设备标识无法识别'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'message' => 'Failed to identify user.', 'http_code' => 400, 'description' => '用户标识无法识别'],
+ ['code' => 'AliGenie.Public.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '系统内部错误.'],
+ ['code' => 'AliGenie.Public.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template information is invalid.', 'http_code' => 400, 'description' => '模板信息有误'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template is unavailable.', 'http_code' => 400, 'description' => '模板未处于可用状态'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template does not exist.', 'http_code' => 400, 'description' => '模板不存在'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'message' => 'The template placeholder information is missing.', 'http_code' => 400, 'description' => '模板占位符信息未填充'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'message' => 'Failed to identify message target.', 'http_code' => 400, 'description' => '消息发送目标识别失败'],
+ ['code' => 'AliGenie.Reminder.CreateFail', 'message' => 'The creation request is not allowed.', 'http_code' => 403, 'description' => '提醒创建行为不合理'],
+ ['code' => 'AliGenie.Reminder.DeviceError', 'message' => 'The device is offline.', 'http_code' => 504, 'description' => '设备离线,暂时无法操作'],
+ ['code' => 'AliGenie.Reminder.HasNoAuthority', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 505, 'description' => '没有此数据操作权限'],
+ ['code' => 'AliGenie.Reminder.StopService', 'message' => 'The servic has stopped.', 'http_code' => 503, 'description' => '暂停服务'],
+ ['code' => 'AliGenie.WakeUpApp.Device.Offline', 'message' => 'The target device is not online.', 'http_code' => 400, 'description' => '目标设备不在线'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Body', 'message' => 'You must specify request body.', 'http_code' => 400, 'description' => '服务请求参数为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', 'message' => 'You must specify EncodeKey.', 'http_code' => 400, 'description' => 'EncodeKey为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'You must specify EncodeType.', 'http_code' => 400, 'description' => 'EncodeType为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'The specified EncodeType is invalid.', 'http_code' => 400, 'description' => 'EncodeType非法 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'You must specify GenieAppId.', 'http_code' => 400, 'description' => 'GenieAppId为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app does not exist.', 'http_code' => 400, 'description' => '猫精应用不存在 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The GenieApp information is inmcomplete.', 'http_code' => 400, 'description' => 'GenieApp信息不完整 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not configured wake up link.', 'http_code' => 400, 'description' => '猫精应用缺乏唤起链接配置 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The application is not installed.', 'http_code' => 400, 'description' => '应用未安装'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => '应用未发布'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', 'message' => 'You must specify OrganizationId.', 'http_code' => 400, 'description' => 'OrganizationId为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'You must specify Path.', 'http_code' => 400, 'description' => 'Path为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'The wake up path is invalid.', 'http_code' => 400, 'description' => '唤起路径有误 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', 'message' => 'You must specify TargetIdentity.', 'http_code' => 400, 'description' => 'TargetIdentity为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'You must specify TargetInfo.', 'http_code' => 400, 'description' => 'TargetInfo为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'The specified TargetInfo is invalid.', 'http_code' => 400, 'description' => 'TargetInfo信息有误'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'You must specify TargetType.', 'http_code' => 400, 'description' => 'TargetType为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'The specified TargetType is invalid.', 'http_code' => 400, 'description' => 'TargetType非法'],
+ ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid', 'http_code' => 400, 'description' => '参数无效'],
+ ['code' => 'ServerError', 'message' => 'internal server error', 'http_code' => 500, 'description' => '内部错误'],
+ ['code' => 'SystemError', 'message' => 'System Error occured.', 'http_code' => 400, 'description' => '系统异常'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'openapi.aligenie.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ImportRoomControlDevices'],
+ ],
+ 'createdAt' => '2025-12-29T10:47:10.000Z',
+ 'description' => '',
],
],
];
diff --git a/data/zh_cn/aligenie/oauth2_1.0/api-docs.php b/data/zh_cn/aligenie/oauth2_1.0/api-docs.php
index cf71288..265e2b1 100644
--- a/data/zh_cn/aligenie/oauth2_1.0/api-docs.php
+++ b/data/zh_cn/aligenie/oauth2_1.0/api-docs.php
@@ -1,35 +1,18 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'AliGenie',
- 'product' => 'AliGenie',
- 'version' => 'oauth2_1.0',
- ],
+ 'info' => ['style' => 'AliGenie', 'product' => 'AliGenie', 'version' => 'oauth2_1.0'],
'directories' => [
[
'id' => 196076,
'title' => '资源API',
'type' => 'directory',
- 'children' => [
- 'GetSmartHomeSceneList',
- 'ExecuteSmartHomeScene',
- 'GetUserBasicInfo',
- 'GetUserPhone',
- 'GetSceneList',
- 'ExecuteScene',
- 'QueryDeviceList',
- 'PushDeviceNotification',
- 'CreatePlayingList',
- ],
+ 'children' => ['GetSmartHomeSceneList', 'ExecuteSmartHomeScene', 'GetUserBasicInfo', 'GetUserPhone', 'GetSceneList', 'ExecuteScene', 'QueryDeviceList', 'PushDeviceNotification', 'CreatePlayingList'],
],
[
'id' => 196077,
'title' => '授权API',
'type' => 'directory',
- 'children' => [
- 'OAuth2TokenEndpoint',
- 'OAuth2RevocationEndpoint',
- ],
+ 'children' => ['OAuth2TokenEndpoint', 'OAuth2RevocationEndpoint'],
],
],
'components' => [
@@ -39,25 +22,17 @@
'GetSmartHomeSceneList' => [
'summary' => '获取全屋App中用户配置的包含三方设备的场景控制列表。',
'path' => '/v1.0/oauth2/iot/smart_home/scene/list',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
@@ -65,12 +40,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'."\n",
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'."\n"],
'FamilySceneList' => [
'description' => '家庭维度场景列表',
'type' => 'array',
@@ -78,32 +48,16 @@
'description' => '家庭场景对象',
'type' => 'object',
'properties' => [
- 'familyId' => [
- 'description' => '家庭Id',
- 'type' => 'string',
- 'example' => '2iS1AH5eo8qrw1PYBL/Ulq==',
- ],
- 'familyName' => [
- 'description' => '家庭名称',
- 'type' => 'string',
- 'example' => '我的家',
- ],
+ 'familyId' => ['description' => '家庭Id', 'type' => 'string', 'example' => '2iS1AH5eo8qrw1PYBL/Ulq=='],
+ 'familyName' => ['description' => '家庭名称', 'type' => 'string', 'example' => '我的家'],
'sceneList' => [
'description' => '场景列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'SceneId' => [
- 'description' => '场景Id',
- 'type' => 'string',
- 'example' => '6813AH5586qrw1P5ln/123==',
- ],
- 'SceneName' => [
- 'description' => '场景名称',
- 'type' => 'string',
- 'example' => '温馨模式',
- ],
+ 'SceneId' => ['description' => '场景Id', 'type' => 'string', 'example' => '6813AH5586qrw1P5ln/123=='],
+ 'SceneName' => ['description' => '场景名称', 'type' => 'string', 'example' => '温馨模式'],
],
],
],
@@ -114,56 +68,34 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"435CF567-12DC-5761-AFA8-650774502E2D\\\\n\\",\\n \\"FamilySceneList\\": [\\n {\\n \\"familyId\\": \\"2iS1AH5eo8qrw1PYBL/Ulq==\\",\\n \\"familyName\\": \\"我的家\\",\\n \\"sceneList\\": [\\n {\\n \\"SceneId\\": \\"6813AH5586qrw1P5ln/123==\\",\\n \\"SceneName\\": \\"温馨模式\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取场景列表(全屋)',
],
'ExecuteSmartHomeScene' => [
'summary' => '执行全屋App中用户配置的包含三方设备的场景。',
'path' => '/v1.0/oauth2/iot/smart_home/scene/execute',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'FamilyId',
'in' => 'formData',
- 'schema' => [
- 'description' => '家庭Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2iS1AH5eo8qrw1PYBL/Ulq==',
- ],
+ 'schema' => ['description' => '家庭Id', 'type' => 'string', 'required' => true, 'example' => '2iS1AH5eo8qrw1PYBL/Ulq=='],
],
[
'name' => 'SceneId',
'in' => 'formData',
- 'schema' => [
- 'description' => '场景Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Y1lCALepjYmTEouxsTrkjB==',
- ],
+ 'schema' => ['description' => '场景Id', 'type' => 'string', 'required' => true, 'example' => 'Y1lCALepjYmTEouxsTrkjB=='],
],
],
'responses' => [
@@ -173,19 +105,12 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '435CF567-12DC-5761-AFA8-650774502E2D',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '435CF567-12DC-5761-AFA8-650774502E2D'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"435CF567-12DC-5761-AFA8-650774502E2D\\"\\n}","type":"json"}]',
'title' => '执行场景(全屋)',
'responseParamsDescription' => '需要关注的异常'."\n"
@@ -203,25 +128,17 @@
'GetUserBasicInfo' => [
'summary' => '获取用户基本信息',
'path' => '/v1.0/oauth2/users/basic',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
@@ -230,12 +147,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'OpenId' => [
- 'title' => '用户openId',
- 'description' => '用户openId',
- 'type' => 'string',
- 'example' => '3hPPBd9YuhfJQCzZ/07AAWdoO3K8zCb/KAqW96zPHXPiFkzjB/JfcWuuFHQQDaGZ4wVbNMV6wYuj075p/rhVLg==',
- ],
+ 'OpenId' => ['title' => '用户openId', 'description' => '用户openId', 'type' => 'string', 'example' => '3hPPBd9YuhfJQCzZ/07AAWdoO3K8zCb/KAqW96zPHXPiFkzjB/JfcWuuFHQQDaGZ4wVbNMV6wYuj075p/rhVLg=='],
'UnionIds' => [
'title' => '用户unionId列表',
'description' => '用户unionId列表',
@@ -243,69 +155,36 @@
'items' => [
'type' => 'object',
'properties' => [
- 'OrganizationId' => [
- 'title' => '组织id',
- 'description' => '组织id',
- 'type' => 'string',
- ],
- 'UnionId' => [
- 'title' => 'unionId',
- 'description' => 'unionId',
- 'type' => 'string',
- ],
+ 'OrganizationId' => ['title' => '组织id', 'description' => '组织id', 'type' => 'string'],
+ 'UnionId' => ['title' => 'unionId', 'description' => 'unionId', 'type' => 'string'],
],
],
],
- 'Nickname' => [
- 'title' => '用户昵称',
- 'description' => '用户昵称',
- 'type' => 'string',
- 'example' => 'xxxxxx',
- ],
- 'AvatarUrl' => [
- 'title' => '用户头像地址',
- 'description' => '用户头像地址',
- 'type' => 'string',
- 'example' => 'https://xxxxxx',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5',
- ],
+ 'Nickname' => ['title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'example' => 'xxxxxx'],
+ 'AvatarUrl' => ['title' => '用户头像地址', 'description' => '用户头像地址', 'type' => 'string', 'example' => 'https://xxxxxx'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OpenId\\": \\"3hPPBd9YuhfJQCzZ/07AAWdoO3K8zCb/KAqW96zPHXPiFkzjB/JfcWuuFHQQDaGZ4wVbNMV6wYuj075p/rhVLg==\\",\\n \\"UnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"\\",\\n \\"UnionId\\": \\"\\"\\n }\\n ],\\n \\"Nickname\\": \\"xxxxxx\\",\\n \\"AvatarUrl\\": \\"https://xxxxxx\\",\\n \\"RequestId\\": \\"4070039E-5822-1F32-9295-1D2883E48BA5\\"\\n}","type":"json"}]',
'title' => '获取用户基本信息',
],
'GetUserPhone' => [
'summary' => '获取天猫精灵用户绑定的手机号',
'path' => '/v1.0/oauth2/user/profile/phone',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
@@ -314,50 +193,30 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Phone' => [
- 'title' => '天猫精灵用户绑定的手机号',
- 'description' => '天猫精灵用户绑定的手机号',
- 'type' => 'string',
- 'example' => '18612345678',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97',
- ],
+ 'Phone' => ['title' => '天猫精灵用户绑定的手机号', 'description' => '天猫精灵用户绑定的手机号', 'type' => 'string', 'example' => '18612345678'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CEADB586-51CB-1B6B-95BD-AB85A7A08E97'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Phone\\": \\"18612345678\\",\\n \\"RequestId\\": \\"CEADB586-51CB-1B6B-95BD-AB85A7A08E97\\"\\n}","type":"json"}]',
'title' => '获取用户手机号',
],
'GetSceneList' => [
'summary' => '获取场景列表',
'path' => '/v1.0/oauth2/iot/scene/list',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
@@ -375,72 +234,39 @@
'description' => '场景对象',
'type' => 'object',
'properties' => [
- 'SceneId' => [
- 'title' => '场景Id',
- 'description' => '场景Id',
- 'type' => 'string',
- 'example' => '840960b85c3c48e0bd7260c1718295fd',
- ],
- 'SceneName' => [
- 'title' => '场景名称',
- 'description' => '场景名称',
- 'type' => 'string',
- 'example' => '回家场景',
- ],
+ 'SceneId' => ['title' => '场景Id', 'description' => '场景Id', 'type' => 'string', 'example' => '840960b85c3c48e0bd7260c1718295fd'],
+ 'SceneName' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'example' => '回家场景'],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '435CF567-58DC-5761-AFA8-650772602E2D',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '435CF567-58DC-5761-AFA8-650772602E2D'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SceneList\\": [\\n {\\n \\"SceneId\\": \\"840960b85c3c48e0bd7260c1718295fd\\",\\n \\"SceneName\\": \\"回家场景\\"\\n }\\n ],\\n \\"RequestId\\": \\"435CF567-58DC-5761-AFA8-650772602E2D\\"\\n}","type":"json"}]',
'title' => '获取场景列表',
],
'ExecuteScene' => [
'summary' => '执行场景',
'path' => '/v1.0/oauth2/iot/scene/execute',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'formData',
- 'schema' => [
- 'title' => '场景Id',
- 'description' => '场景Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a84a55aa410e460a9ac753570c76fecc',
- ],
+ 'schema' => ['title' => '场景Id', 'description' => '场景Id', 'type' => 'string', 'required' => false, 'example' => 'a84a55aa410e460a9ac753570c76fecc'],
],
],
'responses' => [
@@ -450,18 +276,12 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920',
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '191C79AD-F9F9-531E-B8C1-73DF6433B920'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"191C79AD-F9F9-531E-B8C1-73DF6433B920\\"\\n}","type":"json"}]',
'title' => '执行场景',
'responseParamsDescription' => '需要特殊处理的异常'."\n"
@@ -487,25 +307,17 @@
'QueryDeviceList' => [
'summary' => '提供给三方客户端查询用户已授权(三方需要提前申请授权的PK列表)的设备列表。',
'path' => '/v1.0/oauth2/device/list',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
@@ -514,18 +326,8 @@
'description' => '返回数据体',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '实体类型',
- 'description' => '实体类型',
- 'type' => 'string',
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '实体key',
- 'description' => '实体key',
- 'type' => 'string',
- 'example' => '125****0946',
- ],
+ 'EncodeType' => ['title' => '实体类型', 'description' => '实体类型', 'type' => 'string', 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '实体key', 'description' => '实体key', 'type' => 'string', 'example' => '125****0946'],
'DeviceList' => [
'title' => '设备列表',
'description' => '设备列表',
@@ -533,12 +335,7 @@
'items' => [
'type' => 'object',
'properties' => [
- 'DeviceOpenId' => [
- 'title' => '设备唯一标识',
- 'description' => '设备唯一标识',
- 'type' => 'string',
- 'example' => 'jMR2********ojVJXk=',
- ],
+ 'DeviceOpenId' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'jMR2********ojVJXk='],
'DeviceUnionIds' => [
'title' => '设备UnionId信息列表',
'description' => '设备UnionId信息列表',
@@ -548,83 +345,41 @@
'description' => '设备UnionId信息',
'type' => 'object',
'properties' => [
- 'OrganizationId' => [
- 'title' => '组织ID',
- 'description' => '组织ID',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'UnionId' => [
- 'title' => 'UnionId',
- 'description' => 'UnionId',
- 'type' => 'string',
- 'example' => 'cJwXrIut3zIgcKyCiS7aKMAiEiE',
- ],
+ 'OrganizationId' => ['title' => '组织ID', 'description' => '组织ID', 'type' => 'string', 'example' => '123456'],
+ 'UnionId' => ['title' => 'UnionId', 'description' => 'UnionId', 'type' => 'string', 'example' => 'cJwXrIut3zIgcKyCiS7aKMAiEiE'],
],
],
],
- 'DeviceName' => [
- 'title' => '设备名称',
- 'description' => '设备名称',
- 'type' => 'string',
- 'example' => 'CC10电池版',
- ],
- 'DeviceIconUrl' => [
- 'title' => '设备图片地址',
- 'description' => '设备图片地址',
- 'type' => 'string',
- 'example' => 'https://XXXXXX',
- ],
- 'Online' => [
- 'title' => '在线状态,1:在线,0离线',
- 'description' => '在线状态,1:在线,0离线',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'DeviceName' => ['title' => '设备名称', 'description' => '设备名称', 'type' => 'string', 'example' => 'CC10电池版'],
+ 'DeviceIconUrl' => ['title' => '设备图片地址', 'description' => '设备图片地址', 'type' => 'string', 'example' => 'https://XXXXXX'],
+ 'Online' => ['title' => '在线状态,1:在线,0离线', 'description' => '在线状态,1:在线,0离线', 'type' => 'string', 'example' => '1'],
],
],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"125****0946\\",\\n \\"DeviceList\\": [\\n {\\n \\"DeviceOpenId\\": \\"jMR2********ojVJXk=\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"123456\\",\\n \\"UnionId\\": \\"cJwXrIut3zIgcKyCiS7aKMAiEiE\\"\\n }\\n ],\\n \\"DeviceName\\": \\"CC10电池版\\",\\n \\"DeviceIconUrl\\": \\"https://XXXXXX\\",\\n \\"Online\\": \\"1\\"\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
'title' => '查询设备列表',
],
'PushDeviceNotification' => [
'summary' => '推送设备通知',
'path' => '/v1.0/oauth2/device/notification/push',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'body',
@@ -650,67 +405,24 @@
'type' => 'string',
'required' => false,
'example' => 'DEVICE_OPEN_ID',
- 'enum' => [
- 'DEVICE_UNION_ID',
- 'DEVICE_OPEN_ID',
- ],
- ],
- 'TargetIdentity' => [
- 'title' => '推送目标类型对应的标识值。',
- 'description' => '推送目标类型对应的标识值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=',
+ 'enum' => ['DEVICE_UNION_ID', 'DEVICE_OPEN_ID'],
],
+ 'TargetIdentity' => ['title' => '推送目标类型对应的标识值。', 'description' => '推送目标类型对应的标识值。', 'type' => 'string', 'required' => false, 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY='],
],
'required' => true,
],
- 'MessageTemplateId' => [
- 'title' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。',
- 'description' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2iU81*****G9elJ',
- ],
+ 'MessageTemplateId' => ['title' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。', 'description' => '消息模板,在天猫精灵应用平台中申请消息模板时得到的模板id。', 'type' => 'string', 'required' => true, 'example' => '2iU81*****G9elJ'],
'PlaceHolder' => [
'title' => '占位符信息,例如:模板是【你好,{nick}!】这里可以是:{"nick":"小甜甜"}',
'description' => '占位符信息,例如:模板是【你好,{nick}!】这里可以是:{"nick":"小甜甜"}',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"nick":"小甜甜"}',
- 'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。此外,在占位符参数里我们还可以对填写的应用调起链接增加参数,以支持跳转到指定地址的功能,如:`{"nick":"小甜甜","_URL_SUFFIX_":"xxx"}`。消息弹窗内的跳转地址就是:应用调起链接+`${_URL_SUFFIX_}`,此功能只对配置了调起链接的应用有效',
- ],
- ],
- 'EncodeType' => [
- 'title' => '实体类型',
- 'description' => '实体类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '实体key',
- 'description' => '实体key',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1923792******8R7392',
- ],
- 'OrganizationId' => [
- 'title' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。',
- 'description' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '29837******2938',
- ],
- 'IsDebug' => [
- 'title' => '调试标识',
- 'description' => '调试标识',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'additionalProperties' => ['type' => 'string', 'example' => '{"nick":"小甜甜"}', 'description' => '占位符信息,例如:模板【你好,{nick}!】,此处可以是:{"nick":"小甜甜"}。此外,在占位符参数里我们还可以对填写的应用调起链接增加参数,以支持跳转到指定地址的功能,如:`{"nick":"小甜甜","_URL_SUFFIX_":"xxx"}`。消息弹窗内的跳转地址就是:应用调起链接+`${_URL_SUFFIX_}`,此功能只对配置了调起链接的应用有效'],
],
+ 'EncodeType' => ['title' => '实体类型', 'description' => '实体类型', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '实体key', 'description' => '实体key', 'type' => 'string', 'required' => true, 'example' => '1923792******8R7392'],
+ 'OrganizationId' => ['title' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。', 'description' => '组织标识,推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织,申请通过后由平台分配得到。', 'type' => 'string', 'required' => false, 'example' => '29837******2938'],
+ 'IsDebug' => ['title' => '调试标识', 'description' => '调试标识', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
@@ -724,13 +436,7 @@
'description' => '身份信息。',
'type' => 'object',
'properties' => [
- 'SubjectId' => [
- 'title' => '猫精应用id,【开发者平台-技能应用】创建应用后得到的应用id',
- 'description' => '猫精应用id,【开发者平台-技能应用】创建应用后得到的应用id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12797******304102',
- ],
+ 'SubjectId' => ['title' => '猫精应用id,【开发者平台-技能应用】创建应用后得到的应用id', 'description' => '猫精应用id,【开发者平台-技能应用】创建应用后得到的应用id', 'type' => 'string', 'required' => false, 'example' => '12797******304102'],
],
'required' => false,
],
@@ -743,47 +449,30 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F',
- ],
+ 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]',
'title' => '推送设备通知',
],
'CreatePlayingList' => [
'summary' => '创建播放列表',
'path' => '/v1.0/oauth2/content/playing/create',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'OAuth 2.0 Bearer Token' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'OpenCreatePlayingListRequest',
@@ -794,17 +483,11 @@
'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'PlayFrom' => [
- 'title' => '播放来源,配置播控能力的唯一标识'."\n"
- ."\n"
- .'可空,默认为default',
- 'description' => '播放来源,配置播控能力的唯一标识'."\n"
- ."\n"
- .'可空,默认为default',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'PlayFrom' => ['title' => '播放来源,配置播控能力的唯一标识'."\n"
+ ."\n"
+ .'可空,默认为default', 'description' => '播放来源,配置播控能力的唯一标识'."\n"
+ ."\n"
+ .'可空,默认为default', 'type' => 'string', 'required' => false, 'example' => 'default'],
'ContentType' => [
'title' => '播放内容类型'."\n"
."\n"
@@ -815,11 +498,7 @@
'type' => 'string',
'required' => true,
'example' => 'content',
- 'enum' => [
- 'content',
- 'album',
- 'collect',
- ],
+ 'enum' => ['content', 'album', 'collect'],
],
'ContentList' => [
'title' => '播放内容列表'."\n"
@@ -832,49 +511,23 @@
'items' => [
'type' => 'object',
'properties' => [
- 'RawId' => [
- 'title' => '三方id'."\n"
- ."\n"
- .'如果是内容则是内容id;如果是专辑则是专辑id'."\n",
- 'description' => '三方id'."\n"
- ."\n"
- .'如果是内容则是内容id;如果是专辑则是专辑id'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
- 'Source' => [
- 'title' => '来源'."\n",
- 'description' => '来源'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ximalayaH5',
- ],
+ 'RawId' => ['title' => '三方id'."\n"
+ ."\n"
+ .'如果是内容则是内容id;如果是专辑则是专辑id'."\n", 'description' => '三方id'."\n"
+ ."\n"
+ .'如果是内容则是内容id;如果是专辑则是专辑id'."\n", 'type' => 'string', 'required' => true, 'example' => '12345'],
+ 'Source' => ['title' => '来源'."\n", 'description' => '来源'."\n", 'type' => 'string', 'required' => true, 'example' => 'ximalayaH5'],
],
'required' => true,
],
'required' => true,
],
- 'Index' => [
- 'title' => '播放的index'."\n"
- ."\n"
- .'可空。默认为0,表示从头播放',
- 'description' => '播放的index'."\n"
- ."\n"
- .'可空。默认为0,表示从头播放',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'NeedAlbumContinued' => [
- 'title' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true',
- 'description' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'Index' => ['title' => '播放的index'."\n"
+ ."\n"
+ .'可空。默认为0,表示从头播放', 'description' => '播放的index'."\n"
+ ."\n"
+ .'可空。默认为0,表示从头播放', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'NeedAlbumContinued' => ['title' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true', 'description' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
'PlayMode' => [
'title' => '播放模式'."\n"
."\n"
@@ -885,24 +538,10 @@
'type' => 'string',
'required' => false,
'example' => 'Normal',
- 'enum' => [
- 'Repeat',
- 'Shuffle',
- 'RepeatOne',
- 'Normal',
- ],
- ],
- 'ExtendInfo' => [
- 'title' => '扩展信息',
- 'description' => '扩展信息',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'title' => '系统RequestId,调用方不需要传 系统自动填写',
- 'type' => 'string',
+ 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'],
],
+ 'ExtendInfo' => ['title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{}'],
+ 'RequestId' => ['title' => '系统RequestId,调用方不需要传 系统自动填写', 'type' => 'string'],
],
'required' => true,
],
@@ -922,42 +561,19 @@
'type' => 'string',
'required' => true,
'example' => 'UC_CLIENT_ID',
- 'enum' => [
- 'UC_CLIENT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
+ 'enum' => ['UC_CLIENT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
'title' => '设备Id的类型 : OPEN_ID:默认的设备ID标识。 UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '设备Id的类型 : OPEN_ID:默认的设备ID标识。 UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => true,
],
@@ -970,18 +586,12 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10002398812\\"\\n}","type":"json"}]',
'title' => '创建播放列表',
],
@@ -990,75 +600,41 @@
.'1. 通过code获取access_token。'."\n"
.'2. 通过refresh_token刷新access_token。',
'path' => '/v1.0/oauth2/token',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'GrantType',
'in' => 'formData',
- 'schema' => [
- 'title' => '授权类型,必填。'."\n"
- .'authorization_code: 用授权码来获取访问令牌'."\n"
- .'refresh_token: 刷新访问令牌',
- 'description' => '授权类型,必填。'."\n"
- .'authorization_code: 用授权码来获取访问令牌'."\n"
- .'refresh_token: 刷新访问令牌',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'authorization_code',
- ],
+ 'schema' => ['title' => '授权类型,必填。'."\n"
+ .'authorization_code: 用授权码来获取访问令牌'."\n"
+ .'refresh_token: 刷新访问令牌', 'description' => '授权类型,必填。'."\n"
+ .'authorization_code: 用授权码来获取访问令牌'."\n"
+ .'refresh_token: 刷新访问令牌', 'type' => 'string', 'required' => false, 'example' => 'authorization_code'],
],
[
'name' => 'Code',
'in' => 'formData',
- 'schema' => [
- 'title' => '授权码,通过授权码换取访问令牌时必填。',
- 'description' => '授权码,通过授权码换取访问令牌时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rf3mi4JOU-xRIX2zEuRLHi-U9mPnvISeSphbwiBHJ5mEKZtG-xJsbBWrq8RmhQEPRYh0JOd3DaS_VZ90soD_YrsT4OBtgD06DmdIKL2_5KFfI6p_SjXX2-UMJuGfXDkB',
- ],
+ 'schema' => ['title' => '授权码,通过授权码换取访问令牌时必填。', 'description' => '授权码,通过授权码换取访问令牌时必填。', 'type' => 'string', 'required' => false, 'example' => 'rf3mi4JOU-xRIX2zEuRLHi-U9mPnvISeSphbwiBHJ5mEKZtG-xJsbBWrq8RmhQEPRYh0JOd3DaS_VZ90soD_YrsT4OBtgD06DmdIKL2_5KFfI6p_SjXX2-UMJuGfXDkB'],
],
[
'name' => 'RedirectUri',
'in' => 'formData',
- 'schema' => [
- 'title' => '重定向地址,该值必须与您发起授权请求的参数值完全一致。通过授权码换取访问令牌时必填。',
- 'description' => '重定向地址,该值必须与您发起授权请求的参数值完全一致。通过授权码换取访问令牌时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://xxx.xxx.com/xxx',
- ],
+ 'schema' => ['title' => '重定向地址,该值必须与您发起授权请求的参数值完全一致。通过授权码换取访问令牌时必填。', 'description' => '重定向地址,该值必须与您发起授权请求的参数值完全一致。通过授权码换取访问令牌时必填。', 'type' => 'string', 'required' => false, 'example' => 'https://xxx.xxx.com/xxx'],
],
[
'name' => 'RefreshToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '刷新令牌,刷新访问令牌时必填。',
- 'description' => '刷新令牌,刷新访问令牌时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A',
- ],
+ 'schema' => ['title' => '刷新令牌,刷新访问令牌时必填。', 'description' => '刷新令牌,刷新访问令牌时必填。', 'type' => 'string', 'required' => false, 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A'],
],
],
'responses' => [
@@ -1068,103 +644,48 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'AccessToken' => [
- 'title' => '天猫精灵给您的应用颁发的令牌。',
- 'description' => '天猫精灵给您的应用颁发的令牌。',
- 'type' => 'string',
- 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0',
- ],
- 'ExpiresIn' => [
- 'title' => '访问令牌的剩余生命周期(以秒为单位)。',
- 'description' => '访问令牌的剩余生命周期(以秒为单位)。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '604799',
- ],
- 'RefreshToken' => [
- 'title' => '可用于获取新访问令牌的令牌。',
- 'description' => '可用于获取新访问令牌的令牌。',
- 'type' => 'string',
- 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A'."\n",
- ],
- 'Scope' => [
- 'title' => 'access_token 授予的访问权限范围,表示为以空格分隔、区分大小写的字符串列表。',
- 'description' => 'access_token 授予的访问权限范围,表示为以空格分隔、区分大小写的字符串列表。',
- 'type' => 'string',
- 'example' => 'aligenie:user:basic:read aligenie:iot:scene:read',
- ],
- 'TokenType' => [
- 'title' => '返回的令牌的类型。此时,此字段的值始终设置为 Bearer。',
- 'description' => '返回的令牌的类型。此时,此字段的值始终设置为 Bearer。',
- 'type' => 'string',
- 'example' => 'Bearer',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5',
- ],
+ 'AccessToken' => ['title' => '天猫精灵给您的应用颁发的令牌。', 'description' => '天猫精灵给您的应用颁发的令牌。', 'type' => 'string', 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0'],
+ 'ExpiresIn' => ['title' => '访问令牌的剩余生命周期(以秒为单位)。', 'description' => '访问令牌的剩余生命周期(以秒为单位)。', 'type' => 'integer', 'format' => 'int64', 'example' => '604799'],
+ 'RefreshToken' => ['title' => '可用于获取新访问令牌的令牌。', 'description' => '可用于获取新访问令牌的令牌。', 'type' => 'string', 'example' => 'zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A'."\n"],
+ 'Scope' => ['title' => 'access_token 授予的访问权限范围,表示为以空格分隔、区分大小写的字符串列表。', 'description' => 'access_token 授予的访问权限范围,表示为以空格分隔、区分大小写的字符串列表。', 'type' => 'string', 'example' => 'aligenie:user:basic:read aligenie:iot:scene:read'],
+ 'TokenType' => ['title' => '返回的令牌的类型。此时,此字段的值始终设置为 Bearer。', 'description' => '返回的令牌的类型。此时,此字段的值始终设置为 Bearer。', 'type' => 'string', 'example' => 'Bearer'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessToken\\": \\"UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0\\",\\n \\"ExpiresIn\\": 604799,\\n \\"RefreshToken\\": \\"zsEcmaUeb8-NZW4IIUDD7qdgBNflrj6fH8BXJYbW9iXihZTgvbcr1_utC9p5HJLn_lXVwhfivBTgUQZBCGvGl5lxqaxFhmFtt-OrBduFQKL9x8p2lpEMKlxuKHZZZJ3A\\\\n\\",\\n \\"Scope\\": \\"aligenie:user:basic:read aligenie:iot:scene:read\\",\\n \\"TokenType\\": \\"Bearer\\",\\n \\"RequestId\\": \\"4070039E-5822-1F32-9295-1D2883E48BA5\\"\\n}","type":"json"}]',
'title' => 'OAuth2令牌端点',
],
'OAuth2RevocationEndpoint' => [
'summary' => 'OAuth2令牌撤销端点',
'path' => '/v1.0/oauth2/revoke',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'Token',
'in' => 'formData',
- 'schema' => [
- 'title' => '要撤销的令牌,可以是访问令牌或刷新令牌。'."\n"
- .'如果传递的是access_token,则仅会撤销access_token,refresh_token依然可以刷新获取新的访问令牌。'."\n"
- .'如果传递的是refresh_token,则会同时撤销access_token和对应的refresh_token。',
- 'description' => '要撤销的令牌,可以是访问令牌或刷新令牌。'."\n"
- .'如果传递的是access_token,则仅会撤销access_token,refresh_token依然可以刷新获取新的访问令牌。'."\n"
- .'如果传递的是refresh_token,则会同时撤销access_token和对应的refresh_token。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0',
- ],
+ 'schema' => ['title' => '要撤销的令牌,可以是访问令牌或刷新令牌。'."\n"
+ .'如果传递的是access_token,则仅会撤销access_token,refresh_token依然可以刷新获取新的访问令牌。'."\n"
+ .'如果传递的是refresh_token,则会同时撤销access_token和对应的refresh_token。', 'description' => '要撤销的令牌,可以是访问令牌或刷新令牌。'."\n"
+ .'如果传递的是access_token,则仅会撤销access_token,refresh_token依然可以刷新获取新的访问令牌。'."\n"
+ .'如果传递的是refresh_token,则会同时撤销access_token和对应的refresh_token。', 'type' => 'string', 'required' => false, 'example' => 'UJMiksSwuMJvwXrJLULMykSw6qZ6VqaxOkN4qd5cW1Q4HhsLxvUR5xVOIv1WB3br5LoP20lPa8xiYLSMbt8JqHACXdSdw7fNkhRTIHnadxWW5jfDg7BELUB0FcFfPiv0'],
],
[
'name' => 'TokenTypeHint',
'in' => 'formData',
- 'schema' => [
- 'title' => '令牌类型的提示,可以是access_token或refresh_token,用于帮助授权服务器理解要撤销的是哪种类型的令牌。',
- 'description' => '令牌类型的提示,可以是access_token或refresh_token,用于帮助授权服务器理解要撤销的是哪种类型的令牌。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'refresh_token',
- ],
+ 'schema' => ['title' => '令牌类型的提示,可以是access_token或refresh_token,用于帮助授权服务器理解要撤销的是哪种类型的令牌。', 'description' => '令牌类型的提示,可以是access_token或refresh_token,用于帮助授权服务器理解要撤销的是哪种类型的令牌。', 'type' => 'string', 'required' => false, 'example' => 'refresh_token'],
],
],
'responses' => [
@@ -1174,27 +695,17 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4070039E-5822-1F32-9295-1D2883E48BA5'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4070039E-5822-1F32-9295-1D2883E48BA5\\"\\n}","type":"json"}]',
'title' => 'OAuth2令牌撤销端点',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'openapi.aligenie.com',
- ],
+ ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'openapi.aligenie.com'],
],
];
diff --git a/data/zh_cn/aligenie/ssp_1.0/api-docs.php b/data/zh_cn/aligenie/ssp_1.0/api-docs.php
index d1b5d95..f659352 100644
--- a/data/zh_cn/aligenie/ssp_1.0/api-docs.php
+++ b/data/zh_cn/aligenie/ssp_1.0/api-docs.php
@@ -1,405 +1,182 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'AliGenie',
- 'product' => 'AliGenie',
- 'version' => 'ssp_1.0',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'AliGenie', 'version' => 'ssp_1.0'],
'directories' => [
[
- 'id' => 171020,
- 'title' => '账号绑定及用户授权',
+ 'children' => ['AuthLoginWithThirdUserInfo', 'EcologyOpennessSendVerificationCode', 'FindUserlistToAuthLoginWithPhoneNumber', 'AuthLoginWithAligenieUserInfo', 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber', 'AuthLoginWithTaobaoUserInfo', 'EcologyOpennessAuthenticate', 'GetAligenieUserInfo', 'UnbindAligenieUser', 'QueryUserDeviceListByTmeUserId', 'InvalidateThirdPartyAppLoginState'],
'type' => 'directory',
- 'children' => [
- 'AuthLoginWithThirdUserInfo',
- 'EcologyOpennessSendVerificationCode',
- 'FindUserlistToAuthLoginWithPhoneNumber',
- 'AuthLoginWithAligenieUserInfo',
- 'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber',
- 'AuthLoginWithTaobaoUserInfo',
- 'EcologyOpennessAuthenticate',
- 'GetAligenieUserInfo',
- 'UnbindAligenieUser',
- 'QueryUserDeviceListByTmeUserId',
- 'InvalidateThirdPartyAppLoginState',
- ],
+ 'title' => '账号绑定及用户授权',
+ 'id' => 129402,
],
[
- 'id' => 170170,
- 'title' => '激活绑定',
+ 'children' => ['CheckAuthCodeBindForExt', 'GetCodeEnhance', 'ScanCodeBind'],
'type' => 'directory',
- 'children' => [
- 'CheckAuthCodeBindForExt',
- 'GetCodeEnhance',
- 'ScanCodeBind',
- ],
+ 'title' => '激活绑定',
+ 'id' => 129414,
],
[
- 'id' => 96289,
- 'title' => '用户设备关系',
+ 'children' => ['GetUserByDeviceId', 'ListDeviceByUserId', 'UnbindDevice', 'ListDeviceByUserIdAndChanel'],
'type' => 'directory',
- 'children' => [
- 'GetUserByDeviceId',
- 'ListDeviceByUserId',
- 'UnbindDevice',
- 'ListDeviceByUserIdAndChanel',
- ],
+ 'title' => '用户设备关系',
+ 'id' => 129418,
],
[
- 'id' => 96293,
- 'title' => '设备信息',
+ 'children' => ['GetDeviceIdByIdentity', 'ListDeviceIdByIdentities', 'GetDeviceBasicInfo', 'ListDeviceBasicInfo', 'GetDeviceStatusInfo', 'GetDeviceTag', 'DeviceControl', 'GetDeviceSetting', 'GetDeviceStatusDetail', 'SetDeviceSetting'],
'type' => 'directory',
- 'children' => [
- 'GetDeviceIdByIdentity',
- 'ListDeviceIdByIdentities',
- 'GetDeviceBasicInfo',
- 'ListDeviceBasicInfo',
- 'GetDeviceStatusInfo',
- 'GetDeviceTag',
- 'DeviceControl',
- 'GetDeviceSetting',
- 'GetDeviceStatusDetail',
- 'SetDeviceSetting',
- ],
+ 'title' => '设备信息',
+ 'id' => 129423,
],
[
- 'id' => 170173,
- 'title' => '功能API',
- 'type' => 'directory',
'children' => [
[
- 'id' => 199234,
- 'title' => '数据',
+ 'children' => ['GetJiangSuTelecomData'],
'type' => 'directory',
- 'children' => [
- 'GetJiangSuTelecomData',
- ],
+ 'title' => '数据',
+ 'id' => 129435,
],
[
- 'id' => 170178,
- 'title' => '内容点播',
- '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',
+ 'ScgSearch', 'AddAndRemoveFavoriteContent', 'CreatePlayingList', 'GetAlbum', 'GetContent', 'GetCurrentPlayingItem', 'GetCurrentPlayingList', 'IndexControlPlayingList', 'ListAlbumDetail', 'ListCateContent', 'ListCateInfo', 'ListCommonCateFirstFloor', 'ListCommonCateSecondFloor', 'ListPlayHistory', 'ListRecommendContent', 'PlayAndPauseControl', 'PlayModeControl', 'PreviousAndNextControl', 'ProgressControl', 'SearchContent',
+ 'CloudPlayer', 'MobileRecommend',
],
+ 'type' => 'directory',
+ 'title' => '内容点播',
+ 'id' => 129437,
],
[
- 'id' => 170194,
- 'title' => '课程订阅',
+ 'children' => ['AddSub', 'DeleteSub', 'ListAlbumIsAdded', 'ListSub', 'ListSubAlbum', 'ListSubscriptionAlbumCategory', 'GetAlbumDetailById'],
'type' => 'directory',
- 'children' => [
- 'AddSub',
- 'DeleteSub',
- 'ListAlbumIsAdded',
- 'ListSub',
- 'ListSubAlbum',
- 'ListSubscriptionAlbumCategory',
- 'GetAlbumDetailById',
- ],
+ 'title' => '课程订阅',
+ 'id' => 129460,
],
[
- 'id' => 170201,
- 'title' => '留言',
+ 'children' => ['GetUnreadMessageCount', 'ListUserMessage', 'ReadMessage', 'SendMessage'],
'type' => 'directory',
- 'children' => [
- 'GetUnreadMessageCount',
- 'ListUserMessage',
- 'ReadMessage',
- 'SendMessage',
- ],
+ 'title' => '留言',
+ 'id' => 129468,
],
[
- 'id' => 170204,
- 'title' => '闹钟',
+ 'children' => ['CreateAlarm', 'DeleteAlarms', 'GetAlarm', 'ListAlarms', 'ListMusic', 'QueryMusicType', 'UpdateAlarm'],
'type' => 'directory',
- 'children' => [
- 'CreateAlarm',
- 'DeleteAlarms',
- 'GetAlarm',
- 'ListAlarms',
- 'ListMusic',
- 'QueryMusicType',
- 'UpdateAlarm',
- ],
+ 'title' => '闹钟',
+ 'id' => 129473,
],
[
- 'id' => 170174,
- 'title' => '定时',
+ 'children' => ['CreateScheduleTask', 'DeleteScheduleTask', 'GetScheduleTask'],
'type' => 'directory',
- 'children' => [
- 'CreateScheduleTask',
- 'DeleteScheduleTask',
- 'GetScheduleTask',
- ],
+ 'title' => '定时',
+ 'id' => 129481,
],
[
- 'id' => 171175,
- 'title' => '天气',
+ 'children' => ['GetWeather'],
'type' => 'directory',
- 'children' => [
- 'GetWeather',
- ],
+ 'title' => '天气',
+ 'id' => 129485,
],
],
+ 'type' => 'directory',
+ 'title' => '功能API',
+ 'id' => 129434,
],
[
- 'id' => 263709,
- 'title' => '其他',
+ 'children' => ['CreatePlayingListOAuth2', 'ThirdImmediateMsgPush'],
'type' => 'directory',
- 'children' => [
- 'CreatePlayingListOAuth2',
- 'ThirdImmediateMsgPush',
- ],
+ 'title' => '其他',
+ 'id' => 129487,
],
],
'components' => [
- 'schemas' => [
- 'LoginStateInfo' => [
- 'title' => '登录鉴权结构体',
- 'type' => 'object',
- 'properties' => [
- 'ThirdUserIdentifier' => [
- 'title' => '三方用户ID',
- 'type' => 'string',
- ],
- 'ThirdUserType' => [
- 'title' => '三方用户类型',
- 'type' => 'string',
- ],
- 'UserId' => [
- 'title' => '用户ID',
- 'type' => 'string',
- ],
- 'SceneCode' => [
- 'title' => '场景码',
- 'type' => 'string',
- ],
- ],
- ],
- ],
+ 'schemas' => [],
],
'apis' => [
- 'AuthLoginWithThirdUserInfo' => [
- 'summary' => '通过三方用户信息进行授权登录。',
- 'path' => '/v1.0/ssp/authLoginWithThirdUserInfo',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddAndRemoveFavoriteContent' => [
+ 'summary' => '收藏或取消收藏。',
+ 'path' => '/v1.0/ssp/AddAndRemoveFavoriteContent',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'SceneCode',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '场景码,需提前向天猫精灵申请',
- 'description' => '场景码,需要提前向天猫精灵申请',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'wechat_ecology_openness',
- ],
- ],
- [
- 'name' => 'ThirdUserType',
- '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',
+ 'name' => 'OpenAddAndRemoveFavoriteContentRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '扩展信息',
- 'description' => '扩展信息',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{}',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- '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' => '当Code为5140001时,代表登录失败,原因是三方用户未绑定到天猫精灵用户,前端需要根据此错误码走用户手机号授权登录流程,后续流程前端需要将DataObj中SessionId带回服务端。',
+ 'PackageType' => ['description' => '内容类型'."\n"
+ ."\n"
+ .'内容:CONTENT;专辑:ALBUM;歌单:COLLECT。', 'type' => 'string', 'required' => true, 'example' => 'CONTENT'],
+ 'OpenSourceRawIdPair' => [
+ 'description' => '收藏/取消对象',
'type' => 'object',
'properties' => [
- 'SessionId' => [
- 'title' => '会话id',
- 'description' => '会话id',
- 'type' => 'string',
- 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
- ],
+ 'RawId' => ['description' => '三方id', 'type' => 'string', 'required' => true, 'example' => '2105818057'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'required' => true, 'example' => 'xiami'],
+ 'ExtendInfo' => ['description' => '扩展信息', 'type' => 'object', 'required' => false],
],
+ 'required' => true,
],
+ 'FavoriteCmd' => ['description' => '操作类型'."\n"
+ ."\n"
+ .'收藏:ADD;取消收藏:REMOVE', 'type' => 'string', 'required' => true, 'example' => 'ADD'],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"bd9ccdb121ee950ddead51e943e081fe\\",\\n \\"ExpiredTimeLong\\": 1659428051452\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AuthLoginWithThirdUserInfoResponse>\\n <RequestId>73C67BD9-175A-1324-8202-9FAABBB3E6FA</RequestId>\\n <Code>200</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n <Result>\\n <AccessToken>f6221a258d8cfcb7c82fbf9fff9a164b</AccessToken>\\n <ExpiredTimeLong>1659428051452</ExpiredTimeLong>\\n </Result>\\n <DataObj>\\n <SessionId>dbe2eb4458302b9246c6da17fbc95f4b</SessionId>\\n </DataObj>\\n</AuthLoginWithThirdUserInfoResponse>","errorExample":""}]',
- 'title' => '通过三方用户信息进行授权登录',
- ],
- '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' => '会话id',
- 'type' => 'string',
'required' => true,
- 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
],
],
[
- 'name' => 'PhoneNumber',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '手机号码',
- 'description' => '手机号码',
- 'type' => 'string',
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。` UNION_ID:` 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
'required' => true,
- 'example' => '18612345678',
],
],
[
- 'name' => 'Region',
- 'in' => 'formData',
+ 'name' => 'DeviceInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '地区编码',
- 'description' => '地区编码',
- 'type' => 'string',
+ 'description' => '设备标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
'required' => true,
- 'example' => '+86',
],
],
],
@@ -410,125 +187,146 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- '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',
- ],
- ],
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '121212121'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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"}]',
- 'title' => '生态开放发送短信验证码',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"121212121\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAndRemoveFavoriteContentResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>121212121</RequestId>\\n <Success>true</Success>\\n</AddAndRemoveFavoriteContentResponse>","errorExample":""}]',
+ 'title' => '收藏或取消收藏',
],
- 'FindUserlistToAuthLoginWithPhoneNumber' => [
- 'summary' => '通过手机号寻找可授权登录的账号列表',
- 'path' => '/v1.0/ssp/findUserlistToAuthLoginWithPhoneNumber',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddSub' => [
+ 'summary' => '订阅专辑。',
+ 'path' => '/v1.0/ssp/addSub',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'SessionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '会话id',
- 'description' => '会话id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
- ],
- ],
- [
- 'name' => 'Region',
+ 'name' => 'AddSubscriptionInfoRequest',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '地区编码',
- 'description' => '地区编码',
- 'type' => 'string',
+ 'title' => '订阅专辑request',
+ 'description' => '订阅专辑request',
+ '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' => '设置按周提醒的具体日期,取值范围为:1~7',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '设置按周提醒的具体日期,取值范围为:1~7。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '7',
+ 'minimum' => '1',
+ 'example' => '1,3,5,7,6',
+ 'enum' => ['1', '2', '3', '4', '5', '6', '7'],
+ ],
+ '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' => '专辑ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51999575'],
+ 'PlayMode' => ['title' => '播放模式(目前只支持sequence)', 'description' => '播放模式(目前只支持sequence)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sequence'],
+ 'DailyStudyCnt' => ['title' => '每天学习数量', 'description' => '每天学习数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'],
+ ],
'required' => true,
- 'example' => '+86',
+ 'docRequired' => true,
],
],
[
- 'name' => 'PhoneNumber',
+ 'name' => 'DeviceInfo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '手机号码',
- 'description' => '手机号码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '18612345678',
+ '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' => 'Code',
+ 'name' => 'UserInfo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '短信验证码',
- 'description' => '短信验证码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123456',
+ '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,
],
],
],
@@ -539,136 +337,61 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32'],
'Result' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => '结果',
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'UserListToAuthLogin' => [
- 'title' => '可授权登录的账号列表',
- 'description' => '可授权登录的账号列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '可授权登录的账号',
- 'description' => '可授权登录的账号',
- 'type' => 'object',
- 'properties' => [
- 'UserType' => [
- 'title' => '用户类型'."\n"
- .'TAOBAO:淘宝用户'."\n"
- .'ALIGENIE:天猫精灵用户',
- 'description' => '用户类型'."\n"
- .'TAOBAO:淘宝用户'."\n"
- .'ALIGENIE:天猫精灵用户',
- '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' => '用户发现类型'."\n"
- ."\n"
- .'淘宝用户固定为:PHONE_NUMBER_BINDING_WITH_TAOBAO:phoneNumber作为淘宝绑定手机号查询到的;'."\n"
- ."\n"
- .'天猫精灵用户为:'."\n"
- .'PHONE_NUMBER_BINDING_WITH_ALIGENIE:phoneNumber作为精灵绑定手机号查询到的;'."\n"
- .'PHONE_NUMBER_BINDING_WITH_TAOBAO:phoneNumber作为淘宝绑定手机号查询到的;',
- 'type' => 'string',
- 'example' => 'PHONE_NUMBER_BINDING_WITH_ALIGENIE:phoneNumber',
- ],
+ 'Id' => ['title' => '订阅专辑记录ID', 'description' => '订阅专辑记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '81'],
+ 'DeviceId' => ['title' => '设备ID', 'description' => '设备ID', 'type' => 'string', 'example' => '5874DBCCA3038FAA1A70A8060F07F26D'],
+ 'UserId' => ['title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '1152893538998276761'],
+ 'ScheduleInfo' => [
+ 'title' => '定时信息',
+ 'description' => '定时信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'DaysOfWeek' => [
+ 'title' => '提醒触发的周期',
+ 'description' => '提醒触发的周期',
+ 'type' => 'array',
+ 'items' => ['description' => '设置按周提醒的具体日期,取值范围为:1~7。', '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' => '专辑ID', 'type' => 'string', 'example' => '51999575'],
+ 'PlayMode' => ['title' => '播放模式', 'description' => '播放模式', 'type' => 'string', 'example' => 'sequence'],
+ 'DailyStudyCnt' => ['title' => '每天学习数量', 'description' => '每天学习数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
- 'DataObj' => [
- 'title' => 'Code为5140003时代表调用失败,原因是该手机号未找到可授权登录的账号列表,前端可以让用户确认通过手机号生成精灵账号,也可提示用户先基于手机号注册淘宝账号,后续流程前端需要将DataObj中sessionId带回服务端。',
- 'description' => 'Code为5140003时代表调用失败,原因是该手机号未找到可授权登录的账号列表,前端可以让用户确认通过手机号生成精灵账号,也可提示用户先基于手机号注册淘宝账号,后续流程前端需要将DataObj中sessionId带回服务端。',
- 'type' => 'object',
- 'properties' => [
- 'SessionId' => [
- 'title' => '会话id',
- 'description' => '会话id',
- 'type' => 'string',
- 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
- ],
- ],
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B99D27ED-4E12-1414-9FDE-599C57C4B204'],
],
],
],
],
- '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"}]',
- 'title' => '通过手机号寻找可授权登录的账号列表',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Result\\": {\\n \\"Id\\": 81,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": \\"1152893538998276761\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B99D27ED-4E12-1414-9FDE-599C57C4B204\\"\\n}","type":"json"}]',
+ 'title' => '订阅专辑',
],
'AuthLoginWithAligenieUserInfo' => [
'summary' => '通过指定精灵账号进行授权登录。',
'path' => '/v1.0/ssp/authLoginWithAligenieUserInfo',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
@@ -676,24 +399,12 @@
[
'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会话id',
- 'description' => '会话id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
- ],
+ 'schema' => ['title' => '会话id', 'description' => '会话id', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'],
],
[
'name' => 'EncryptedAligenieUserIdentifier',
'in' => 'formData',
- 'schema' => [
- 'title' => '加密过的精灵用户标识',
- 'description' => '加密过的精灵用户标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'UYugfm/3Nb9q24AyES2rYmC5tIglSoDX3Mbna/vrldcjGPtC8VzFwo+CU5c4CHLjrK7ekskG2WVaevM5Zi9f0w==',
- ],
+ 'schema' => ['title' => '加密过的精灵用户标识', 'description' => '加密过的精灵用户标识', 'type' => 'string', 'required' => true, 'example' => 'UYugfm/3Nb9q24AyES2rYmC5tIglSoDX3Mbna/vrldcjGPtC8VzFwo+CU5c4CHLjrK7ekskG2WVaevM5Zi9f0w=='],
],
],
'responses' => [
@@ -703,51 +414,17 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- 'default' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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',
- ],
+ 'LoginStateAccessToken' => ['title' => '登录态访问令牌', 'description' => '登录态访问令牌', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'],
+ 'ExpiredTimeLong' => ['title' => '登录态访问令牌过期时间(长整型)', 'description' => '登录态访问令牌过期时间(长整型)', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230', 'default' => '1659506854230'],
],
],
],
@@ -760,24 +437,15 @@
'AuthLoginWithAligenieUserInfoGeneratedByPhoneNumber' => [
'summary' => '通过手机号生成精灵账号进行授权登录。',
'path' => '/v1.0/ssp/authLoginWithAligenieUserInfoGeneratedByPhoneNumber',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
@@ -785,13 +453,7 @@
[
'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会话id',
- 'description' => '会话id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
- ],
+ 'schema' => ['title' => '会话id', 'description' => '会话id', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'],
],
],
'responses' => [
@@ -801,51 +463,17 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- 'default' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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',
- ],
+ 'LoginStateAccessToken' => ['title' => '登录态访问令牌', 'description' => '登录态访问令牌', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'],
+ 'ExpiredTimeLong' => ['title' => '登录态访问令牌过期时间(长整型)', 'description' => '登录态访问令牌过期时间(长整型)', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230', 'default' => '1659506854230'],
],
],
],
@@ -858,24 +486,15 @@
'AuthLoginWithTaobaoUserInfo' => [
'summary' => '通过指定淘宝账号进行授权登录',
'path' => '/v1.0/ssp/authLoginWithTaobaoUserInfo',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
@@ -883,24 +502,12 @@
[
'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '会话id',
- 'description' => '会话id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b',
- ],
+ 'schema' => ['title' => '会话id', 'description' => '会话id', 'type' => 'string', 'required' => true, 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'],
],
[
'name' => 'EncryptedTaobaoUserIdentifier',
'in' => 'formData',
- 'schema' => [
- 'title' => '加密过的淘宝用户标识',
- 'description' => '加密过的淘宝用户标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh',
- ],
+ 'schema' => ['title' => '加密过的淘宝用户标识', 'description' => '加密过的淘宝用户标识', 'type' => 'string', 'required' => true, 'example' => 'KsVgypxAipf+xNECMZV2ONMcheqiIoEGFvgx+T8s1oV6/euTK9+ImYvLVPsSqFDh'],
],
],
'responses' => [
@@ -910,48 +517,17 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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',
- ],
+ 'LoginStateAccessToken' => ['title' => '登录态访问令牌', 'description' => '登录态访问令牌', 'type' => 'string', 'example' => 'd15aa92de679d0d225aa845268be19ee'],
+ 'ExpiredTimeLong' => ['title' => '登录态访问令牌过期时间(长整型)', 'description' => '登录态访问令牌过期时间(长整型)', 'type' => 'integer', 'format' => 'int64', 'example' => '1659506854230'],
],
],
],
@@ -961,63 +537,42 @@
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"d15aa92de679d0d225aa845268be19ee\\",\\n \\"ExpiredTimeLong\\": 1659506854230\\n }\\n}","type":"json"}]',
'title' => '通过指定淘宝账号进行授权登录',
],
- 'EcologyOpennessAuthenticate' => [
- 'summary' => '使用登录态访问令牌进行鉴权获取三方用户标识和精灵方用户openId',
- 'path' => '/v1.0/ssp/ecologyOpennessAuthenticate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => 'read',
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'LoginStateAccessToken',
+ 'name' => 'SceneCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '登录态访问令牌',
- 'description' => '登录态访问令牌',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd15aa*****ee',
- ],
+ 'schema' => ['title' => '场景码,需提前向天猫精灵申请', 'description' => '场景码,需要提前向天猫精灵申请', 'type' => 'string', 'required' => true, 'example' => 'wechat_ecology_openness'],
],
[
- 'name' => 'EncodeType',
+ 'name' => 'ThirdUserType',
'in' => 'formData',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '实体类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
+ 'schema' => ['title' => '三方用户类型,场景接入申请完成后进行分配', 'description' => '三方用户类型', 'type' => 'string', 'required' => true, 'example' => 'weChatUser'],
],
[
- 'name' => 'EncodeKey',
+ 'name' => 'ThirdUserIdentifier',
'in' => 'formData',
- 'schema' => [
- 'title' => '实体key',
- 'description' => '实体key',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12*****',
- ],
+ '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' => [
@@ -1027,123 +582,103 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73****9-175A-1324-8202-9FAAB*****A',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- 'default' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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' => [
- 'UserOpenId' => [
- 'title' => '精灵用户openId',
- 'description' => '精灵用户openId',
- 'type' => 'string',
- 'example' => 'o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==',
- ],
- 'EncodeType' => [
- 'title' => '实体类型',
- 'description' => '实体类型',
- 'type' => 'string',
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '实体key',
- 'description' => '实体key',
- 'type' => 'string',
- 'example' => '12****7',
- ],
- 'SceneCode' => [
- 'title' => '场景码',
- 'description' => '场景码',
- 'type' => 'string',
- 'example' => '******',
- ],
- 'ThirdUserType' => [
- 'title' => '三方用户类型',
- 'description' => '三方用户类型',
- 'type' => 'string',
- 'example' => '******',
- ],
- 'ThirdUserIdentifier' => [
- 'title' => '三方用户标识',
- 'description' => '三方用户标识',
- 'type' => 'string',
- 'example' => '******',
- ],
+ 'LoginStateAccessToken' => ['title' => '登录态访问令牌', 'description' => '登录态访问令牌', 'type' => 'string', 'example' => 'bd9ccdb121ee950ddead51e943e081fe'],
+ 'ExpiredTimeLong' => ['title' => '登录态访问令牌过期时间', 'description' => '登录态访问令牌过期时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1659428051452', 'default' => '1659333475811'],
+ ],
+ ],
+ 'DataObj' => [
+ 'title' => '当Code为5140001时,代表登录失败,原因是三方用户未绑定到天猫精灵用户,前端需要根据此错误码走用户手机号授权登录流程,后续流程前端需要将DataObj中SessionId带回服务端。',
+ 'description' => '当Code为5140001时,代表登录失败,原因是三方用户未绑定到天猫精灵用户,前端需要根据此错误码走用户手机号授权登录流程,后续流程前端需要将DataObj中SessionId带回服务端。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => ['title' => '会话id', 'description' => '会话id', 'type' => 'string', 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'],
],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"SceneCode\\": \\"******\\",\\n \\"ThirdUserType\\": \\"******\\",\\n \\"ThirdUserIdentifier\\": \\"******\\"\\n }\\n}","type":"json"}]',
- 'title' => '生态开放鉴权',
- 'description' => '注意:当登录态失效时,接入方需要重新发起授权登录流程获取新的登录态(入口服务API:AuthLoginWithThirdUserInfo)。'."\n"
- ."\n"
- .'- 通过Java-SDK(其它语言SDK请在接入时咨询天猫精灵开发)调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
- .'当API调用抛出TeaException,且TeaException.code为InvalidAuthentication时代表登录态失效。'."\n"
- ."\n"
- .'- 通过发送http请求调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
- .'当API调用返回的http响应状态码为400时代表登录态失效。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"LoginStateAccessToken\\": \\"bd9ccdb121ee950ddead51e943e081fe\\",\\n \\"ExpiredTimeLong\\": 1659428051452\\n },\\n \\"DataObj\\": {\\n \\"SessionId\\": \\"dbe2eb4458302b9246c6da17fbc95f4b\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AuthLoginWithThirdUserInfoResponse>\\n <RequestId>73C67BD9-175A-1324-8202-9FAABBB3E6FA</RequestId>\\n <Code>200</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n <Result>\\n <AccessToken>f6221a258d8cfcb7c82fbf9fff9a164b</AccessToken>\\n <ExpiredTimeLong>1659428051452</ExpiredTimeLong>\\n </Result>\\n <DataObj>\\n <SessionId>dbe2eb4458302b9246c6da17fbc95f4b</SessionId>\\n </DataObj>\\n</AuthLoginWithThirdUserInfoResponse>","errorExample":""}]',
+ 'title' => '通过三方用户信息进行授权登录',
],
- 'GetAligenieUserInfo' => [
- 'summary' => '通过登录态凭证获取三方绑定的精灵账号信息',
- 'path' => '/v1.0/ssp/getAligenieUserInfo',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CheckAuthCodeBindForExt' => [
+ 'summary' => '轮询激活绑定结果。',
+ 'path' => '/v1.0/ssp/checkAuthCodeBindForExt',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'LoginStateAccessToken',
+ 'name' => 'EncodeType',
'in' => 'query',
'schema' => [
- 'title' => '登录态访问凭证',
- 'description' => '登录态访问凭证',
+ 'title' => '编码类型,此处填写PROJECT_ID。',
+ 'description' => '编码类型,此处填写PROJECT_ID。',
'type' => 'string',
'required' => true,
- 'example' => '99ce8a70c23a94f8569e1a525bef6e85',
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
+ ],
+ ],
+ [
+ 'name' => 'EncodeKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ ],
+ [
+ 'name' => 'AuthCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '指定用户和渠道获取的authCode', 'description' => '通过指定用户id获取到的authCode'."\n", 'type' => 'string', 'required' => true, 'example' => 'Aexfgc'],
+ ],
+ [
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '用户标识信息列表。',
+ 'description' => '用户标识信息列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => [
+ 'title' => '编码类型,此处填写PROJECT_ID。',
+ 'description' => '编码类型,此处填写PROJECT_ID。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => [
+ 'title' => '用户Id的类型:'."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
+ 'description' => '用户Id的类型:'."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'Id' => ['title' => '用户标识,填写userOpenId或userUnionId的值。', 'description' => '用户标识,填写userOpenId或userUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1***2'],
+ ],
+ 'required' => true,
],
],
],
@@ -1154,203 +689,166 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- ],
+ 'Message' => ['title' => '调用该接口的返回结果。', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
+ 'title' => '详细信息',
+ 'description' => '详细信息',
'type' => 'object',
'properties' => [
- 'AligenieNickname' => [
- 'title' => '精灵用户昵称',
- 'description' => '精灵用户昵称',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Avatar' => [
- 'title' => '精灵用户头像地址',
- 'description' => '精灵用户头像地址',
- 'type' => 'string',
- 'example' => 'http://img.alicdn.com/xxx.jpg',
+ 'UserOpenInfo' => [
+ 'title' => '用户开放信息',
+ 'description' => '用户开放信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'IdType' => ['title' => 'USER_ID', 'description' => 'USER_ID', 'type' => 'string', 'example' => 'USER_ID'],
+ 'Id' => ['title' => '对外的用户id', 'description' => '对外的用户id', 'type' => 'string', 'example' => '0963*0158'],
+ ],
],
- 'Deletable' => [
- 'title' => '是否可注销',
- 'description' => '是否可注销',
- 'type' => 'boolean',
+ 'DeviceOpenInfo' => [
+ 'title' => '设备开放信息',
+ 'description' => '设备开放信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'IdType' => ['title' => 'DEVICE_ID', 'description' => 'DEVICE_ID', 'type' => 'string', 'example' => 'DEVICE_ID'],
+ 'Id' => ['title' => '对外的设备id', 'description' => '对外的设备id', 'type' => 'string', 'example' => 'A963*0158'],
+ ],
],
],
],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- '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"}]',
- 'title' => '获取三方绑定的精灵账号信息',
- 'description' => '注意:当登录态失效时,接入方需要重新发起授权登录流程获取新的登录态(入口服务API:AuthLoginWithThirdUserInfo)。'."\n"
- ."\n"
- .'- 通过Java-SDK(其它语言SDK请在接入时咨询天猫精灵开发)调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
- .'当API调用抛出TeaException,且TeaException.code为InvalidAuthentication时代表登录态失效。'."\n"
- ."\n"
- .'- 通过发送http请求调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
- .'当API调用返回的http响应状态码为400时代表登录态失效。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenInfo\\": {\\n \\"IdType\\": \\"USER_ID\\",\\n \\"Id\\": \\"0963*0158\\"\\n },\\n \\"DeviceOpenInfo\\": {\\n \\"IdType\\": \\"DEVICE_ID\\",\\n \\"Id\\": \\"A963*0158\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '轮询激活绑定结果',
],
- 'UnbindAligenieUser' => [
- 'summary' => '通过登录态凭证解绑三方和精灵账号的关系'."\n",
- 'path' => '/v1.0/ssp/unbindAligenieUser',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CloudPlayer' => [
+ 'summary' => '云推歌,提供设备openUuid和天猫精灵openUserId,创建播放列表。',
+ 'path' => '/v1.0/ssp/cloud/player',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'LoginStateAccessToken',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '登录态访问凭证',
- 'description' => '登录态访问凭证',
- 'type' => 'string',
+ 'description' => '开放用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => [
+ 'description' => '编码类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
+ ],
+ 'EncodeKey' => ['description' => '编码key', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => [
+ 'description' => 'ID 类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'Id' => ['description' => '开放ID', 'type' => 'string', 'required' => true, 'example' => '1234'],
+ 'OrganizationId' => ['description' => '组织ID(可为空)', 'type' => 'string', 'required' => false, 'example' => '为空'],
+ ],
'required' => true,
- 'example' => '99ce8a70c23a94f8569e1a525bef6e85',
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'DeviceInfo',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
+ 'EncodeType' => [
+ 'description' => '编码类型',
'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
+ 'EncodeKey' => [
+ 'description' => '编码key',
'type' => 'string',
- 'example' => 'OK',
+ 'required' => true,
+ 'example' => '123',
+ 'enum' => [],
],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
+ 'IdType' => [
+ 'description' => 'ID类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['UNION_ID', 'OPEN_ID'],
],
+ 'Id' => ['description' => '开放ID', 'type' => 'string', 'required' => true, 'example' => '1234'],
+ 'OrganizationId' => ['description' => '组织ID(可为空)', 'type' => 'string', 'required' => false, 'example' => '为空'],
],
+ 'required' => true,
],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '解除三方和精灵账号的关系',
- 'description' => '注意:当登录态失效时,接入方需要重新发起授权登录流程获取新的登录态(入口服务API:AuthLoginWithThirdUserInfo)。'."\n"
- ."\n"
- .'- 通过Java-SDK(其它语言SDK请在接入时咨询天猫精灵开发)调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
- .'当API调用抛出TeaException,且TeaException.code为InvalidAuthentication时代表登录态失效。'."\n"
- ."\n"
- .'- 通过发送http请求调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
- .'当API调用返回的http响应状态码为400时代表登录态失效。',
- ],
- 'QueryUserDeviceListByTmeUserId' => [
- 'summary' => '通过tme用户id获取授权的天猫精灵用户+设备列表,提供给酷狗云推歌使用',
- 'path' => '/v1.0/ssp/queryUserDeviceListByTmeUserId',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '云推歌来源',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['KG' => '酷狗'],
+ 'example' => 'KG',
+ ],
],
- ],
- 'consumes' => [
- 'application/json',
- 'application/x-www-form-urlencoded',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- ],
- 'parameters' => [
[
- 'name' => 'TmeUserId',
+ 'name' => 'SongIdList',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => 'TME用户id',
- 'description' => 'TME用户id',
- 'type' => 'string',
+ 'description' => '歌曲ID列表【1-200】个歌曲',
+ 'type' => 'array',
+ 'items' => ['description' => '歌曲id', 'type' => 'string', 'required' => false, 'example' => '123'],
'required' => true,
- 'example' => 'FDEEDE337BAA780793D72F7F20BEF2F5',
+ 'maxItems' => 200,
+ 'minItems' => 1,
],
],
[
- 'name' => 'Sp',
+ 'name' => 'CurPlayIndex',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前播放歌曲的索引。从1开始', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PlayMode',
'in' => 'query',
'schema' => [
- 'title' => '"KG":酷狗'."\n"
- .'"KW":酷我'."\n"
- .'"QM":Q音',
- 'description' => '"KG":酷狗'."\n"
- .'"KW":酷我'."\n"
- .'"QM":Q音',
+ 'description' => '播放模式',
'type' => 'string',
'required' => true,
- 'example' => 'KG',
+ 'enumValueTitles' => ['Shuffle' => '随机', 'RepeatOne' => '单曲循环', 'Repeat' => '循环', 'Normal' => '顺序'],
+ 'example' => 'Normal',
],
],
+ [
+ 'name' => 'SongId',
+ 'in' => 'query',
+ 'schema' => ['description' => '歌曲id(索引有问题时,根据该ID重新计算索引)', 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
],
'responses' => [
200 => [
@@ -1359,158 +857,156 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Result' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ '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' => '返回结果:true:检验成功false:检验失败', '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"}]',
+ 'title' => '云推歌',
+ 'description' => '同步检验入参后返回,'."\n"
+ .'异步创建播放列表。',
+ 'responseParamsDescription' => '返回值为 true / false,表示创建播放列表是否成功。',
+ ],
+ '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' => [
- 'Sp' => [
- 'title' => '"KG":酷狗'."\n"
- .'"KW":酷我'."\n"
- .'"QM":Q音',
- 'description' => '"KG":酷狗'."\n"
- .'"KW":酷我'."\n"
- .'"QM":Q音',
- 'type' => 'string',
- 'example' => 'KG',
- ],
- 'EncodeType' => [
- 'title' => '实体类型(三方透传即可)',
- 'description' => '实体类型(三方透传即可)',
+ 'Type' => [
+ 'title' => '调度类型/循环类型',
+ 'description' => '调度类型/循环类型:'."\n"
+ .'ONCE -> 单次,WEEKLY -> 周循环,STATUTORY_WORKING_DAY ->法定工作日',
'type' => 'string',
- 'example' => 'PROJECT_ID',
+ 'required' => true,
+ 'example' => 'ONCE',
+ 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'],
],
- 'EncodeKey' => [
- 'title' => '实体key(三方透传即可)',
- 'description' => '实体key(三方透传即可)',
- 'type' => 'string',
- 'example' => '12****7',
+ 'Once' => [
+ 'title' => '单次',
+ 'description' => '单次::循环类型为ONCE时,该属性可用',
+ '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,
],
- 'AligenieUserInfoList' => [
- 'title' => '天猫精灵用户列表',
- 'description' => '天猫精灵用户列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'OpenUserId' => [
- 'title' => '用户id',
- 'description' => '用户id',
- 'type' => 'string',
- 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==',
- ],
- 'UserNickname' => [
- 'title' => '用户昵称',
- 'description' => '用户昵称',
- 'type' => 'string',
- 'example' => 'a***e',
- ],
- 'AuthorizedDeviceList' => [
- 'title' => '用户授权的设备列表',
- 'description' => '用户授权的设备列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'OpenDeviceId' => [
- 'title' => '按照天猫精灵开放平台标准加密的设备id',
- 'description' => '设备id',
- 'type' => 'string',
- 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=',
- ],
- 'DeviceName' => [
- 'title' => '设备名称',
- 'description' => '设备名称',
- 'type' => 'string',
- 'example' => 'CC',
- ],
- 'Online' => [
- 'title' => '设备是否在线',
- 'description' => '设备是否在线',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TmeProductId' => [
- 'title' => 'TME产品id',
- 'description' => 'TME产品id',
- 'type' => 'string',
- ],
- 'TmeDeviceId' => [
- 'title' => '透出给TME的设备id',
- 'description' => '透出给TME的设备id',
- 'type' => 'string',
- ],
- ],
- ],
- ],
+ 'Weekly' => [
+ 'title' => '周循环',
+ 'description' => '周循环:循环类型为WEEKLY时,该属性可用',
+ 'type' => 'object',
+ 'properties' => [
+ 'DaysOfWeek' => [
+ 'title' => '周几触发集合',
+ 'description' => '周几触发集合',
+ 'type' => 'array',
+ 'items' => ['description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填', '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' => '法定工作日:循环类型为STATUTORY_WORKING_DAY时,该属性可用',
+ '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' => '铃声类别id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
+ 'MusicTypeName' => ['title' => '音乐类别名称', 'description' => '铃声类别名称', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'],
+ 'MusicId' => ['title' => '音乐id', 'description' => '铃声id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
+ 'MusicName' => ['title' => '音乐名称', 'description' => '铃声名称', 'type' => 'string', 'required' => true, 'example' => 'xx铃声'],
+ 'MusicUrl' => ['title' => '音乐url', 'description' => '铃声url', '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,
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Sp\\": \\"KG\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"AligenieUserInfoList\\": [\\n {\\n \\"OpenUserId\\": \\"R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==\\",\\n \\"UserNickname\\": \\"a***e\\",\\n \\"AuthorizedDeviceList\\": [\\n {\\n \\"OpenDeviceId\\": \\"fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=\\",\\n \\"DeviceName\\": \\"CC\\",\\n \\"Online\\": true,\\n \\"TmeProductId\\": \\"\\",\\n \\"TmeDeviceId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '通过tme用户id获取授权的天猫精灵用户+设备列表',
- ],
- 'InvalidateThirdPartyAppLoginState' => [
- 'summary' => '当发生非设备端的用户操作会导致设备端的三方应用登录态失效(比如用户在新设备上登录相同账号导致老设备登录态失效,或用户修改密码导致老设备登录态失效等),三方需要调用该接口通知天猫精灵。',
- 'path' => '/v1.0/ssp/invalidateThirdPartyAppLoginState',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'name' => 'UserInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => [
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
+ 'required' => true,
+ ],
],
- ],
- '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',
@@ -1520,19 +1016,14 @@
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
@@ -1540,190 +1031,172 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'com.*.*.*',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'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',
+ 'title' => 'AmpResult',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '响应信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '调用是否成功标志',
- 'description' => '调用是否成功标志',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求结果状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xx为空'],
+ 'Result' => ['description' => '闹钟id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '失效三方应用登录态',
- 'description' => '> 修改消息通知模板'."\n"
- .'> - 需要查询出模板的templateId 根据templateId然后修改其他参数',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlarmResponse>\\n <Code>200</Code>\\n <Message>xx为空</Message>\\n <Result>1234567</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</CreateAlarmResponse>","errorExample":""}]',
+ 'title' => '创建闹钟',
+ 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
],
- 'CheckAuthCodeBindForExt' => [
- 'summary' => '轮询激活绑定结果。',
- 'path' => '/v1.0/ssp/checkAuthCodeBindForExt',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => 'EncodeType',
- 'in' => 'query',
+ 'name' => 'OpenCreatePlayingListRequest',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '编码类型,此处填写PROJECT_ID。',
- 'description' => '编码类型,此处填写PROJECT_ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
+ 'description' => '业务参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'PlayFrom' => ['description' => '播放来源,配置播控能力的唯一标识'."\n"
+ ."\n"
+ .'可空,默认为default', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ 'ContentType' => ['description' => '播放内容类型'."\n"
+ ."\n"
+ .'内容:content;专辑:album;歌单:collect', 'type' => 'string', 'required' => true, 'example' => 'content'],
+ 'ContentList' => [
+ 'description' => '播放内容列表'."\n"
+ ."\n"
+ .'若是内容,支持多个;若是专辑,只有第一个有效。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '播放对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RawId' => ['description' => '三方id'."\n"
+ ."\n"
+ .'如果是内容则是内容id;如果是专辑则是专辑id', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'required' => true, 'example' => 'xiami'],
+ ],
+ 'required' => true,
+ ],
+ 'required' => true,
+ ],
+ 'Index' => ['description' => '播放的index'."\n"
+ ."\n"
+ .'可空。默认为0,表示从头播放', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'NeedAlbumContinued' => ['description' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'PlayMode' => ['description' => '播放模式'."\n"
+ ."\n"
+ .'列表循环:Repeat;随机:Shuffle;单曲循环:RepeatOne;顺序播放:Normal。', 'type' => 'string', 'required' => false, 'example' => 'Repeat'],
+ 'ExtendInfo' => ['description' => '扩展信息', 'type' => 'object', 'required' => false],
],
- ],
- ],
- [
- 'name' => 'EncodeKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'type' => 'string',
'required' => true,
- 'example' => '123',
],
],
[
- 'name' => 'AuthCode',
+ 'name' => 'UserInfo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '指定用户和渠道获取的authCode',
- 'description' => '通过指定用户id获取到的authCode'."\n",
- 'type' => 'string',
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => [
+ 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME:`apk包名,Android应用客户链路的编码类型。'."\n"
+ .'`SKILL_ID`:技能ID,云端链路的编码类型。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
+ ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。'."\n"
+ .'编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => [
+ 'description' => '用户Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
'required' => true,
- 'example' => 'Aexfgc',
],
],
[
- 'name' => 'UserInfo',
+ 'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息列表。',
- 'description' => '用户标识信息列表。',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
'EncodeType' => [
- 'title' => '编码类型,此处填写PROJECT_ID。',
- 'description' => '编码类型,此处填写PROJECT_ID。',
+ 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'`SKILL_ID`:技能ID,云端链路的编码类型。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
+ 'enum' => ['PROJECT_ID'],
],
'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
+ 'description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
'type' => 'string',
'required' => true,
'example' => '123',
+ 'enum' => [],
],
'IdType' => [
- 'title' => '用户Id的类型:'."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'description' => '用户Id的类型:'."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
+ 'description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。'."\n"
+ .'`UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '用户标识,填写userOpenId或userUnionId的值。',
- 'description' => '用户标识,填写userOpenId或userUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1***2',
+ 'enum' => ['UNION_ID', 'OPEN_ID'],
],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -1732,181 +1205,137 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'OpenServiceResult<OpenPlayingItem>',
+ 'description' => 'OpenServiceResult<OpenPlayingItem>',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '调用该接口的返回结果。',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码', 'description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '详细信息',
- 'description' => '详细信息',
+ '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' => '对外的用户id',
- 'type' => 'string',
- 'example' => '0963*0158',
- ],
- ],
- ],
- 'DeviceOpenInfo' => [
- 'title' => '设备开放信息',
- 'description' => '设备开放信息',
+ 'RawId' => ['title' => '三方id', 'description' => '三方id', 'type' => 'string', 'example' => '550144364'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => 'ximalayav2'],
+ 'AlbumRawId' => ['title' => '三方专辑id', 'description' => '三方专辑id', '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' => [
- 'IdType' => [
- 'title' => 'DEVICE_ID',
- 'description' => 'DEVICE_ID',
- 'type' => 'string',
- 'example' => 'DEVICE_ID',
- ],
- 'Id' => [
- 'title' => '对外的设备id',
- 'description' => '对外的设备id',
- 'type' => 'string',
- 'example' => 'A963*0158',
- ],
+ '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' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
],
],
+ 'PlayMode' => ['title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', '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' => '歌词url', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'],
+ 'Copyright' => ['title' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Type' => ['description' => 'type (music\\program\\joke\\news\\children_song\\radio等)', 'type' => 'string', 'example' => 'story'],
+ 'ItemUrl' => ['description' => '播放url', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3'],
+ 'DefaultPlayOrder' => ['description' => 'package 默认播放顺序 0 顺序,1 倒序', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Valid' => ['description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID'],
+ 'Pos' => ['description' => '该项在播放列表中的位置', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenInfo\\": {\\n \\"IdType\\": \\"USER_ID\\",\\n \\"Id\\": \\"0963*0158\\"\\n },\\n \\"DeviceOpenInfo\\": {\\n \\"IdType\\": \\"DEVICE_ID\\",\\n \\"Id\\": \\"A963*0158\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '轮询激活绑定结果',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <LyricUrl>https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc</LyricUrl>\\n <Copyright>0</Copyright>\\n <Type>story</Type>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</CreatePlayingListResponse>","errorExample":""}]',
+ 'title' => '播放列表创建',
],
- 'GetCodeEnhance' => [
- 'summary' => '获取authCode。',
- 'path' => '/v1.0/ssp/getCodeEnhance',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreatePlayingListOAuth2' => [
+ 'summary' => '播放列表创建走OAuth2授权。',
+ 'path' => '/v1.0/ssp/CreatePlayingListOAuth2',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'OAuth 2.0 Bearer Token' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'ChannelInfo',
- 'in' => 'query',
+ 'name' => 'OpenCreatePlayingListRequest',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '激活渠道,如微信小程序,三方app等',
- 'description' => '激活渠道,如微信小程序,三方app等',
+ 'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'Channel' => [
- 'title' => '激活渠道,如WeChat',
- 'description' => '激活渠道,如WeChat、ThirdApp',
- 'type' => 'string',
+ 'PlayFrom' => ['description' => '播放来源,配置播控能力的唯一标识'."\n"
+ ."\n"
+ .'可空,默认为default', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ 'ContentType' => ['description' => '播放内容类型'."\n"
+ ."\n"
+ .'内容:content;专辑:album;歌单:collect', 'type' => 'string', 'required' => true, 'example' => 'content'],
+ 'ContentList' => [
+ 'description' => '播放对象',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '播放对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RawId' => ['description' => '三方id'."\n"
+ ."\n"
+ .'如果是内容则是内容id;如果是专辑则是专辑id', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'required' => true, 'example' => 'xiami'],
+ ],
+ 'required' => true,
+ ],
'required' => true,
- 'example' => 'WeChat、ThirdApp',
- ],
- 'ExtInfo' => [
- 'title' => '扩展信息',
- 'description' => '扩展信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
],
+ 'Index' => ['description' => '播放的index'."\n"
+ ."\n"
+ .'可空。默认为0,表示从头播放', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'NeedAlbumContinued' => ['description' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'PlayMode' => ['description' => '播放模式'."\n"
+ ."\n"
+ .'列表循环:Repeat;随机:Shuffle;单曲循环:RepeatOne;顺序播放:Normal。', 'type' => 'string', 'required' => false, 'example' => 'Repeat'],
+ 'ExtendInfo' => ['description' => '扩展信息', 'type' => 'object', 'required' => false],
],
'required' => true,
],
],
[
- 'name' => 'UserInfo',
+ 'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息列表。',
- 'description' => '用户标识信息列表。',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写PROJECT_ID。',
- 'description' => '编码类型,此处填写PROJECT_ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'EncodeType' => ['description' => '编码类型,此处填写PROJECT_ID。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
- 'title' => '设备Id的类型 :'."\n"
+ 'description' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'description' => '用户Id的类型:'."\n"
- .'OPENID:默认的用户ID标识。'."\n"
- .'UNIONID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '用户标识,填写userOpenId或userUnionId的值。',
- 'description' => '用户标识,填写userOpenId或userUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'enum' => ['UNION_ID', 'OPEN_ID'],
],
+ 'Id' => ['description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => true,
],
@@ -1919,156 +1348,215 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '调用该接口的返回结果。',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '调用返回码', 'description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '返回的详细信息。',
- 'description' => '返回的详细信息。',
- 'type' => 'string',
- 'example' => 'Aexfgc',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'title' => '服务的实际返回结果',
+ 'description' => '服务的实际返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'RawId' => ['title' => '三方id', 'description' => '三方id', 'type' => 'string', 'example' => '123123'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => 'qignting'],
+ 'AlbumRawId' => ['title' => '三方专辑id', 'description' => '三方专辑id', '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' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
+ ],
+ ],
+ 'PlayMode' => ['title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', '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' => '歌词url', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'],
+ 'Copyright' => ['title' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Type' => ['description' => 'type (music\\program\\joke\\news\\children_song\\radio等)', 'type' => 'string', 'example' => 'program'],
+ 'ItemUrl' => ['description' => '播放url', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3'],
+ 'DefaultPlayOrder' => ['description' => 'package 默认播放顺序 0 顺序,1 倒序', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Valid' => ['description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID'],
+ 'Pos' => ['description' => '该项在播放列表中的位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
],
+ 'Message' => ['title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": \\"Aexfgc\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '获取authCode',
- 'description' => '通过指定用户id,获取对应的authCode',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qignting\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 96,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"program\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 1\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => '播放列表创建_OAuth2',
],
- 'ScanCodeBind' => [
- 'summary' => '带屏设备通过扫描二维码完成用户和设备的激活绑定。',
- 'path' => '/v1.0/ssp/scanCode',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateScheduleTask' => [
+ 'summary' => '创建定时任务。',
+ 'path' => '/v1.0/ssp/CreateScheduleTask',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
+ 'name' => 'Payload',
'in' => 'formData',
- 'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
- 'description' => '用户标识信息',
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写PROJECT_ID。',
- 'description' => '编码类型,此处填写PROJECT_ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
+ 'IdempotentId' => ['title' => '幂等id', 'description' => '幂等id', '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' => '触发星期,1-7分别代表周一到周日',
+ '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'],
],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
'required' => true,
- 'example' => '129****0946',
],
- 'IdType' => [
- 'title' => '设备Id的类型 :'."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'description' => '设备Id的类型 :'."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
+ 'ActionDTOs' => [
+ 'title' => '调度行动参数',
+ 'description' => '调度行动参数',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'customAction' => ['description' => '厂商自定义命令', 'type' => 'object', 'required' => false, 'example' => '{"k1":"v1","k2":{"key":1}}'],
+ ],
+ 'required' => false,
],
- ],
- 'Id' => [
- 'title' => '用户标识,填写userOpenId或userUnionId的值。',
- 'description' => '用户标识,填写userOpenId或userUnionId的值。',
- 'type' => 'string',
'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '111',
],
+ 'AccessKeyId' => ['title' => '调用方ak', 'type' => 'string'],
],
'required' => true,
],
],
[
- 'name' => 'BindReq',
+ 'name' => 'UserInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '扫描绑定入参',
- 'description' => '扫码绑定入参',
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => 'authCode',
- 'description' => 'authCode',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ASdfre',
- ],
- 'ClientId' => [
- 'title' => '产品clientId',
- 'description' => '产品clientId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'RnY8v0W0ZVn58ZrUAOr2RD',
- ],
- 'ExtInfo' => [
- 'title' => '扩展参数',
- 'description' => '扩展参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"key":"value"}',
- ],
- 'UserId' => [
- 'title' => '精灵用户id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', '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' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -2077,303 +1565,212 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'AmpResult<Long>',
+ 'description' => 'AmpResult<Long>',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '结果信息',
- 'description' => '结果信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- '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' => '用户OpenId',
- ],
- 'DeviceOpenId' => [
- 'title' => 'A963*0158',
- 'description' => 'A963*0158',
- 'type' => 'string',
- 'example' => '设备OpenId',
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '686DF82F-45C4-7DF7-8B67-27B91CFD63A9',
- ],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '调用成功'],
+ 'Result' => ['description' => '创建成功的任务id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'F7E2****B7C94'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"BizType\\": \\"AILABS\\",\\n \\"BizGroup\\": \\"X1\\",\\n \\"UserOpenId\\": \\"用户OpenId\\",\\n \\"DeviceOpenId\\": \\"设备OpenId\\"\\n },\\n \\"RequestId\\": \\"686DF82F-45C4-7DF7-8B67-27B91CFD63A9\\"\\n}","type":"json"}]',
- 'title' => '通过扫描二维码进行激活绑定',
- 'description' => '通过扫描设备上的激活绑定相关的二维码信息进行激活绑定。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <Result>1234567</Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</CreateScheduleTaskResponse>","errorExample":""}]',
+ 'title' => '创建定时任务',
+ 'description' => '根据单次、每日、法定工作日等定时规则,配置生态inside自定义指令数据的触发任务',
+ 'responseParamsDescription' => ' 仅服务返回的状态码为200时为成功,否则均表示失败',
],
- 'GetUserByDeviceId' => [
- 'summary' => '根据设备openID,获取设备绑定用户ID。',
- 'path' => '/v1.0/ssp/getUserByDeviceId',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'DeviceInfo',
- 'in' => 'query',
+ 'name' => 'Payload',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息列表。',
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写“PROJECT_ID”',
- 'description' => '编码类型,此处填写**PROJECT_ID**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'type' => 'string',
+ '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' => '删除的闹总id集合', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567'],
'required' => true,
- 'example' => '12**45',
],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'UserInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
- 'description' => '设备Id的类型'."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,配置为deviceOpenId或deviceUnionId。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'DeviceInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => [
+ 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '用户open信息',
- 'description' => '返回的用户信息列表。',
- 'type' => 'object',
- 'properties' => [
- 'UserOpenId' => [
- 'title' => '用户信息对应的openId',
- 'description' => '用户信息对应的openId。',
- 'type' => 'string',
- 'example' => '0963*0158',
- ],
- 'UserUnionIds' => [
- 'title' => '组织id及归一id列表',
- 'description' => '用户的组织ID及UnionID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '信息列表',
- 'type' => 'object',
- 'properties' => [
- 'OrganizationId' => [
- 'title' => '组织id',
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => '1**2',
- ],
- 'UserUnionId' => [
- 'title' => '组织id对应的归一id',
- 'description' => '用户的UnionID。',
- 'type' => 'string',
- 'example' => '1553*B0C3',
- ],
- ],
- ],
- ],
- ],
- 'example' => 'true',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
- 'example' => '0EC7*726E',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
+ 'required' => true,
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AliGenie.GetUserByDeviceId.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'AmpResult',
+ 'description' => 'AmpResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '闹钟服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '闹钟id为空'],
+ 'Result' => ['description' => '删除闹钟是否执行成功', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"0963*0158\\",\\n \\"UserUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"UserUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetUserByDeviceIdResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <UserOpenId>0963*0158</UserOpenId>\\n <UserUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <UserUnionId>1553*B0C3</UserUnionId>\\n </UserUnionIds>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetUserByDeviceIdResponse>","errorExample":""}]',
- 'title' => '获取设备绑定的用户ID',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"闹钟id为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlarmsResponse>\\n <Code>200</Code>\\n <Message>闹钟id为空</Message>\\n <Result>true</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</DeleteAlarmsResponse>","errorExample":""}]',
+ 'title' => '批量删除闹钟',
+ 'responseParamsDescription' => '仅请求返回的状态码为200时为成功,否则均为失败',
],
- 'ListDeviceByUserId' => [
- 'summary' => '根据用户openID,获取绑定的设备ID列表。',
- 'path' => '/v1.0/ssp/listDeviceByUserId',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
+ 'name' => 'Payload',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '待删除的调度id', 'description' => '待删除的任务id', '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' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
- 'description' => '用户标识信息列表。',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写“PROJECT_ID”',
- 'description' => '编码类型,此处填写**PROJECT_ID**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在开放平台申请过组织后才会有',
- 'description' => '用户Id的类型:'."\n"
- .' - OPEN_ID:默认的用户ID标识。'."\n"
- .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,填写userOpenId或userUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', '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' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -2382,383 +1779,476 @@
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => 'AmpResult<Boolean>',
+ 'description' => 'AmpResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '返回result',
- 'description' => '返回的详细信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '信息列表',
- 'type' => 'object',
- 'properties' => [
- 'DeviceOpenId' => [
- 'title' => '设备信息对应的openId',
- 'description' => '设备信息对应的openId。',
- 'type' => 'string',
- 'example' => 'A963*0158',
- ],
- 'DeviceUnionIds' => [
- 'title' => '组织id及归一id列表',
- 'description' => '设备对应的组织ID及UnionId信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '信息列表',
- 'type' => 'object',
- 'properties' => [
- 'OrganizationId' => [
- 'title' => '组织id',
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => '1**2',
- ],
- 'DeviceUnionId' => [
- 'title' => '组织id对应的归一id',
- 'description' => '设备的UnionId。',
- 'type' => 'string',
- 'example' => '1553*B0C3',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Code' => ['title' => '错误码', 'description' => '响应码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '响应信息', 'type' => 'string', 'example' => '调用成功'],
+ 'Result' => ['title' => '删除结果', 'description' => '响应结果', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'F7E2****B7C94'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AliGenie.ListDeviceByUserId.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <Result>true</Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</DeleteScheduleTaskResponse>","errorExample":""}]',
+ 'title' => '删除定时任务',
+ 'description' => '根据定时任务id,删除指定定时任务',
+ 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
+ ],
+ 'DeleteSub' => [
+ 'summary' => '删除订阅专辑。',
+ 'path' => '/v1.0/ssp/deleteSub',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'SubId',
+ 'in' => 'query',
+ 'schema' => ['title' => '订阅专辑记录ID', 'description' => '订阅专辑记录ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '81'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceByUserIdResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceByUserIdResponse>","errorExample":""}]',
- 'title' => '获取用户绑定的设备列表',
- ],
- 'UnbindDevice' => [
- 'summary' => '根据用户open信息和设备open信息进行解除绑定关系。',
- 'path' => '/v1.0/ssp/unbindDevice',
- 'methods' => [
- 'post',
+ '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' => '请求ID', 'type' => 'string', 'example' => '0AA6C15C-FD61-1E32-9881-480CC6F35A70'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0AA6C15C-FD61-1E32-9881-480CC6F35A70\\"\\n}","type":"json"}]',
+ 'title' => '删除订阅专辑',
+ ],
+ 'DeviceControl' => [
+ 'summary' => '设备音量等属性值控制。',
+ 'path' => '/v1.0/ssp/control',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => [],
+ 'produces' => [],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'DeviceInfo',
+ 'name' => 'ControlRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
+ 'title' => '控制音量入参',
+ 'description' => '控制音量入参',
+ 'type' => 'object',
+ 'properties' => [
+ 'Volume' => ['title' => '音量目标值', 'description' => '音量目标值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'Muted' => ['title' => '是否静音', 'description' => '是否静音,在设置该字段为true时,需要同时指定音量值为0', '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' => '编码类型,此处填写**PROJECT_ID**。',
+ 'title' => '编码类型,此处填写PROJECT_ID。',
+ 'description' => '编码类型,此处填写PROJECT_ID。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,该产品所在项目的Project ID。请在天猫精灵AI平台控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
- 'description' => '设备Id的类型'."\n"
- .' - OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'title' => '设备Id的类型 :'."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'description' => '设备Id的类型 :'."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['title' => '设备的组织ID,如果IdType为UNION_ID时必填。', 'description' => '设备的组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1*****2'],
],
'required' => true,
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '调用该接口的返回结果。', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '返回的详细信息。', 'description' => '返回的详细信息。', 'type' => 'boolean'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '设备音量等属性值控制',
+ 'description' => '指定设备修改音量等属性值'."\n",
+ ],
+ 'EcologyOpennessAuthenticate' => [
+ 'summary' => '使用登录态访问令牌进行鉴权获取三方用户标识和精灵方用户openId',
+ 'path' => '/v1.0/ssp/ecologyOpennessAuthenticate',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'LoginStateAccessToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '登录态访问令牌', 'description' => '登录态访问令牌', 'type' => 'string', 'required' => true, 'example' => 'd15aa*****ee'],
+ ],
[
- 'name' => 'UserInfo',
+ 'name' => 'EncodeType',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '实体类型', 'description' => '实体类型', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ ],
+ [
+ 'name' => 'EncodeKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '实体key', 'description' => '实体key', 'type' => 'string', 'required' => true, 'example' => '12*****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '用户标识信息',
- 'description' => '用户标识信息列表。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写“PROJECT_ID”',
- 'description' => '编码类型,此处填写**PROJECT_ID**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,即该产品所在项目的Project ID。请在天猫精灵AI平台控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在开放平台申请过组织后才会有',
- 'description' => '用户ID的类型:'."\n"
- .' - OPEN_ID:默认的用户ID标识。'."\n"
- .' - UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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' => '精灵用户openId', 'type' => 'string', 'example' => 'o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ=='],
+ 'EncodeType' => ['title' => '实体类型', 'description' => '实体类型', 'type' => 'string', 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '实体key', 'description' => '实体key', 'type' => 'string', 'example' => '12****7'],
+ 'SceneCode' => ['title' => '场景码', 'description' => '场景码', 'type' => 'string', 'example' => '******'],
+ 'ThirdUserType' => ['title' => '三方用户类型', 'description' => '三方用户类型', 'type' => 'string', 'example' => '******'],
+ 'ThirdUserIdentifier' => ['title' => '三方用户标识', 'description' => '三方用户标识', 'type' => 'string', 'example' => '******'],
],
],
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识,填写userOpenId或userUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
],
- 'required' => true,
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73****9-175A-1324-8202-9FAAB*****A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"o****RnNAW/smBNX9By7Zlc3J7iQUXPiUj/6OizU+ifLSzn1vpQL9ZgSp22u7hsxj0UZ2i6urbv9HQ==\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"SceneCode\\": \\"******\\",\\n \\"ThirdUserType\\": \\"******\\",\\n \\"ThirdUserIdentifier\\": \\"******\\"\\n }\\n}","type":"json"}]',
+ 'title' => '生态开放鉴权',
+ 'description' => '注意:当登录态失效时,接入方需要重新发起授权登录流程获取新的登录态(入口服务API:AuthLoginWithThirdUserInfo)。'."\n"
+ ."\n"
+ .'- 通过Java-SDK(其它语言SDK请在接入时咨询天猫精灵开发)调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
+ .'当API调用抛出TeaException,且TeaException.code为InvalidAuthentication时代表登录态失效。'."\n"
+ ."\n"
+ .'- 通过发送http请求调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
+ .'当API调用返回的http响应状态码为400时代表登录态失效。',
+ ],
+ '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' => '会话id', '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' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExpireIn' => ['title' => '有效期(单位:秒)', 'description' => '有效期(单位:秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '900'],
+ 'RepeatInterval' => ['title' => '下次可重新发送的时间间隔(单位:秒)', 'description' => '下次可重新发送的时间间隔(单位:秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
+ ],
],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AliGenie.UnbindDevice.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ '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"}]',
+ 'title' => '生态开放发送短信验证码',
+ ],
+ 'FindUserlistToAuthLoginWithPhoneNumber' => [
+ 'summary' => '通过手机号寻找可授权登录的账号列表',
+ 'path' => '/v1.0/ssp/findUserlistToAuthLoginWithPhoneNumber',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '会话id', 'description' => '会话id', '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' => '请求ID', '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' => '用户类型'."\n"
+ .'TAOBAO:淘宝用户'."\n"
+ .'ALIGENIE:天猫精灵用户', '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' => '用户发现类型'."\n"
+ ."\n"
+ .'淘宝用户固定为:PHONE_NUMBER_BINDING_WITH_TAOBAO:phoneNumber作为淘宝绑定手机号查询到的;'."\n"
+ ."\n"
+ .'天猫精灵用户为:'."\n"
+ .'PHONE_NUMBER_BINDING_WITH_ALIGENIE:phoneNumber作为精灵绑定手机号查询到的;'."\n"
+ .'PHONE_NUMBER_BINDING_WITH_TAOBAO:phoneNumber作为淘宝绑定手机号查询到的;', 'type' => 'string', 'example' => 'PHONE_NUMBER_BINDING_WITH_ALIGENIE:phoneNumber'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DataObj' => [
+ 'title' => 'Code为5140003时代表调用失败,原因是该手机号未找到可授权登录的账号列表,前端可以让用户确认通过手机号生成精灵账号,也可提示用户先基于手机号注册淘宝账号,后续流程前端需要将DataObj中sessionId带回服务端。',
+ 'description' => 'Code为5140003时代表调用失败,原因是该手机号未找到可授权登录的账号列表,前端可以让用户确认通过手机号生成精灵账号,也可提示用户先基于手机号注册淘宝账号,后续流程前端需要将DataObj中sessionId带回服务端。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => ['title' => '会话id', 'description' => '会话id', 'type' => 'string', 'example' => 'dbe2eb4458302b9246c6da17fbc95f4b'],
+ ],
+ ],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindDeviceResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>true</Result>\\n <RequestId>0EC7*726E</RequestId>\\n</UnbindDeviceResponse>","errorExample":""}]',
- 'title' => '解绑设备',
+ '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"}]',
+ 'title' => '通过手机号寻找可授权登录的账号列表',
],
- 'ListDeviceByUserIdAndChanel' => [
- 'summary' => '获取指定渠道的设备列表。',
- 'path' => '/v1.0/ssp/listDeviceByUserIdAndChanel',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => 'ChannelInfo',
- 'in' => 'query',
+ 'name' => 'Payload',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '激活渠道,如微信小程序,三方app等',
- 'description' => '激活渠道,如微信小程序,三方app等',
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'Channel' => [
- 'title' => '激活配网渠道,如WeChat',
- 'description' => '激活配网渠道,如WeChat、ThirdApp',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'WeChat、ThirdApp',
- ],
- 'ExtInfo' => [
- 'title' => '扩展信息',
- 'description' => '扩展信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'RequestId' => ['type' => 'string', 'required' => true],
+ 'UserId' => ['type' => 'string', 'required' => true],
+ 'AccessKeyId' => ['title' => '调用方', 'type' => 'string', 'required' => true],
+ 'DeviceId' => ['type' => 'string', 'required' => true],
+ 'AlarmId' => ['description' => '闹钟id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567'],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息列表。',
- 'description' => '用户标识信息列表。',
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写PROJECT_ID。',
- 'description' => '编码类型,此处填写PROJECT_ID。',
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => [
+ 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => '123',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', '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' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
- 'title' => '用户Id的类型:'."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
- 'description' => '用户Id的类型:'."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
+ 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'Id' => [
- 'title' => '用户标识,填写userOpenId或userUnionId的值。',
- 'description' => '用户标识,填写userOpenId或userUnionId的值。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => '123',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1***2',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -2767,421 +2257,322 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'AmpResult',
+ 'description' => 'AmpResult',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '调用该接口的返回结果。',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => '闹钟服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'id为空'],
'Result' => [
- 'title' => '信息列表',
- 'description' => '信息列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DeviceOpenId' => [
- 'title' => '设备信息对应的openId。',
- 'description' => '设备信息对应的openId。',
- 'type' => 'string',
- 'example' => 'A963*0158',
- ],
- 'DeviceUnionIds' => [
- 'title' => '设备信息列表',
- 'description' => '信息列表',
- 'type' => 'array',
- 'items' => [
+ 'title' => '模型数据',
+ 'description' => '闹钟详情',
+ 'type' => 'object',
+ 'properties' => [
+ 'AlarmId' => ['title' => '闹钟id', 'description' => '闹钟id', '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' => '调度类型/循环类型: ONCE -> 单次,WEEKLY -> 周循环,STATUTORYWORKINGDAY ->法定工作日',
+ 'type' => 'string',
+ 'example' => 'ONCE',
+ 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'],
+ ],
+ 'Once' => [
+ 'title' => '单次',
+ 'description' => '单次::循环类型为ONCE时,该属性可用',
'type' => 'object',
'properties' => [
- 'OrganizationId' => [
- 'title' => '组织ID。',
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => '1***2',
- ],
- 'DeviceUnionId' => [
- 'title' => '设备的UnionId。',
- 'description' => '设备的UnionId。',
- 'type' => 'string',
- 'example' => '1553*B0C3',
+ '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' => '法定工作日:循环类型为STATUTORYWORKINGDAY时,该属性可用',
+ 'type' => 'object',
+ 'properties' => [
+ 'Hour' => ['title' => '触发时间:时', 'description' => '触发时间:时', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Minute' => ['title' => '触发时间:分', 'description' => '触发时间:分', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ ],
+ 'Weekly' => [
+ 'title' => '周循环',
+ 'description' => '周循环:循环类型为WEEKLY时,该属性可用',
+ 'type' => 'object',
+ 'properties' => [
+ 'Hour' => ['title' => '触发时间:时', 'description' => '触发时间:时', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Minute' => ['title' => '触发时间:分'."\n", 'description' => '触发时间:分'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'DaysOfWeek' => [
+ 'title' => '周几触发集合',
+ 'description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
+ 'type' => 'array',
+ 'items' => ['description' => '周一', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
+ 'MusicInfo' => [
+ 'title' => '音乐信息',
+ 'description' => '铃声信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'MusicType' => ['title' => '音乐类别id', 'description' => '铃声类别id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MusicTypeName' => ['title' => '音乐类别名称', 'description' => '铃声类别名称', 'type' => 'string', 'example' => 'xx音乐'],
+ 'MusicId' => ['title' => '音乐id', 'description' => '铃声id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MusicName' => ['title' => '音乐名称', 'description' => '铃声名称', 'type' => 'string', 'example' => 'xx铃声'],
+ 'MusicUrl' => ['title' => '音乐url', 'description' => '铃声url', 'type' => 'string', 'example' => 'http://xx'],
+ ],
+ ],
+ 'Volume' => ['title' => '音量', 'description' => '铃声音量', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
+ 'Status' => ['title' => '状态 0 正常 1 删除 2 关闭', 'description' => '状态 0 正常 1 删除 2 关闭', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
- 'RequestId' => [
- 'title' => '请求Id',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => 'RE***D',
- ],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1***2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"RE***D\\"\\n}","type":"json"}]',
- 'title' => '获取指定渠道的设备列表',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"id为空\\",\\n \\"Result\\": {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 123454321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAlarmResponse>\\n <Code>200</Code>\\n <Message>id为空</Message>\\n <Result>\\n <AlarmId>1234567</AlarmId>\\n <UserId>123454321</UserId>\\n <Uuid>AF18***065EE4BD***68CEFD9***84D4</Uuid>\\n <ScheduleTypeDesc>单次</ScheduleTypeDesc>\\n <TriggerDateDesc>2022-07-29</TriggerDateDesc>\\n <TriggerTimeDesc>10:00</TriggerTimeDesc>\\n <ScheduleInfo>\\n <Type>ONCE</Type>\\n <Once>\\n <Year>2022</Year>\\n <Month>7</Month>\\n <Day>29</Day>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </Once>\\n <StatutoryWorkingDay>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </StatutoryWorkingDay>\\n <Weekly>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n <DaysOfWeek>1</DaysOfWeek>\\n </Weekly>\\n </ScheduleInfo>\\n <MusicInfo>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx音乐</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx铃声</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </MusicInfo>\\n <Volume>40</Volume>\\n <Status>0</Status>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</GetAlarmResponse>","errorExample":""}]',
+ 'title' => '获取单个闹钟详情',
+ 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
],
- 'GetDeviceIdByIdentity' => [
- 'summary' => '根据设备MAC/SN获取设备ID。',
- 'path' => '/v1.0/ssp/getDeviceIdByIdentity',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetAlbum' => [
+ 'summary' => '按照特定的id获取专辑信息。',
+ 'path' => '/v1.0/ssp/GetAlbum',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'EncodeType',
+ 'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'title' => '编码类型,此处填写“PROJECT_ID”',
- 'description' => '编码类型,此处填写**PROJECT_ID**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
+ 'schema' => ['description' => '专辑id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12343'],
],
[
- 'name' => 'EncodeKey',
+ 'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '129****0946',
- ],
+ 'schema' => ['description' => '默认值song', 'type' => 'string', 'required' => true, 'example' => 'song'],
],
- [
- 'name' => 'IdentityType',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '填写设备认证类型,“MAC”或者“SN”',
- 'description' => '设备认证类型,填写**MAC**或者**SN**或者**CTEI**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MAC',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求requestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
+ 'Code' => ['description' => 'code编码', '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' => '作者主键id', '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' => '根据所属公共类目转换controlType', 'type' => 'string', 'example' => 'audio'],
+ 'Charge' => ['description' => '是否收费', 'type' => 'boolean', 'example' => 'false'],
+ 'CommCateId' => ['description' => '对应的类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017'],
+ 'Cover' => [
+ 'description' => '专辑封面图片',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', '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' => '专辑id', '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' => '根据所属公共类目转换favoriteType', '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' => '三方id', 'type' => 'string', 'example' => '23242'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 13123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Finished\\": \\"FINISHED\\",\\n \\"TotalEpisode\\": 12,\\n \\"RawId\\": \\"23242\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAlbumResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>13123</Id>\\n <Online>false</Online>\\n <Source>qignting</Source>\\n <Title>超能狂少在都市</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>1231231</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qignting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <Finished>FINISHED</Finished>\\n <TotalEpisode>12</TotalEpisode>\\n <RawId>23242</RawId>\\n </Result>\\n</GetAlbumResponse>","errorExample":""}]',
+ 'title' => '按照特定的id获取专辑信息',
+ ],
+ 'GetAlbumDetailById' => [
+ 'summary' => '获取专辑信息。',
+ 'path' => '/v1.0/ssp/getAlbumDetailById',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IdentityId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '认证标识,填写MAC地址或者SN的值。',
- 'description' => '认证标识,填写MAC地址或者SN的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b4:xx:xx:xx:65:2b',
- ],
+ 'AliGenie_Auth_SPI' => [],
],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'ProductKey',
+ 'name' => 'AlbumId',
'in' => 'query',
- 'schema' => [
- 'title' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。',
- 'description' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。当IdentityType为**CTEI**时可不传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Mm*****XnZ8',
- ],
+ 'schema' => ['title' => '专辑ID', 'description' => '专辑ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51999575'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '返回result',
- 'description' => '返回的详细信息。',
+ 'title' => '专辑内容',
+ 'description' => '专辑内容',
'type' => 'object',
'properties' => [
- 'DeviceOpenId' => [
- 'title' => '设备信息对应的openId',
- 'description' => '设备对应的openId。',
- 'type' => 'string',
- 'example' => 'A963*0158',
- ],
- 'DeviceUnionIds' => [
- 'title' => '组织id及归一id列表',
- 'description' => '设备对应的组织ID及UnionId信息。',
+ 'AlbumId' => ['title' => '专辑ID', 'description' => '专辑ID', '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' => '专辑内容List',
'type' => 'array',
'items' => [
- 'description' => '信息列表',
'type' => 'object',
'properties' => [
- 'OrganizationId' => [
- 'title' => '组织id',
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => '1**2',
- ],
- 'DeviceUnionId' => [
- 'title' => '组织id对应的归一id',
- 'description' => '设备的UnionId。',
- 'type' => 'string',
- 'example' => '1553*B0C3',
- ],
+ 'Id' => ['title' => '专辑内容ID', 'description' => '专辑内容ID', '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,用于排查问题,如果没有这个参数,可以在responseHeader里进行排查。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7DA****A0726E',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A0B7CACD-485B-14E2-854F-39EACB09E45B'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7DA****A0726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceIdByIdentityResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </Result>\\n <RequestId>0EC7DA****A0726E</RequestId>\\n</GetDeviceIdByIdentityResponse>","errorExample":""}]',
- 'title' => '获取设备ID',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"AlbumTitle\\": \\"小科学家探索\\",\\n \\"AlbumDescription\\": \\"每次一个百科知识或者故事\\\\\\\\n丰富孩子的视野,拓展眼界和知识面,培养和孩子的探究能力和好奇心\\\\\\\\n\\\\\\\\n\\",\\n \\"AlbumCoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"AlbumContentList\\": [\\n {\\n \\"Id\\": \\"468009044\\",\\n \\"Title\\": \\"001为什么肚子饿时会咕咕叫\\",\\n \\"Duration\\": \\"3分24秒\\",\\n \\"OrderIndex\\": \\"1000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A0B7CACD-485B-14E2-854F-39EACB09E45B\\"\\n}","type":"json"}]',
+ 'title' => '获取专辑信息',
],
- 'ListDeviceIdByIdentities' => [
- 'summary' => '批量根据设备MAC/SN获取设备ID。',
- 'path' => '/v1.0/ssp/listDeviceIdByIdentities',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetAligenieUserInfo' => [
+ 'summary' => '通过登录态凭证获取三方绑定的精灵账号信息',
+ 'path' => '/v1.0/ssp/getAligenieUserInfo',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'EncodeType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '编码类型,此处填写“PROJECT_ID”',
- 'description' => '编码类型,此处填写**PROJECT_ID**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- ],
- [
- 'name' => 'EncodeKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '125****0946',
- ],
- ],
- [
- 'name' => 'IdentityType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '填写设备认证类型,“MAC”或者“SN”',
- 'description' => '设备认证类型,填写**MAC**或**SN**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MAC',
- ],
- ],
- [
- 'name' => 'IdentityIds',
+ 'name' => 'LoginStateAccessToken',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '设备的认证标识列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => '认证标识,填写MAC地址或者SN的值。',
- 'description' => '认证标识,填写MAC地址或SN值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b4:xx:xx:xx:65:2b',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'ProductKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。',
- 'description' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Mm*****XnZ8',
- ],
+ 'schema' => ['title' => '登录态访问凭证', 'description' => '登录态访问凭证', 'type' => 'string', 'required' => true, 'example' => '99ce8a70c23a94f8569e1a525bef6e85'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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' => '返回result',
- 'description' => '返回的详细信息列表。',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'DeviceOpenId' => [
- 'title' => '设备信息对应的openId',
- 'description' => '设备对应的openId。',
- 'type' => 'string',
- 'example' => 'A963*0158',
- ],
- 'DeviceUnionIds' => [
- 'title' => '组织id及归一id列表',
- 'description' => '设备对应的组织ID及UnionId信息。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'OrganizationId' => [
- 'title' => '组织id',
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => '1**2',
- ],
- 'DeviceUnionId' => [
- 'title' => '组织id对应的归一id',
- 'description' => '设备的UnionId。',
- 'type' => 'string',
- 'example' => '1553*B0C3',
- ],
- ],
- 'description' => '信息列表',
- ],
- ],
- ],
- 'description' => '信息列表',
+ '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'],
],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceIdByIdentitiesResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <b4:xx:xx:xx:65:2b>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </b4:xx:xx:xx:65:2b>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceIdByIdentitiesResponse>","errorExample":""}]',
- 'title' => '批量获取设备ID',
+ '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"}]',
+ 'title' => '获取三方绑定的精灵账号信息',
+ 'description' => '注意:当登录态失效时,接入方需要重新发起授权登录流程获取新的登录态(入口服务API:AuthLoginWithThirdUserInfo)。'."\n"
+ ."\n"
+ .'- 通过Java-SDK(其它语言SDK请在接入时咨询天猫精灵开发)调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
+ .'当API调用抛出TeaException,且TeaException.code为InvalidAuthentication时代表登录态失效。'."\n"
+ ."\n"
+ .'- 通过发送http请求调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
+ .'当API调用返回的http响应状态码为400时代表登录态失效。',
],
- 'GetDeviceBasicInfo' => [
- 'summary' => '根据设备ID,获取设备基本信息。',
- 'path' => '/v1.0/ssp/getDeviceBasicInfo',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetCodeEnhance' => [
+ 'summary' => '获取authCode。',
+ 'path' => '/v1.0/ssp/getCodeEnhance',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
@@ -3191,58 +2582,52 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'DeviceInfo',
+ 'name' => 'ChannelInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息列表。',
+ 'title' => '激活渠道,如微信小程序,三方app等',
+ 'description' => '激活渠道,如微信小程序,三方app等',
+ 'type' => 'object',
+ 'properties' => [
+ 'Channel' => ['title' => '激活渠道,如WeChat', 'description' => '激活渠道,如WeChat、ThirdApp', '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' => '编码类型,此处填写**PROJECT_ID**。',
+ 'title' => '编码类型,此处填写PROJECT_ID。',
+ 'description' => '编码类型,此处填写PROJECT_ID。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 :'."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'title' => '设备Id的类型 :'."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'description' => '用户Id的类型:'."\n"
+ .'OPENID:默认的用户ID标识。'."\n"
+ .'UNIONID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '用户标识,填写userOpenId或userUnionId的值。', 'description' => '用户标识,填写userOpenId或userUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => true,
],
@@ -3251,316 +2636,316 @@
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '调用该接口的返回结果。', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '返回的详细信息。', 'description' => '返回的详细信息。', 'type' => 'string', 'example' => 'Aexfgc'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": \\"Aexfgc\\",\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '获取authCode',
+ 'description' => '通过指定用户id,获取对应的authCode',
+ ],
+ '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' => '内容id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => '默认值song', 'type' => 'string', 'required' => true, 'example' => 'song'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求RequestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
'Result' => [
- 'title' => '返回result',
- 'description' => '返回的详细信息。',
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '设备名称',
- 'description' => '设备的名称。',
- 'type' => 'string',
- 'example' => '我的设备',
- ],
- 'FirmwareVersion' => [
- 'title' => '固件版本',
- 'description' => '设备的固件版本。',
- 'type' => 'string',
- 'example' => '2.0.3',
+ 'Alias' => [
+ 'description' => '别名',
+ 'type' => 'array',
+ 'items' => ['description' => '别名', 'type' => 'string', 'example' => '超能狂少在都市'],
],
- 'Mac' => [
- 'title' => '设备MAC地址',
- 'description' => '设备的MAC地址。',
- 'type' => 'string',
- 'example' => 'b4:xx:xx:xx:65:2b',
+ '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' => '作者主键id', 'type' => 'integer', 'format' => 'int64', 'example' => '123123'],
+ 'Online' => ['description' => '是否在线', 'type' => 'boolean', 'example' => 'false'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'qingting'],
+ 'Title' => ['description' => '作者标题', 'type' => 'string', 'example' => '播音呆瓜小贼'],
+ ],
+ ],
],
- 'Sn' => [
- 'title' => '设备SN',
- 'description' => '设备的SN信息。',
- 'type' => 'string',
- 'example' => '1200xxx048',
+ 'Category' => ['description' => '根据所属公共类目转换controlType', 'type' => 'string', 'example' => 'audio'],
+ 'Charge' => ['description' => '是否收费', 'type' => 'boolean', 'example' => 'false'],
+ 'CommCateId' => ['description' => '对应的类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017'],
+ 'Cover' => [
+ 'description' => '专辑封面图片',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', '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' => '内容id', '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' => '根据所属公共类目转换favoriteType', 'type' => 'string', 'example' => 'program'],
+ 'Valid' => ['description' => '是否可播', 'type' => 'string', 'example' => 'VALID'],
+ 'Duration' => ['description' => '时长信息', 'type' => 'integer', 'format' => 'int64', 'example' => '180'],
+ 'AlbumId' => ['description' => '对应的专辑id', 'type' => 'string', 'example' => '1231'],
+ 'Lyric' => ['description' => '歌词信息', 'type' => 'string', 'example' => 'http://1231.lrc'],
+ 'Styles' => [
+ 'description' => '曲风',
+ 'type' => 'array',
+ 'items' => ['description' => '曲风', 'type' => 'string', 'example' => '1312'],
],
+ 'RawId' => ['description' => '内容的三方id', 'type' => 'string', 'example' => '1231231'],
],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceBasicInfo.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceBasicInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <Name>我的设备</Name>\\n <FirmwareVersion>2.0.3</FirmwareVersion>\\n <Mac>b4:xx:xx:xx:65:2b</Mac>\\n <Sn>1200xxx048</Sn>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceBasicInfoResponse>","errorExample":""}]',
- 'title' => '获取设备基本信息',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 123123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 0,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"1231\\",\\n \\"Lyric\\": \\"http://1231.lrc\\",\\n \\"Styles\\": [\\n \\"1312\\"\\n ],\\n \\"RawId\\": \\"1231231\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>123123</Id>\\n <Online>false</Online>\\n <Source>qingting</Source>\\n <Title>播音呆瓜小贼</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <Duration>180</Duration>\\n <AlbumId>1231</AlbumId>\\n <Lyric>http://1231.lrc</Lyric>\\n <Styles>1312</Styles>\\n <RawId>1231231</RawId>\\n </Result>\\n</GetContentResponse>","errorExample":""}]',
+ 'title' => ' 按照特定的id获取内容信息',
],
- 'ListDeviceBasicInfo' => [
- 'summary' => '根据设备openID列表,批量获取设备基本信息。',
- 'path' => '/v1.0/ssp/listDeviceBasicInfo',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => 'DeviceInfos',
+ 'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息列表。',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写“PROJECT_ID”',
- 'description' => '编码类型,此处填写**PROJECT_ID**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 :'."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Ids' => [
- 'title' => '设备标识列表(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识信息列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'required' => false,
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '设备的组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
- 'required' => false,
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'DeviceInfo',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '设备标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
+ 'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '返回result,key为deviceOpenId或deviceUnionId,value为对应的设备信息',
- 'description' => '返回的详细信息。',
+ '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' => '设备的MAC地址。',
- 'type' => 'string',
- 'example' => 'b4:xx:xx:xx:65:2b',
- ],
- 'Sn' => [
- 'title' => '设备SN',
- 'description' => '设备的SN信息。',
- 'type' => 'string',
- 'example' => '1200xx048',
+ 'properties' => [
+ 'RawId' => ['description' => '三方id', 'type' => 'string', 'example' => '550144364'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'ximalayav2'],
+ 'AlbumRawId' => ['description' => '三方专辑id', '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' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'description' => '返回的设备信息列表。',
+ 'PlayMode' => ['description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Repeat'],
+ 'AudioLength' => ['description' => '长度', 'type' => 'integer', 'format' => 'int32', 'example' => '190'],
+ 'Progress' => ['description' => '歌曲播放进度', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'LyricUrl' => ['description' => '歌词url', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'],
+ 'Copyright' => ['description' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Type' => ['description' => 'type (music\\program\\joke\\news\\children_song\\radio等)', 'type' => 'string', 'example' => 'story'],
+ 'ItemUrl' => ['description' => '播放url', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3'],
+ 'DefaultPlayOrder' => ['description' => 'package 默认播放顺序 0 顺序,1 倒序', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Valid' => ['description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID'],
+ 'Pos' => ['description' => '该项在播放列表中的位置', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息'."\n"
+ ."\n", 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AliGenie.ListDeviceBasicInfo.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xx048\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceBasicInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DAFE****ce3ej=>\\n <Name>我的设备</Name>\\n <FirmwareVersion>2.0.3</FirmwareVersion>\\n <Mac>b4:xx:xx:xx:65:2b</Mac>\\n <Sn>1200xx048</Sn>\\n </DAFE****ce3ej=>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceBasicInfoResponse>\\n","errorExample":""}]',
- 'title' => '批量查询设备基本信息',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": \\"false\\",\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCurrentPlayingItemResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Copyright>0</Copyright>\\n <Type>story</Type>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</GetCurrentPlayingItemResponse>","errorExample":""}]',
+ 'title' => '获取当前播放项',
],
- 'GetDeviceStatusInfo' => [
- 'summary' => '根据设备openID,获取设备在线状态。',
- 'path' => '/v1.0/ssp/getDeviceStatusInfo',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息列表。',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写“PROJECT_ID”',
- 'description' => '编码类型,此处填写**PROJECT_ID**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 :'."\n"
- .'- OPEN_ID:默认的设备ID标识。'."\n"
- .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '设备的组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -3569,86 +2954,69 @@
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据体',
- 'description' => '返回数据列表。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '返回result',
- 'description' => '返回的详细信息。',
- 'type' => 'object',
- 'properties' => [
- 'Online' => [
- 'title' => '是否在线,0为不在线,1为在线',
- 'description' => '设备是否在线,0表示不在线,1 表示在线。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'description' => '服务的实际返回结果',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RawId' => ['description' => '三方id', 'type' => 'string', 'example' => '550144364'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'ximalayav2'],
+ 'AlbumRawId' => ['description' => '三方专辑id', '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' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
+ ],
+ ],
+ 'PlayMode' => ['description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Normal'],
+ 'AudioLength' => ['description' => '长度', 'type' => 'integer', 'format' => 'int32', 'example' => '190'],
+ 'Progress' => ['description' => '歌曲播放进度', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'LyricUrl' => ['description' => '歌词url', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'],
+ 'Type' => ['description' => 'type (music\\program\\joke\\news\\children_song\\radio等)', 'type' => 'string', 'example' => 'story'],
+ 'Copyright' => ['description' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ItemUrl' => ['description' => '播放url', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3'],
+ 'DefaultPlayOrder' => ['description' => 'package 默认播放顺序 0 顺序,1 倒序', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Valid' => ['description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID'],
+ 'Pos' => ['description' => '该项在播放列表中的位置', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceStatusInfo.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Online\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceStatusInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <Online>1</Online>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceStatusInfoResponse>","errorExample":""}]',
- 'title' => '获取设备状态',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Normal\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCurrentPlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Normal</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</GetCurrentPlayingListResponse>","errorExample":""}]',
+ 'title' => '获取当前播放列表',
],
- 'GetDeviceTag' => [
- 'summary' => '获取设备的标签信息。',
- 'path' => '/v1.0/ssp/getDeviceTag',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDeviceBasicInfo' => [
+ 'summary' => '根据设备ID,获取设备基本信息。',
+ 'path' => '/v1.0/ssp/getDeviceBasicInfo',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -3667,44 +3035,21 @@
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
'IdType' => [
'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
- 'description' => '设备ID的类型:'."\n"
- .' - OPEN_ID:默认的设备ID标识。'."\n"
+ 'description' => '设备Id的类型 :'."\n"
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
.'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => true,
],
@@ -3717,214 +3062,128 @@
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回的错误信息',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '返回result',
'description' => '返回的详细信息。',
'type' => 'object',
'properties' => [
- 'DeviceTags' => [
- 'title' => '设备标签结果',
- 'description' => '设备的标签信息。',
- 'type' => 'object',
- 'example' => '{ "antest1": "antest1", "antest": "a" }',
- ],
+ 'Name' => ['title' => '设备名称', 'description' => '设备的名称。', 'type' => 'string', 'example' => '我的设备'],
+ 'FirmwareVersion' => ['title' => '固件版本', 'description' => '设备的固件版本。', 'type' => 'string', 'example' => '2.0.3'],
+ 'Mac' => ['title' => '设备MAC地址', 'description' => '设备的MAC地址。', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'],
+ 'Sn' => ['title' => '设备SN', 'description' => '设备的SN信息。', 'type' => 'string', 'example' => '1200xxx048'],
],
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'AliGenie.GetDeviceBasicInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'AliGenie.Public.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceTags\\": {\\n \\"antest1\\": \\"antest1\\",\\n \\"antest\\": \\"a\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceTagResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceTags>\\n <antest1>antest1</antest1>\\n <antest>a</antest>\\n </DeviceTags>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceTagResponse>","errorExample":""}]',
- 'title' => '获取设备标签',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xxx048\\"\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceBasicInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <Name>我的设备</Name>\\n <FirmwareVersion>2.0.3</FirmwareVersion>\\n <Mac>b4:xx:xx:xx:65:2b</Mac>\\n <Sn>1200xxx048</Sn>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceBasicInfoResponse>","errorExample":""}]',
+ 'title' => '获取设备基本信息',
],
- 'DeviceControl' => [
- 'summary' => '设备音量等属性值控制。',
- 'path' => '/v1.0/ssp/control',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDeviceIdByIdentity' => [
+ 'summary' => '根据设备MAC/SN获取设备ID。',
+ 'path' => '/v1.0/ssp/getDeviceIdByIdentity',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [],
- 'produces' => [],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'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' => '是否静音,在设置该字段为true时,需要同时指定音量值为0',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'EncodeType',
+ 'in' => 'query',
+ 'schema' => ['title' => '编码类型,此处填写“PROJECT_ID”', 'description' => '编码类型,此处填写**PROJECT_ID**。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
],
[
- 'name' => 'DeviceInfo',
+ 'name' => 'EncodeKey',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '设备标识信息列表。',
- 'description' => '设备标识信息列表。',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'title' => '编码类型,此处填写PROJECT_ID。',
- 'description' => '编码类型,此处填写PROJECT_ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型 :'."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'description' => '设备Id的类型 :'."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'OrganizationId' => [
- 'title' => '设备的组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '设备的组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1*****2',
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '129****0946'],
+ ],
+ [
+ 'name' => 'IdentityType',
+ 'in' => 'query',
+ 'schema' => ['title' => '填写设备认证类型,“MAC”或者“SN”', 'description' => '设备认证类型,填写**MAC**或者**SN**或者**CTEI**。', 'type' => 'string', 'required' => true, 'example' => 'MAC'],
+ ],
+ [
+ 'name' => 'IdentityId',
+ 'in' => 'query',
+ 'schema' => ['title' => '认证标识,填写MAC地址或者SN的值。', 'description' => '认证标识,填写MAC地址或者SN的值。', 'type' => 'string', 'required' => true, 'example' => 'b4:xx:xx:xx:65:2b'],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。', 'description' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。当IdentityType为**CTEI**时可不传。', 'type' => 'string', 'required' => false, 'example' => 'Mm*****XnZ8'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '返回数据体',
+ 'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '调用该接口的返回结果。',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '返回的详细信息。',
+ 'title' => '返回result',
'description' => '返回的详细信息。',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceOpenId' => ['title' => '设备信息对应的openId', 'description' => '设备对应的openId。', 'type' => 'string', 'example' => 'A963*0158'],
+ 'DeviceUnionIds' => [
+ 'title' => '组织id及归一id列表',
+ 'description' => '设备对应的组织ID及UnionId信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '信息列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrganizationId' => ['title' => '组织id', 'description' => '组织ID。', 'type' => 'string', 'example' => '1**2'],
+ 'DeviceUnionId' => ['title' => '组织id对应的归一id', 'description' => '设备的UnionId。', 'type' => 'string', 'example' => '1553*B0C3'],
+ ],
+ ],
+ ],
+ ],
],
+ 'RequestId' => ['title' => '请求ID,用于排查问题,如果没有这个参数,可以在responseHeader里进行排查。', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7DA****A0726E'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '设备音量等属性值控制',
- 'description' => '指定设备修改音量等属性值'."\n",
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7DA****A0726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceIdByIdentityResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </Result>\\n <RequestId>0EC7DA****A0726E</RequestId>\\n</GetDeviceIdByIdentityResponse>","errorExample":""}]',
+ 'title' => '获取设备ID',
],
'GetDeviceSetting' => [
'summary' => '获取设备的用户设置。',
'path' => '/v1.0/ssp/getDeviceSetting',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
@@ -3946,10 +3205,7 @@
'description' => '设备设置指定的Key集合,'."\n"
.'勿扰模式:nightMode',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'items' => ['type' => 'string', 'required' => false],
'required' => true,
],
],
@@ -3968,17 +3224,9 @@
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
'IdType' => [
'title' => '设备Id的类型'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
@@ -3989,25 +3237,10 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识,配置为deviceOpenId或deviceUnionId。',
- 'description' => '设备标识,配置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '122',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '设备标识,配置为deviceOpenId或deviceUnionId。', 'description' => '设备标识,配置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '122'],
],
'required' => false,
],
@@ -4020,30 +3253,10 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '调用该接口的返回结果。',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '返回具体的设备设置信息。',
- 'description' => '返回具体的设备设置信息。',
- 'type' => 'object',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'Message' => ['title' => '调用该接口的返回结果。', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '返回具体的设备设置信息。', 'description' => '返回具体的设备设置信息。', 'type' => 'object'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
@@ -4054,13 +3267,8 @@
'GetDeviceStatusDetail' => [
'summary' => '获取设备状态详情。',
'path' => '/v1.0/ssp/getDeviceStatusDetail',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
@@ -4081,10 +3289,7 @@
.'设备音量:speaker'."\n"
.'设备电量:power',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'items' => ['type' => 'string', 'required' => false],
'required' => true,
],
],
@@ -4103,17 +3308,9 @@
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
'title' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
@@ -4124,25 +3321,10 @@
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'OPEN_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'enum' => ['OPEN_ID', 'OPEN_ID'],
],
+ 'Id' => ['title' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => true,
],
@@ -4155,19 +3337,8 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '调用该接口的返回结果。',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '调用该接口的返回结果。', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '返回的详细信息。',
'description' => '返回的详细信息。',
@@ -4178,81 +3349,19 @@
'description' => '播放器信息',
'type' => 'object',
'properties' => [
- 'AudioAnchor' => [
- 'title' => '歌手',
- 'description' => '歌手',
- 'type' => 'string',
- 'example' => '刘德华',
- ],
- 'AudioExt' => [
- 'title' => '扩展信息',
- 'description' => '扩展信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'AudioId' => [
- 'title' => '歌曲id',
- 'description' => '歌曲id',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'Format' => [
- 'title' => '歌曲类型(mp3)',
- 'description' => '歌曲类型(mp3)',
- 'type' => 'string',
- 'example' => 'mp3',
- ],
- 'AudioSource' => [
- 'title' => '歌曲来源(xiami)',
- 'description' => '歌曲来源(xiami)',
- 'type' => 'string',
- 'example' => 'xiami',
- ],
- 'AudioLength' => [
- 'title' => ' 歌曲长度,秒',
- 'description' => ' 歌曲长度,秒',
- 'type' => 'string',
- 'example' => '253',
- ],
- 'Source' => [
- 'title' => '播放来源(cloud)',
- 'description' => '播放来源(cloud)',
- 'type' => 'string',
- 'example' => 'cloud',
- ],
- 'AudioUrl' => [
- 'title' => '歌曲url',
- 'description' => '歌曲url',
- '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' => '播放状态,pause',
- 'type' => 'string',
- 'example' => 'pause',
- ],
+ 'AudioAnchor' => ['title' => '歌手', 'description' => '歌手', 'type' => 'string', 'example' => '刘德华'],
+ 'AudioExt' => ['title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'example' => '""'],
+ 'AudioId' => ['title' => '歌曲id', 'description' => '歌曲id', 'type' => 'string', 'example' => '123'],
+ 'Format' => ['title' => '歌曲类型(mp3)', 'description' => '歌曲类型(mp3)', 'type' => 'string', 'example' => 'mp3'],
+ 'AudioSource' => ['title' => '歌曲来源(xiami)', 'description' => '歌曲来源(xiami)', 'type' => 'string', 'example' => 'xiami'],
+ 'AudioLength' => ['title' => ' 歌曲长度,秒', 'description' => ' 歌曲长度,秒', 'type' => 'string', 'example' => '253'],
+ 'Source' => ['title' => '播放来源(cloud)', 'description' => '播放来源(cloud)', 'type' => 'string', 'example' => 'cloud'],
+ 'AudioUrl' => ['title' => '歌曲url', 'description' => '歌曲url', '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' => '播放状态,pause', 'type' => 'string', 'example' => 'pause'],
],
],
'Speaker' => [
@@ -4260,18 +3369,8 @@
'description' => '音量信息',
'type' => 'object',
'properties' => [
- 'Volume' => [
- 'title' => '音量当前值',
- 'description' => '音量当前值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Muted' => [
- 'title' => '是否静音',
- 'description' => '是否静音',
- 'type' => 'boolean',
- ],
+ 'Volume' => ['title' => '音量当前值', 'description' => '音量当前值', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Muted' => ['title' => '是否静音', 'description' => '是否静音', 'type' => 'boolean'],
],
],
'Power' => [
@@ -4279,28 +3378,13 @@
'description' => '电量信息',
'type' => 'object',
'properties' => [
- 'Quantity' => [
- 'title' => '电量值',
- 'description' => '电量值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'Status' => [
- 'title' => '电源状态',
- 'description' => '电源状态',
- 'type' => 'string',
- ],
+ 'Quantity' => ['title' => '电量值', 'description' => '电量值', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'Status' => ['title' => '电源状态', 'description' => '电源状态', 'type' => 'string'],
],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '0EC7*726E',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
@@ -4308,16 +3392,11 @@
'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"}]',
'title' => '获取设备状态详情',
],
- 'SetDeviceSetting' => [
- 'summary' => '修改设备的用户设置。',
- 'path' => '/v1.0/ssp/setDeviceSetting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDeviceStatusInfo' => [
+ 'summary' => '根据设备openID,获取设备在线状态。',
+ 'path' => '/v1.0/ssp/getDeviceStatusInfo',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
@@ -4327,82 +3406,35 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Key',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备设置指定的Key集合,'."\n"
- .'勿扰模式:nightMode',
- 'description' => '设备设置指定的Key集合,'."\n"
- .'勿扰模式:nightMode',
- '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' => '用户标识信息列表。',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息列表。',
'type' => 'object',
'properties' => [
'EncodeType' => [
- 'title' => '编码类型,此处填写PROJECT_ID。',
- 'description' => '编码类型,此处填写PROJECT_ID。',
+ 'title' => '编码类型,此处填写“PROJECT_ID”',
+ 'description' => '编码类型,此处填写**PROJECT_ID**。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
'IdType' => [
- 'title' => '设备Id的类型 :'."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'description' => '设备Id的类型 :'."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'title' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填。',
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '设备的组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -4411,636 +3443,231 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '返回数据体',
+ 'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '调用该接口的返回结果。',
- 'description' => '调用该接口的返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '返回的错误码,200表示调用成功。',
- 'description' => '返回的错误码,200表示调用成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '设置执行结果',
- 'description' => '设置执行结果',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'title' => '请求ID。',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0EC7*726E',
+ 'title' => '返回result',
+ 'description' => '返回的详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Online' => ['title' => '是否在线,0为不在线,1为在线', 'description' => '设备是否在线,0表示不在线,1 表示在线。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
- 'title' => '修改设备的用户设置',
- ],
- 'GetJiangSuTelecomData' => [
- 'summary' => '江苏电信号百自研桌面lucher的衍生需求,号百期望统计该项目上线后的激活率、活跃率、以及用户TOP使用习惯等信息,生成日报表和周报表,日报表按接口自动化方式同步,周报表则走线下同步',
- 'path' => '/v1.0/ssp/GetJiangSuTelecomData',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.GetDeviceStatusInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Online\\": 1\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceStatusInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <Online>1</Online>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceStatusInfoResponse>","errorExample":""}]',
+ 'title' => '获取设备状态',
+ ],
+ 'GetDeviceTag' => [
+ 'summary' => '获取设备的标签信息。',
+ 'path' => '/v1.0/ssp/getDeviceTag',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Date',
+ 'name' => 'DeviceInfo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '日期,格式yyyy-MM-dd,按照数据产出的业务日期,不是数据产生的日期,生产数据的日期都是T+1的。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-11-09',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => [
+ 'title' => '编码类型,此处填写“PROJECT_ID”',
+ 'description' => '编码类型,此处填写**PROJECT_ID**。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'IdType' => [
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
+ 'description' => '设备ID的类型:'."\n"
+ .' - OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ 'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '返回数据体',
+ 'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '状态码,正常返回200',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '服务的实际返回结果',
+ 'title' => '返回result',
+ 'description' => '返回的详细信息。',
'type' => 'object',
'properties' => [
- 'OssUrl' => [
- 'description' => 'Oss对象地址 有效时间10分钟',
- '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',
- ],
+ 'DeviceTags' => ['title' => '设备标签结果', 'description' => '设备的标签信息。', 'type' => 'object', 'example' => '{ "antest1": "antest1", "antest": "a" }'],
],
],
- 'Message' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949',
- ],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.GetDeviceTag.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OssUrl\\": \\"http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949\\"\\n}","type":"json"}]',
- 'title' => '获取江苏电信号百的数据',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"DeviceTags\\": {\\n \\"antest1\\": \\"antest1\\",\\n \\"antest\\": \\"a\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceTagResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceTags>\\n <antest1>antest1</antest1>\\n <antest>a</antest>\\n </DeviceTags>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetDeviceTagResponse>","errorExample":""}]',
+ 'title' => '获取设备标签',
],
- 'ScgSearch' => [
- 'summary' => '根据选品池ID查询选品池内容。',
- 'path' => '/v1.0/ssp/scgSearch',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetJiangSuTelecomData' => [
+ 'summary' => '江苏电信号百自研桌面lucher的衍生需求,号百期望统计该项目上线后的激活率、活跃率、以及用户TOP使用习惯等信息,生成日报表和周报表,日报表按接口自动化方式同步,周报表则走线下同步',
+ 'path' => '/v1.0/ssp/GetJiangSuTelecomData',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'TopicId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '选品池ID 可选:MC201132(民族中国风),MC201136(流行音乐),MC201139(甜蜜爱情),MC201133(民谣),MC201137(放松阅读),MC201138(快乐),PA202029(故事),PA202030(儿歌),PA202028(国学历史),PA202032(百科),PA202031(英文儿歌)',
- 'description' => '选品池ID 可选:MC201132(民族中国风),MC201136(流行音乐),MC201139(甜蜜爱情),MC201133(民谣),MC201137(放松阅读),MC201138(快乐),PA202029(故事),PA202030(儿歌),PA202028(国学历史),PA202032(百科),PA202031(英文儿歌)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MC201132',
- ],
- ],
- [
- 'name' => 'ScgFilter',
+ 'name' => 'Date',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '查询filter',
- 'description' => '查询filter',
- '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' => '是否使用pageParam对象分页,offSetParam和pageParam二选一,默认分页模式为pageParam',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'OffSetParam' => [
- 'title' => '分页类型',
- 'description' => '分页类型',
- 'type' => 'object',
- 'properties' => [
- 'Offset' => [
- 'title' => '跳过的条目数量',
- 'description' => '跳过的条目数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'Limit' => [
- 'title' => '返回的条目数量',
- 'description' => '返回的条目数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- 'required' => false,
- ],
- 'PageParam' => [
- 'title' => '分页类型',
- 'description' => '分页类型',
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'title' => '每页记录条数',
- 'description' => '每页记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'PageNum' => [
- 'title' => '页数',
- 'description' => '页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => '日期,格式yyyy-MM-dd,按照数据产出的业务日期,不是数据产生的日期,生产数据的日期都是T+1的。', 'type' => 'string', 'required' => false, 'example' => '2024-11-09'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'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',
- ],
+ 'Code' => ['description' => '状态码,正常返回200', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '返回的内容数据',
- 'description' => '返回的详细信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回的内容数据',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'title' => '内容来源',
- 'description' => '内容来源',
- 'type' => 'string',
- 'example' => 'xiami',
- ],
- 'Title' => [
- 'title' => '内容标题',
- 'description' => '内容标题',
- 'type' => 'string',
- 'example' => '那个人',
- ],
- 'Type' => [
- 'title' => '内容类型',
- 'description' => '内容类型',
- 'type' => 'string',
- 'example' => 'music',
- ],
- 'Cover' => [
- 'title' => '内容封面',
- 'description' => '内容封面',
- 'type' => 'object',
- 'properties' => [
- 'Img' => [
- 'title' => '封面图片',
- 'description' => '封面图片(Img与Large,Medium,Small可能不会同时出现,会出现只有其中一种的情况)',
- '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' => '是否支持试听'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ContentType' => [
- 'title' => '内容类型',
- 'description' => '内容类型',
- 'type' => 'string',
- 'example' => 'MUSIC_CONTENT',
- ],
- 'Singers' => [
- 'title' => '歌手名',
- 'description' => '歌手名',
- 'type' => 'string',
- 'example' => '黎偌天',
- ],
- 'AlbumRawId' => [
- 'title' => '专辑ID',
- 'description' => '专辑ID',
- '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' => '作者ID'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '作者ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1795716629',
- ],
- ],
- 'IsAudition' => [
- 'title' => '能否试听',
- 'description' => '能否试听',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'AuthorNames' => [
- 'title' => '作者姓名',
- 'description' => '作者姓名',
- 'type' => 'array',
- 'items' => [
- 'description' => '作者姓名',
- 'type' => 'string',
- 'example' => '"王一鸣Iris", "黎偌天", "薛晨雨"',
- ],
- ],
- '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' => '三方内容ID',
- 'type' => 'string',
- 'example' => '1795716629',
- ],
- ],
+ 'description' => '服务的实际返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'OssUrl' => ['description' => 'Oss对象地址 有效时间10分钟', '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'],
],
- 'example' => '{"sourceId":0,"copyright":0,"releaseTime":1196438400000,"hotScore":0.9546929544543479,"tppExtendInfo":"{\\"userEvent\\":\\"前台投放\\",\\"scgTopicName\\":\\"inside民族中国风曲风音乐库\\",\\"scgTopicId\\":\\"MC201132\\"}","source":"xiami","title":"题帕三绝","type":"music","x1Pv30d":10307,"valid":10,"cover":{"img":"http://img.xiami.net/qianxun/07d8ec1a38a5462c3afbfac41413b8af/47244c25fcf3a8f67442d02e3127d023-500x432.jpg","canResize":false},"duration":0,"rawId":"1771626071","albumType":0,"alias":["题帕三绝"],"id":268033175,"supportAudition":false,"contentType":"MUSIC_CONTENT","authorIds":[],"singers":"陈力","albumRawId":"1771626071","album":false,"x1PvTotal":14676,"commCateId":80021001,"finished":0,"isAudition":false,"appIds":[],"authorNames":["陈力","王立平","曹雪芹"],"needCharge":false,"isCharge":false,"category":"audio"}',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
],
+ 'Message' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"xiami\\",\\n \\"Title\\": \\"那个人\\",\\n \\"Type\\": \\"music\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"canResize\\": false,\\n \\"Large\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Medium\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Small\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\"\\n },\\n \\"Alias\\": [\\n \\"那个人\\"\\n ],\\n \\"SupportAudition\\": false,\\n \\"ContentType\\": \\"MUSIC_CONTENT\\",\\n \\"Singers\\": \\"黎偌天\\",\\n \\"AlbumRawId\\": \\"1795716629\\",\\n \\"Album\\": false,\\n \\"AlbumType\\": 0,\\n \\"AuthorIds\\": [\\n 1795716629\\n ],\\n \\"IsAudition\\": false,\\n \\"AuthorNames\\": [\\n \\"\\\\\\"王一鸣Iris\\\\\\", \\\\\\"黎偌天\\\\\\", \\\\\\"薛晨雨\\\\\\"\\"\\n ],\\n \\"NeedCharge\\": false,\\n \\"IsCharge\\": \\"false\\",\\n \\"Category\\": \\"audio\\",\\n \\"RawId\\": \\"1795716629\\"\\n }\\n ],\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ScgSearchResponse>\\n <PageNum>1</PageNum>\\n <Message>OK</Message>\\n <PageSize>10</PageSize>\\n <Result>\\n <Source>xiami</Source>\\n <Title>那个人</Title>\\n <Type>music</Type>\\n <Cover>\\n <Img>http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg</Img>\\n <canResize>false</canResize>\\n </Cover>\\n <Alias>那个人</Alias>\\n <SupportAudition>false</SupportAudition>\\n <ContentType>MUSIC_CONTENT</ContentType>\\n <Singers>黎偌天</Singers>\\n <AlbumRawId>1795716629</AlbumRawId>\\n <Album>false</Album>\\n <AlbumType>0</AlbumType>\\n <AuthorIds>1795716629</AuthorIds>\\n <IsAudition>false</IsAudition>\\n <AuthorNames>\\"王一鸣Iris\\", \\"黎偌天\\", \\"薛晨雨\\"</AuthorNames>\\n <NeedCharge>false</NeedCharge>\\n <IsCharge>false</IsCharge>\\n <Category>audio</Category>\\n <RawId>1795716629</RawId>\\n </Result>\\n <RequestId>73C67BD9-175A-1324-8202-9FAABBB3E6FA</RequestId>\\n <Code>200</Code>\\n</ScgSearchResponse>","errorExample":""}]',
- 'title' => '根据选品池ID查询选品池内容',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OssUrl\\": \\"http://jiangsu-telecom.oss-cn-zhangjiakou.aliyuncs.com/jiangsuTelecom/jiangsu_telecom_2024-11-06_data.xls?Expires=1731056700&OSSAccessKeyId=STS.NUqZx6e1HjWYHhYwyDqbRNySp&Signature=wqMK%2Bspo08cg7xDIrzJdgFpZT3U%3D&security-token=CAIS6wJ1q6Ft5B2yfSjIr5bEEcKCiO5p3ZWySk7ok3kRfe1%2Bobz4kjz2IHhMeXJsBuketv42nmxV7%2FoblrN0UIQAT1HPbsZsq84Pq1%2F4O9GY%2FpXrseBZ08VJ18si00SpsvXJasDVEfn%2FGJ70GX2m%2BwZ3xbzlD0bAO3WuLZyOj7N%2Bc90TRXPWRDFaBdBQVGAAwY1gQhm3D%2Fu2NQPwiWf9FVdhvhEG6Vly8qOi2MaRmHG85R%2FYsrZL%2B9uuc8b5P5A0Y8wlAo6PsbYoJvab4kl58ANX8ap6tqtA9Arcs8uVa1sruE3ebrGIrYQ3dFUgPPRnQvIdtrP1nvt5%2FOXS0p%2Fs01NHNOpWXiLTAoe7247OBeiqO8p%2FKeyjZGQuOTooxiRr2elNRQX4VGsiE7JJQhf7CU293KO0YeZxdAR%2FoOMPnzRBdA2yRaA0rjOmtJPBTFOEIL7ymXpDY8bnsxtwDRYu1%2BXrCqUee2Ik3j4vnOf9Je0agAEDuPfR8GLB8uVv4ZCGRRAM5mV3gKCxl07flVk1UPsxMZWBeVwwALT34lxk4x6ivWA7ZXjXdMmIapup%2FEb6UU%2BWhJH1G4sevkw5%2BGb8h8aRjJHBoxB4YLXNTEb5Rk6sVv%2BoCfkljy3%2FWImWGIMigurkAfOIBgUSql8JgFTxQrOHbiAA\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"26C9C3D0-160D-5CDE-BF7A-B3C8D14AA949\\"\\n}","type":"json"}]',
+ 'title' => '获取江苏电信号百的数据',
],
- 'AddAndRemoveFavoriteContent' => [
- 'summary' => '收藏或取消收藏。',
- 'path' => '/v1.0/ssp/AddAndRemoveFavoriteContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetScheduleTask' => [
+ 'summary' => '获取定时任务信息。',
+ 'path' => '/v1.0/ssp/GetScheduleTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'OpenAddAndRemoveFavoriteContentRequest',
+ 'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '业务参数',
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'PackageType' => [
- 'description' => '内容类型'."\n"
- ."\n"
- .'内容:CONTENT;专辑:ALBUM;歌单:COLLECT。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CONTENT',
- ],
- 'OpenSourceRawIdPair' => [
- 'description' => '收藏/取消对象',
- 'type' => 'object',
- 'properties' => [
- 'RawId' => [
- 'description' => '三方id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2105818057',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xiami',
- ],
- 'ExtendInfo' => [
- 'description' => '扩展信息',
- 'type' => 'object',
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
- 'FavoriteCmd' => [
- 'description' => '操作类型'."\n"
- ."\n"
- .'收藏:ADD;取消收藏:REMOVE',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ADD',
- ],
+ 'Id' => ['title' => '待查询的调度id', 'description' => '待查询的任务id', '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' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
+ 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。` UNION_ID:` 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '用户Id的类型-OPENID:默认的用户ID标识-UNIONID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGENAME:apk包名,Android应用客户链路的编码类型-SKILLID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的SkillID;编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
+ 'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '设备Id的类型-OPENID:默认的设备ID标识-UNIONID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGENAME:apk包名,Android应用客户链路的编码类型-SKILLID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的SkillID;编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -5049,265 +3676,141 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'AmpResult<ScheduleOpenResponse>',
+ 'description' => 'AmpResult<ScheduleOpenResponse>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '错误码', 'description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '响应信息', 'type' => 'string', 'example' => '调用成功'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'F7E21065-6C21-1158-A2F9-AEFE5CAB7C94'],
'Result' => [
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '121212121',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
+ 'title' => '服务响应出参',
+ 'description' => '服务响应出参',
+ 'type' => 'object',
+ 'properties' => [
+ 'ScheduleId' => ['title' => '调度id', 'description' => '任务id', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'],
+ 'ScheduleType' => [
+ 'title' => '调度类型',
+ 'description' => '调度类型',
+ 'type' => 'string',
+ 'example' => 'ONCE',
+ 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_DAY'],
+ ],
+ 'Cron' => ['title' => '触发cron表达式', 'description' => '触发cron表达式', '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 \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"121212121\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAndRemoveFavoriteContentResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>121212121</RequestId>\\n <Success>true</Success>\\n</AddAndRemoveFavoriteContentResponse>","errorExample":""}]',
- 'title' => '收藏或取消收藏',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"RequestId\\": \\"F7E21065-6C21-1158-A2F9-AEFE5CAB7C94\\",\\n \\"Result\\": {\\n \\"ScheduleId\\": 1234567,\\n \\"ScheduleType\\": \\"ONCE\\",\\n \\"Cron\\": \\"0 10 20 30 6 ? 2022\\",\\n \\"ScheduleStartTime\\": \\"1656577473000\\",\\n \\"ScheduleEndTime\\": \\"1659169473000\\",\\n \\"ActionTopicList\\": [\\n {\\n \\"CustomAction\\": {\\n \\"k1\\": \\"v1\\",\\n \\"k2\\": {\\n \\"key\\": 1\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <RequestId>F7E21065-6C21-1158-A2F9-AEFE5CAB7C94</RequestId>\\n <Result>\\n <Uuid>362*****8C1</Uuid>\\n <ScheduleId>1234567</ScheduleId>\\n <ScheduleType>ONCE</ScheduleType>\\n <Cron>0 10 20 30 6 ? 2022</Cron>\\n <ScheduleStartTime>1656577473000</ScheduleStartTime>\\n <ScheduleEndTime>1659169473000</ScheduleEndTime>\\n <ActionTopicList/>\\n </Result>\\n</GetScheduleTaskResponse>","errorExample":""}]',
+ 'title' => '获取定时任务信息',
+ 'description' => '根据定时任务id,查询指定定时任务数据详情',
+ 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
],
- 'CreatePlayingList' => [
- 'summary' => '创建播放列表并播放指定的内容。',
- 'path' => '/v1.0/ssp/CreatePlayingList',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetUnreadMessageCount' => [
+ 'summary' => '查询用户的未读留言条数。',
+ 'path' => '/v1.0/ssp/getUnreadMessageCount',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'OpenCreatePlayingListRequest',
- 'in' => 'formData',
+ 'name' => 'UserInfo',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '业务参数',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'PlayFrom' => [
- 'description' => '播放来源,配置播控能力的唯一标识'."\n"
- ."\n"
- .'可空,默认为default',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- 'ContentType' => [
- 'description' => '播放内容类型'."\n"
- ."\n"
- .'内容:content;专辑:album;歌单:collect',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'content',
- ],
- 'ContentList' => [
- 'description' => '播放内容列表'."\n"
- ."\n"
- .'若是内容,支持多个;若是专辑,只有第一个有效。',
- 'type' => 'array',
- 'items' => [
- 'description' => '播放对象',
- 'type' => 'object',
- 'properties' => [
- 'RawId' => [
- 'description' => '三方id'."\n"
- ."\n"
- .'如果是内容则是内容id;如果是专辑则是专辑id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xiami',
- ],
- ],
- 'required' => true,
- ],
- 'required' => true,
- ],
- 'Index' => [
- 'description' => '播放的index'."\n"
- ."\n"
- .'可空。默认为0,表示从头播放',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'NeedAlbumContinued' => [
- 'description' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'PlayMode' => [
- 'description' => '播放模式'."\n"
- ."\n"
- .'列表循环:Repeat;随机:Shuffle;单曲循环:RepeatOne;顺序播放:Normal。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Repeat',
- ],
- 'ExtendInfo' => [
- 'description' => '扩展信息',
- 'type' => 'object',
- 'required' => false,
- ],
+ 'EncodeType' => ['description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGENAME:apk包名,Android应用客户链路的编码类型 - SKILLID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'EncodeKey' => ['description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'IdType' => ['description' => '用户Id的类型 - OPENID:默认的用户ID标识 - UNIONID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
- 'required' => true,
+ 'required' => false,
],
],
- [
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '用户标识信息',
+ 'title' => 'Schema of Response',
+ 'description' => '服务返回结果',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME:`apk包名,Android应用客户链路的编码类型。'."\n"
- .'`SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。'."\n"
- .'编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'Message' => ['title' => 'Id of the request', 'description' => '错误信息', 'type' => 'string', 'example' => '用户信息不存在'],
+ 'Code' => ['description' => '服务返回的状态码', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Result' => ['description' => '未读留言条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
- 'required' => true,
],
],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"用户信息不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": 10\\n}","errorExample":""},{"type":"xml","example":"<GetUnreadMessageCountResponse>\\n <Message>用户信息不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>10</Result>\\n</GetUnreadMessageCountResponse>","errorExample":""}]',
+ 'title' => '查询未读留言条数',
+ ],
+ 'GetUserByDeviceId' => [
+ 'summary' => '根据设备openID,获取设备绑定用户ID。',
+ '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' => [
- 'description' => '设备标识信息',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息列表。',
'type' => 'object',
'properties' => [
'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。'."\n"
- .'`SKILL_ID`:技能ID,云端链路的编码类型。',
+ 'title' => '编码类型,此处填写“PROJECT_ID”',
+ 'description' => '编码类型,此处填写**PROJECT_ID**。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- 'enum' => [],
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
'IdType' => [
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。'."\n"
- .'`UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'UNION_ID',
- 'OPEN_ID',
- ],
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,配置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -5316,709 +3819,209 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenServiceResult<OpenPlayingItem>',
- 'description' => 'OpenServiceResult<OpenPlayingItem>',
+ 'title' => '返回数据体',
+ 'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '调用返回码',
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '服务的实际返回结果',
- 'description' => '服务的实际返回结果',
+ 'title' => '用户open信息',
+ 'description' => '返回的用户信息列表。',
'type' => 'object',
'properties' => [
- 'RawId' => [
- 'title' => '三方id',
- 'description' => '三方id',
- 'type' => 'string',
- 'example' => '550144364',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'ximalayav2',
- ],
- 'AlbumRawId' => [
- 'title' => '三方专辑id',
- 'description' => '三方专辑id',
- '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' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'UserOpenId' => ['title' => '用户信息对应的openId', 'description' => '用户信息对应的openId。', 'type' => 'string', 'example' => '0963*0158'],
+ 'UserUnionIds' => [
+ 'title' => '组织id及归一id列表',
+ 'description' => '用户的组织ID及UnionID列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '信息列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrganizationId' => ['title' => '组织id', 'description' => '组织ID。', 'type' => 'string', 'example' => '1**2'],
+ 'UserUnionId' => ['title' => '组织id对应的归一id', 'description' => '用户的UnionID。', 'type' => 'string', 'example' => '1553*B0C3'],
],
],
],
- 'PlayMode' => [
- 'title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- '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' => '歌词url',
- 'type' => 'string',
- 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
- ],
- 'Copyright' => [
- 'title' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Type' => [
- 'description' => 'type (music\\program\\joke\\news\\children_song\\radio等)',
- 'type' => 'string',
- 'example' => 'story',
- ],
- 'ItemUrl' => [
- 'description' => '播放url',
- 'type' => 'string',
- 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
- ],
- 'DefaultPlayOrder' => [
- 'description' => 'package 默认播放顺序 0 顺序,1 倒序',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Valid' => [
- 'description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Pos' => [
- 'description' => '该项在播放列表中的位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
'example' => 'true',
],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <LyricUrl>https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc</LyricUrl>\\n <Copyright>0</Copyright>\\n <Type>story</Type>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</CreatePlayingListResponse>","errorExample":""}]',
- 'title' => '播放列表创建',
- ],
- 'GetAlbum' => [
- 'summary' => '按照特定的id获取专辑信息。',
- 'path' => '/v1.0/ssp/GetAlbum',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.GetUserByDeviceId.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"UserOpenId\\": \\"0963*0158\\",\\n \\"UserUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"UserUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<GetUserByDeviceIdResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <UserOpenId>0963*0158</UserOpenId>\\n <UserUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <UserUnionId>1553*B0C3</UserUnionId>\\n </UserUnionIds>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</GetUserByDeviceIdResponse>","errorExample":""}]',
+ 'title' => '获取设备绑定的用户ID',
+ ],
+ 'GetWeather' => [
+ 'summary' => '查询天气。',
+ 'path' => '/v1.0/ssp/GetWeather',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'query',
- 'schema' => [
- 'description' => '专辑id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12343',
- ],
- ],
- [
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'description' => '默认值song',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'song',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
+ 'name' => 'Payload',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求requestId',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
- 'Code' => [
- 'description' => 'code编码',
- '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' => '作者主键id',
- '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' => '根据所属公共类目转换controlType',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Charge' => [
- 'description' => '是否收费',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CommCateId' => [
- 'description' => '对应的类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80012017',
- ],
- 'Cover' => [
- 'description' => '专辑封面图片',
- 'type' => 'object',
- 'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- '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' => '专辑id',
- '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' => '根据所属公共类目转换favoriteType',
- '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' => '三方id',
- 'type' => 'string',
- 'example' => '23242',
- ],
- ],
- ],
+ '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,
],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 13123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qignting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Finished\\": \\"FINISHED\\",\\n \\"TotalEpisode\\": 12,\\n \\"RawId\\": \\"23242\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAlbumResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>13123</Id>\\n <Online>false</Online>\\n <Source>qignting</Source>\\n <Title>超能狂少在都市</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>1231231</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qignting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <Finished>FINISHED</Finished>\\n <TotalEpisode>12</TotalEpisode>\\n <RawId>23242</RawId>\\n </Result>\\n</GetAlbumResponse>","errorExample":""}]',
- 'title' => '按照特定的id获取专辑信息',
- ],
- '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',
+ 'name' => 'UserInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '内容id',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
'required' => true,
- 'example' => '123123',
],
],
[
- 'name' => 'Type',
- 'in' => 'query',
+ 'name' => 'DeviceInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '默认值song',
- 'type' => 'string',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => false, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
'required' => true,
- 'example' => 'song',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'AmpResult<WeatherResponse>',
+ 'description' => 'AmpResult<WeatherResponse>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求RequestId',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '调用成功'],
+ 'Code' => ['title' => 'HttpCode', 'description' => 'HttpCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '返回结果',
+ 'title' => '模型数据',
+ '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' => '作者主键id',
- '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' => '根据所属公共类目转换controlType',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Charge' => [
- 'description' => '是否收费',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CommCateId' => [
- 'description' => '对应的类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80012017',
- ],
- 'Cover' => [
- 'description' => '专辑封面图片',
+ 'CurrentMeteorology' => [
+ 'title' => '当前天气',
+ 'description' => '当前天气',
'type' => 'object',
'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- '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',
+ 'Weather' => [
+ 'title' => '白天天气',
+ 'description' => '白天天气',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '天气编号: 形如:"000,100"', 'description' => '天气编号: 形如:"000,100"', 'type' => 'string', 'example' => '000'],
+ 'Name' => ['title' => '天气名称描述: "晴(000),多云(100)"', 'description' => '天气名称描述: "晴(000), 多云(100), 阴(101), 雨(200), 小雨(201), 小到中雨(202), 中雨(203), 中到大雨(204), 大雨(205), 大到暴雨(206), 暴雨(207), 大暴雨(209), 特大暴雨(211), 阵雨(212), 雷阵雨(213), 冻雨(214), 雪(300), 雨夹雪(301), 阵雪(302), 小雪(303), 小到中雪(304), 中雪(305), 大雪(307), 暴雪(309), 雾(400), 浮尘(501), 扬沙(502), 沙尘暴(503), 强沙尘暴(504), 大部晴朗(000), 少云(100), 小阵雨(212), 雷电(213), 冰粒(214), 雷阵雨伴有冰雹(215), 小阵雪(302), 冻雾(400), 霾(500), 尘卷风(502), 局部阵雨(212), 雷暴(213), 冰针(214), 冰雹(215), 强阵雨(212)"', 'type' => 'string', 'example' => '晴'],
+ ],
],
- 'Small' => [
- 'description' => '小图',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
+ 'Temperature' => [
+ 'title' => '温度',
+ 'description' => '温度',
+ 'type' => 'object',
+ 'properties' => [
+ 'Current' => ['title' => '当前温度气温值', 'description' => '当前温度气温值', 'type' => 'string', 'example' => '36'],
+ 'CurrentDesc' => ['title' => '当前温度气温值描述', 'description' => '当前温度气温值描述', 'type' => 'string', 'example' => '36度'],
+ 'High' => ['title' => '气温最高值', 'description' => '气温最高值', 'type' => 'string', 'example' => '37'],
+ 'HighDesc' => ['title' => '气温最高值描述', 'description' => '气温最高值描述', 'type' => 'string', 'example' => '37度'],
+ 'Low' => ['title' => '气温最低值', 'description' => '气温最低值', 'type' => 'string', 'example' => '28'],
+ 'LowDesc' => ['title' => '气温最低值描述', 'description' => '气温最低值描述', 'type' => 'string', 'example' => '28度'],
+ 'Logical' => ['title' => '带有逻辑的温度,逻辑如下:', 'description' => '带有逻辑的温度,逻辑如下:', 'type' => 'string', 'example' => '41'],
+ ],
],
],
],
- 'Description' => [
- 'description' => '内容描述',
- 'type' => 'string',
- 'example' => '内容描述',
- ],
- 'HotScore' => [
- 'description' => '热度分',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '内容描述',
- ],
- 'Id' => [
- 'description' => '内容id',
- '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' => '根据所属公共类目转换favoriteType',
- 'type' => 'string',
- 'example' => 'program',
- ],
- 'Valid' => [
- 'description' => '是否可播',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Duration' => [
- 'description' => '时长信息',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '180',
- ],
- 'AlbumId' => [
- 'description' => '对应的专辑id',
- 'type' => 'string',
- 'example' => '1231',
- ],
- 'Lyric' => [
- 'description' => '歌词信息',
- 'type' => 'string',
- 'example' => 'http://1231.lrc',
- ],
- 'Styles' => [
- 'description' => '曲风',
- 'type' => 'array',
- 'items' => [
- 'description' => '曲风',
- 'type' => 'string',
- 'example' => '1312',
- ],
- ],
- 'RawId' => [
- 'description' => '内容的三方id',
- 'type' => 'string',
- 'example' => '1231231',
- ],
],
],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'F7E2****B7C94'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 123123,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 0,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"1231\\",\\n \\"Lyric\\": \\"http://1231.lrc\\",\\n \\"Styles\\": [\\n \\"1312\\"\\n ],\\n \\"RawId\\": \\"1231231\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>123123</Id>\\n <Online>false</Online>\\n <Source>qingting</Source>\\n <Title>播音呆瓜小贼</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <Duration>180</Duration>\\n <AlbumId>1231</AlbumId>\\n <Lyric>http://1231.lrc</Lyric>\\n <Styles>1312</Styles>\\n <RawId>1231231</RawId>\\n </Result>\\n</GetContentResponse>","errorExample":""}]',
- 'title' => ' 按照特定的id获取内容信息',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"调用成功\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"CurrentMeteorology\\": {\\n \\"Weather\\": {\\n \\"Code\\": \\"000\\",\\n \\"Name\\": \\"晴\\"\\n },\\n \\"Temperature\\": {\\n \\"Current\\": \\"36\\",\\n \\"CurrentDesc\\": \\"36度\\",\\n \\"High\\": \\"37\\",\\n \\"HighDesc\\": \\"37度\\",\\n \\"Low\\": \\"28\\",\\n \\"LowDesc\\": \\"28度\\",\\n \\"Logical\\": \\"41\\"\\n }\\n }\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<GetWeatherResponse>\\n <Message>调用成功</Message>\\n <Code>200</Code>\\n <Result>\\n <CurrentMeteorology>\\n <Weather>\\n <Code>000</Code>\\n <Name>晴</Name>\\n </Weather>\\n <Temperature>\\n <Current>36</Current>\\n <CurrentDesc>36度</CurrentDesc>\\n <High>37</High>\\n <HighDesc>37度</HighDesc>\\n <Low>28</Low>\\n <LowDesc>28度</LowDesc>\\n <Logical>41</Logical>\\n </Temperature>\\n </CurrentMeteorology>\\n </Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</GetWeatherResponse>","errorExample":""}]',
+ 'title' => '查询天气',
+ 'description' => '根据系统参数获取到的设备信息,查询设备所在地的天气数据',
+ 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
],
- 'GetCurrentPlayingItem' => [
- 'summary' => '获取当前播放项。',
- 'path' => '/v1.0/ssp/GetCurrentPlayingItem',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'IndexControlPlayingList' => [
+ 'summary' => '播放列表点击播放。',
+ 'path' => '/v1.0/ssp/IndexControlPlayingList',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
+ 'name' => 'OpenIndexControlRequest',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '业务参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => ['description' => '需要播放的index', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'],
+ 'NeedContentContinued' => ['description' => '内容是否续播。默认是false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'ExtendInfo' => ['description' => '扩展信息', 'type' => 'object', 'required' => false],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
@@ -6026,42 +4029,17 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。` UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -6071,46 +4049,19 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -6123,313 +4074,90 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'RawId' => [
- 'description' => '三方id',
- 'type' => 'string',
- 'example' => '550144364',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'ximalayav2',
- ],
- 'AlbumRawId' => [
- 'description' => '三方专辑id',
- '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' => '足球鞋赛车 晚安妈妈',
- ],
+ 'RawId' => ['description' => '三方id', 'type' => 'string', 'example' => '550144364'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'ximalayav2'],
+ 'AlbumRawId' => ['description' => '三方专辑id', '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' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ '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' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'PlayMode' => [
- 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- 'type' => 'string',
- 'example' => 'Repeat',
- ],
- 'AudioLength' => [
- 'description' => '长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '190',
- ],
- 'Progress' => [
- 'description' => '歌曲播放进度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'LyricUrl' => [
- 'description' => '歌词url',
- 'type' => 'string',
- 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
- ],
- 'Copyright' => [
- 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Type' => [
- 'description' => 'type (music\\program\\joke\\news\\children_song\\radio等)',
- 'type' => 'string',
- 'example' => 'story',
- ],
- 'ItemUrl' => [
- 'description' => '播放url',
- 'type' => 'string',
- 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
- ],
- 'DefaultPlayOrder' => [
- 'description' => 'package 默认播放顺序 0 顺序,1 倒序',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Valid' => [
- 'description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Pos' => [
- 'description' => '该项在播放列表中的位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'PlayMode' => ['description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Repeat'],
+ 'AudioLength' => ['description' => '长度', 'type' => 'integer', 'format' => 'int32', 'example' => '190'],
+ 'Progress' => ['description' => '歌曲播放进度', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'LyricUrl' => ['description' => '歌词url', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'],
+ 'Type' => ['description' => 'type (music\\program\\joke\\news\\children_song\\radio等)', 'type' => 'string', 'example' => 'story'],
+ 'Copyright' => ['description' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ItemUrl' => ['description' => '播放url', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3'],
+ 'DefaultPlayOrder' => ['description' => 'package 默认播放顺序 0 顺序,1 倒序', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Valid' => ['description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID'],
+ 'Pos' => ['description' => '该项在播放列表中的位置', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": \\"false\\",\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"story\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCurrentPlayingItemResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Copyright>0</Copyright>\\n <Type>story</Type>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</GetCurrentPlayingItemResponse>","errorExample":""}]',
- 'title' => '获取当前播放项',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<IndexControlPlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</IndexControlPlayingListResponse>","errorExample":""}]',
+ 'title' => '播放列表点击播放',
],
- 'GetCurrentPlayingList' => [
- 'summary' => '获取当前播放列表。',
- 'path' => '/v1.0/ssp/GetCurrentPlayingList',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'InvalidateThirdPartyAppLoginState' => [
+ 'summary' => '当发生非设备端的用户操作会导致设备端的三方应用登录态失效(比如用户在新设备上登录相同账号导致老设备登录态失效,或用户修改密码导致老设备登录态失效等),三方需要调用该接口通知天猫精灵。',
+ 'path' => '/v1.0/ssp/invalidateThirdPartyAppLoginState',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OpenQueryPlayListRequest',
+ 'name' => 'DeviceInfo',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '业务参数',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'PageNum' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '15',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ou***lk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'IdType' => ['title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'description' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'EncodeType' => ['title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型', 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => 'com.*.*.*'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
],
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '用户标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'DeviceInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '设备标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => true,
- ],
+ 'name' => 'ThirdPartyAppId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '三方应用标识', 'description' => '三方应用标识', 'type' => 'string', 'required' => true, 'example' => 'com.*.*.*'],
],
],
'responses' => [
@@ -6439,315 +4167,114 @@
'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' => '三方id',
- 'type' => 'string',
- 'example' => '550144364',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'ximalayav2',
- ],
- 'AlbumRawId' => [
- 'description' => '三方专辑id',
- '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' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- 'PlayMode' => [
- 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'AudioLength' => [
- 'description' => '长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '190',
- ],
- 'Progress' => [
- 'description' => '歌曲播放进度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'LyricUrl' => [
- 'description' => '歌词url',
- 'type' => 'string',
- 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
- ],
- 'Type' => [
- 'description' => 'type (music\\program\\joke\\news\\children_song\\radio等)',
- 'type' => 'string',
- 'example' => 'story',
- ],
- 'Copyright' => [
- 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ItemUrl' => [
- 'description' => '播放url',
- 'type' => 'string',
- 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
- ],
- 'DefaultPlayOrder' => [
- 'description' => 'package 默认播放顺序 0 顺序,1 倒序',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Valid' => [
- 'description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Pos' => [
- 'description' => '该项在播放列表中的位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ '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'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Normal\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCurrentPlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Normal</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</GetCurrentPlayingListResponse>","errorExample":""}]',
- 'title' => '获取当前播放列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAFCD152-4791-5F2F-B0BE-2DC06FD4F05B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '失效三方应用登录态',
+ 'description' => '> 修改消息通知模板'."\n"
+ .'> - 需要查询出模板的templateId 根据templateId然后修改其他参数',
],
- 'IndexControlPlayingList' => [
- 'summary' => '播放列表点击播放。',
- 'path' => '/v1.0/ssp/IndexControlPlayingList',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAlarms' => [
+ 'summary' => '查询设备某一个用户的闹钟列表,分页查询。',
+ 'path' => '/v1.0/ssp/listAlarm',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'OpenIndexControlRequest',
+ 'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '业务参数',
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'Index' => [
- 'description' => '需要播放的index',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '0',
- ],
- 'NeedContentContinued' => [
- 'description' => '内容是否续播。默认是false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'ExtendInfo' => [
- 'description' => '扩展信息',
- 'type' => 'object',
- 'required' => false,
- ],
+ 'CurrentPage' => ['title' => '当前页', 'description' => '当前页', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '每页条数', 'description' => '每页条数 :最大值100', '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' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
+ 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。` UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -6756,226 +4283,140 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'AmpResult',
+ 'description' => 'AmpResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => '闹钟服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '设备账号未关联'],
'Result' => [
- 'description' => '服务的实际返回结果',
+ 'description' => '闹钟列表结果集合',
'type' => 'object',
'properties' => [
- 'RawId' => [
- 'description' => '三方id',
- 'type' => 'string',
- 'example' => '550144364',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'ximalayav2',
- ],
- 'AlbumRawId' => [
- 'description' => '三方专辑id',
- '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' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'TotalCount' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageCount' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageSize' => ['title' => '每页条数', 'description' => '每页条数:最大100,超过100按100处理', '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' => '闹钟id', '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' => '调度类型/循环类型: ONCE -> 单次,WEEKLY -> 周循环,STATUTORYWORKINGDAY ->法定工作日',
+ 'type' => 'string',
+ 'example' => 'ONCE',
+ 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'],
+ ],
+ 'Once' => [
+ 'title' => '单次',
+ 'description' => '单次::循环类型为ONCE时,该属性可用',
+ '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' => '周循环:循环类型为WEEKLY时,该属性可用',
+ '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' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ ],
+ 'StatutoryWorkingDay' => [
+ 'title' => '法定工作日',
+ 'description' => '法定工作日:循环类型为STATUTORYWORKINGDAY时,该属性可用',
+ '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' => '铃声类别id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MusicTypeName' => ['title' => '音乐类别名称', 'description' => '铃声类别名称', 'type' => 'string', 'example' => 'xx音乐'],
+ 'MusicId' => ['title' => '音乐id', 'description' => '铃声id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MusicName' => ['title' => '音乐名称', 'description' => '铃声名称', 'type' => 'string', 'example' => 'xx铃声'],
+ 'MusicUrl' => ['title' => '音乐url', 'description' => '音乐url', 'type' => 'string', 'example' => 'http://xx'],
+ ],
+ ],
+ 'Volume' => ['title' => '音量', 'description' => '铃声音量,默认40', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
+ 'Status' => ['title' => '状态 0 正常 1 删除 2 关闭', 'description' => '状态 0 正常 1 删除 2 关闭', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
],
- 'PlayMode' => [
- 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- 'type' => 'string',
- 'example' => 'Repeat',
- ],
- 'AudioLength' => [
- 'description' => '长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '190',
- ],
- 'Progress' => [
- 'description' => '歌曲播放进度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'LyricUrl' => [
- 'description' => '歌词url',
- 'type' => 'string',
- 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
- ],
- 'Type' => [
- 'description' => 'type (music\\program\\joke\\news\\children_song\\radio等)',
- 'type' => 'string',
- 'example' => 'story',
- ],
- 'Copyright' => [
- 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ItemUrl' => [
- 'description' => '播放url',
- 'type' => 'string',
- 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
- ],
- 'DefaultPlayOrder' => [
- 'description' => 'package 默认播放顺序 0 顺序,1 倒序',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Valid' => [
- 'description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Pos' => [
- 'description' => '该项在播放列表中的位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
],
],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<IndexControlPlayingListResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</IndexControlPlayingListResponse>","errorExample":""}]',
- 'title' => '播放列表点击播放',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 1234321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<ListAlarmsResponse>\\n <Code>200</Code>\\n <Message>设备账号未关联</Message>\\n <Result>\\n <TotalCount>100</TotalCount>\\n <PageCount>10</PageCount>\\n <PageSize>10</PageSize>\\n <CurrentPage>1</CurrentPage>\\n <Model>\\n <AlarmId>1234567</AlarmId>\\n <UserId>1234321</UserId>\\n <Uuid>AF18***065EE4BD***68CEFD9***84D4</Uuid>\\n <ScheduleTypeDesc>单次</ScheduleTypeDesc>\\n <TriggerDateDesc>2022-07-29</TriggerDateDesc>\\n <TriggerTimeDesc>10:00</TriggerTimeDesc>\\n <ScheduleInfo>\\n <Type>ONCE</Type>\\n <Once>\\n <Year>2022</Year>\\n <Month>7</Month>\\n <Day>29</Day>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </Once>\\n <Weekly>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n <DaysOfWeek>1</DaysOfWeek>\\n </Weekly>\\n <StatutoryWorkingDay>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </StatutoryWorkingDay>\\n </ScheduleInfo>\\n <MusicInfo>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx音乐</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx铃声</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </MusicInfo>\\n <Volume>40</Volume>\\n <Status>0</Status>\\n </Model>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</ListAlarmsResponse>","errorExample":""}]',
+ 'title' => '查询闹钟列表',
+ 'responseParamsDescription' => '1.仅请求返回的状态码为200时为成功,否则均为失败'."\n"
+ .'2.分页返回参数与实际列表数不符合,这里仅为展示',
],
'ListAlbumDetail' => [
'summary' => '获取音乐音频专辑里面的内容列表。',
'path' => '/v1.0/ssp/ListAlbumDetail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
- 'schema' => [
- 'description' => '专辑id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '121321',
- ],
+ 'schema' => ['description' => '专辑id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '121321'],
],
[
'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
],
'responses' => [
@@ -6983,33 +4424,14 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
'Result' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'CurrentPageNum' => [
- 'description' => '当前页',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'CurrentPageNum' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'OpenDataItemList' => [
'description' => 'data信息',
'type' => 'array',
@@ -7020,17 +4442,9 @@
'Alias' => [
'description' => '别名',
'type' => 'array',
- 'items' => [
- 'description' => '别名',
- 'type' => 'string',
- 'example' => '超能狂少在都市',
- ],
- ],
- 'Audition' => [
- 'description' => '是否可试听',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'items' => ['description' => '别名', 'type' => 'string', 'example' => '超能狂少在都市'],
],
+ 'Audition' => ['description' => '是否可试听', 'type' => 'boolean', 'example' => 'false'],
'Authors' => [
'description' => '内容的作者',
'type' => 'array',
@@ -7041,171 +4455,51 @@
'AuthorTypes' => [
'description' => '作者类型',
'type' => 'array',
- 'items' => [
- 'description' => '作者类型',
- 'type' => 'string',
- 'example' => 'ANCHOR',
- ],
- ],
- 'Gender' => [
- 'description' => '性别',
- 'type' => 'string',
- 'example' => 'MALE',
- ],
- 'Id' => [
- 'description' => '作者主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12314',
- ],
- 'Online' => [
- 'description' => '是否在线',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
- 'Title' => [
- 'description' => '作者标题',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
+ 'items' => ['description' => '作者类型', 'type' => 'string', 'example' => 'ANCHOR'],
],
+ 'Gender' => ['description' => '性别', 'type' => 'string', 'example' => 'MALE'],
+ 'Id' => ['description' => '作者主键id', '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' => '根据所属公共类目转换controlType',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Charge' => [
- 'description' => '是否收费',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CommCateId' => [
- 'description' => '对应的类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80012017',
- ],
+ 'Category' => ['description' => '根据所属公共类目转换controlType', 'type' => 'string', 'example' => 'audio'],
+ 'Charge' => ['description' => '是否收费', 'type' => 'boolean', 'example' => 'false'],
+ 'CommCateId' => ['description' => '对应的类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017'],
'Cover' => [
'description' => '内容封面图片',
'type' => 'object',
'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Img' => [
- 'description' => '默认图片',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
- ],
- 'Large' => [
- 'description' => '大图',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
- ],
- 'Medium' => [
- 'description' => '中图',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
- ],
- 'Small' => [
- 'description' => '小图',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
- ],
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', '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' => '内容id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1231231',
- ],
- 'ItemType' => [
- 'description' => '内容的类型, 音乐 音频 电台 笑话等',
- 'type' => 'string',
- 'example' => 'ALBUM',
- ],
- 'OrderIndex' => [
- 'description' => 'orderIndex 顺序',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
+ 'Description' => ['description' => '内容描述', 'type' => 'string', 'example' => '内容描述'],
+ 'Duration' => ['description' => '时长', 'type' => 'integer', 'format' => 'int64', 'example' => '180'],
+ 'HotScore' => ['description' => '热度分', 'type' => 'number', 'format' => 'double', 'example' => '10'],
+ 'Id' => ['description' => '内容id', 'type' => 'integer', 'format' => 'int64', 'example' => '1231231'],
+ 'ItemType' => ['description' => '内容的类型, 音乐 音频 电台 笑话等', 'type' => 'string', 'example' => 'ALBUM'],
+ 'OrderIndex' => ['description' => 'orderIndex 顺序', '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' => '根据所属公共类目转换favoriteType',
- 'type' => 'string',
- 'example' => 'program',
- ],
- 'Valid' => [
- 'description' => '是否可播',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'RawId' => [
- 'description' => '三方id',
- 'type' => 'string',
- 'example' => '12323423',
+ 'items' => ['description' => '风格', 'type' => 'string', 'example' => '13131'],
],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '超能狂少在都市'],
+ 'Type' => ['description' => '根据所属公共类目转换favoriteType', 'type' => 'string', 'example' => 'program'],
+ 'Valid' => ['description' => '是否可播', 'type' => 'string', 'example' => 'VALID'],
+ 'RawId' => ['description' => '三方id', 'type' => 'string', 'example' => '12323423'],
],
],
],
- 'PageSize' => [
- 'description' => '页记录数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'TotalSize' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '21421',
- ],
+ 'PageSize' => ['description' => '页记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'TotalSize' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '21421'],
],
],
],
@@ -7215,27 +4509,121 @@
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"CurrentPageNum\\": 1,\\n \\"OpenDataItemList\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Gender\\": \\"MALE\\",\\n \\"Id\\": 12314,\\n \\"Online\\": false,\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"播音呆瓜小贼\\"\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"Duration\\": 180,\\n \\"HotScore\\": 10,\\n \\"Id\\": 1231231,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"OrderIndex\\": 1,\\n \\"Source\\": \\"qingting\\",\\n \\"Styles\\": [\\n \\"13131\\"\\n ],\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"12323423\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 21421\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAlbumDetailResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <CurrentPageNum>1</CurrentPageNum>\\n <OpenDataItemList>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Gender>MALE</Gender>\\n <Id>12314</Id>\\n <Online>false</Online>\\n <Source>qingting</Source>\\n <Title>播音呆瓜小贼</Title>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <Duration>180</Duration>\\n <HotScore>10</HotScore>\\n <Id>1231231</Id>\\n <ItemType>ALBUM</ItemType>\\n <OrderIndex>1</OrderIndex>\\n <Source>qingting</Source>\\n <Styles>13131</Styles>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <RawId>12323423</RawId>\\n </OpenDataItemList>\\n <PageSize>10</PageSize>\\n <TotalSize>21421</TotalSize>\\n </Result>\\n</ListAlbumDetailResponse>","errorExample":""}]',
'title' => '获取音乐音频专辑里面的内容列表',
],
+ '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' => '专辑idList',
+ 'type' => 'array',
+ 'items' => ['title' => '专辑ID', 'description' => '专辑ID', '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' => '请求ID', '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' => '专辑ID', 'type' => 'string', 'example' => '51999575'],
+ 'IsAdded' => ['title' => '是否被订阅', 'description' => '是否被订阅', 'type' => 'string', 'example' => 'false'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCC85E69-5DA6-197E-A8C1-8A1B19CF781B\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"AlbumId\\": \\"51999575\\",\\n \\"IsAdded\\": \\"false\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '专辑是否被订阅',
+ ],
'ListCateContent' => [
'summary' => '根据特定的类目,按照指定的排序顺序获取该类目下的内容。',
'path' => '/v1.0/ssp/ListCateContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -7247,49 +4635,18 @@
'description' => '请求参数',
'type' => 'object',
'properties' => [
- 'CateId' => [
- 'description' => '类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '80010',
- ],
- 'IsAlbum' => [
- 'description' => '是否查询专辑',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'false',
- ],
- 'SortBy' => [
- 'description' => '排序字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hot_score',
- ],
+ 'CateId' => ['description' => '类目id', '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',
+ '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,
],
@@ -7302,45 +4659,20 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -7353,45 +4685,20 @@
'description' => ' 设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -7404,45 +4711,16 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'sucess',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => 'message信息', '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',
- ],
+ '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' => 'data信息',
'type' => 'array',
@@ -7450,22 +4728,9 @@
'description' => 'data信息',
'type' => 'object',
'properties' => [
- 'id' => [
- 'description' => '主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '26152778',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '超能狂少在都市',
- ],
+ 'id' => ['description' => '主键id', 'type' => 'integer', 'format' => 'int64', 'example' => '26152778'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'qingting'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '超能狂少在都市'],
'Authors' => [
'description' => '作者信息',
'type' => 'array',
@@ -7473,186 +4738,60 @@
'description' => '作者信息',
'type' => 'object',
'properties' => [
- 'RawId' => [
- 'description' => '三方作者id',
- 'type' => 'string',
- 'example' => '123123',
- ],
- 'Gender' => [
- 'description' => '性别',
- 'type' => 'string',
- 'example' => 'MALE',
- ],
+ 'RawId' => ['description' => '三方作者id', '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',
+ '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' => '中图(Deprecated)',
- 'type' => 'string',
- 'example' => 'https://a.jpg',
- ],
- 'Medium' => [
- 'description' => '中图',
- 'type' => 'string',
- 'example' => 'https://a.jpg',
- ],
- 'Small' => [
- 'description' => '小图',
- 'type' => 'string',
- 'example' => 'https://a.jpg',
- ],
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Img' => ['description' => '默认图片', 'type' => 'string', 'example' => 'https://a.jpg'],
+ 'Large' => ['description' => '大图', 'type' => 'string', 'example' => 'https://a.jpg'],
+ 'Mediam' => ['description' => '中图(Deprecated)', 'type' => 'string', 'example' => 'https://a.jpg'],
+ 'Medium' => ['description' => '中图', 'type' => 'string', 'example' => 'https://a.jpg'],
+ 'Small' => ['description' => '小图', 'type' => 'string', 'example' => 'https://a.jpg'],
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'Id' => [
- 'description' => '作者信息主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13597709',
- ],
- 'Title' => [
- 'description' => '作者标题',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Description' => [
- 'description' => '作者描述',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Online' => [
- 'description' => '是否在线',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Id' => ['description' => '作者信息主键id', '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' => '根据所属公共类目转换controlType',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Type' => [
- 'description' => '根据所属公共类目转换favoriteType',
- 'type' => 'string',
- 'example' => 'program',
- ],
- 'HotScore' => [
- 'description' => '热度分',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0',
- ],
- 'Valid' => [
- 'description' => ' 是否可播',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
+ 'ItemType' => ['description' => ' 内容的类型, 音乐 音频 电台 笑话等', 'type' => 'string', 'example' => 'ALBUM'],
+ 'Category' => ['description' => '根据所属公共类目转换controlType', 'type' => 'string', 'example' => 'audio'],
+ 'Type' => ['description' => '根据所属公共类目转换favoriteType', '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' => '中图(Deprecated)',
- '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' => '是否可以使用oss规则裁剪',
- '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/2017020718275.jpg'],
+ 'Mediam' => ['description' => '中图(Deprecated)', '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' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'CommCateId' => [
- 'description' => '对应的类目id',
- 'type' => 'string',
- 'example' => '80012017',
- ],
+ 'CommCateId' => ['description' => '对应的类目id', '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' => '专辑三方id',
- 'type' => 'string',
- 'example' => '206775',
+ 'items' => ['description' => '别名', 'type' => 'string', 'example' => '超能狂少在都市'],
],
+ 'Charge' => ['description' => '是否收费', 'type' => 'boolean', 'example' => 'false'],
+ 'Audition' => ['description' => '是否可试听', 'type' => 'boolean', 'example' => 'true'],
+ 'Description' => ['description' => '内容描述', 'type' => 'string', 'example' => '作者:月不醉 简介:啥,假冒你男友?退役兵王回归都市后做了一名小保安,机缘巧合下却被冷艳女总拉去客串男友,从此之后,他与冷艳老总开始纠缠不清···拳打恶一代,脚踩高富帅,哥哥我专治各种不服。面对各类的阴谋阳谋,面对各种黑恶势力,且看哥如何称霸都市,踏上巅峰!'],
+ 'RawId' => ['description' => '专辑三方id', 'type' => 'string', 'example' => '206775'],
],
],
],
@@ -7668,24 +4807,15 @@
'ListCateInfo' => [
'summary' => '获取类目信息。',
'path' => '/v1.0/ssp/ListCateInfo',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
@@ -7693,13 +4823,7 @@
[
'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '默认值song(扩展字段目前仅支持song)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'song',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '默认值song(扩展字段目前仅支持song)', 'type' => 'string', 'required' => true, 'example' => 'song'],
],
],
'responses' => [
@@ -7709,48 +4833,21 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
'Result' => [
'description' => '返回参数',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'CateId' => [
- 'description' => '类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80064',
- ],
- 'CateName' => [
- 'description' => '类目名称',
- 'type' => 'string',
- 'example' => '时尚生活',
- ],
- 'ParentCateId' => [
- 'description' => '父类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
+ 'CateId' => ['description' => '类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80064'],
+ 'CateName' => ['description' => '类目名称', 'type' => 'string', 'example' => '时尚生活'],
+ 'ParentCateId' => ['description' => '父类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
- 'RequestId' => [
- 'description' => '请求requestId',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
+ 'RequestId' => ['description' => '请求requestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
],
],
],
@@ -7761,37 +4858,22 @@
'ListCommonCateFirstFloor' => [
'summary' => '获取音乐或音频的一级类目列表。',
'path' => '/v1.0/ssp/ListCommonCateFirstFloor',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '默认值song(扩展字段目前仅支持song)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'song',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '默认值song(扩展字段目前仅支持song)', 'type' => 'string', 'required' => true, 'example' => 'song'],
],
],
'responses' => [
@@ -7800,48 +4882,21 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求requestId',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求requestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
'Result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'CateId' => [
- 'description' => '类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80012',
- ],
- 'CateName' => [
- 'description' => '类目名称',
- 'type' => 'string',
- 'example' => '有声内容',
- ],
- 'ParentCateId' => [
- 'description' => '父类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
+ 'CateId' => ['description' => '类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80012'],
+ 'CateName' => ['description' => '类目名称', 'type' => 'string', 'example' => '有声内容'],
+ 'ParentCateId' => ['description' => '父类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
],
],
],
@@ -7852,37 +4907,22 @@
'ListCommonCateSecondFloor' => [
'summary' => '获取指定一级类目下面的二级类目列表。',
'path' => '/v1.0/ssp/ListCommonCateSecondFloor',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ParentCateId',
'in' => 'query',
- 'schema' => [
- 'description' => '父类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '80010',
- ],
+ 'schema' => ['description' => '父类目id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '80010'],
],
],
'responses' => [
@@ -7890,48 +4930,21 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求requestId',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['description' => '请求requestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'CateId' => [
- 'description' => '类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80018009',
- ],
- 'CateName' => [
- 'description' => '类目名称',
- 'type' => 'string',
- 'example' => '儿童笑话',
- ],
- 'ParentCateId' => [
- 'description' => '父类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80018',
- ],
+ 'CateId' => ['description' => '类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80018009'],
+ 'CateName' => ['description' => '类目名称', 'type' => 'string', 'example' => '儿童笑话'],
+ 'ParentCateId' => ['description' => '父类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80018'],
],
],
],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
],
],
],
@@ -7939,547 +4952,143 @@
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CateId\\": 80018009,\\n \\"CateName\\": \\"儿童笑话\\",\\n \\"ParentCateId\\": 80018\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListCommonCateSecondFloorResponse>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Code>200</Code>\\n <Result>\\n <CateId>80018009</CateId>\\n <CateName>儿童笑话</CateName>\\n <ParentCateId>80018</ParentCateId>\\n </Result>\\n <Message>success</Message>\\n</ListCommonCateSecondFloorResponse>","errorExample":""}]',
'title' => '获取指定一级类目下面的二级类目列表',
],
- 'ListPlayHistory' => [
- 'summary' => '获取历史播放接口。',
- 'path' => '/v1.0/ssp/ListPlayHistory',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDeviceBasicInfo' => [
+ 'summary' => '根据设备openID列表,批量获取设备基本信息。',
+ 'path' => '/v1.0/ssp/listDeviceBasicInfo',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Request',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '音乐music,有声书program,故事story,儿歌children_song,电台radio',
- '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',
+ 'name' => 'DeviceInfos',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '用户标识信息',
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息列表。',
'type' => 'object',
'properties' => [
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'DeviceInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '设备标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
+ 'title' => '编码类型,此处填写“PROJECT_ID”',
+ 'description' => '编码类型,此处填写**PROJECT_ID**。',
'type' => 'string',
'required' => true,
- 'example' => 'DAFE****ce3ej=',
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型 :'."\n"
+ .'- OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1**2',
+ 'Ids' => [
+ 'title' => '设备标识列表(deviceOpenId或deviceUnionId)',
+ 'description' => '设备标识信息列表。',
+ 'type' => 'array',
+ 'items' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'required' => false,
],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '设备的组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
- 'required' => true,
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '返回数据体',
+ 'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '返回结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果',
+ 'title' => '返回result,key为deviceOpenId或deviceUnionId,value为对应的设备信息',
+ 'description' => '返回的详细信息。',
+ 'type' => 'object',
+ 'additionalProperties' => [
'type' => 'object',
'properties' => [
- 'Alias' => [
- 'description' => '别名',
- 'type' => 'array',
- 'items' => [
- 'description' => '别名',
- 'type' => 'string',
- 'example' => '超能狂少在都市',
- ],
- ],
- 'Audition' => [
- 'description' => '是否可试听',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Authors' => [
- 'description' => '内容的作者',
- 'type' => 'array',
- 'items' => [
- 'description' => '内容作者',
- 'type' => 'object',
- 'properties' => [
- 'AuthorTypes' => [
- 'description' => '作者类型',
- 'type' => 'array',
- 'items' => [
- 'description' => '作者类型',
- 'type' => 'string',
- 'example' => 'ANCHOR',
- ],
- ],
- 'Cover' => [
- 'description' => '头像图片',
- 'type' => 'object',
- 'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- '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' => '三方作者id',
- 'type' => 'string',
- 'example' => '123123',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
- 'Id' => [
- 'description' => '作者主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13597709',
- ],
- 'Title' => [
- 'description' => '作者标题',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Description' => [
- 'description' => '作者描述',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Online' => [
- 'description' => '是否在线',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- ],
- 'Category' => [
- 'description' => ' '."\n"
- .'根据所属公共类目转换controlType',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Charge' => [
- 'description' => ' '."\n"
- .'是否收费',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CommCateId' => [
- 'description' => '对应的类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80012017',
- ],
- 'Cover' => [
- 'description' => '专辑封面图片',
- 'type' => 'object',
- 'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- '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' => '中图(Deprecated)',
- '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' => '内容id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13597709',
- ],
- 'ItemType' => [
- 'description' => '内容的类型, 音乐 音频 电台 笑话等',
- 'type' => 'string',
- 'example' => 'ALBUM',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
- 'Type' => [
- 'description' => '根据所属公共类目转换favoriteType',
- 'type' => 'string',
- 'example' => 'program',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '超能狂少在都市',
- ],
- 'Valid' => [
- 'description' => '是否可播',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
+ 'Name' => ['title' => '设备名称', 'description' => '设备的名称。', 'type' => 'string', 'example' => '我的设备'],
+ 'FirmwareVersion' => ['title' => '固件版本', 'description' => '设备的固件版本。', 'type' => 'string', 'example' => '2.0.3'],
+ 'Mac' => ['title' => '设备MAC地址', 'description' => '设备的MAC地址。', 'type' => 'string', 'example' => 'b4:xx:xx:xx:65:2b'],
+ 'Sn' => ['title' => '设备SN', 'description' => '设备的SN信息。', 'type' => 'string', 'example' => '1200xx048'],
],
+ 'description' => '返回的设备信息列表。',
],
],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Type\\": \\"program\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Valid\\": \\"VALID\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPlayHistoryResponse>\\n <requestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</requestId>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>123123</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>false</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Type>program</Type>\\n <Title>超能狂少在都市</Title>\\n <Valid>VALID</Valid>\\n </Result>\\n</ListPlayHistoryResponse>","errorExample":""}]',
- 'title' => '获取历史播放接口',
- ],
- 'ListRecommendContent' => [
- 'summary' => '获取每日推荐的音乐或者音频。',
- 'path' => '/v1.0/ssp/ListRecommendContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.ListDeviceBasicInfo.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"Name\\": \\"我的设备\\",\\n \\"FirmwareVersion\\": \\"2.0.3\\",\\n \\"Mac\\": \\"b4:xx:xx:xx:65:2b\\",\\n \\"Sn\\": \\"1200xx048\\"\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceBasicInfoResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DAFE****ce3ej=>\\n <Name>我的设备</Name>\\n <FirmwareVersion>2.0.3</FirmwareVersion>\\n <Mac>b4:xx:xx:xx:65:2b</Mac>\\n <Sn>1200xx048</Sn>\\n </DAFE****ce3ej=>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceBasicInfoResponse>\\n","errorExample":""}]',
+ 'title' => '批量查询设备基本信息',
+ ],
+ 'ListDeviceByUserId' => [
+ 'summary' => '根据用户openID,获取绑定的设备ID列表。',
+ 'path' => '/v1.0/ssp/listDeviceByUserId',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Request',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求参数',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '默认值song(扩展字段目前仅支持song)',
- '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' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'DeviceInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '设备标识信息',
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息列表。',
'type' => 'object',
'properties' => [
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
+ 'title' => '编码类型,此处填写“PROJECT_ID”',
+ 'description' => '编码类型,此处填写**PROJECT_ID**。',
'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型:'."\n"
+ .' - OPEN_ID:默认的用户ID标识。'."\n"
+ .'- UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,填写userOpenId或userUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -8488,571 +5097,113 @@
'responses' => [
200 => [
'schema' => [
+ 'title' => '返回数据体',
+ 'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'code 编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求RequestId',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '返回结果',
+ 'title' => '返回result',
+ 'description' => '返回的详细信息。',
'type' => 'array',
'items' => [
- 'description' => '返回结果',
+ 'description' => '信息列表',
'type' => 'object',
'properties' => [
- 'Alias' => [
- 'description' => '别名',
- 'type' => 'array',
- 'items' => [
- 'description' => '别名',
- 'type' => 'string',
- 'example' => '超能狂少在都市',
- ],
- ],
- 'Audition' => [
- 'description' => '是否可试听',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Authors' => [
- 'description' => '内容的作者',
+ 'DeviceOpenId' => ['title' => '设备信息对应的openId', 'description' => '设备信息对应的openId。', 'type' => 'string', 'example' => 'A963*0158'],
+ 'DeviceUnionIds' => [
+ 'title' => '组织id及归一id列表',
+ 'description' => '设备对应的组织ID及UnionId信息。',
'type' => 'array',
'items' => [
- 'description' => '内容的作者',
+ 'description' => '信息列表',
'type' => 'object',
'properties' => [
- 'AuthorTypes' => [
- 'description' => '作者类型',
- 'type' => 'array',
- 'items' => [
- 'description' => '作者类型',
- 'type' => 'string',
- 'example' => 'ANCHOR',
- ],
- ],
- 'Cover' => [
- 'description' => '头像图片',
- 'type' => 'object',
- 'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- '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' => '三方作者id',
- 'type' => 'string',
- 'example' => '12311',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
- 'Id' => [
- 'description' => '作者主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13597709',
- ],
- 'Title' => [
- 'description' => '作者标题',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Description' => [
- 'description' => '作者描述',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Online' => [
- 'description' => '是否在线',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- ],
- 'Category' => [
- 'description' => '根据所属公共类目转换controlType',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Charge' => [
- 'description' => '是否收费',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CommCateId' => [
- 'description' => '对应的类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80012017',
- ],
- 'Cover' => [
- 'description' => '专辑封面图片',
- 'type' => 'object',
- 'properties' => [
- 'CanResize' => [
- 'description' => ' '."\n"
- .'是否可以使用oss规则裁剪',
- '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' => '中图(Deprecated)',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
- ],
- 'Medium' => [
- 'description' => '中图',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
- ],
- 'Small' => [
- 'description' => '小图',
- 'type' => 'string',
- 'example' => 'http://pic.qtfm.cn/2017/0207/2017020718285.jpg',
+ 'OrganizationId' => ['title' => '组织id', 'description' => '组织ID。', 'type' => 'string', 'example' => '1**2'],
+ 'DeviceUnionId' => ['title' => '组织id对应的归一id', 'description' => '设备的UnionId。', 'type' => 'string', 'example' => '1553*B0C3'],
],
],
],
- 'Description' => [
- 'description' => '内容描述',
- 'type' => 'string',
- 'example' => '内容描述',
- ],
- 'HotScore' => [
- 'description' => ' '."\n"
- .'热度分',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '10',
- ],
- 'Id' => [
- 'description' => '内容id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13597709',
- ],
- 'ItemType' => [
- 'description' => ' '."\n"
- .'内容的类型, 音乐 音频 电台 笑话等',
- 'type' => 'string',
- 'example' => 'ALBUM',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '超能狂少在都市',
- ],
- 'Type' => [
- 'description' => '根据所属公共类目转换favoriteType',
- 'type' => 'string',
- 'example' => 'program',
- ],
- 'Valid' => [
- 'description' => '是否可播',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'RawId' => [
- 'description' => '三方id',
- 'type' => 'string',
- 'example' => '123123',
- ],
],
],
],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"12311\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"123123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRecommendContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>12311</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>false</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <RawId>123123</RawId>\\n </Result>\\n</ListRecommendContentResponse>","errorExample":""}]',
- 'title' => '获取每日推荐的音乐或者音频',
- ],
- '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' => '播放:Play;暂停:Pause。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Play',
- 'enum' => [
- 'Play',
- 'Pause',
- ],
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '用户标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'DeviceInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '设备标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => true,
- ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.ListDeviceByUserId.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
- ],
- ],
- ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PlayAndPauseControlResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PlayAndPauseControlResponse>","errorExample":""}]',
- 'title' => '播放暂停控制',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceByUserIdResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceByUserIdResponse>","errorExample":""}]',
+ 'title' => '获取用户绑定的设备列表',
],
- 'PlayModeControl' => [
- 'summary' => '播放模式切换。',
- 'path' => '/v1.0/ssp/PlayModeControl',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDeviceByUserIdAndChanel' => [
+ 'summary' => '获取指定渠道的设备列表。',
+ 'path' => '/v1.0/ssp/listDeviceByUserIdAndChanel',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'OpenPlayModeControlRequest',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '业务参数',
- 'type' => 'object',
- 'properties' => [
- 'OpenPlayMode' => [
- 'description' => '播放模式'."\n"
- ."\n"
- .'列表循环:Repeat,;随机:Shuffle,;单曲循环:RepeatOne,;普通模式:Normal;',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Normal',
- 'enum' => [
- 'Repeat',
- 'Shuffle',
- 'RepeatOne',
- 'Normal',
- ],
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'UserInfo',
+ 'name' => 'ChannelInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '用户标识信息',
+ 'title' => '激活渠道,如微信小程序,三方app等',
+ 'description' => '激活渠道,如微信小程序,三方app等',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'Channel' => ['title' => '激活配网渠道,如WeChat', 'description' => '激活配网渠道,如WeChat、ThirdApp', 'type' => 'string', 'required' => true, 'example' => 'WeChat、ThirdApp'],
+ 'ExtInfo' => ['title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
'required' => true,
],
],
[
- 'name' => 'DeviceInfo',
+ 'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '设备标识信息',
+ 'title' => '用户标识信息列表。',
+ 'description' => '用户标识信息列表。',
'type' => 'object',
'properties' => [
'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
+ 'title' => '编码类型,此处填写PROJECT_ID。',
+ 'description' => '编码类型,此处填写PROJECT_ID。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'title' => '用户Id的类型:'."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
+ 'description' => '用户Id的类型:'."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '用户标识,填写userOpenId或userUnionId的值。', 'description' => '用户标识,填写userOpenId或userUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1***2'],
],
'required' => true,
],
@@ -9065,511 +5216,234 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '调用该接口的返回结果。', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '服务的实际返回结果',
- 'type' => 'object',
- 'properties' => [
- 'OpenPlayMode' => [
- 'description' => '播放模式'."\n"
- ."\n"
- .'列表循环:Repeat,;随机:Shuffle,;单曲循环:RepeatOne,;普通模式:Normal;',
- 'type' => 'string',
- 'example' => 'Normal',
- 'enum' => [
- 'Repeat',
- 'Shuffle',
- 'RepeatOne',
- 'Normal',
+ 'title' => '信息列表',
+ 'description' => '信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceOpenId' => ['title' => '设备信息对应的openId。', 'description' => '设备信息对应的openId。', 'type' => 'string', 'example' => 'A963*0158'],
+ 'DeviceUnionIds' => [
+ 'title' => '设备信息列表',
+ 'description' => '信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrganizationId' => ['title' => '组织ID。', 'description' => '组织ID。', 'type' => 'string', 'example' => '1***2'],
+ 'DeviceUnionId' => ['title' => '设备的UnionId。', 'description' => '设备的UnionId。', 'type' => 'string', 'example' => '1553*B0C3'],
+ ],
+ ],
],
],
],
],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求Id', 'description' => '请求Id', 'type' => 'string', 'example' => 'RE***D'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OpenPlayMode\\": \\"Normal\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PlayModeControlResponse>\\n <Code>200</Code>\\n <Result>\\n <openPlayMode>Normal</openPlayMode>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PlayModeControlResponse>","errorExample":""}]',
- 'title' => '播放模式切换',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1***2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"RE***D\\"\\n}","type":"json"}]',
+ 'title' => '获取指定渠道的设备列表',
],
- 'PreviousAndNextControl' => [
- 'summary' => '对创建的播放列表中的内容进行上下一首控制。',
- 'path' => '/v1.0/ssp/PreviousAndNextControl',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDeviceIdByIdentities' => [
+ 'summary' => '批量根据设备MAC/SN获取设备ID。',
+ 'path' => '/v1.0/ssp/listDeviceIdByIdentities',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'OpenControlPlayingListRequest',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '业务参数',
- 'type' => 'object',
- 'properties' => [
- 'Cmd' => [
- 'description' => '下一首:NEXT;上一首:PREVIOUS',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NEXT',
- ],
- 'IsFromDevice' => [
- 'description' => '是否设备发起,默认false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'ExtendInfo' => [
- 'type' => 'object',
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
+ 'name' => 'EncodeType',
+ 'in' => 'query',
+ 'schema' => ['title' => '编码类型,此处填写“PROJECT_ID”', 'description' => '编码类型,此处填写**PROJECT_ID**。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
],
[
- 'name' => 'UserInfo',
+ 'name' => 'EncodeKey',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '用户标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '125****0946'],
],
[
- 'name' => 'DeviceInfo',
+ 'name' => 'IdentityType',
+ 'in' => 'query',
+ 'schema' => ['title' => '填写设备认证类型,“MAC”或者“SN”', 'description' => '设备认证类型,填写**MAC**或**SN**。', 'type' => 'string', 'required' => true, 'example' => 'MAC'],
+ ],
+ [
+ 'name' => 'IdentityIds',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '设备标识信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => true,
+ 'description' => '设备的认证标识列表。',
+ 'type' => 'array',
+ 'items' => ['title' => '认证标识,填写MAC地址或者SN的值。', 'description' => '认证标识,填写MAC地址或SN值。', 'type' => 'string', 'required' => true, 'example' => 'b4:xx:xx:xx:65:2b'],
+ 'required' => false,
],
],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。', 'description' => '产品唯一标志符productKey,在天猫精灵AI平台中创建产品时,平台颁发的全局唯一标识。', 'type' => 'string', 'required' => true, 'example' => 'Mm*****XnZ8'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '返回数据体',
+ 'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '返回的错误信息', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '服务的实际返回结果',
+ 'title' => '返回result',
+ 'description' => '返回的详细信息列表。',
'type' => 'object',
- 'properties' => [
- 'RawId' => [
- 'description' => '三方id',
- 'type' => 'string',
- 'example' => '550144364',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'ximalayav2',
- ],
- 'AlbumRawId' => [
- 'description' => '三方专辑id',
- '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' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DeviceOpenId' => ['title' => '设备信息对应的openId', 'description' => '设备对应的openId。', 'type' => 'string', 'example' => 'A963*0158'],
+ 'DeviceUnionIds' => [
+ 'title' => '组织id及归一id列表',
+ 'description' => '设备对应的组织ID及UnionId信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OrganizationId' => ['title' => '组织id', 'description' => '组织ID。', 'type' => 'string', 'example' => '1**2'],
+ 'DeviceUnionId' => ['title' => '组织id对应的归一id', 'description' => '设备的UnionId。', 'type' => 'string', 'example' => '1553*B0C3'],
+ ],
+ 'description' => '信息列表',
],
],
],
- 'PlayMode' => [
- 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- 'type' => 'string',
- 'example' => 'Repeat',
- ],
- 'AudioLength' => [
- 'description' => '长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '190',
- ],
- 'Progress' => [
- 'description' => '歌曲播放进度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'LyricUrl' => [
- 'description' => '歌词url',
- 'type' => 'string',
- 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
- ],
- 'Type' => [
- 'description' => 'type (music\\program\\joke\\news\\children_song\\radio等)',
- 'type' => 'string',
- 'example' => 'story',
- ],
- 'Copyright' => [
- 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ItemUrl' => [
- 'description' => '播放url',
- 'type' => 'string',
- 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
- ],
- 'DefaultPlayOrder' => [
- 'description' => 'package 默认播放顺序 0 顺序,1 倒序',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Valid' => [
- 'description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Pos' => [
- 'description' => '该项在播放列表中的位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'description' => '信息列表',
],
],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PreviousAndNextControlResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PreviousAndNextControlResponse>","errorExample":""}]',
- 'title' => '上下首控制',
- ],
- 'ProgressControl' => [
- 'summary' => '进度控制。',
- 'path' => '/v1.0/ssp/ProgressControl',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"key\\": {\\n \\"DeviceOpenId\\": \\"A963*0158\\",\\n \\"DeviceUnionIds\\": [\\n {\\n \\"OrganizationId\\": \\"1**2\\",\\n \\"DeviceUnionId\\": \\"1553*B0C3\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceIdByIdentitiesResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>\\n <b4:xx:xx:xx:65:2b>\\n <DeviceOpenId>A963*0158</DeviceOpenId>\\n <DeviceUnionIds>\\n <OrganizationId>1**2</OrganizationId>\\n <DeviceUnionId>1553*B0C3</DeviceUnionId>\\n </DeviceUnionIds>\\n </b4:xx:xx:xx:65:2b>\\n </Result>\\n <RequestId>0EC7*726E</RequestId>\\n</ListDeviceIdByIdentitiesResponse>","errorExample":""}]',
+ 'title' => '批量获取设备ID',
+ ],
+ 'ListMusic' => [
+ 'summary' => '基于音乐类型查询该类型下的铃声列表。',
+ 'path' => '/v1.0/ssp/listMusic',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'OpenProgressControlRequest',
+ 'name' => 'Payload',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '业务参数',
+ 'title' => '服务请求入参',
+ 'description' => '服务请求入参',
'type' => 'object',
'properties' => [
- 'Progress' => [
- 'description' => '歌曲进度。单位秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '12',
- ],
- 'ExtendInfo' => [
- 'description' => '扩展信息',
- 'type' => 'object',
- 'required' => false,
- ],
+ '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' => '铃声类别id,由queryMusicType接口返回', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
+ 'MusicTypeName' => ['title' => '音乐类别名称', 'description' => '铃声类别名称,由queryMusicType接口返回', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'],
+ 'MusicId' => ['title' => '音乐id', 'description' => '铃声id,扩展字段,暂不用传', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ 'MusicName' => ['title' => '音乐名称', 'description' => '铃声名称,扩展字段,暂不用传', 'type' => 'string', 'required' => false, 'example' => 'xx铃声'],
+ 'CurrentPage' => ['title' => '当前页', 'description' => '当前页', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '每页条数', 'description' => '每页条数:最大值100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
+ 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'query',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
+ 'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'`OPEN_ID`:默认的设备ID标识。` UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
+ 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -9578,64 +5452,59 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'AmpResult',
+ 'description' => 'AmpResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '调用返回码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => '闹钟服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '音乐类型名称为空'],
'Result' => [
- 'description' => '服务的实际返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
+ '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' => '每页条数:最大值100,超过100按100处理', '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' => '铃声类别id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MusicTypeName' => ['title' => '音乐类别名称', 'description' => '铃声类别名称', 'type' => 'string', 'example' => 'xx'],
+ 'MusicId' => ['title' => '音乐id', 'description' => '铃声id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MusicName' => ['title' => '音乐名称', 'description' => '铃声名称', 'type' => 'string', 'example' => 'xx'],
+ 'MusicUrl' => ['title' => '音乐url', 'description' => '铃声url', 'type' => 'string', 'example' => 'http://xx'],
+ ],
+ ],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ProgressControlResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</ProgressControlResponse>","errorExample":""}]',
- 'title' => '进度控制',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"音乐类型名称为空\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<ListMusicResponse>\\n <Code>200</Code>\\n <Message>音乐类型名称为空</Message>\\n <Result>\\n <TotalCount>100</TotalCount>\\n <PageCount>10</PageCount>\\n <PageSize>10</PageSize>\\n <CurrentPage>1</CurrentPage>\\n <Model>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </Model>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</ListMusicResponse>","errorExample":""}]',
+ 'title' => '查询铃声分页列表',
+ 'responseParamsDescription' => '仅请求返回的状态码为200时为成功,否则均为失败',
],
- 'SearchContent' => [
- 'summary' => '按照特定的搜索条件搜索。',
- 'path' => '/v1.0/ssp/SearchContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListPlayHistory' => [
+ 'summary' => '获取历史播放接口。',
+ 'path' => '/v1.0/ssp/ListPlayHistory',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -9647,50 +5516,9 @@
'description' => '请求参数',
'type' => 'object',
'properties' => [
- 'Query' => [
- 'description' => '查询关键字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '周杰伦',
- ],
- 'Cate' => [
- 'description' => '搜索的范围音乐或者音频'."\n"
- .'入参枚举 :music | program',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'music',
- ],
- 'SubCate' => [
- 'description' => '当cate 是music时 可以不传subCate 
如果传subCate 可以为 :'."\n"
- .'song (歌曲)、 singer(艺人) 、album (专辑)'."\n"
- ."\n"
- .'当cate是program时 可以不传subCate '."\n"
- .'如果传subCate 可以为 :'."\n"
- .'album (专辑)、audio(节目音频)、radio(电台)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'singer',
- ],
- 'QueryAlbum' => [
- 'description' => '是否查询专辑',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'PageNum' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'Type' => ['description' => '音乐music,有声书program,故事story,儿歌children_song,电台radio', '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,
],
@@ -9703,45 +5531,20 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '用户标识,设置为userOpenId或userUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的用户ID标识。'."\n"
- .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => true, 'example' => '1**2'],
],
'required' => true,
],
@@ -9754,45 +5557,20 @@
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeKey' => [
- 'description' => '编码类型对应的值'."\n"
- ."\n"
- .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
- .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'EncodeType' => [
- 'description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
- ."\n"
- .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
- .'SKILL_ID:技能ID,云端链路的编码类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- ],
- 'Id' => [
- 'description' => '设备标识,设置为deviceOpenId或deviceUnionId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => true, 'example' => '1**2'],
],
'required' => true,
],
@@ -9803,254 +5581,80 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E',
- ],
- 'Code' => [
- 'description' => 'code编码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
'Result' => [
- 'description' => '返回信息',
+ 'description' => '返回结果',
'type' => 'array',
'items' => [
- 'description' => '返回信息',
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
'Alias' => [
'description' => '别名',
'type' => 'array',
- 'items' => [
- 'description' => '别名',
- 'type' => 'string',
- 'example' => '超能狂少在都市',
- ],
- ],
- 'Audition' => [
- 'description' => '是否可试听',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'items' => ['description' => '别名', 'type' => 'string', 'example' => '超能狂少在都市'],
],
+ 'Audition' => ['description' => '是否可试听', 'type' => 'boolean', 'example' => 'false'],
'Authors' => [
'description' => '内容的作者',
'type' => 'array',
'items' => [
- 'description' => '作者信息',
+ 'description' => '内容作者',
'type' => 'object',
'properties' => [
'AuthorTypes' => [
'description' => '作者类型',
'type' => 'array',
- 'items' => [
- 'description' => '作者类型',
- 'type' => 'string',
- 'example' => 'ANCHOR',
- ],
+ 'items' => ['description' => '作者类型', 'type' => 'string', 'example' => 'ANCHOR'],
],
'Cover' => [
'description' => '头像图片',
'type' => 'object',
'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Img' => [
- 'description' => '默认图片',
- 'type' => 'string',
- 'example' => 'https://a.jpg',
- ],
- 'Large' => [
- 'description' => '大图',
- 'type' => 'string',
- 'example' => 'https://a.jpg',
- ],
- 'Medium' => [
- 'description' => '中图',
- 'type' => 'string',
- 'example' => 'https://a.jpg',
- ],
- 'Small' => [
- 'description' => '小图',
- 'type' => 'string',
- 'example' => 'https://a.jpg',
- ],
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', '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' => '三方作者id',
- 'type' => 'string',
- 'example' => '123123',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qingting',
- ],
- 'Id' => [
- 'description' => '作者主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13597709',
- ],
- 'Title' => [
- 'description' => '作者标题',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Description' => [
- 'description' => '作者描述',
- 'type' => 'string',
- 'example' => '播音呆瓜小贼',
- ],
- 'Online' => [
- 'description' => '是否在线',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Gender' => ['description' => '性别', 'type' => 'string', 'example' => 'MALE'],
+ 'RawId' => ['description' => '三方作者id', 'type' => 'string', 'example' => '123123'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'qingting'],
+ 'Id' => ['description' => '作者主键id', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709'],
+ 'Title' => ['description' => '作者标题', 'type' => 'string', 'example' => '播音呆瓜小贼'],
+ 'Description' => ['description' => '作者描述', 'type' => 'string', 'example' => '播音呆瓜小贼'],
+ 'Online' => ['description' => '是否在线', 'type' => 'boolean', 'example' => 'false'],
],
],
],
- 'Category' => [
- 'description' => '根据所属公共类目转换controlType',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Charge' => [
- 'description' => '是否收费',
- 'type' => 'boolean',
- 'example' => 'fasle',
- ],
- 'CommCateId' => [
- 'description' => '对应的类目id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80012017',
- ],
+ 'Category' => ['description' => ' '."\n"
+ .'根据所属公共类目转换controlType', 'type' => 'string', 'example' => 'audio'],
+ 'Charge' => ['description' => ' '."\n"
+ .'是否收费', 'type' => 'boolean', 'example' => 'false'],
+ 'CommCateId' => ['description' => '对应的类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017'],
'Cover' => [
'description' => '专辑封面图片',
'type' => 'object',
'properties' => [
- 'CanResize' => [
- 'description' => '是否可以使用oss规则裁剪',
- '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' => '中图(Deprecated)',
- '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' => '内容id',
- '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' => '根据所属公共类目转换favoriteType',
- 'type' => 'string',
- 'example' => 'program',
- ],
- 'Valid' => [
- 'description' => '是否可播',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Duration' => [
- 'description' => '时长信息',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '180',
- ],
- 'AlbumId' => [
- 'description' => '对应的专辑id',
- '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',
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', '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' => '中图(Deprecated)', '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' => '内容id', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709'],
+ 'ItemType' => ['description' => '内容的类型, 音乐 音频 电台 笑话等', 'type' => 'string', 'example' => 'ALBUM'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'qingting'],
+ 'Type' => ['description' => '根据所属公共类目转换favoriteType', 'type' => 'string', 'example' => 'program'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '超能狂少在都市'],
+ 'Valid' => ['description' => '是否可播', 'type' => 'string', 'example' => 'VALID'],
],
],
],
@@ -10058,321 +5662,60 @@
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": true,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"13123\\",\\n \\"Lyric\\": \\"http://a1231.lrc\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Styles\\": [\\n \\"1231\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>123123</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>true</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Valid>VALID</Valid>\\n <Duration>180</Duration>\\n </Result>\\n</SearchContentResponse>","errorExample":""}]',
- 'title' => '按照特定的搜索条件搜索',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Type\\": \\"program\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Valid\\": \\"VALID\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPlayHistoryResponse>\\n <requestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</requestId>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>123123</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>false</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Type>program</Type>\\n <Title>超能狂少在都市</Title>\\n <Valid>VALID</Valid>\\n </Result>\\n</ListPlayHistoryResponse>","errorExample":""}]',
+ 'title' => '获取历史播放接口',
],
- 'CloudPlayer' => [
- 'summary' => '云推歌,提供设备openUuid和天猫精灵openUserId,创建播放列表。',
- 'path' => '/v1.0/ssp/cloud/player',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRecommendContent' => [
+ 'summary' => '获取每日推荐的音乐或者音频。',
+ 'path' => '/v1.0/ssp/ListRecommendContent',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'UserInfo',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '开放用户信息',
- 'type' => 'object',
- 'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码key',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'IdType' => [
- 'description' => 'ID 类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'description' => '开放ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1234',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID(可为空)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为空',
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'DeviceInfo',
- 'in' => 'query',
+ 'name' => 'Request',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '设备标识信息',
+ 'description' => '请求参数',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码key',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- 'enum' => [],
- ],
- 'IdType' => [
- 'description' => 'ID类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'UNION_ID',
- 'OPEN_ID',
- ],
- ],
- 'Id' => [
- 'description' => '开放ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1234',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID(可为空)',
- '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' => '歌曲ID列表【1-200】个歌曲',
- 'type' => 'array',
- 'items' => [
- 'description' => '歌曲id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
+ 'Type' => ['description' => '默认值song(扩展字段目前仅支持song)', 'type' => 'string', 'required' => false, 'example' => 'song'],
+ 'Count' => ['description' => '推荐数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => true,
- 'maxItems' => 200,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'CurPlayIndex',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前播放歌曲的索引。从1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PlayMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '播放模式',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'Shuffle' => '随机',
- 'RepeatOne' => '单曲循环',
- 'Repeat' => '循环',
- 'Normal' => '顺序',
- ],
- 'example' => 'Normal',
- ],
- ],
- [
- 'name' => 'SongId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '歌曲id(索引有问题时,根据该ID重新计算索引)',
- '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' => '返回结果:true:检验成功false:检验失败',
- '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"}]',
- 'title' => '云推歌',
- 'description' => '同步检验入参后返回,'."\n"
- .'异步创建播放列表。',
- 'responseParamsDescription' => '返回值为 true / false,表示创建播放列表是否成功。',
- ],
- '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' => '用户信息- userId',
+ 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1414895629783187053',
- ],
- 'IdType' => [
- 'description' => 'ID 类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'description' => 'ID 值',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,IdType设置为UNION_ID时,该参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '暂无',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => false, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => false, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -10382,767 +5725,109 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '设备标识信息。',
+ 'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'EncodeType' => [
- 'description' => '编码类型,此处填写PROJECT_ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1414895629783187053',
- 'enum' => [],
- ],
- 'IdType' => [
- 'description' => '设备Id的类型'."\n"
- ."\n"
- .'OPEN_ID:默认的设备ID标识。'."\n"
- .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'UNION_ID',
- 'OPEN_ID',
- ],
- ],
- 'Id' => [
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '暂无',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => false, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => false, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => false, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => false, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
- [
- 'name' => 'BotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '机器人ID。',
- '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' => '请求类型为 STYLE 时必填。',
- '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',
- ],
+ 'Code' => ['description' => 'code 编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求RequestId', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
'Result' => [
- 'description' => '请求结果。',
+ 'description' => '返回结果',
'type' => 'array',
'items' => [
- 'description' => '服务的实际返回结果',
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'Source' => [
- 'description' => '内容的来源',
- 'type' => 'string',
- 'example' => 'KG',
- ],
- 'RawId' => [
- 'description' => '内容的三方id',
- 'type' => 'string',
- 'example' => '550144364',
- ],
- 'Cover' => [
- 'description' => '专辑封面图片',
- 'type' => 'string',
- 'example' => 'http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg',
+ 'Alias' => [
+ 'description' => '别名',
+ 'type' => 'array',
+ 'items' => ['description' => '别名', 'type' => 'string', 'example' => '超能狂少在都市'],
],
+ 'Audition' => ['description' => '是否可试听', 'type' => 'boolean', 'example' => 'false'],
'Authors' => [
- 'description' => '作者信息',
+ '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"}]',
- 'title' => '移动轻纳管推荐接口',
- 'description' => '根据 Type 区分场景(每日推荐、热歌等)即可。',
- ],
- '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' => '订阅专辑request',
- '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' => '设置按周提醒的具体日期,取值范围为:1~7',
- 'type' => 'array',
- 'items' => [
- 'description' => '设置按周提醒的具体日期,取值范围为:1~7。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '7',
- 'minimum' => '1',
- 'example' => '1,3,5,7,6',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- ],
- ],
- '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' => '专辑ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '51999575',
- ],
- 'PlayMode' => [
- 'title' => '播放模式(目前只支持sequence)',
- 'description' => '播放模式(目前只支持sequence)',
- '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' => '状态码。说明 200表示成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Result' => [
- 'title' => '结果',
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '订阅专辑记录ID',
- 'description' => '订阅专辑记录ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '81',
- ],
- 'DeviceId' => [
- 'title' => '设备ID',
- 'description' => '设备ID',
- 'type' => 'string',
- 'example' => '5874DBCCA3038FAA1A70A8060F07F26D',
- ],
- 'UserId' => [
- 'title' => '用户ID',
- 'description' => '用户ID',
- 'type' => 'string',
- 'example' => '1152893538998276761',
- ],
- 'ScheduleInfo' => [
- 'title' => '定时信息',
- 'description' => '定时信息',
- 'type' => 'object',
- 'properties' => [
- 'DaysOfWeek' => [
- 'title' => '提醒触发的周期',
- 'description' => '提醒触发的周期',
- 'type' => 'array',
- 'items' => [
- 'description' => '设置按周提醒的具体日期,取值范围为:1~7。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'description' => '内容的作者',
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthorTypes' => [
+ 'description' => '作者类型',
+ 'type' => 'array',
+ 'items' => ['description' => '作者类型', 'type' => 'string', 'example' => 'ANCHOR'],
+ ],
+ 'Cover' => [
+ 'description' => '头像图片',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', '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' => '三方作者id', 'type' => 'string', 'example' => '12311'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'qingting'],
+ 'Id' => ['description' => '作者主键id', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709'],
+ 'Title' => ['description' => '作者标题', 'type' => 'string', 'example' => '播音呆瓜小贼'],
+ 'Description' => ['description' => '作者描述', 'type' => 'string', 'example' => '播音呆瓜小贼'],
+ 'Online' => ['description' => '是否在线', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'Hour' => [
- 'title' => '提醒触发的小时',
- 'description' => '提醒触发的时间时钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'Minute' => [
- 'title' => '提醒触发的分钟',
- 'description' => '提醒触发的时间分钟数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- ],
- ],
- 'AlbumId' => [
- 'title' => '专辑ID',
- 'description' => '专辑ID',
- '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' => '请求ID。',
- '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"}]',
- 'title' => '订阅专辑',
- ],
- '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' => '订阅专辑记录ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '81',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Result' => [
- 'title' => '返回结果',
- 'description' => '返回结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- '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"}]',
- 'title' => '删除订阅专辑',
- ],
- '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' => '专辑idList',
- 'type' => 'array',
- 'items' => [
- 'title' => '专辑ID',
- 'description' => '专辑ID',
- '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' => '请求ID',
- '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' => '专辑ID',
- 'type' => 'string',
- 'example' => '51999575',
],
- 'IsAdded' => [
- 'title' => '是否被订阅',
- 'description' => '是否被订阅',
- 'type' => 'string',
- 'example' => 'false',
+ 'Category' => ['description' => '根据所属公共类目转换controlType', 'type' => 'string', 'example' => 'audio'],
+ 'Charge' => ['description' => '是否收费', 'type' => 'boolean', 'example' => 'false'],
+ 'CommCateId' => ['description' => '对应的类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017'],
+ 'Cover' => [
+ 'description' => '专辑封面图片',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanResize' => ['description' => ' '."\n"
+ .'是否可以使用oss规则裁剪', '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' => '中图(Deprecated)', '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' => ' '."\n"
+ .'热度分', 'type' => 'number', 'format' => 'double', 'example' => '10'],
+ 'Id' => ['description' => '内容id', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709'],
+ 'ItemType' => ['description' => ' '."\n"
+ .'内容的类型, 音乐 音频 电台 笑话等', 'type' => 'string', 'example' => 'ALBUM'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'qingting'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '超能狂少在都市'],
+ 'Type' => ['description' => '根据所属公共类目转换favoriteType', 'type' => 'string', 'example' => 'program'],
+ 'Valid' => ['description' => '是否可播', 'type' => 'string', 'example' => 'VALID'],
+ 'RawId' => ['description' => '三方id', 'type' => 'string', 'example' => '123123'],
],
],
],
@@ -11150,38 +5835,21 @@
],
],
],
- '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"}]',
- 'title' => '专辑是否被订阅',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"12311\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": false\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": false,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"RawId\\": \\"123123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRecommendContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>F12B6147-5925-19E5-A3AD-E1EE1360F34E</RequestId>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>12311</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>false</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <Description>内容描述</Description>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Type>program</Type>\\n <Valid>VALID</Valid>\\n <RawId>123123</RawId>\\n </Result>\\n</ListRecommendContentResponse>","errorExample":""}]',
+ 'title' => '获取每日推荐的音乐或者音频',
],
'ListSub' => [
'summary' => '用户已订阅列表。',
'path' => '/v1.0/ssp/listSub',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
@@ -11195,24 +5863,8 @@
'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',
- ],
+ '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,
@@ -11231,33 +5883,17 @@
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
+ '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,
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['type' => 'string', 'required' => false],
],
'required' => true,
'docRequired' => true,
@@ -11276,33 +5912,17 @@
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
+ '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,
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['type' => 'string', 'required' => false],
],
'required' => true,
'docRequired' => true,
@@ -11316,44 +5936,16 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', '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',
- ],
+ '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' => '订阅列表',
@@ -11361,26 +5953,9 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '订阅记录ID',
- 'description' => '订阅记录ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'DeviceId' => [
- 'title' => '设备ID',
- 'description' => '设备ID',
- 'type' => 'string',
- 'example' => '5874DBCCA3038FAA1A70A8060F07F26D',
- ],
- 'UserId' => [
- 'title' => '用户ID',
- 'description' => '用户ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1152893538998276761',
- ],
+ 'Id' => ['title' => '订阅记录ID', 'description' => '订阅记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'DeviceId' => ['title' => '设备ID', 'description' => '设备ID', 'type' => 'string', 'example' => '5874DBCCA3038FAA1A70A8060F07F26D'],
+ 'UserId' => ['title' => '用户ID', 'description' => '用户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1152893538998276761'],
'ScheduleInfo' => [
'title' => '定时信息',
'description' => '定时信息',
@@ -11390,84 +5965,32 @@
'title' => '触发周期',
'description' => '触发周期',
'type' => 'array',
- 'items' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ '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',
- ],
+ 'Hour' => ['title' => '触发小时', 'description' => '触发小时', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'Minute' => ['title' => '触发分钟', 'description' => '触发分钟', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
- 'AlbumId' => [
- 'title' => '专辑ID',
- 'description' => '专辑ID',
- 'type' => 'string',
- 'example' => '51999575',
- ],
- 'PlayMode' => [
- 'title' => '播放模式',
- 'description' => '播放模式',
- 'type' => 'string',
- 'example' => 'sequence',
- ],
- 'DailyStudyCnt' => [
- 'title' => '每天学习数量',
- 'description' => '每天学习数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'CoverUrl' => [
- 'title' => '专辑封面',
- 'description' => '专辑封面',
- 'type' => 'string',
- 'example' => 'https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg',
- ],
- 'Title' => [
- 'title' => '专辑标题',
- 'description' => '专辑标题',
- 'type' => 'string',
- 'example' => '小科学家探索',
- ],
+ 'AlbumId' => ['title' => '专辑ID', 'description' => '专辑ID', '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' => '请求ID',
- 'type' => 'string',
- 'example' => '0D0C09C2-ADC1-198B-964D-24F4FAD967DB',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": true,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"DeviceId\\": \\"5874DBCCA3038FAA1A70A8060F07F26D\\",\\n \\"UserId\\": 1152893538998276700,\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 2\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23\\n },\\n \\"AlbumId\\": \\"51999575\\",\\n \\"PlayMode\\": \\"sequence\\",\\n \\"DailyStudyCnt\\": 2,\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/8838/1600839452498.jpg\\",\\n \\"Title\\": \\"小科学家探索\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0D0C09C2-ADC1-198B-964D-24F4FAD967DB\\"\\n}","type":"json"}]',
@@ -11476,24 +5999,15 @@
'ListSubAlbum' => [
'summary' => '专辑列表。',
'path' => '/v1.0/ssp/listSubAlbum',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
@@ -11507,68 +6021,22 @@
'description' => 'request',
'type' => 'object',
'properties' => [
- 'CategoryId' => [
- 'title' => '分类ID',
- 'description' => '分类ID',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '80011',
- ],
- 'AlbumId' => [
- 'title' => '专辑ID',
- 'description' => '专辑ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4476001',
- ],
- 'Title' => [
- 'title' => '专辑标题',
- 'description' => '专辑标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '睡前故事',
- ],
+ 'CategoryId' => ['title' => '分类ID', 'description' => '分类ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '80011'],
+ 'AlbumId' => ['title' => '专辑ID', 'description' => '专辑ID', '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',
- ],
+ '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',
- ],
+ 'DeviceId' => ['title' => '设备ID', 'type' => 'string', 'docRequired' => true, 'example' => '5874DBCCA3038FAA1A70A8060F07F26D'],
+ 'UserId' => ['title' => '用户ID', 'type' => 'string', 'docRequired' => true, 'example' => '1152893538998276761'],
],
'required' => true,
'docRequired' => true,
@@ -11583,26 +6051,11 @@
'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,
- ],
+ '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,
@@ -11617,26 +6070,11 @@
'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,
- ],
+ '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,
@@ -11650,43 +6088,16 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', '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',
- ],
+ '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' => '专辑List',
@@ -11694,38 +6105,11 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '记录ID',
- 'description' => '记录ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CategoryId' => [
- 'title' => '专辑分类ID',
- 'description' => '专辑分类ID',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '80011',
- ],
- 'AlbumId' => [
- 'title' => '专辑ID',
- 'description' => '专辑ID',
- 'type' => 'string',
- 'example' => '4476001',
- ],
- 'Title' => [
- 'title' => '专辑标题',
- 'description' => '专辑标题',
- 'type' => 'string',
- 'example' => '睡前故事',
- ],
- 'CoverUrl' => [
- 'title' => '专辑封面',
- 'description' => '专辑封面',
- 'type' => 'string',
- 'example' => 'https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg',
- ],
+ 'Id' => ['title' => '记录ID', 'description' => '记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CategoryId' => ['title' => '专辑分类ID', 'description' => '专辑分类ID', 'type' => 'integer', 'format' => 'int32', 'example' => '80011'],
+ 'AlbumId' => ['title' => '专辑ID', 'description' => '专辑ID', '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' => '定时信息',
@@ -11735,74 +6119,29 @@
'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' => '定时任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
+ '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' => '定时任务ID', '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',
- ],
+ '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' => '请求ID',
- 'type' => 'string',
- 'example' => 'CB13B8D7-37FB-1B3E-8EB9-65BB413267E1',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"TotalCount\\": 3,\\n \\"TotalPageCount\\": 1,\\n \\"HasNext\\": true,\\n \\"DataList\\": [\\n {\\n \\"Id\\": 1,\\n \\"CategoryId\\": 80011,\\n \\"AlbumId\\": \\"4476001\\",\\n \\"Title\\": \\"睡前故事\\",\\n \\"CoverUrl\\": \\"https://ailabs.alibabausercontent.com/images/17825/jknoamc2.jpg\\",\\n \\"ScheduleInfo\\": {\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"Hour\\": 12,\\n \\"Minute\\": 23,\\n \\"ScheduleId\\": 0\\n },\\n \\"TotalEpisode\\": 23,\\n \\"Sequence\\": 1,\\n \\"IsAdded\\": true\\n }\\n ]\\n },\\n \\"RequestId\\": \\"CB13B8D7-37FB-1B3E-8EB9-65BB413267E1\\"\\n}","type":"json"}]',
@@ -11811,24 +6150,15 @@
'ListSubscriptionAlbumCategory' => [
'summary' => '专辑分类。',
'path' => '/v1.0/ssp/listSubscriptionAlbumCategory',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
@@ -11836,13 +6166,7 @@
[
'name' => 'CategoryName',
'in' => 'query',
- 'schema' => [
- 'title' => '分类名称',
- 'description' => '分类名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '儿歌',
- ],
+ 'schema' => ['title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'required' => false, 'example' => '儿歌'],
],
],
'responses' => [
@@ -11850,19 +6174,8 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '附加信息', 'description' => '附加信息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
'title' => '分类List',
'description' => '分类List',
@@ -11870,288 +6183,29 @@
'items' => [
'type' => 'object',
'properties' => [
- 'CategoryId' => [
- 'title' => '分类ID',
- 'description' => '分类ID',
- 'type' => 'string',
- 'example' => '80011',
- ],
- 'CategoryName' => [
- 'title' => '分类名称',
- 'description' => '分类名称',
- 'type' => 'string',
- 'example' => '儿童',
- ],
+ 'CategoryId' => ['title' => '分类ID', 'description' => '分类ID', 'type' => 'string', 'example' => '80011'],
+ 'CategoryName' => ['title' => '分类名称', 'description' => '分类名称', 'type' => 'string', 'example' => '儿童'],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '60E7A523-9766-1D07-87A2-6E587420C59B',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '60E7A523-9766-1D07-87A2-6E587420C59B'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'IdempotentParameterMismatch',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": [\\n {\\n \\"CategoryId\\": \\"80011\\",\\n \\"CategoryName\\": \\"儿童\\"\\n }\\n ],\\n \\"RequestId\\": \\"60E7A523-9766-1D07-87A2-6E587420C59B\\"\\n}","type":"json"}]',
'title' => '专辑分类',
],
- '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' => '专辑ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '51999575',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => '附加信息',
- 'description' => '附加信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Result' => [
- 'title' => '专辑内容',
- 'description' => '专辑内容',
- 'type' => 'object',
- 'properties' => [
- 'AlbumId' => [
- 'title' => '专辑ID',
- 'description' => '专辑ID',
- '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' => '专辑内容List',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '专辑内容ID',
- 'description' => '专辑内容ID',
- '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' => '请求ID',
- '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"}]',
- 'title' => '获取专辑信息',
- ],
- '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' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGENAME:apk包名,Android应用客户链路的编码类型 - SKILLID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'IdType' => [
- 'description' => '用户Id的类型 - OPENID:默认的用户ID标识 - UNIONID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- ],
- 'Id' => [
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '服务返回结果',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => 'Id of the request',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '用户信息不存在',
- ],
- 'Code' => [
- 'description' => '服务返回的状态码',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Result' => [
- 'description' => '未读留言条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"用户信息不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": 10\\n}","errorExample":""},{"type":"xml","example":"<GetUnreadMessageCountResponse>\\n <Message>用户信息不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>10</Result>\\n</GetUnreadMessageCountResponse>","errorExample":""}]',
- 'title' => '查询未读留言条数',
- ],
'ListUserMessage' => [
'summary' => '查询用户的留言消息列表,基于查询条件开始时间,查询条数返回结果。',
'path' => '/v1.0/ssp/listUserMessage',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
@@ -12163,23 +6217,12 @@
[
'name' => 'BeforeTime',
'in' => 'query',
- 'schema' => [
- 'description' => '某个时间点之后',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-07-27 14:06:55.984',
- ],
+ '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',
- ],
+ 'schema' => ['description' => '查询条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'UserInfo',
@@ -12194,38 +6237,18 @@
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
'description' => '用户Id的类型 - OPENID:默认的用户ID标识 - UNIONID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -12238,17 +6261,8 @@
'description' => '服务返回结果',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'Id of the request',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '外部userId映射关系不存在',
- ],
- 'Code' => [
- 'description' => '服务返回的状态码 SUCCESS为成功 否则均为失败',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
+ 'Message' => ['title' => 'Id of the request', 'description' => '错误信息', 'type' => 'string', 'example' => '外部userId映射关系不存在'],
+ 'Code' => ['description' => '服务返回的状态码 SUCCESS为成功 否则均为失败', 'type' => 'string', 'example' => 'SUCCESS'],
'Result' => [
'description' => '用户留言查询结果列表',
'type' => 'array',
@@ -12256,57 +6270,16 @@
'description' => '留言详情',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '留言id',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'GmtCreate' => [
- 'description' => '留言发出时间',
- 'type' => 'string',
- 'example' => '2022-07-27 14:06:27.000',
- ],
- 'Status' => [
- 'description' => '留言状态,0为未读,1为已读',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Source' => [
- 'description' => '消息来源于app/box',
- 'type' => 'string',
- 'example' => 'app',
- ],
- 'Type' => [
- 'description' => '目前只有audio',
- 'type' => 'string',
- 'example' => 'audio',
- ],
- 'Content' => [
- 'description' => '留言文本',
- 'type' => 'string',
- 'example' => '哈哈哈',
- ],
- 'Url' => [
- 'description' => '留言音频链接',
- 'type' => 'string',
- 'example' => 'http://xx',
- ],
- 'SourceUuid' => [
- 'description' => '来源设备ID',
- 'type' => 'string',
- 'example' => 'AF188**065EE4B**DD68CE**951D84D4',
- ],
- 'DeviceName' => [
- 'description' => '设备名称',
- 'type' => 'string',
- 'example' => '卧室的小芳',
- ],
- 'Pic' => [
- 'description' => '设备图片',
- 'type' => 'string',
- 'example' => 'http://xx',
- ],
+ 'Id' => ['description' => '留言id', 'type' => 'string', 'example' => '123456'],
+ 'GmtCreate' => ['description' => '留言发出时间', 'type' => 'string', 'example' => '2022-07-27 14:06:27.000'],
+ 'Status' => ['description' => '留言状态,0为未读,1为已读', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Source' => ['description' => '消息来源于app/box', 'type' => 'string', 'example' => 'app'],
+ 'Type' => ['description' => '目前只有audio', 'type' => 'string', 'example' => 'audio'],
+ 'Content' => ['description' => '留言文本', 'type' => 'string', 'example' => '哈哈哈'],
+ 'Url' => ['description' => '留言音频链接', 'type' => 'string', 'example' => 'http://xx'],
+ 'SourceUuid' => ['description' => '来源设备ID', 'type' => 'string', 'example' => 'AF188**065EE4B**DD68CE**951D84D4'],
+ 'DeviceName' => ['description' => '设备名称', 'type' => 'string', 'example' => '卧室的小芳'],
+ 'Pic' => ['description' => '设备图片', 'type' => 'string', 'example' => 'http://xx'],
],
],
],
@@ -12317,676 +6290,190 @@
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"123456\\",\\n \\"GmtCreate\\": \\"2022-07-27 14:06:27.000\\",\\n \\"Status\\": 0,\\n \\"Source\\": \\"app\\",\\n \\"Type\\": \\"audio\\",\\n \\"Content\\": \\"哈哈哈\\",\\n \\"Url\\": \\"http://xx\\",\\n \\"SourceUuid\\": \\"AF188**065EE4B**DD68CE**951D84D4\\",\\n \\"DeviceName\\": \\"卧室的小芳\\",\\n \\"Pic\\": \\"http://xx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListUserMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>\\n <Id>123456</Id>\\n <GmtCreate>2022-07-27 14:06:27.000</GmtCreate>\\n <Status>0</Status>\\n <Source>app</Source>\\n <Type>audio</Type>\\n <Content>哈哈哈</Content>\\n <Url>http://xx</Url>\\n <SourceUuid>AF188**065EE4B**DD68CE**951D84D4</SourceUuid>\\n <DeviceName>卧室的小芳</DeviceName>\\n <Pic>http://xx</Pic>\\n </Result>\\n</ListUserMessageResponse>","errorExample":""}]',
'title' => '查询用户留言消息列表',
],
- 'ReadMessage' => [
- 'summary' => '将某一条留言设置为已读状态。',
- 'path' => '/v1.0/ssp/readMessage',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ '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' => [],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'],
'parameters' => [
[
'name' => 'UserInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '用户信息',
+ 'description' => '用户信息- userId',
'type' => 'object',
'properties' => [
'EncodeType' => [
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGENAME:apk包名,Android应用客户链路的编码类型 - SKILLID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
- ],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。', 'type' => 'string', 'required' => true, 'example' => '1414895629783187053'],
'IdType' => [
- 'description' => ' '."\n"
- .'用户Id的类型 - OPENID:默认的用户ID标识 - UNIONID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => 'ID 类型',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123L',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['description' => 'ID 值', 'type' => 'string', 'required' => true, 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg=='],
+ 'OrganizationId' => ['description' => '组织ID,IdType设置为UNION_ID时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '暂无'],
],
'required' => true,
],
],
[
- 'name' => 'MessageId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '留言id',
- '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' => '外部userId映射关系不存在',
- ],
- 'Code' => [
- 'description' => '服务返回的状态码,只有SUCCESS为成功,否则均为失败',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Result' => [
- 'description' => '已读成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<ReadMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>true</Result>\\n</ReadMessageResponse>","errorExample":""}]',
- 'title' => '已读一条留言',
- ],
- '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' => '留言url',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xx',
- ],
- ],
- [
- 'name' => 'UserInfo',
+ 'name' => 'DeviceInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
+ 'description' => '设备标识信息。',
'type' => 'object',
'properties' => [
'EncodeType' => [
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGENAME:apk包名,Android应用客户链路的编码类型 - SKILLID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,此处填写PROJECT_ID。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
- 'enum' => [
- 'PROJECT_ID',
- ],
+ 'enum' => ['PROJECT_ID'],
],
'EncodeKey' => [
- 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
+ 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。',
'type' => 'string',
'required' => true,
- 'example' => '123L',
+ 'example' => '1414895629783187053',
+ 'enum' => [],
],
'IdType' => [
- 'description' => '用户Id的类型 - OPENID:默认的用户ID标识 - UNIONID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'Id' => [
- 'description' => ' '."\n"
- .'用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123L',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['UNION_ID', 'OPEN_ID'],
],
+ 'Id' => ['description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM='],
+ 'OrganizationId' => ['description' => '组织ID,**IdType**设置为**UNION_ID**时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '暂无'],
],
'required' => true,
],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '服务返回结果',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => 'Id of the request',
- 'description' => '错误信息,存在即发送失败',
- 'type' => 'string',
- 'example' => '外部userId映射关系不存在',
- ],
- 'Code' => [
- 'description' => '服务返回的状态码,SUCCESS为成功,否则均为失败',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Result' => [
- 'description' => '留言发送结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SendMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>true</Result>\\n</SendMessageResponse>","errorExample":""}]',
- 'title' => '发送留言',
- ],
- 'CreateAlarm' => [
- 'summary' => '创建一个闹钟,支持单次、每周、法定工作日三种类型。',
- 'path' => '/v1.0/ssp/createAlarm',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
[
- 'AliGenie_Auth_SPI' => [],
+ 'name' => 'BotId',
+ 'in' => 'query',
+ 'schema' => ['description' => '机器人ID。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
[
- 'name' => 'Payload',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'Type',
+ 'in' => 'query',
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
- 'type' => 'object',
- 'properties' => [
- 'ScheduleInfo' => [
- 'title' => '调度信息',
- 'description' => '调度信息',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '调度类型/循环类型',
- 'description' => '调度类型/循环类型:'."\n"
- .'ONCE -> 单次,WEEKLY -> 周循环,STATUTORY_WORKING_DAY ->法定工作日',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ONCE',
- 'enum' => [
- 'ONCE',
- 'WEEKLY',
- 'STATUTORY_WORKING_DAY',
- ],
- ],
- 'Once' => [
- 'title' => '单次',
- 'description' => '单次::循环类型为ONCE时,该属性可用',
- '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' => '周循环:循环类型为WEEKLY时,该属性可用',
- 'type' => 'object',
- 'properties' => [
- 'DaysOfWeek' => [
- 'title' => '周几触发集合',
- 'description' => '周几触发集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
- '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' => '法定工作日:循环类型为STATUTORY_WORKING_DAY时,该属性可用',
- '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' => '铃声类别id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- 'MusicTypeName' => [
- 'title' => '音乐类别名称',
- 'description' => '铃声类别名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx音乐',
- ],
- 'MusicId' => [
- 'title' => '音乐id',
- 'description' => '铃声id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- 'MusicName' => [
- 'title' => '音乐名称',
- 'description' => '铃声名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx铃声',
- ],
- 'MusicUrl' => [
- 'title' => '音乐url',
- 'description' => '铃声url',
- '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,
+ 'description' => '请求类型:获取每日推荐、热歌,或风格歌单',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['STYLE' => '风格歌单', 'DAILY_REC' => '每日推荐', 'HOT' => '热歌'],
+ 'example' => 'DAILY_REC',
],
],
[
- 'name' => 'UserInfo',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'Style',
+ 'in' => 'query',
'schema' => [
- 'title' => '用户标识信息',
- 'description' => '用户标识信息',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
+ 'description' => '请求类型为 STYLE 时必填。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['钢琴' => '钢琴', '抖音' => '抖音', '欢快' => '欢快', '轻音乐' => '轻音乐', '流行' => '流行', 'DJ' => 'DJ'],
+ 'example' => '轻音乐',
],
],
[
- 'name' => 'DeviceInfo',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
+ 'name' => 'Count',
+ 'in' => 'query',
+ 'schema' => ['description' => '推荐结果的数量', 'type' => 'string', 'required' => false, 'example' => '6'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求结果状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'xx为空',
- ],
+ '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' => '闹钟id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
+ 'description' => '请求结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '服务的实际返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['description' => '内容的来源', 'type' => 'string', 'example' => 'KG'],
+ 'RawId' => ['description' => '内容的三方id', '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' => '稻香'],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlarmResponse>\\n <Code>200</Code>\\n <Message>xx为空</Message>\\n <Result>1234567</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</CreateAlarmResponse>","errorExample":""}]',
- 'title' => '创建闹钟',
- 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5C5809B4-F465-52E0-9A8B-61396F9E593B\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"KG\\",\\n \\"RawId\\": \\"550144364\\",\\n \\"Cover\\": \\"http://img4.kuwo.cn/star/albumcover/120/78/77/1688821132.jpg\\",\\n \\"Authors\\": [\\n \\"[\\\\\\"周杰伦\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"稻香\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '移动轻纳管推荐接口',
+ 'description' => '根据 Type 区分场景(每日推荐、热歌等)即可。',
],
- 'DeleteAlarms' => [
- 'summary' => '删除闹钟,可以同时删除多个。',
- 'path' => '/v1.0/ssp/deleteAlarms',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PlayAndPauseControl' => [
+ 'summary' => '播放暂停控制。',
+ 'path' => '/v1.0/ssp/PlayAndPauseControl',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
+ 'name' => 'OpenPlayAndPauseControlParam',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
+ 'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'UserId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'AccessKeyId' => [
- 'title' => '调用方',
- 'type' => 'string',
- 'required' => true,
- ],
- 'DeviceId' => [
+ 'OpenPlayAndPauseCommand' => [
+ 'description' => '播放:Play;暂停:Pause。',
'type' => 'string',
'required' => true,
- ],
- 'AlarmIds' => [
- 'title' => '待删除闹钟',
- 'description' => '待删除闹钟',
- 'type' => 'array',
- 'format' => 'int64',
- 'items' => [
- 'description' => '删除的闹总id集合',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1234567',
- ],
- 'required' => true,
+ 'example' => 'Play',
+ 'enum' => ['Play', 'Pause'],
],
],
'required' => true,
@@ -12994,112 +6481,47 @@
],
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -13108,96 +6530,54 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult',
- 'description' => 'AmpResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '闹钟服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '闹钟id为空',
- ],
- 'Result' => [
- 'description' => '删除闹钟是否执行成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"闹钟id为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlarmsResponse>\\n <Code>200</Code>\\n <Message>闹钟id为空</Message>\\n <Result>true</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</DeleteAlarmsResponse>","errorExample":""}]',
- 'title' => '批量删除闹钟',
- 'responseParamsDescription' => '仅请求返回的状态码为200时为成功,否则均为失败',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PlayAndPauseControlResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PlayAndPauseControlResponse>","errorExample":""}]',
+ 'title' => '播放暂停控制',
],
- 'GetAlarm' => [
- 'summary' => '获取某一个闹钟详细信息。',
- 'path' => '/v1.0/ssp/getAlarm',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PlayModeControl' => [
+ 'summary' => '播放模式切换。',
+ 'path' => '/v1.0/ssp/PlayModeControl',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
+ 'name' => 'OpenPlayModeControlRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
+ 'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'UserId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'AccessKeyId' => [
- 'title' => '调用方',
- 'type' => 'string',
- 'required' => true,
- ],
- 'DeviceId' => [
+ 'OpenPlayMode' => [
+ 'description' => '播放模式'."\n"
+ ."\n"
+ .'列表循环:Repeat,;随机:Shuffle,;单曲循环:RepeatOne,;普通模式:Normal;',
'type' => 'string',
'required' => true,
- ],
- 'AlarmId' => [
- 'description' => '闹钟id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1234567',
+ 'example' => 'Normal',
+ 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'],
],
],
'required' => true,
@@ -13205,112 +6585,46 @@
],
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -13319,413 +6633,108 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult',
- 'description' => 'AmpResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '闹钟服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'id为空',
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'title' => '模型数据',
- 'description' => '闹钟详情',
+ 'description' => '服务的实际返回结果',
'type' => 'object',
'properties' => [
- 'AlarmId' => [
- 'title' => '闹钟id',
- 'description' => '闹钟id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567',
- ],
- 'ScheduleTypeDesc' => [
- 'title' => '循环类型描述',
- 'description' => '循环类型中文描述',
- 'type' => 'string',
- 'example' => '单次',
- ],
- 'TriggerDateDesc' => [
- 'title' => '触发日期描述(单次)',
- 'description' => '触发日期描述(单次)',
- 'type' => 'string',
- 'example' => '2022-07-29',
- ],
- 'TriggerTimeDesc' => [
- 'title' => '触发时间描述',
- 'description' => '触发时间描述',
+ 'OpenPlayMode' => [
+ 'description' => '播放模式'."\n"
+ ."\n"
+ .'列表循环:Repeat,;随机:Shuffle,;单曲循环:RepeatOne,;普通模式:Normal;',
'type' => 'string',
- 'example' => '10:00',
- ],
- 'ScheduleInfo' => [
- 'title' => '调度信息',
- 'description' => '调度信息',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '循环类型',
- 'description' => '调度类型/循环类型: ONCE -> 单次,WEEKLY -> 周循环,STATUTORYWORKINGDAY ->法定工作日',
- 'type' => 'string',
- 'example' => 'ONCE',
- 'enum' => [
- 'ONCE',
- 'WEEKLY',
- 'STATUTORY_WORKING_DAY',
- ],
- ],
- 'Once' => [
- 'title' => '单次',
- 'description' => '单次::循环类型为ONCE时,该属性可用',
- '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' => '法定工作日:循环类型为STATUTORYWORKINGDAY时,该属性可用',
- 'type' => 'object',
- 'properties' => [
- 'Hour' => [
- 'title' => '触发时间:时',
- 'description' => '触发时间:时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Minute' => [
- 'title' => '触发时间:分',
- 'description' => '触发时间:分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- 'Weekly' => [
- 'title' => '周循环',
- 'description' => '周循环:循环类型为WEEKLY时,该属性可用',
- 'type' => 'object',
- 'properties' => [
- 'Hour' => [
- 'title' => '触发时间:时',
- 'description' => '触发时间:时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Minute' => [
- 'title' => '触发时间:分'."\n",
- 'description' => '触发时间:分'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'DaysOfWeek' => [
- 'title' => '周几触发集合',
- 'description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
- 'type' => 'array',
- 'items' => [
- 'description' => '周一',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- ],
- ],
- 'MusicInfo' => [
- 'title' => '音乐信息',
- 'description' => '铃声信息',
- 'type' => 'object',
- 'properties' => [
- 'MusicType' => [
- 'title' => '音乐类别id',
- 'description' => '铃声类别id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MusicTypeName' => [
- 'title' => '音乐类别名称',
- 'description' => '铃声类别名称',
- 'type' => 'string',
- 'example' => 'xx音乐',
- ],
- 'MusicId' => [
- 'title' => '音乐id',
- 'description' => '铃声id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MusicName' => [
- 'title' => '音乐名称',
- 'description' => '铃声名称',
- 'type' => 'string',
- 'example' => 'xx铃声',
- ],
- 'MusicUrl' => [
- 'title' => '音乐url',
- 'description' => '铃声url',
- 'type' => 'string',
- 'example' => 'http://xx',
- ],
- ],
- ],
- 'Volume' => [
- 'title' => '音量',
- 'description' => '铃声音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Status' => [
- 'title' => '状态 0 正常 1 删除 2 关闭',
- 'description' => '状态 0 正常 1 删除 2 关闭',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
+ 'example' => 'Normal',
+ 'enum' => ['Repeat', 'Shuffle', 'RepeatOne', 'Normal'],
],
],
],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
- ],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"id为空\\",\\n \\"Result\\": {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 123454321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAlarmResponse>\\n <Code>200</Code>\\n <Message>id为空</Message>\\n <Result>\\n <AlarmId>1234567</AlarmId>\\n <UserId>123454321</UserId>\\n <Uuid>AF18***065EE4BD***68CEFD9***84D4</Uuid>\\n <ScheduleTypeDesc>单次</ScheduleTypeDesc>\\n <TriggerDateDesc>2022-07-29</TriggerDateDesc>\\n <TriggerTimeDesc>10:00</TriggerTimeDesc>\\n <ScheduleInfo>\\n <Type>ONCE</Type>\\n <Once>\\n <Year>2022</Year>\\n <Month>7</Month>\\n <Day>29</Day>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </Once>\\n <StatutoryWorkingDay>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </StatutoryWorkingDay>\\n <Weekly>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n <DaysOfWeek>1</DaysOfWeek>\\n </Weekly>\\n </ScheduleInfo>\\n <MusicInfo>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx音乐</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx铃声</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </MusicInfo>\\n <Volume>40</Volume>\\n <Status>0</Status>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</GetAlarmResponse>","errorExample":""}]',
- 'title' => '获取单个闹钟详情',
- 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"OpenPlayMode\\": \\"Normal\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PlayModeControlResponse>\\n <Code>200</Code>\\n <Result>\\n <openPlayMode>Normal</openPlayMode>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PlayModeControlResponse>","errorExample":""}]',
+ 'title' => '播放模式切换',
],
- 'ListAlarms' => [
- 'summary' => '查询设备某一个用户的闹钟列表,分页查询。',
- 'path' => '/v1.0/ssp/listAlarm',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'PreviousAndNextControl' => [
+ 'summary' => '对创建的播放列表中的内容进行上下一首控制。',
+ 'path' => '/v1.0/ssp/PreviousAndNextControl',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
+ 'name' => 'OpenControlPlayingListRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
+ 'description' => '业务参数',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'title' => '当前页',
- 'description' => '当前页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页条数',
- 'description' => '每页条数 :最大值100',
- '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,
- ],
+ 'Cmd' => ['description' => '下一首:NEXT;上一首:PREVIOUS', 'type' => 'string', 'required' => true, 'example' => 'NEXT'],
+ 'IsFromDevice' => ['description' => '是否设备发起,默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'ExtendInfo' => ['type' => 'object', 'required' => false],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。` SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。 `UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -13734,482 +6743,128 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult',
- 'description' => 'AmpResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '闹钟服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '设备账号未关联',
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '闹钟列表结果集合',
+ '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' => '每页条数:最大100,超过100按100处理',
- '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' => '闹钟id',
- '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' => '调度类型/循环类型: ONCE -> 单次,WEEKLY -> 周循环,STATUTORYWORKINGDAY ->法定工作日',
- 'type' => 'string',
- 'example' => 'ONCE',
- 'enum' => [
- 'ONCE',
- 'WEEKLY',
- 'STATUTORY_WORKING_DAY',
- ],
- ],
- 'Once' => [
- 'title' => '单次',
- 'description' => '单次::循环类型为ONCE时,该属性可用',
- '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' => '周循环:循环类型为WEEKLY时,该属性可用',
- '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' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'StatutoryWorkingDay' => [
- 'title' => '法定工作日',
- 'description' => '法定工作日:循环类型为STATUTORYWORKINGDAY时,该属性可用',
- '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' => '铃声类别id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MusicTypeName' => [
- 'title' => '音乐类别名称',
- 'description' => '铃声类别名称',
- 'type' => 'string',
- 'example' => 'xx音乐',
- ],
- 'MusicId' => [
- 'title' => '音乐id',
- 'description' => '铃声id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MusicName' => [
- 'title' => '音乐名称',
- 'description' => '铃声名称',
- 'type' => 'string',
- 'example' => 'xx铃声',
- ],
- 'MusicUrl' => [
- 'title' => '音乐url',
- 'description' => '音乐url',
- 'type' => 'string',
- 'example' => 'http://xx',
- ],
- ],
- ],
- 'Volume' => [
- 'title' => '音量',
- 'description' => '铃声音量,默认40',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
- 'Status' => [
- 'title' => '状态 0 正常 1 删除 2 关闭',
- 'description' => '状态 0 正常 1 删除 2 关闭',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
+ 'RawId' => ['description' => '三方id', 'type' => 'string', 'example' => '550144364'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'ximalayav2'],
+ 'AlbumRawId' => ['description' => '三方专辑id', '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' => '是否可以使用oss规则裁剪', 'type' => 'boolean', 'example' => 'false'],
],
],
+ 'PlayMode' => ['description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)', 'type' => 'string', 'example' => 'Repeat'],
+ 'AudioLength' => ['description' => '长度', 'type' => 'integer', 'format' => 'int32', 'example' => '190'],
+ 'Progress' => ['description' => '歌曲播放进度', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'LyricUrl' => ['description' => '歌词url', 'type' => 'string', 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc'],
+ 'Type' => ['description' => 'type (music\\program\\joke\\news\\children_song\\radio等)', 'type' => 'string', 'example' => 'story'],
+ 'Copyright' => ['description' => '版权字段升级为是否可播:0 可播, 1/2 不可播', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ItemUrl' => ['description' => '播放url', 'type' => 'string', 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3'],
+ 'DefaultPlayOrder' => ['description' => 'package 默认播放顺序 0 顺序,1 倒序', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Valid' => ['description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)', 'type' => 'string', 'example' => 'VALID'],
+ 'Pos' => ['description' => '该项在播放列表中的位置', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
- ],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"设备账号未关联\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"AlarmId\\": 1234567,\\n \\"UserId\\": 1234321,\\n \\"Uuid\\": \\"AF18***065EE4BD***68CEFD9***84D4\\",\\n \\"ScheduleTypeDesc\\": \\"单次\\",\\n \\"TriggerDateDesc\\": \\"2022-07-29\\",\\n \\"TriggerTimeDesc\\": \\"10:00\\",\\n \\"ScheduleInfo\\": {\\n \\"Type\\": \\"ONCE\\",\\n \\"Once\\": {\\n \\"Year\\": 2022,\\n \\"Month\\": 7,\\n \\"Day\\": 29,\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n },\\n \\"Weekly\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0,\\n \\"DaysOfWeek\\": [\\n 1\\n ]\\n },\\n \\"StatutoryWorkingDay\\": {\\n \\"Hour\\": 10,\\n \\"Minute\\": 0\\n }\\n },\\n \\"MusicInfo\\": {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx音乐\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx铃声\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n },\\n \\"Volume\\": 40,\\n \\"Status\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<ListAlarmsResponse>\\n <Code>200</Code>\\n <Message>设备账号未关联</Message>\\n <Result>\\n <TotalCount>100</TotalCount>\\n <PageCount>10</PageCount>\\n <PageSize>10</PageSize>\\n <CurrentPage>1</CurrentPage>\\n <Model>\\n <AlarmId>1234567</AlarmId>\\n <UserId>1234321</UserId>\\n <Uuid>AF18***065EE4BD***68CEFD9***84D4</Uuid>\\n <ScheduleTypeDesc>单次</ScheduleTypeDesc>\\n <TriggerDateDesc>2022-07-29</TriggerDateDesc>\\n <TriggerTimeDesc>10:00</TriggerTimeDesc>\\n <ScheduleInfo>\\n <Type>ONCE</Type>\\n <Once>\\n <Year>2022</Year>\\n <Month>7</Month>\\n <Day>29</Day>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </Once>\\n <Weekly>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n <DaysOfWeek>1</DaysOfWeek>\\n </Weekly>\\n <StatutoryWorkingDay>\\n <Hour>10</Hour>\\n <Minute>0</Minute>\\n </StatutoryWorkingDay>\\n </ScheduleInfo>\\n <MusicInfo>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx音乐</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx铃声</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </MusicInfo>\\n <Volume>40</Volume>\\n <Status>0</Status>\\n </Model>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</ListAlarmsResponse>","errorExample":""}]',
- 'title' => '查询闹钟列表',
- 'responseParamsDescription' => '1.仅请求返回的状态码为200时为成功,否则均为失败'."\n"
- .'2.分页返回参数与实际列表数不符合,这里仅为展示',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"550144364\\",\\n \\"Source\\": \\"ximalayav2\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"足球鞋赛车 晚安妈妈\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Large\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Mediam\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Medium\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"Small\\": \\"http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&columns=640&rows=640\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 0,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Type\\": \\"story\\",\\n \\"Copyright\\": 0,\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 0\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<PreviousAndNextControlResponse>\\n <Code>200</Code>\\n <Result>\\n <RawId>550144364</RawId>\\n <Source>ximalayav2</Source>\\n <AlbumRawId>260744</AlbumRawId>\\n <AlbumName>晚安妈妈睡前故事</AlbumName>\\n <Liked>false</Liked>\\n <Singer>晚安妈妈</Singer>\\n <Title>足球鞋赛车 晚安妈妈</Title>\\n <Cover>\\n <Img>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Img>\\n <Large>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Large>\\n <Mediam>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Mediam>\\n <Medium>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Medium>\\n <Small>http://imgopen.xmcdn.com/group58/M06/08/9B/wKgLglzTyTjiOy0oAAcOTv16ohg815.jpg!op_type=3&amp;columns=640&amp;rows=640</Small>\\n <CanResize>false</CanResize>\\n </Cover>\\n <PlayMode>Repeat</PlayMode>\\n <AudioLength>190</AudioLength>\\n <Progress>0</Progress>\\n <Type>story</Type>\\n <Copyright>0</Copyright>\\n <ItemUrl>https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3</ItemUrl>\\n <DefaultPlayOrder>1</DefaultPlayOrder>\\n <Valid>VALID</Valid>\\n <Pos>0</Pos>\\n </Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</PreviousAndNextControlResponse>","errorExample":""}]',
+ 'title' => '上下首控制',
],
- 'ListMusic' => [
- 'summary' => '基于音乐类型查询该类型下的铃声列表。',
- 'path' => '/v1.0/ssp/listMusic',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ProgressControl' => [
+ 'summary' => '进度控制。',
+ 'path' => '/v1.0/ssp/ProgressControl',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
+ 'name' => 'OpenProgressControlRequest',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
+ 'description' => '业务参数',
'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' => '铃声类别id,由queryMusicType接口返回',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- 'MusicTypeName' => [
- 'title' => '音乐类别名称',
- 'description' => '铃声类别名称,由queryMusicType接口返回',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx音乐',
- ],
- 'MusicId' => [
- 'title' => '音乐id',
- 'description' => '铃声id,扩展字段,暂不用传',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- 'MusicName' => [
- 'title' => '音乐名称',
- 'description' => '铃声名称,扩展字段,暂不用传',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx铃声',
- ],
- 'CurrentPage' => [
- 'title' => '当前页',
- 'description' => '当前页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页条数',
- 'description' => '每页条数:最大值100',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'Progress' => ['description' => '歌曲进度。单位秒', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12'],
+ 'ExtendInfo' => ['description' => '扩展信息', 'type' => 'object', 'required' => false],
],
'required' => true,
],
],
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的用户ID标识。 `UNION_ID`: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'`PACKAGE_NAME`:apk包名,Android应用客户链路的编码类型。 `SKILL_ID`:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是`SKILL_ID`时,其值为应用的Skill ID。 编码类型是`PACKAGE_NAME`时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'`OPEN_ID`:默认的设备ID标识。` UNION_ID`: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'rV/XSgPuxZjx/hN3iw8U+e8ouRjKOX95tn1a0kwb2+Ao6Q1CAxASJUZDWtlk1r43LWcVW6fvY1Rr4sEPFodpnA=='],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => true,
],
@@ -14218,133 +6873,34 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult',
- 'description' => 'AmpResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '闹钟服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '音乐类型名称为空',
- ],
- 'Result' => [
- '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' => '每页条数:最大值100,超过100按100处理',
- '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' => '铃声类别id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MusicTypeName' => [
- 'title' => '音乐类别名称',
- 'description' => '铃声类别名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MusicId' => [
- 'title' => '音乐id',
- 'description' => '铃声id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MusicName' => [
- 'title' => '音乐名称',
- 'description' => '铃声名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MusicUrl' => [
- 'title' => '音乐url',
- 'description' => '铃声url',
- 'type' => 'string',
- 'example' => 'http://xx',
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
- ],
+ 'Code' => ['description' => '调用返回码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['description' => '服务的实际返回结果', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '10002398812'],
+ 'Success' => ['description' => '调用是否成功,true成功,false失败。失败时请关注Message信息', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"音乐类型名称为空\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Model\\": [\\n {\\n \\"MusicType\\": 1,\\n \\"MusicTypeName\\": \\"xx\\",\\n \\"MusicId\\": 1,\\n \\"MusicName\\": \\"xx\\",\\n \\"MusicUrl\\": \\"http://xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<ListMusicResponse>\\n <Code>200</Code>\\n <Message>音乐类型名称为空</Message>\\n <Result>\\n <TotalCount>100</TotalCount>\\n <PageCount>10</PageCount>\\n <PageSize>10</PageSize>\\n <CurrentPage>1</CurrentPage>\\n <Model>\\n <MusicType>1</MusicType>\\n <MusicTypeName>xx</MusicTypeName>\\n <MusicId>1</MusicId>\\n <MusicName>xx</MusicName>\\n <MusicUrl>http://xx</MusicUrl>\\n </Model>\\n </Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</ListMusicResponse>","errorExample":""}]',
- 'title' => '查询铃声分页列表',
- 'responseParamsDescription' => '仅请求返回的状态码为200时为成功,否则均为失败',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ProgressControlResponse>\\n <Code>200</Code>\\n <Result>true</Result>\\n <Message>success</Message>\\n <RequestId>10002398812</RequestId>\\n <Success>true</Success>\\n</ProgressControlResponse>","errorExample":""}]',
+ 'title' => '进度控制',
],
'QueryMusicType' => [
'summary' => '获取设备支持的闹钟音乐类型集合。',
'path' => '/v1.0/ssp/queryMusicType',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
@@ -14357,23 +6913,10 @@
'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,
- ],
+ 'RequestId' => ['type' => 'string', 'required' => true],
+ 'UserId' => ['type' => 'string', 'required' => true],
+ 'AccessKeyId' => ['title' => '调用方', 'type' => 'string', 'required' => true],
+ 'DeviceId' => ['type' => 'string', 'required' => true],
],
'required' => false,
],
@@ -14387,23 +6930,14 @@
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'HOFF****my7Iw=',
- ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
'IdType' => [
'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
@@ -14411,25 +6945,10 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -14443,23 +6962,14 @@
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
'IdType' => [
'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
'EncodeType' => [
'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
@@ -14467,25 +6977,10 @@
'type' => 'string',
'required' => true,
'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -14499,18 +6994,8 @@
'description' => 'AmpResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '闹钟服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '设备账号未关联',
- ],
+ 'Code' => ['description' => '闹钟服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '设备账号未关联'],
'Result' => [
'description' => '铃声类型列表',
'type' => 'array',
@@ -14518,27 +7003,12 @@
'description' => '铃声类型详情',
'type' => 'object',
'properties' => [
- 'MusicType' => [
- 'title' => '铃声类型id',
- 'description' => '铃声类型id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MusicTypeName' => [
- 'title' => 'musicTypeName',
- 'description' => '铃声类别名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MusicType' => ['title' => '铃声类型id', 'description' => '铃声类型id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MusicTypeName' => ['title' => 'musicTypeName', 'description' => '铃声类别名称', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
- ],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881'],
],
],
],
@@ -14547,732 +7017,227 @@
'title' => '获取闹钟音乐类型列表',
'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
],
- 'UpdateAlarm' => [
- 'summary' => '更新闹钟,可以更新触发时间、循环类型、音乐。',
- 'path' => '/v1.0/ssp/updateAlarm',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'QueryUserDeviceListByTmeUserId' => [
+ 'summary' => '通过tme用户id获取授权的天猫精灵用户+设备列表,提供给酷狗云推歌使用',
+ 'path' => '/v1.0/ssp/queryUserDeviceListByTmeUserId',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json', 'application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none'],
'parameters' => [
[
- 'name' => 'Payload',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'TmeUserId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'TME用户id', 'description' => 'TME用户id', 'type' => 'string', 'required' => true, 'example' => 'FDEEDE337BAA780793D72F7F20BEF2F5'],
+ ],
+ [
+ 'name' => 'Sp',
+ 'in' => 'query',
+ 'schema' => ['title' => '"KG":酷狗'."\n"
+ .'"KW":酷我'."\n"
+ .'"QM":Q音', 'description' => '"KG":酷狗'."\n"
+ .'"KW":酷我'."\n"
+ .'"QM":Q音', 'type' => 'string', 'required' => true, 'example' => 'KG'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'ScheduleInfo' => [
- 'title' => '调度信息',
- 'description' => '调度信息',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '860194F7-9593-50EA-8E53-BCEC0D325A00'],
+ 'Code' => ['title' => '响应码', 'description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '响应信息', 'description' => '响应信息', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['title' => '调用是否成功标志', 'description' => '调用是否成功标志', 'type' => 'boolean', 'example' => 'true'],
+ 'Result' => [
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'title' => '调度类型/循环类型',
- 'description' => '调度类型/循环类型:'."\n"
- .'ONCE -> 单次,WEEKLY -> 周循环,STATUTORY_WORKING_DAY ->法定工作日',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'WEEKLY',
- 'enum' => [
- 'ONCE',
- 'WEEKLY',
- 'STATUTORY_WORKING_DAY',
- ],
- ],
- 'Once' => [
- 'title' => '单次',
- 'description' => '单次::循环类型为ONCE时,该属性可用',
- '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' => '周循环:循环类型为WEEKLY时,该属性可用',
- 'type' => 'object',
- 'properties' => [
- 'DaysOfWeek' => [
- 'title' => '周几触发集合',
- 'description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
- 'type' => 'array',
- 'items' => [
- 'description' => '周一',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'Sp' => ['title' => '"KG":酷狗'."\n"
+ .'"KW":酷我'."\n"
+ .'"QM":Q音', 'description' => '"KG":酷狗'."\n"
+ .'"KW":酷我'."\n"
+ .'"QM":Q音', 'type' => 'string', 'example' => 'KG'],
+ 'EncodeType' => ['title' => '实体类型(三方透传即可)', 'description' => '实体类型(三方透传即可)', 'type' => 'string', 'example' => 'PROJECT_ID'],
+ 'EncodeKey' => ['title' => '实体key(三方透传即可)', 'description' => '实体key(三方透传即可)', 'type' => 'string', 'example' => '12****7'],
+ 'AligenieUserInfoList' => [
+ 'title' => '天猫精灵用户列表',
+ 'description' => '天猫精灵用户列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenUserId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => 'R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg=='],
+ 'UserNickname' => ['title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'example' => 'a***e'],
+ 'AuthorizedDeviceList' => [
+ 'title' => '用户授权的设备列表',
+ 'description' => '用户授权的设备列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenDeviceId' => ['title' => '按照天猫精灵开放平台标准加密的设备id', 'description' => '设备id', 'type' => 'string', 'example' => 'fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM='],
+ 'DeviceName' => ['title' => '设备名称', 'description' => '设备名称', 'type' => 'string', 'example' => 'CC'],
+ 'Online' => ['title' => '设备是否在线', 'description' => '设备是否在线', 'type' => 'boolean', 'example' => 'true'],
+ 'TmeProductId' => ['title' => 'TME产品id', 'description' => 'TME产品id', 'type' => 'string'],
+ 'TmeDeviceId' => ['title' => '透出给TME的设备id', 'description' => '透出给TME的设备id', 'type' => 'string'],
+ ],
+ ],
],
- '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' => '法定工作日:循环类型为STATUTORY_WORKING_DAY时,该属性可用',
- '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' => '铃声类别id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12',
- ],
- 'MusicTypeName' => [
- 'title' => '音乐类别名称',
- 'description' => '铃声类别名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx音乐',
- ],
- 'MusicId' => [
- 'title' => '音乐id',
- 'description' => '铃声id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '2',
- ],
- 'MusicName' => [
- 'title' => '音乐名称',
- 'description' => '铃声名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx铃声',
- ],
- 'MusicUrl' => [
- 'title' => '音乐url',
- 'description' => '铃声url',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://music-url.mp3',
- ],
- ],
- 'required' => true,
- ],
- 'AlarmId' => [
- 'title' => '闹钟id',
- 'description' => '闹钟id',
- '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,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"860194F7-9593-50EA-8E53-BCEC0D325A00\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Sp\\": \\"KG\\",\\n \\"EncodeType\\": \\"PROJECT_ID\\",\\n \\"EncodeKey\\": \\"12****7\\",\\n \\"AligenieUserInfoList\\": [\\n {\\n \\"OpenUserId\\": \\"R457Av3qg/OXTwVnFt12z6MwNe0HAS699V6n63OaLdu+VmwvhcNfMzBd+la553wWJhj3kBMjgHq2Y2dyCFoDBg==\\",\\n \\"UserNickname\\": \\"a***e\\",\\n \\"AuthorizedDeviceList\\": [\\n {\\n \\"OpenDeviceId\\": \\"fjwZiYQdtkaI95fHaLNjYcaOA/mxUPzxxw2J5iBiTBnjUCWKwER4TSHCqkBnNOYvGJ4bRZA9KzBB2naS4r/Am0lSe8ECDAAOcJ9QKLFF6DM=\\",\\n \\"DeviceName\\": \\"CC\\",\\n \\"Online\\": true,\\n \\"TmeProductId\\": \\"\\",\\n \\"TmeDeviceId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '通过tme用户id获取授权的天猫精灵用户+设备列表',
+ ],
+ 'ReadMessage' => [
+ 'summary' => '将某一条留言设置为已读状态。',
+ 'path' => '/v1.0/ssp/readMessage',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
- 'description' => '用户标识信息',
+ 'description' => '用户信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
+ 'EncodeType' => [
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGENAME:apk包名,Android应用客户链路的编码类型 - SKILLID:技能ID,云端链路的编码类型',
'type' => 'string',
'required' => true,
- 'example' => 'HOFF****my7Iw=',
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
+ 'EncodeKey' => ['description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
- 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => ' '."\n"
+ .'用户Id的类型 - OPENID:默认的用户ID标识 - UNIONID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['description' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => '123L'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填', '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' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'OPEN_ID',
- 'enum' => [
- 'OPEN_ID',
- 'UNION_ID',
- ],
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'PACKAGE_NAME',
- 'enum' => [
- 'PACKAGE_NAME',
- 'SKILL_ID',
- ],
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
+ 'name' => 'MessageId',
+ 'in' => 'query',
+ 'schema' => ['description' => '留言id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult',
- 'description' => 'AmpResult',
+ 'title' => 'Schema of Response',
+ 'description' => '服务返回结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '闹钟服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'xx为空',
- ],
- 'Result' => [
- 'description' => '更新结果是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '43***28C-A810-5***-8747-EC226A086881',
- ],
+ 'Message' => ['title' => 'Id of the request', 'description' => '错误信息', 'type' => 'string', 'example' => '外部userId映射关系不存在'],
+ 'Code' => ['description' => '服务返回的状态码,只有SUCCESS为成功,否则均为失败', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Result' => ['description' => '已读成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlarmResponse>\\n <Code>200</Code>\\n <Message>xx为空</Message>\\n <Result>true</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</UpdateAlarmResponse>","errorExample":""}]',
- 'title' => '更新闹钟',
- 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<ReadMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>true</Result>\\n</ReadMessageResponse>","errorExample":""}]',
+ 'title' => '已读一条留言',
],
- 'CreateScheduleTask' => [
- 'summary' => '创建定时任务。',
- 'path' => '/v1.0/ssp/CreateScheduleTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ScanCodeBind' => [
+ 'summary' => '带屏设备通过扫描二维码完成用户和设备的激活绑定。',
+ 'path' => '/v1.0/ssp/scanCode',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
- 'type' => 'object',
- 'properties' => [
- 'IdempotentId' => [
- 'title' => '幂等id',
- 'description' => '幂等id',
- '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' => '触发星期,1-7分别代表周一到周日',
- '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',
+ 'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'title' => '编码类型,此处填写PROJECT_ID。',
+ 'description' => '编码类型,此处填写PROJECT_ID。',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '129****0946'],
+ 'IdType' => [
+ 'title' => '设备Id的类型 :'."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
+ 'description' => '设备Id的类型 :'."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '用户标识,填写userOpenId或userUnionId的值。', 'description' => '用户标识,填写userOpenId或userUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '111'],
],
'required' => true,
],
],
[
- 'name' => 'DeviceInfo',
+ 'name' => 'BindReq',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息',
+ 'title' => '扫描绑定入参',
+ 'description' => '扫码绑定入参',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'Code' => ['title' => 'authCode', 'description' => 'authCode', 'type' => 'string', 'required' => true, 'example' => 'ASdfre'],
+ 'ClientId' => ['title' => '产品clientId', 'description' => '产品clientId', '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,
],
@@ -15281,194 +7246,92 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult<Long>',
- 'description' => 'AmpResult<Long>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '调用成功',
- ],
+ 'Message' => ['title' => '结果信息', 'description' => '结果信息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Result' => [
- 'description' => '创建成功的任务id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567',
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'F7E2****B7C94',
+ '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' => '用户OpenId'],
+ 'DeviceOpenId' => ['title' => 'A963*0158', 'description' => 'A963*0158', 'type' => 'string', 'example' => '设备OpenId'],
+ ],
],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '686DF82F-45C4-7DF7-8B67-27B91CFD63A9'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": 1234567,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <Result>1234567</Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</CreateScheduleTaskResponse>","errorExample":""}]',
- 'title' => '创建定时任务',
- 'description' => '根据单次、每日、法定工作日等定时规则,配置生态inside自定义指令数据的触发任务',
- 'responseParamsDescription' => ' 仅服务返回的状态码为200时为成功,否则均表示失败',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"BizType\\": \\"AILABS\\",\\n \\"BizGroup\\": \\"X1\\",\\n \\"UserOpenId\\": \\"用户OpenId\\",\\n \\"DeviceOpenId\\": \\"设备OpenId\\"\\n },\\n \\"RequestId\\": \\"686DF82F-45C4-7DF7-8B67-27B91CFD63A9\\"\\n}","type":"json"}]',
+ 'title' => '通过扫描二维码进行激活绑定',
+ 'description' => '通过扫描设备上的激活绑定相关的二维码信息进行激活绑定。',
],
- 'DeleteScheduleTask' => [
- 'summary' => '删除定时任务。',
- 'path' => '/v1.0/ssp/DeleteScheduleTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ScgSearch' => [
+ 'summary' => '根据选品池ID查询选品池内容。',
+ 'path' => '/v1.0/ssp/scgSearch',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '待删除的调度id',
- 'description' => '待删除的任务id',
- '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' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
- ],
- 'required' => true,
- ],
+ 'name' => 'TopicId',
+ 'in' => 'query',
+ 'schema' => ['title' => '选品池ID 可选:MC201132(民族中国风),MC201136(流行音乐),MC201139(甜蜜爱情),MC201133(民谣),MC201137(放松阅读),MC201138(快乐),PA202029(故事),PA202030(儿歌),PA202028(国学历史),PA202032(百科),PA202031(英文儿歌)', 'description' => '选品池ID 可选:MC201132(民族中国风),MC201136(流行音乐),MC201139(甜蜜爱情),MC201133(民谣),MC201137(放松阅读),MC201138(快乐),PA202029(故事),PA202030(儿歌),PA202028(国学历史),PA202032(百科),PA202031(英文儿歌)', 'type' => 'string', 'required' => true, 'example' => 'MC201132'],
],
[
- 'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'name' => 'ScgFilter',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
- 'description' => '设备标识信息',
+ 'title' => '查询filter',
+ 'description' => '查询filter',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PROJECT_ID',
+ '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,
],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
+ 'UseOffSet' => ['title' => '是否使用pageParam对象分页,offSetParam和pageParam二选一,默认分页模式为pageParam', 'description' => '是否使用pageParam对象分页,offSetParam和pageParam二选一,默认分页模式为pageParam', '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,
- 'example' => '12**45',
],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
+ '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,
- 'example' => '1**2',
],
],
'required' => true,
@@ -15478,199 +7341,165 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult<Boolean>',
- 'description' => 'AmpResult<Boolean>',
+ 'title' => 'result',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '错误码',
- 'description' => '响应码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => '调用成功',
- ],
+ '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' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'F7E2****B7C94',
+ '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' => '封面图片(Img与Large,Medium,Small可能不会同时出现,会出现只有其中一种的情况)', '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' => '是否支持试听'."\n", 'type' => 'boolean', 'example' => 'false'],
+ 'ContentType' => ['title' => '内容类型', 'description' => '内容类型', 'type' => 'string', 'example' => 'MUSIC_CONTENT'],
+ 'Singers' => ['title' => '歌手名', 'description' => '歌手名', 'type' => 'string', 'example' => '黎偌天'],
+ 'AlbumRawId' => ['title' => '专辑ID', 'description' => '专辑ID', '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' => '作者ID'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => '作者ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1795716629'],
+ ],
+ 'IsAudition' => ['title' => '能否试听', 'description' => '能否试听', 'type' => 'boolean', 'example' => 'false'],
+ 'AuthorNames' => [
+ 'title' => '作者姓名',
+ 'description' => '作者姓名',
+ 'type' => 'array',
+ 'items' => ['description' => '作者姓名', 'type' => 'string', 'example' => '"王一鸣Iris", "黎偌天", "薛晨雨"'],
+ ],
+ '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' => '三方内容ID', 'type' => 'string', 'example' => '1795716629'],
+ ],
+ ],
+ 'example' => '{"sourceId":0,"copyright":0,"releaseTime":1196438400000,"hotScore":0.9546929544543479,"tppExtendInfo":"{\\"userEvent\\":\\"前台投放\\",\\"scgTopicName\\":\\"inside民族中国风曲风音乐库\\",\\"scgTopicId\\":\\"MC201132\\"}","source":"xiami","title":"题帕三绝","type":"music","x1Pv30d":10307,"valid":10,"cover":{"img":"http://img.xiami.net/qianxun/07d8ec1a38a5462c3afbfac41413b8af/47244c25fcf3a8f67442d02e3127d023-500x432.jpg","canResize":false},"duration":0,"rawId":"1771626071","albumType":0,"alias":["题帕三绝"],"id":268033175,"supportAudition":false,"contentType":"MUSIC_CONTENT","authorIds":[],"singers":"陈力","albumRawId":"1771626071","album":false,"x1PvTotal":14676,"commCateId":80021001,"finished":0,"isAudition":false,"appIds":[],"authorNames":["陈力","王立平","曹雪芹"],"needCharge":false,"isCharge":false,"category":"audio"}',
],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '73C67BD9-175A-1324-8202-9FAABBB3E6FA'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"调用成功\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <Result>true</Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</DeleteScheduleTaskResponse>","errorExample":""}]',
- 'title' => '删除定时任务',
- 'description' => '根据定时任务id,删除指定定时任务',
- 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"Result\\": [\\n {\\n \\"Source\\": \\"xiami\\",\\n \\"Title\\": \\"那个人\\",\\n \\"Type\\": \\"music\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"canResize\\": false,\\n \\"Large\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Medium\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\",\\n \\"Small\\": \\"http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg\\"\\n },\\n \\"Alias\\": [\\n \\"那个人\\"\\n ],\\n \\"SupportAudition\\": false,\\n \\"ContentType\\": \\"MUSIC_CONTENT\\",\\n \\"Singers\\": \\"黎偌天\\",\\n \\"AlbumRawId\\": \\"1795716629\\",\\n \\"Album\\": false,\\n \\"AlbumType\\": 0,\\n \\"AuthorIds\\": [\\n 1795716629\\n ],\\n \\"IsAudition\\": false,\\n \\"AuthorNames\\": [\\n \\"\\\\\\"王一鸣Iris\\\\\\", \\\\\\"黎偌天\\\\\\", \\\\\\"薛晨雨\\\\\\"\\"\\n ],\\n \\"NeedCharge\\": false,\\n \\"IsCharge\\": \\"false\\",\\n \\"Category\\": \\"audio\\",\\n \\"RawId\\": \\"1795716629\\"\\n }\\n ],\\n \\"RequestId\\": \\"73C67BD9-175A-1324-8202-9FAABBB3E6FA\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ScgSearchResponse>\\n <PageNum>1</PageNum>\\n <Message>OK</Message>\\n <PageSize>10</PageSize>\\n <Result>\\n <Source>xiami</Source>\\n <Title>那个人</Title>\\n <Type>music</Type>\\n <Cover>\\n <Img>http://img.xiami.net/images/album/img59/56/58da2153e3133_2826959_1490690387.jpg</Img>\\n <canResize>false</canResize>\\n </Cover>\\n <Alias>那个人</Alias>\\n <SupportAudition>false</SupportAudition>\\n <ContentType>MUSIC_CONTENT</ContentType>\\n <Singers>黎偌天</Singers>\\n <AlbumRawId>1795716629</AlbumRawId>\\n <Album>false</Album>\\n <AlbumType>0</AlbumType>\\n <AuthorIds>1795716629</AuthorIds>\\n <IsAudition>false</IsAudition>\\n <AuthorNames>\\"王一鸣Iris\\", \\"黎偌天\\", \\"薛晨雨\\"</AuthorNames>\\n <NeedCharge>false</NeedCharge>\\n <IsCharge>false</IsCharge>\\n <Category>audio</Category>\\n <RawId>1795716629</RawId>\\n </Result>\\n <RequestId>73C67BD9-175A-1324-8202-9FAABBB3E6FA</RequestId>\\n <Code>200</Code>\\n</ScgSearchResponse>","errorExample":""}]',
+ 'title' => '根据选品池ID查询选品池内容',
],
- 'GetScheduleTask' => [
- 'summary' => '获取定时任务信息。',
- 'path' => '/v1.0/ssp/GetScheduleTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'SearchContent' => [
+ 'summary' => '按照特定的搜索条件搜索。',
+ 'path' => '/v1.0/ssp/SearchContent',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Payload',
+ 'name' => 'Request',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '服务请求入参',
- 'description' => '服务请求入参',
+ 'description' => '请求参数',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '待查询的调度id',
- 'description' => '待查询的任务id',
- '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',
- ],
+ 'Query' => ['description' => '查询关键字', 'type' => 'string', 'required' => false, 'example' => '周杰伦'],
+ 'Cate' => ['description' => '搜索的范围音乐或者音频'."\n"
+ .'入参枚举 :music | program', 'type' => 'string', 'required' => false, 'example' => 'music'],
+ 'SubCate' => ['description' => '当cate 是music时 可以不传subCate 
如果传subCate 可以为 :'."\n"
+ .'song (歌曲)、 singer(艺人) 、album (专辑)'."\n"
+ ."\n"
+ .'当cate是program时 可以不传subCate '."\n"
+ .'如果传subCate 可以为 :'."\n"
+ .'album (专辑)、audio(节目音频)、radio(电台)', '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' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPENID:默认的用户ID标识-UNIONID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGENAME:apk包名,Android应用客户链路的编码类型-SKILLID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的SkillID;编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的用户标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '用户标识,设置为userOpenId或userUnionId。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => ['description' => '用户Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的用户ID标识。'."\n"
+ .'UNION_ID: 组织维度的用户ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
],
[
'name' => 'DeviceInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '设备标识信息',
'description' => '设备标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '设备标识(deviceOpenId或deviceUnionId)',
- 'description' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
- 'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPENID:默认的设备ID标识-UNIONID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGENAME:apk包名,Android应用客户链路的编码类型-SKILLID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的SkillID;编码类型是PACKAGENAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值'."\n"
+ ."\n"
+ .'编码类型是SKILL_ID时,其值为应用的Skill ID。'."\n"
+ .'编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'EncodeType' => ['description' => '编码类型,获取天猫精灵的设备标识的途径有多种,不同途径对应不同的编码类型。'."\n"
+ ."\n"
+ .'PACKAGE_NAME:apk包名,Android应用客户链路的编码类型。'."\n"
+ .'SKILL_ID:技能ID,云端链路的编码类型。', 'type' => 'string', 'required' => true, 'example' => 'PACKAGE_NAME'],
+ 'Id' => ['description' => '设备标识,设置为deviceOpenId或deviceUnionId。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => ['description' => '设备Id的类型'."\n"
+ ."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,在天猫精灵技能应用开放平台申请过组织后才会有该值。', 'type' => 'string', 'required' => true, 'example' => 'OPEN_ID'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -15679,81 +7508,89 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult<ScheduleOpenResponse>',
- 'description' => 'AmpResult<ScheduleOpenResponse>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '错误码',
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '响应信息',
- 'type' => 'string',
- 'example' => '调用成功',
- ],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'F7E21065-6C21-1158-A2F9-AEFE5CAB7C94',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F12B6147-5925-19E5-A3AD-E1EE1360F34E'],
+ 'Code' => ['description' => 'code编码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => 'message信息', 'type' => 'string', 'example' => 'success'],
'Result' => [
- 'title' => '服务响应出参',
- 'description' => '服务响应出参',
- 'type' => 'object',
- 'properties' => [
- 'ScheduleId' => [
- 'title' => '调度id',
- 'description' => '任务id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567',
- ],
- 'ScheduleType' => [
- 'title' => '调度类型',
- 'description' => '调度类型',
- 'type' => 'string',
- 'example' => 'ONCE',
- 'enum' => [
- 'ONCE',
- 'WEEKLY',
- 'STATUTORY_DAY',
+ 'description' => '返回信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Alias' => [
+ 'description' => '别名',
+ 'type' => 'array',
+ 'items' => ['description' => '别名', 'type' => 'string', 'example' => '超能狂少在都市'],
],
- ],
- 'Cron' => [
- 'title' => '触发cron表达式',
- 'description' => '触发cron表达式',
- '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}}',
+ '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' => '是否可以使用oss规则裁剪', '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' => '三方作者id', 'type' => 'string', 'example' => '123123'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => 'qingting'],
+ 'Id' => ['description' => '作者主键id', 'type' => 'integer', 'format' => 'int64', 'example' => '13597709'],
+ 'Title' => ['description' => '作者标题', 'type' => 'string', 'example' => '播音呆瓜小贼'],
+ 'Description' => ['description' => '作者描述', 'type' => 'string', 'example' => '播音呆瓜小贼'],
+ 'Online' => ['description' => '是否在线', 'type' => 'boolean', 'example' => 'true'],
],
],
],
+ 'Category' => ['description' => '根据所属公共类目转换controlType', 'type' => 'string', 'example' => 'audio'],
+ 'Charge' => ['description' => '是否收费', 'type' => 'boolean', 'example' => 'fasle'],
+ 'CommCateId' => ['description' => '对应的类目id', 'type' => 'integer', 'format' => 'int64', 'example' => '80012017'],
+ 'Cover' => [
+ 'description' => '专辑封面图片',
+ 'type' => 'object',
+ 'properties' => [
+ 'CanResize' => ['description' => '是否可以使用oss规则裁剪', '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' => '中图(Deprecated)', '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' => '内容id', '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' => '根据所属公共类目转换favoriteType', 'type' => 'string', 'example' => 'program'],
+ 'Valid' => ['description' => '是否可播', 'type' => 'string', 'example' => 'VALID'],
+ 'Duration' => ['description' => '时长信息', 'type' => 'integer', 'format' => 'int64', 'example' => '180'],
+ 'AlbumId' => ['description' => '对应的专辑id', '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'],
+ ],
],
],
],
@@ -15761,162 +7598,52 @@
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"调用成功\\",\\n \\"RequestId\\": \\"F7E21065-6C21-1158-A2F9-AEFE5CAB7C94\\",\\n \\"Result\\": {\\n \\"ScheduleId\\": 1234567,\\n \\"ScheduleType\\": \\"ONCE\\",\\n \\"Cron\\": \\"0 10 20 30 6 ? 2022\\",\\n \\"ScheduleStartTime\\": \\"1656577473000\\",\\n \\"ScheduleEndTime\\": \\"1659169473000\\",\\n \\"ActionTopicList\\": [\\n {\\n \\"CustomAction\\": {\\n \\"k1\\": \\"v1\\",\\n \\"k2\\": {\\n \\"key\\": 1\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetScheduleTaskResponse>\\n <Code>200</Code>\\n <Message>调用成功</Message>\\n <RequestId>F7E21065-6C21-1158-A2F9-AEFE5CAB7C94</RequestId>\\n <Result>\\n <Uuid>362*****8C1</Uuid>\\n <ScheduleId>1234567</ScheduleId>\\n <ScheduleType>ONCE</ScheduleType>\\n <Cron>0 10 20 30 6 ? 2022</Cron>\\n <ScheduleStartTime>1656577473000</ScheduleStartTime>\\n <ScheduleEndTime>1659169473000</ScheduleEndTime>\\n <ActionTopicList/>\\n </Result>\\n</GetScheduleTaskResponse>","errorExample":""}]',
- 'title' => '获取定时任务信息',
- 'description' => '根据定时任务id,查询指定定时任务数据详情',
- 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F12B6147-5925-19E5-A3AD-E1EE1360F34E\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Result\\": [\\n {\\n \\"Alias\\": [\\n \\"超能狂少在都市\\"\\n ],\\n \\"Audition\\": false,\\n \\"Authors\\": [\\n {\\n \\"AuthorTypes\\": [\\n \\"ANCHOR\\"\\n ],\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"https://a.jpg\\",\\n \\"Large\\": \\"https://a.jpg\\",\\n \\"Medium\\": \\"https://a.jpg\\",\\n \\"Small\\": \\"https://a.jpg\\"\\n },\\n \\"Gender\\": \\"MALE\\",\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Id\\": 13597709,\\n \\"Title\\": \\"播音呆瓜小贼\\",\\n \\"Description\\": \\"播音呆瓜小贼\\",\\n \\"Online\\": true\\n }\\n ],\\n \\"Category\\": \\"audio\\",\\n \\"Charge\\": true,\\n \\"CommCateId\\": 80012017,\\n \\"Cover\\": {\\n \\"CanResize\\": false,\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\"\\n },\\n \\"Description\\": \\"内容描述\\",\\n \\"HotScore\\": 10,\\n \\"Id\\": 13597709,\\n \\"ItemType\\": \\"ALBUM\\",\\n \\"Source\\": \\"qingting\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Type\\": \\"program\\",\\n \\"Valid\\": \\"VALID\\",\\n \\"Duration\\": 180,\\n \\"AlbumId\\": \\"13123\\",\\n \\"Lyric\\": \\"http://a1231.lrc\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Styles\\": [\\n \\"1231\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchContentResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <Result>\\n <Alias>超能狂少在都市</Alias>\\n <Audition>false</Audition>\\n <Authors>\\n <AuthorTypes>ANCHOR</AuthorTypes>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>https://a.jpg</Img>\\n <Large>https://a.jpg</Large>\\n <Medium>https://a.jpg</Medium>\\n <Small>https://a.jpg</Small>\\n </Cover>\\n <Gender>MALE</Gender>\\n <RawId>123123</RawId>\\n <Source>qingting</Source>\\n <Id>13597709</Id>\\n <Title>播音呆瓜小贼</Title>\\n <Description>播音呆瓜小贼</Description>\\n <Online>true</Online>\\n </Authors>\\n <Category>audio</Category>\\n <Charge>false</Charge>\\n <CommCateId>80012017</CommCateId>\\n <Cover>\\n <CanResize>false</CanResize>\\n <Img>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Img>\\n <Large>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Large>\\n <Mediam>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Mediam>\\n <Medium>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Medium>\\n <Small>http://pic.qtfm.cn/2017/0207/2017020718285.jpg</Small>\\n </Cover>\\n <HotScore>10</HotScore>\\n <Id>13597709</Id>\\n <ItemType>ALBUM</ItemType>\\n <Source>qingting</Source>\\n <Title>超能狂少在都市</Title>\\n <Valid>VALID</Valid>\\n <Duration>180</Duration>\\n </Result>\\n</SearchContentResponse>","errorExample":""}]',
+ 'title' => '按照特定的搜索条件搜索',
],
- 'GetWeather' => [
- 'summary' => '查询天气。',
- 'path' => '/v1.0/ssp/GetWeather',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SendMessage' => [
+ 'summary' => '发送一条留言。',
+ 'path' => '/v1.0/ssp/sendMessage',
+ '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' => 'Url',
+ 'in' => 'query',
+ 'schema' => ['description' => '留言url', 'type' => 'string', 'required' => false, 'example' => 'http://xx'],
],
[
'name' => 'UserInfo',
- 'in' => 'formData',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '用户标识信息',
- 'description' => '用户标识信息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '用户标识(userOpenId或userUnionId)',
- 'description' => '用户标识(userOpenId或userUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HOFF****my7Iw=',
- ],
- 'IdType' => [
- 'title' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '用户Id的类型-OPEN_ID:默认的用户ID标识-UNION_ID:组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPEN_ID',
- ],
'EncodeType' => [
- 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGENAME:apk包名,Android应用客户链路的编码类型 - SKILLID:技能ID,云端链路的编码类型',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- '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' => '设备标识(deviceOpenId或deviceUnionId)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DAFE****ce3ej=',
- ],
+ 'EncodeKey' => ['description' => '编码类型对应的值,编码类型是SKILLID时,其值为应用的Skill ID; 编码类型是PACKAGENAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '123L'],
'IdType' => [
- 'title' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
- 'description' => '设备Id的类型-OPEN_ID:默认的设备ID标识-UNION_ID:组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型 - OPENID:默认的用户ID标识 - UNIONID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'EncodeType' => [
- 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型-PACKAGE_NAME:apk包名,Android应用客户链路的编码类型-SKILL_ID:技能ID,云端链路的编码类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PROJECT_ID',
- ],
- 'EncodeKey' => [
- 'title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的SkillID;编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12**45',
- ],
- 'OrganizationId' => [
- 'title' => '组织ID,如果IdType为UNION_ID时必填',
- 'description' => '组织ID,如果IdType为UNION_ID时必填',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1**2',
- ],
+ 'Id' => ['description' => ' '."\n"
+ .'用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => '123L'],
+ 'OrganizationId' => ['description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
],
'required' => true,
],
@@ -15925,271 +7652,76 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'AmpResult<WeatherResponse>',
- 'description' => 'AmpResult<WeatherResponse>',
+ 'title' => 'Schema of Response',
+ 'description' => '服务返回结果',
'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' => '天气编号: 形如:"000,100"',
- 'type' => 'string',
- 'example' => '000',
- ],
- 'Name' => [
- 'title' => '天气名称描述: "晴(000),多云(100)"',
- 'description' => '天气名称描述: "晴(000), 多云(100), 阴(101), 雨(200), 小雨(201), 小到中雨(202), 中雨(203), 中到大雨(204), 大雨(205), 大到暴雨(206), 暴雨(207), 大暴雨(209), 特大暴雨(211), 阵雨(212), 雷阵雨(213), 冻雨(214), 雪(300), 雨夹雪(301), 阵雪(302), 小雪(303), 小到中雪(304), 中雪(305), 大雪(307), 暴雪(309), 雾(400), 浮尘(501), 扬沙(502), 沙尘暴(503), 强沙尘暴(504), 大部晴朗(000), 少云(100), 小阵雨(212), 雷电(213), 冰粒(214), 雷阵雨伴有冰雹(215), 小阵雪(302), 冻雾(400), 霾(500), 尘卷风(502), 局部阵雨(212), 雷暴(213), 冰针(214), 冰雹(215), 强阵雨(212)"',
- 'type' => 'string',
- 'example' => '晴',
- ],
- ],
- ],
- 'Temperature' => [
- 'title' => '温度',
- 'description' => '温度',
- 'type' => 'object',
- 'properties' => [
- 'Current' => [
- 'title' => '当前温度气温值',
- 'description' => '当前温度气温值',
- 'type' => 'string',
- 'example' => '36',
- ],
- 'CurrentDesc' => [
- 'title' => '当前温度气温值描述',
- 'description' => '当前温度气温值描述',
- 'type' => 'string',
- 'example' => '36度',
- ],
- 'High' => [
- 'title' => '气温最高值',
- 'description' => '气温最高值',
- 'type' => 'string',
- 'example' => '37',
- ],
- 'HighDesc' => [
- 'title' => '气温最高值描述',
- 'description' => '气温最高值描述',
- 'type' => 'string',
- 'example' => '37度',
- ],
- 'Low' => [
- 'title' => '气温最低值',
- 'description' => '气温最低值',
- 'type' => 'string',
- 'example' => '28',
- ],
- 'LowDesc' => [
- 'title' => '气温最低值描述',
- 'description' => '气温最低值描述',
- 'type' => 'string',
- 'example' => '28度',
- ],
- 'Logical' => [
- 'title' => '带有逻辑的温度,逻辑如下:',
- 'description' => '带有逻辑的温度,逻辑如下:',
- 'type' => 'string',
- 'example' => '41',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'F7E2****B7C94',
- ],
+ 'Message' => ['title' => 'Id of the request', 'description' => '错误信息,存在即发送失败', 'type' => 'string', 'example' => '外部userId映射关系不存在'],
+ 'Code' => ['description' => '服务返回的状态码,SUCCESS为成功,否则均为失败', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Result' => ['description' => '留言发送结果', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"调用成功\\",\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"CurrentMeteorology\\": {\\n \\"Weather\\": {\\n \\"Code\\": \\"000\\",\\n \\"Name\\": \\"晴\\"\\n },\\n \\"Temperature\\": {\\n \\"Current\\": \\"36\\",\\n \\"CurrentDesc\\": \\"36度\\",\\n \\"High\\": \\"37\\",\\n \\"HighDesc\\": \\"37度\\",\\n \\"Low\\": \\"28\\",\\n \\"LowDesc\\": \\"28度\\",\\n \\"Logical\\": \\"41\\"\\n }\\n }\\n },\\n \\"RequestId\\": \\"F7E2****B7C94\\"\\n}","errorExample":""},{"type":"xml","example":"<GetWeatherResponse>\\n <Message>调用成功</Message>\\n <Code>200</Code>\\n <Result>\\n <CurrentMeteorology>\\n <Weather>\\n <Code>000</Code>\\n <Name>晴</Name>\\n </Weather>\\n <Temperature>\\n <Current>36</Current>\\n <CurrentDesc>36度</CurrentDesc>\\n <High>37</High>\\n <HighDesc>37度</HighDesc>\\n <Low>28</Low>\\n <LowDesc>28度</LowDesc>\\n <Logical>41</Logical>\\n </Temperature>\\n </CurrentMeteorology>\\n </Result>\\n <RequestId>F7E2****B7C94</RequestId>\\n</GetWeatherResponse>","errorExample":""}]',
- 'title' => '查询天气',
- 'description' => '根据系统参数获取到的设备信息,查询设备所在地的天气数据',
- 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"外部userId映射关系不存在\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<SendMessageResponse>\\n <Message>外部userId映射关系不存在</Message>\\n <Code>SUCCESS</Code>\\n <Result>true</Result>\\n</SendMessageResponse>","errorExample":""}]',
+ 'title' => '发送留言',
],
- 'CreatePlayingListOAuth2' => [
- 'summary' => '播放列表创建走OAuth2授权。',
- 'path' => '/v1.0/ssp/CreatePlayingListOAuth2',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SetDeviceSetting' => [
+ 'summary' => '修改设备的用户设置。',
+ 'path' => '/v1.0/ssp/setDeviceSetting',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
- 'OAuth 2.0 Bearer Token' => [],
+ 'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'OpenCreatePlayingListRequest',
+ 'name' => 'Key',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '业务参数',
- 'type' => 'object',
- 'properties' => [
- 'PlayFrom' => [
- 'description' => '播放来源,配置播控能力的唯一标识'."\n"
- ."\n"
- .'可空,默认为default',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- 'ContentType' => [
- 'description' => '播放内容类型'."\n"
- ."\n"
- .'内容:content;专辑:album;歌单:collect',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'content',
- ],
- 'ContentList' => [
- 'description' => '播放对象',
- 'type' => 'array',
- 'items' => [
- 'description' => '播放对象',
- 'type' => 'object',
- 'properties' => [
- 'RawId' => [
- 'description' => '三方id'."\n"
- ."\n"
- .'如果是内容则是内容id;如果是专辑则是专辑id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xiami',
- ],
- ],
- 'required' => true,
- ],
- 'required' => true,
- ],
- 'Index' => [
- 'description' => '播放的index'."\n"
- ."\n"
- .'可空。默认为0,表示从头播放',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'NeedAlbumContinued' => [
- 'description' => '专辑是否续播,比如上次专辑听到第五集,是否继续从第五集开始。默认为true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'PlayMode' => [
- 'description' => '播放模式'."\n"
- ."\n"
- .'列表循环:Repeat;随机:Shuffle;单曲循环:RepeatOne;顺序播放:Normal。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Repeat',
- ],
- 'ExtendInfo' => [
- 'description' => '扩展信息',
- 'type' => 'object',
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '设备设置指定的Key集合,'."\n"
+ .'勿扰模式:nightMode', 'description' => '设备设置指定的Key集合,'."\n"
+ .'勿扰模式:nightMode', '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' => '设备标识信息',
+ 'description' => '用户标识信息列表。',
'type' => 'object',
'properties' => [
'EncodeType' => [
+ 'title' => '编码类型,此处填写PROJECT_ID。',
'description' => '编码类型,此处填写PROJECT_ID。',
'type' => 'string',
'required' => true,
'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
- 'EncodeKey' => [
- 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'description' => '编码类型对应的值,此处填写该产品所在项目的Project ID。请在天猫精灵AI平台的控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '123'],
'IdType' => [
+ 'title' => '设备Id的类型 :'."\n"
+ .'OPEN_ID:默认的设备ID标识。'."\n"
+ .'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'description' => '设备Id的类型 :'."\n"
.'OPEN_ID:默认的设备ID标识。'."\n"
.'UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
'required' => true,
'example' => 'OPEN_ID',
- 'enum' => [
- 'UNION_ID',
- 'OPEN_ID',
- ],
- ],
- 'Id' => [
- 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
- 'OrganizationId' => [
- 'description' => '组织ID,如果IdType为UNION_ID时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
+ 'Id' => ['title' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => '123'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填。', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false],
],
'required' => true,
],
@@ -16202,321 +7734,81 @@
'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' => '三方id',
- 'type' => 'string',
- 'example' => '123123',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => 'qignting',
- ],
- 'AlbumRawId' => [
- 'title' => '三方专辑id',
- 'description' => '三方专辑id',
- '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' => '是否可以使用oss规则裁剪',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- 'PlayMode' => [
- 'title' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- 'description' => '播放模式 (Repeat, Shuffle, RepeatOne, Normal)',
- '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' => '歌词url',
- 'type' => 'string',
- 'example' => 'https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc',
- ],
- 'Copyright' => [
- 'title' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'description' => '版权字段升级为是否可播:0 可播, 1/2 不可播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Type' => [
- 'description' => 'type (music\\program\\joke\\news\\children_song\\radio等)',
- 'type' => 'string',
- 'example' => 'program',
- ],
- 'ItemUrl' => [
- 'description' => '播放url',
- 'type' => 'string',
- 'example' => 'https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3',
- ],
- 'DefaultPlayOrder' => [
- 'description' => 'package 默认播放顺序 0 顺序,1 倒序',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Valid' => [
- 'description' => '是否可播:VALID(10), UNKNOWN(20), NOT_VALID(30)',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
- 'Pos' => [
- 'description' => '该项在播放列表中的位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'Message' => [
- 'title' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'description' => '附加信息,典型应用场景是对失败调用进行简述,方便调用方定位问题',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '10002398812',
- ],
- 'Success' => [
- 'description' => '调用是否成功,true成功,false失败。失败时请关注Message信息',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['title' => '调用该接口的返回结果。', 'description' => '调用该接口的返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '返回的错误码,200表示调用成功。', 'description' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '设置执行结果', 'description' => '设置执行结果', 'type' => 'boolean'],
+ 'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Result\\": {\\n \\"RawId\\": \\"123123\\",\\n \\"Source\\": \\"qignting\\",\\n \\"AlbumRawId\\": \\"260744\\",\\n \\"AlbumName\\": \\"晚安妈妈睡前故事\\",\\n \\"Liked\\": false,\\n \\"Singer\\": \\"晚安妈妈\\",\\n \\"Title\\": \\"超能狂少在都市\\",\\n \\"Cover\\": {\\n \\"Img\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Large\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Mediam\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Medium\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"Small\\": \\"http://pic.qtfm.cn/2017/0207/2017020718285.jpg\\",\\n \\"CanResize\\": false\\n },\\n \\"PlayMode\\": \\"Repeat\\",\\n \\"AudioLength\\": 190,\\n \\"Progress\\": 96,\\n \\"LyricUrl\\": \\"https://aicontent.alibabausercontent.com/lyric/thirdsource/6f4c8408073db134b0d097c122b5a1a1.lrc\\",\\n \\"Copyright\\": 0,\\n \\"Type\\": \\"program\\",\\n \\"ItemUrl\\": \\"https://openaudio.cos.tx.xmcdn.com/storages/587f-audiofreehighqps/15/CE/GKwRIJIGnb11ABc6SwF59DNb.mp3\\",\\n \\"DefaultPlayOrder\\": 1,\\n \\"Valid\\": \\"VALID\\",\\n \\"Pos\\": 1\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"10002398812\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => '播放列表创建_OAuth2',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","type":"json"}]',
+ 'title' => '修改设备的用户设置',
],
'ThirdImmediateMsgPush' => [
- 'summary' => '三方即时信息数据变更事件推送。',
+ 'summary' => '三方即时信息数据变更事件推送',
'path' => '/v1.0/ssp/thirdImmediateMsgPush',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AliGenie_Auth_SPI' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
- 'schema' => [
- 'title' => '用户id',
- 'description' => '用户id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'userId',
- ],
+ 'schema' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'required' => false, 'example' => 'userId'],
],
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'title' => '订单id',
- 'description' => '订单id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'orderId',
- ],
+ 'schema' => ['title' => '订单id', 'description' => '订单id', 'type' => 'string', 'required' => false, 'example' => 'orderId'],
],
[
'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'title' => '请求来源',
- 'description' => '请求来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'source',
- ],
+ 'schema' => ['title' => '请求来源', 'description' => '请求来源', 'type' => 'string', 'required' => false, 'example' => 'source'],
],
[
'name' => 'BizType',
'in' => 'query',
- 'schema' => [
- 'title' => '业务类型(FLIGHT:航班、TRAIN:火车)',
- 'description' => '业务类型(FLIGHT:航班、TRAIN:火车)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FLIGHT',
- ],
+ 'schema' => ['title' => '业务类型(FLIGHT:航班、TRAIN:火车)', 'description' => '业务类型(FLIGHT:航班、TRAIN:火车)', 'type' => 'string', 'required' => false, 'example' => 'FLIGHT'],
],
[
'name' => 'TrafficChangeType',
'in' => 'query',
- 'schema' => [
- 'title' => '变动类型(TRAIN_ISSUED、FLIGHT_CHANGED)',
- 'description' => '变动类型(TRAIN_ISSUED、FLIGHT_CHANGED)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TRAIN_ISSUED',
- ],
+ 'schema' => ['title' => '变动类型(TRAIN_ISSUED、FLIGHT_CHANGED)', 'description' => '变动类型(TRAIN_ISSUED、FLIGHT_CHANGED)', 'type' => 'string', 'required' => false, 'example' => 'TRAIN_ISSUED'],
],
[
'name' => 'TrafficChangeTypeDesc',
'in' => 'query',
- 'schema' => [
- 'title' => '变动类型描述(已出票、已改签)',
- 'description' => '变动类型描述(已出票、已改签)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '已出票',
- ],
+ 'schema' => ['title' => '变动类型描述(已出票、已改签)', 'description' => '变动类型描述(已出票、已改签)', 'type' => 'string', 'required' => false, 'example' => '已出票'],
],
[
'name' => 'ChangeDetail',
'in' => 'query',
- 'schema' => [
- 'title' => '变动信息明细(变动数据json)',
- 'description' => '变动信息明细(变动数据json)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['title' => '变动信息明细(变动数据json)', 'description' => '变动信息明细(变动数据json)', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'TrafficJourneyIds',
'in' => 'query',
- 'schema' => [
- 'title' => '变更的行程id',
- 'description' => '变更的行程id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'trafficJourneyIds',
- ],
+ 'schema' => ['title' => '变更的行程id', 'description' => '变更的行程id', 'type' => 'string', 'required' => false, 'example' => 'trafficJourneyIds'],
],
[
'name' => 'TrafficSubOrderIds',
'in' => 'query',
- 'schema' => [
- 'title' => '变更的火车申请单子订单id',
- 'description' => '变更的火车申请单子订单id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'trafficSubOrderIds',
- ],
+ 'schema' => ['title' => '变更的火车申请单子订单id', 'description' => '变更的火车申请单子订单id', 'type' => 'string', 'required' => false, 'example' => 'trafficSubOrderIds'],
],
[
'name' => 'PsgIds',
'in' => 'query',
- 'schema' => [
- 'title' => '变更的乘客id',
- 'description' => '变更的乘客id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'psgIds',
- ],
+ 'schema' => ['title' => '变更的乘客id', 'description' => '变更的乘客id', 'type' => 'string', 'required' => false, 'example' => 'psgIds'],
],
],
'responses' => [
@@ -16526,56 +7818,448 @@
'description' => '',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'title' => '调用是否成功',
- 'description' => '调用是否成功',
- 'type' => 'boolean',
+ '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' => '请求id', 'type' => 'string', 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B'],
+ 'Success' => ['title' => '是否推送成功', 'description' => '是否推送成功', 'type' => 'boolean'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '三方即时信息数据变更事件推送',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-01T09:51:37.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-09-01T02:40:36.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2025-09-01T02:40:31.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2025-09-01T02:36:01.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ '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"}]',
+ ],
+ 'UnbindAligenieUser' => [
+ 'summary' => '通过登录态凭证解绑三方和精灵账号的关系'."\n",
+ 'path' => '/v1.0/ssp/unbindAligenieUser',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AliGenie_Auth_SPI' => [],
+ ],
+ ],
+ 'consumes' => ['application/x-www-form-urlencoded'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'LoginStateAccessToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '登录态访问凭证', 'description' => '登录态访问凭证', 'type' => 'string', 'required' => true, 'example' => '99ce8a70c23a94f8569e1a525bef6e85'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', '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"}]',
+ 'title' => '解除三方和精灵账号的关系',
+ 'description' => '注意:当登录态失效时,接入方需要重新发起授权登录流程获取新的登录态(入口服务API:AuthLoginWithThirdUserInfo)。'."\n"
+ ."\n"
+ .'- 通过Java-SDK(其它语言SDK请在接入时咨询天猫精灵开发)调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
+ .'当API调用抛出TeaException,且TeaException.code为InvalidAuthentication时代表登录态失效。'."\n"
+ ."\n"
+ .'- 通过发送http请求调用携带登录态访问凭证(LoginStateAccessToken)参数的服务API'."\n"
+ .'当API调用返回的http响应状态码为400时代表登录态失效。',
+ ],
+ 'UnbindDevice' => [
+ 'summary' => '根据用户open信息和设备open信息进行解除绑定关系。',
+ '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' => [
+ 'title' => '设备标识信息',
+ 'description' => '设备标识信息列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => [
+ 'title' => '编码类型,此处填写“PROJECT_ID”',
+ 'description' => '编码类型,此处填写**PROJECT_ID**。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,该产品所在项目的Project ID。请在天猫精灵AI平台控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'IdType' => [
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型'."\n"
+ .' - OPEN_ID:默认的设备ID标识。'."\n"
+ .'- UNION_ID: 组织维度的设备ID标识,需要提前在开放平台申请组织。',
'type' => 'string',
- 'example' => '500000000',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
],
- 'ErrorMsg' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
+ 'Id' => ['title' => '设备标识(deviceOpenId或deviceUnionId)', 'description' => '设备标识,填写deviceOpenId或deviceUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'UserInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '用户标识信息',
+ 'description' => '用户标识信息列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EncodeType' => [
+ 'title' => '编码类型,此处填写“PROJECT_ID”',
+ 'description' => '编码类型,此处填写**PROJECT_ID**。',
'type' => 'string',
- 'example' => '服务器内部异常',
+ 'required' => true,
+ 'example' => 'PROJECT_ID',
+ 'enum' => ['PROJECT_ID'],
],
- 'Model' => [
- 'title' => '推送结果',
- 'description' => '推送结果',
+ 'EncodeKey' => ['title' => '编码类型对应的值,此处填写天猫精灵AI平台中,该产品ProductKey所在项目的Project ID。', 'description' => '编码类型对应的值,即该产品所在项目的Project ID。请在天猫精灵AI平台控制台中查看。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'IdType' => [
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在开放平台申请过组织后才会有',
+ 'description' => '用户ID的类型:'."\n"
+ .' - OPEN_ID:默认的用户ID标识。'."\n"
+ .' - UNION_ID: 组织维度的用户ID标识,需要提前在开放平台申请组织。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'Id' => ['title' => '用户标识(userOpenId或userUnionId)', 'description' => '用户标识,填写userOpenId或userUnionId的值。', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填。', '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' => '返回的错误码,200表示调用成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Result' => ['title' => '是否解绑成功', 'description' => '设备是否解绑成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => '0EC7*726E'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AliGenie.UnbindDevice.InvalidParameter', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'AliGenie.Public.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0EC7*726E\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindDeviceResponse>\\n <Message>success</Message>\\n <Code>200</Code>\\n <Result>true</Result>\\n <RequestId>0EC7*726E</RequestId>\\n</UnbindDeviceResponse>","errorExample":""}]',
+ 'title' => '解绑设备',
+ ],
+ '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' => [
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求id',
+ 'Type' => [
+ 'title' => '调度类型/循环类型',
+ 'description' => '调度类型/循环类型:'."\n"
+ .'ONCE -> 单次,WEEKLY -> 周循环,STATUTORY_WORKING_DAY ->法定工作日',
'type' => 'string',
- 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B',
+ 'required' => true,
+ 'example' => 'WEEKLY',
+ 'enum' => ['ONCE', 'WEEKLY', 'STATUTORY_WORKING_DAY'],
],
- 'Success' => [
- 'title' => '是否推送成功',
- 'description' => '是否推送成功',
- 'type' => 'boolean',
+ 'Once' => [
+ 'title' => '单次',
+ 'description' => '单次::循环类型为ONCE时,该属性可用',
+ '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' => '周循环:循环类型为WEEKLY时,该属性可用',
+ 'type' => 'object',
+ 'properties' => [
+ 'DaysOfWeek' => [
+ 'title' => '周几触发集合',
+ 'description' => '周几触发集合:数值在 1-7 之间,数字几则为对应的周几,如果是每天,则全部都填',
+ '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' => '法定工作日:循环类型为STATUTORY_WORKING_DAY时,该属性可用',
+ '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' => '铃声类别id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12'],
+ 'MusicTypeName' => ['title' => '音乐类别名称', 'description' => '铃声类别名称', 'type' => 'string', 'required' => true, 'example' => 'xx音乐'],
+ 'MusicId' => ['title' => '音乐id', 'description' => '铃声id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'],
+ 'MusicName' => ['title' => '音乐名称', 'description' => '铃声名称', 'type' => 'string', 'required' => true, 'example' => 'xx铃声'],
+ 'MusicUrl' => ['title' => '音乐url', 'description' => '铃声url', 'type' => 'string', 'required' => false, 'example' => 'http://music-url.mp3'],
],
+ 'required' => true,
+ ],
+ 'AlarmId' => ['title' => '闹钟id', 'description' => '闹钟id', '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' => '用户标识(userOpenId或userUnionId)', 'type' => 'string', 'required' => true, 'example' => 'HOFF****my7Iw='],
+ 'IdType' => [
+ 'title' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '用户Id的类型 - OPEN_ID:默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的用户标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', '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' => '设备标识(deviceOpenId或deviceUnionId)', 'type' => 'string', 'required' => true, 'example' => 'DAFE****ce3ej='],
+ 'IdType' => [
+ 'title' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'description' => '设备Id的类型 - OPEN_ID:默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识,在猫精技能应用开放平台申请过组织后才会有',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'OPEN_ID',
+ 'enum' => ['OPEN_ID', 'UNION_ID'],
+ ],
+ 'EncodeType' => [
+ 'title' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'description' => '编码类型,获取猫精的设备标识的途径有多种,不同途径对应不同的编码类型 - PACKAGE_NAME:apk包名,Android应用客户链路的编码类型 - SKILL_ID:技能ID,云端链路的编码类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PACKAGE_NAME',
+ 'enum' => ['PACKAGE_NAME', 'SKILL_ID'],
+ ],
+ 'EncodeKey' => ['title' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'description' => '编码类型对应的值,编码类型是SKILL_ID时,其值为应用的Skill ID; 编码类型是PACKAGE_NAME时,其值为对应客户端App的packageName。', 'type' => 'string', 'required' => true, 'example' => '12**45'],
+ 'OrganizationId' => ['title' => '组织ID,如果IdType为UNION_ID时必填', 'description' => '组织ID,如果IdType为UNION_ID时必填', 'type' => 'string', 'required' => false, 'example' => '1**2'],
+ ],
+ 'required' => true,
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'AmpResult',
+ 'description' => 'AmpResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '闹钟服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'xx为空'],
+ 'Result' => ['description' => '更新结果是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '43***28C-A810-5***-8747-EC226A086881'],
+ ],
+ ],
+ ],
],
- '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"}]',
- 'title' => '三方即时信息数据变更事件推送',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"xx为空\\",\\n \\"Result\\": true,\\n \\"RequestId\\": \\"43***28C-A810-5***-8747-EC226A086881\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlarmResponse>\\n <Code>200</Code>\\n <Message>xx为空</Message>\\n <Result>true</Result>\\n <RequestId>43***28C-A810-5***-8747-EC226A086881</RequestId>\\n</UpdateAlarmResponse>","errorExample":""}]',
+ 'title' => '更新闹钟',
+ 'responseParamsDescription' => '仅服务返回的状态码为200时为成功,否则均表示失败',
],
],
- 'endpoints' => [
+ 'endpoints' => [],
+ 'errorCodes' => [
+ ['code' => 'AliGenie.GetDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.GetPhoneNumber.BizError', 'message' => 'The user has no phoneNumber.', 'http_code' => 400, 'description' => '用户未绑定手机号'],
+ ['code' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', 'message' => 'The user information does not exist.', 'http_code' => 400, 'description' => '用户信息不存在'],
+ ['code' => 'AliGenie.ListDeviceIdByIdentity.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '参数错误'],
+ ['code' => 'AliGenie.Notifications.Application.Invalid', 'message' => 'The AliGenie app info is invalid.', 'http_code' => 400, 'description' => '应用信息缺失'],
+ ['code' => 'AliGenie.Notifications.Application.Status', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => '应用未发布'],
+ ['code' => 'AliGenie.Notifications.Application.Url', 'message' => 'The AliGenie app awaken url is missing.', 'http_code' => 400, 'description' => '应用唤起链接未配置'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'The device not bind user.', 'http_code' => 400, 'description' => '设备未绑定用户'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', 'message' => 'Failed to identify device.', 'http_code' => 400, 'description' => '设备标识无法识别'],
+ ['code' => 'AliGenie.Notifications.InvalidParameter.UserInfo', 'message' => 'Failed to identify user.', 'http_code' => 400, 'description' => '用户标识无法识别'],
+ ['code' => 'AliGenie.Public.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '系统内部错误.'],
+ ['code' => 'AliGenie.Public.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template information is invalid.', 'http_code' => 400, 'description' => '模板信息有误'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template is unavailable.', 'http_code' => 400, 'description' => '模板未处于可用状态'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', 'message' => 'The template does not exist.', 'http_code' => 400, 'description' => '模板不存在'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', 'message' => 'The template placeholder information is missing.', 'http_code' => 400, 'description' => '模板占位符信息未填充'],
+ ['code' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', 'message' => 'Failed to identify message target.', 'http_code' => 400, 'description' => '消息发送目标识别失败'],
+ ['code' => 'AliGenie.Reminder.CreateFail', 'message' => 'The creation request is not allowed.', 'http_code' => 403, 'description' => '提醒创建行为不合理'],
+ ['code' => 'AliGenie.Reminder.DeviceError', 'message' => 'The device is offline.', 'http_code' => 504, 'description' => '设备离线,暂时无法操作'],
+ ['code' => 'AliGenie.Reminder.HasNoAuthority', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 505, 'description' => '没有此数据操作权限'],
+ ['code' => 'AliGenie.Reminder.StopService', 'message' => 'The servic has stopped.', 'http_code' => 503, 'description' => '暂停服务'],
+ ['code' => 'AliGenie.WakeUpApp.Device.Offline', 'message' => 'The target device is not online.', 'http_code' => 400, 'description' => '目标设备不在线'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Body', 'message' => 'You must specify request body.', 'http_code' => 400, 'description' => '服务请求参数为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', 'message' => 'You must specify EncodeKey.', 'http_code' => 400, 'description' => 'EncodeKey为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'You must specify EncodeType.', 'http_code' => 400, 'description' => 'EncodeType为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', 'message' => 'The specified EncodeType is invalid.', 'http_code' => 400, 'description' => 'EncodeType非法 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'You must specify GenieAppId.', 'http_code' => 400, 'description' => 'GenieAppId为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app does not exist.', 'http_code' => 400, 'description' => '猫精应用不存在 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The GenieApp information is inmcomplete.', 'http_code' => 400, 'description' => 'GenieApp信息不完整 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not configured wake up link.', 'http_code' => 400, 'description' => '猫精应用缺乏唤起链接配置 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The application is not installed.', 'http_code' => 400, 'description' => '应用未安装'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', 'message' => 'The AliGenie app has not been released.', 'http_code' => 400, 'description' => '应用未发布'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', 'message' => 'You must specify OrganizationId.', 'http_code' => 400, 'description' => 'OrganizationId为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'You must specify Path.', 'http_code' => 400, 'description' => 'Path为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.Path', 'message' => 'The wake up path is invalid.', 'http_code' => 400, 'description' => '唤起路径有误 '],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', 'message' => 'You must specify TargetIdentity.', 'http_code' => 400, 'description' => 'TargetIdentity为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'You must specify TargetInfo.', 'http_code' => 400, 'description' => 'TargetInfo为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', 'message' => 'The specified TargetInfo is invalid.', 'http_code' => 400, 'description' => 'TargetInfo信息有误'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'You must specify TargetType.', 'http_code' => 400, 'description' => 'TargetType为空'],
+ ['code' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', 'message' => 'The specified TargetType is invalid.', 'http_code' => 400, 'description' => 'TargetType非法'],
+ ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid', 'http_code' => 400, 'description' => '参数无效'],
+ ['code' => 'ServerError', 'message' => 'internal server error', 'http_code' => 500, 'description' => '内部错误'],
+ ['code' => 'SystemError', 'message' => 'System Error occured.', 'http_code' => 400, 'description' => '系统异常'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ThirdImmediateMsgPush'],
+ ],
+ 'createdAt' => '2025-09-01T09:51:37.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'openapi.aligenie.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ThirdImmediateMsgPush'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ThirdImmediateMsgPush'],
+ ],
+ 'createdAt' => '2025-09-01T02:40:31.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ThirdImmediateMsgPush'],
+ ],
+ 'createdAt' => '2025-09-01T02:36:01.000Z',
+ 'description' => '',
],
],
];