From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/en_us/aligenie/iap_1.0/api-docs.php | 4179 ++++++++++++++++++++++++++++++ 1 file changed, 4179 insertions(+) create mode 100644 data/en_us/aligenie/iap_1.0/api-docs.php (limited to 'data/en_us/aligenie/iap_1.0') diff --git a/data/en_us/aligenie/iap_1.0/api-docs.php b/data/en_us/aligenie/iap_1.0/api-docs.php new file mode 100644 index 0000000..d0f2c45 --- /dev/null +++ b/data/en_us/aligenie/iap_1.0/api-docs.php @@ -0,0 +1,4179 @@ + '1.0', + 'info' => [ + 'style' => 'AliGenie', + 'product' => 'AliGenie', + 'version' => 'iap_1.0', + ], + 'directories' => [ + [ + 'id' => 167271, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetBusAppConfig', + 'AppUseTimeReport', + 'PullCashier', + 'VideoAppReport', + 'GetAccountForApp', + ], + ], + [ + 'id' => 95708, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetPhoneNumber', + ], + ], + [ + 'id' => 95710, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateReminder', + 'GetReminder', + 'ListReminders', + 'UpdateReminder', + 'DeleteReminder', + ], + ], + [ + 'id' => 95716, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'WakeUpApp', + ], + ], + [ + 'id' => 95719, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PushNotifications', + 'SendNotifications', + ], + ], + [ + 'id' => 263437, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CheckThirdRightSendPlan', + 'CallBackThirdRightSendPlan', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'ThirdImmediateMsgPush', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetBusAppConfig' => [ + 'summary' => '获取应用配置', + 'path' => '/v1.0/iap/app/config/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '业务参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'type' => 'string', + 'required' => false, + ], + 'SubjectId' => [ + 'type' => 'string', + 'required' => true, + ], + 'DeviceId' => [ + 'type' => 'string', + ], + 'phone' => [ + 'title' => '手机号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '136****1111', + ], + 'originUuid' => [ + 'title' => '明文uuid', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '731D5F********DC3B', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识(UserOpenId或UserUnionId)', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'SKILL_ID', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SKILL_ID', + 'enum' => [ + 'SKILL_ID', + 'PACKAGE_NAME', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'title' => '返回的错误码，0表示成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => ' 0', + ], + 'RetMsg' => [ + 'title' => '返回的错误信息，成功则不返回信息。', + 'description' => '', + 'type' => 'string', + 'example' => ' 请求异常', + ], + 'RetValue' => [ + 'title' => '返回的结果对象', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VipLabel' => [ + 'title' => 'VIP透标URL', + 'description' => '', + 'type' => 'string', + 'example' => 'https://******.com/design/******?imageId=xxxxx', + ], + 'ShoppingBar' => [ + 'title' => '导购条URL', + 'description' => '', + 'type' => 'string', + 'example' => 'https://******.com/design/******?imageId=xxxxx', + ], + 'ShoppingWindow' => [ + 'title' => '导购弹窗URL', + 'description' => '', + 'type' => 'string', + 'example' => 'https://******.com/design/******?imageId=xxxxx', + ], + 'Cashier' => [ + 'title' => '收银台URL', + 'type' => 'string', + 'example' => 'https://******.com/*****/******?appId=xxxxx', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"\\\\t请求异常\\",\\n \\"RetValue\\": {\\n \\"VipLabel\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingBar\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"ShoppingWindow\\": \\"https://******.com/design/******?imageId=xxxxx\\",\\n \\"Cashier\\": \\"https://******.com/*****/******?appId=xxxxx\\"\\n }\\n}","type":"json"}]', + ], + 'AppUseTimeReport' => [ + 'summary' => '应用使用时长上报', + 'path' => '/v1.0/iap/vip/use/time/report', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户id', + 'type' => 'string', + 'required' => true, + ], + 'DeviceId' => [ + 'title' => '设备di', + 'type' => 'string', + 'required' => false, + ], + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + ], + 'Action' => [ + 'title' => '操作', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'start', + ], + 'StepCode' => [ + 'title' => '步进码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2', + ], + 'ResourceId' => [ + 'title' => '资源id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'ResourceType' => [ + 'title' => 'resourceType', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'IsPrivilege' => [ + 'title' => '是否会员专享权益：1-是 0-否', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'VipType' => [ + 'title' => '会员类型', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'originUuid' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '731D5F********DC3B', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RetValue' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '500', + 'errorMessage' => '内部服务错误_xxx', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n true\\n","errorExample":""}]', + ], + 'PullCashier' => [ + 'summary' => '拉取收银台', + 'path' => '/v1.0/iap/pull/cashier/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + ], + 'DeviceId' => [ + 'type' => 'string', + 'required' => false, + ], + 'originUuid' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '731D5F********DC3B', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'title' => '错误吗', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RetValue' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '500', + 'errorMessage' => '内部服务错误_xxx', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求成功\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n true\\n","errorExample":""}]', + ], + 'VideoAppReport' => [ + 'summary' => '视频类应用会员信息上报', + 'path' => '/v1.0/iap/vip/use/video/report', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => [ + 'title' => '设备di', + 'type' => 'string', + 'required' => false, + ], + 'isLogin' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'isVip' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'startTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1652337963097', + ], + 'endTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1652337963097', + ], + 'loginNick' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'phone' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '188*777', + ], + 'pkgName' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'com.***.test', + ], + 'originUuid' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '731D5F********DC3B', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetMsg' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RetValue' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '500', + 'errorMessage' => '内部服务错误_xxx', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n true\\n","errorExample":""}]', + ], + 'GetAccountForApp' => [ + 'summary' => '获取会员信息', + 'path' => '/v1.0/iap/vip/account/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'type' => 'string', + 'required' => true, + ], + 'SubjectId' => [ + 'type' => 'string', + 'required' => true, + ], + 'DeviceId' => [ + 'type' => 'string', + ], + 'Phone' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '188*777', + ], + 'originUuid' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '731D5F********DC3B', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RetValue' => [ + 'title' => '用户信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IsVip' => [ + 'title' => '是否VIP', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VipExpireAt' => [ + 'title' => '若以前开通过会员，返回会员失效时间，若从未开通过会员，此字段为0', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652340138347', + ], + 'StrVipExpire' => [ + 'title' => '日期格式，到期时间', + 'description' => '', + 'type' => 'string', + 'example' => '2022-05-12 15:22:18', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '500', + 'errorMessage' => '内部服务错误_xx', + ], + [ + 'errorCode' => '10000', + 'errorMessage' => '猫精用户已更换手机号，请重登', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"请求异常\\",\\n \\"RetValue\\": {\\n \\"IsVip\\": true,\\n \\"VipExpireAt\\": 1652340138347,\\n \\"StrVipExpire\\": \\"2022-05-12 15:22:18\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n \\n true\\n 1652340138347\\n 2022-05-12 15:22:18\\n \\n","errorExample":""}]', + ], + 'GetPhoneNumber' => [ + 'summary' => '用户手机号获取', + 'path' => '/v1.0/iap/profile/phoneNumber', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'phoneNumber' => [ + 'title' => '用户手机号', + 'description' => '', + 'type' => 'string', + 'example' => '137****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.GetPhoneNumber.InvalidParameter.UserIdentity', + 'errorMessage' => 'The user information does not exist.', + ], + [ + 'errorCode' => 'AliGenie.GetPhoneNumber.BizError', + 'errorMessage' => 'The user has no phoneNumber.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"phoneNumber\\": \\"137****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 137****\\n","errorExample":""}]', + ], + 'CreateReminder' => [ + 'summary' => '创建提醒', + 'path' => '/v1.0/iap/reminder/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '提醒内容', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '提醒内容', + ], + 'UserId' => [ + 'title' => '精灵id', + 'type' => 'string', + 'required' => true, + 'example' => '12****78', + ], + 'DeviceId' => [ + 'title' => '设备id', + 'type' => 'string', + 'required' => true, + 'example' => 'BED****AAC', + ], + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + 'example' => '20******01', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'default' => 'false', + ], + 'RecurrenceRule' => [ + 'title' => '提醒调度信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Year' => [ + 'title' => '触发时间的年', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2021', + ], + 'Month' => [ + 'title' => '触发时间的月', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Day' => [ + 'title' => '触发时间的日', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '25', + ], + 'Hour' => [ + 'title' => '触发时间的时', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + 'Minute' => [ + 'title' => '触发时间的分', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Second' => [ + 'title' => '触发时间的秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Freq' => [ + 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ONCE', + 'enum' => [ + 'ONCE', + 'DAILY', + 'WEEKLY', + 'MONTHLY', + ], + ], + 'StartDateTime' => [ + 'title' => '开始时间，时间戳毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1635134400000', + ], + 'EndDateTime' => [ + 'title' => '结束时间，时间戳毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1635134700000', + ], + 'DaysOfMonth' => [ + 'title' => '月循环相关，表示每月的几号的集合,数值范围为1-31', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + 'DaysOfWeek' => [ + 'title' => '周循环相关，表示每周几触发，数值范围为1-7', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '服务成功标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '不能设置过去的时间。', + ], + 'Model' => [ + 'title' => '创建的提醒id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20****1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n","errorExample":""}]', + ], + 'GetReminder' => [ + 'summary' => '查询提醒', + 'path' => '/v1.0/iap/reminder/get', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '提醒的唯一id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20****34', + ], + 'UserId' => [ + 'title' => '精灵id', + 'type' => 'string', + 'required' => true, + 'example' => '12****56', + ], + 'DeviceId' => [ + 'title' => '设备id', + 'type' => 'string', + 'required' => true, + 'example' => 'BED****AAC', + ], + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + 'example' => '20****01', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'SKILL_ID', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'SKILL_ID', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '服务成功标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'ErrorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '参数不合法。', + ], + 'Model' => [ + 'title' => '提醒信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RemindResponses' => [ + 'title' => '提醒信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RemindId' => [ + 'title' => '提醒id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20*****1', + ], + 'RepeatCount' => [ + 'title' => '重复次数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ActionTopic' => [ + 'title' => '执行动作topic', + 'description' => '', + 'type' => 'string', + 'example' => '宝宝快去刷牙', + ], + 'DayDesc' => [ + 'title' => '触发条件描述', + 'description' => '', + 'type' => 'string', + 'example' => '每天', + ], + 'RemindTime' => [ + 'title' => '下次提醒时间', + 'description' => '', + 'type' => 'string', + 'example' => '1629850800000', + ], + 'Week' => [ + 'title' => '触发为周几', + 'description' => '', + 'type' => 'string', + 'example' => '周三', + ], + 'RecurrenceRule' => [ + 'title' => '调度信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Freq' => [ + 'title' => '调度类型', + 'description' => '', + 'type' => 'string', + 'example' => 'WEEKLY', + ], + 'Year' => [ + 'title' => '年', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2021', + ], + 'Month' => [ + 'title' => '月', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'Day' => [ + 'title' => '天', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'Hour' => [ + 'title' => '小时', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + ], + 'Minute' => [ + 'title' => '分', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Second' => [ + 'title' => '秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DaysOfMonth' => [ + 'title' => '月的第几天 可用作月循环', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'DaysOfWeek' => [ + 'title' => '周循环字段，取值范围：1-7', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'StartDateTime' => [ + 'title' => '调度开始时间', + 'description' => '', + 'type' => 'string', + 'format' => 'int64', + 'example' => '1630054800000', + ], + 'EndDateTime' => [ + 'title' => '调度结束时间', + 'description' => '', + 'type' => 'string', + 'format' => 'int64', + 'example' => '1661598000000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数不合法。\\",\\n \\"Model\\": {\\n \\"RemindResponses\\": [\\n {\\n \\"RemindId\\": 0,\\n \\"RepeatCount\\": 1,\\n \\"ActionTopic\\": \\"宝宝快去刷牙\\",\\n \\"DayDesc\\": \\"每天\\",\\n \\"RemindTime\\": \\"1629850800000\\",\\n \\"Week\\": \\"周三\\",\\n \\"RecurrenceRule\\": {\\n \\"Freq\\": \\"WEEKLY\\",\\n \\"Year\\": 2021,\\n \\"Month\\": 8,\\n \\"Day\\": 27,\\n \\"Hour\\": 18,\\n \\"Minute\\": 0,\\n \\"Second\\": 0,\\n \\"DaysOfMonth\\": [\\n 1\\n ],\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"StartDateTime\\": 1630054800000,\\n \\"EndDateTime\\": 1661598000000\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 400\\n 参数不合法。\\n \\n \\n 1\\n 宝宝快去刷牙\\n 每天\\n 1629850800000\\n 周三\\n \\n WEEKLY\\n 2021\\n 8\\n 27\\n 18\\n 0\\n 0\\n 1\\n 1\\n 1630054800000\\n 1661598000000\\n \\n \\n \\n","errorExample":""}]', + ], + 'ListReminders' => [ + 'summary' => '查询提醒列表', + 'path' => '/v1.0/iap/reminder/list', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '精灵id', + 'type' => 'string', + 'required' => true, + 'example' => '12****56', + ], + 'DeviceId' => [ + 'title' => '设备id', + 'type' => 'string', + 'required' => true, + 'example' => 'BED****AAC', + ], + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + 'example' => '20****01', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '服务成功标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'ErrorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '参数不合法。', + ], + 'Model' => [ + 'title' => '提醒信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RemindResponses' => [ + 'title' => '提醒信息', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RemindId' => [ + 'title' => '提醒id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20****1', + ], + 'RepeatCount' => [ + 'title' => '重复次数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ActionTopic' => [ + 'title' => '执行动作topic', + 'description' => '', + 'type' => 'string', + 'example' => '宝宝快去刷牙', + ], + 'DayDesc' => [ + 'title' => '触发条件描述', + 'description' => '', + 'type' => 'string', + 'example' => '每天', + ], + 'RemindTime' => [ + 'title' => '下次提醒时间', + 'description' => '', + 'type' => 'string', + 'example' => '1629850800000', + ], + 'Week' => [ + 'title' => '触发为周几', + 'description' => '', + 'type' => 'string', + 'example' => '周三', + ], + 'RecurrenceRule' => [ + 'title' => '调度信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Freq' => [ + 'title' => '调度类型', + 'description' => '', + 'type' => 'string', + 'example' => 'WEEKLY', + ], + 'Year' => [ + 'title' => '年', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2021', + ], + 'Month' => [ + 'title' => '月', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'Day' => [ + 'title' => '天', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'Hour' => [ + 'title' => '小时', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + ], + 'Minute' => [ + 'title' => '分', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Second' => [ + 'title' => '秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DaysOfMonth' => [ + 'title' => '月的第几天 可用作月循环', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'DaysOfWeek' => [ + 'title' => '周循环字段，取值范围：1-7', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'StartDateTime' => [ + 'title' => '调度开始时间', + 'description' => '', + 'type' => 'string', + 'format' => 'int64', + 'example' => '1630054800000', + ], + 'EndDateTime' => [ + 'title' => '调度结束时间', + 'description' => '', + 'type' => 'string', + 'format' => 'int64', + 'example' => '1661598000000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数不合法。\\",\\n \\"Model\\": {\\n \\"RemindResponses\\": [\\n {\\n \\"RemindId\\": 0,\\n \\"RepeatCount\\": 1,\\n \\"ActionTopic\\": \\"宝宝快去刷牙\\",\\n \\"DayDesc\\": \\"每天\\",\\n \\"RemindTime\\": \\"1629850800000\\",\\n \\"Week\\": \\"周三\\",\\n \\"RecurrenceRule\\": {\\n \\"Freq\\": \\"WEEKLY\\",\\n \\"Year\\": 2021,\\n \\"Month\\": 8,\\n \\"Day\\": 27,\\n \\"Hour\\": 18,\\n \\"Minute\\": 0,\\n \\"Second\\": 0,\\n \\"DaysOfMonth\\": [\\n 1\\n ],\\n \\"DaysOfWeek\\": [\\n 1\\n ],\\n \\"StartDateTime\\": 1630054800000,\\n \\"EndDateTime\\": 1661598000000\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 400\\n 参数不合法。\\n \\n \\n 1\\n 宝宝快去刷牙\\n 每天\\n 1629850800000\\n 周三\\n \\n WEEKLY\\n 2021\\n 8\\n 27\\n 18\\n 0\\n 0\\n 1\\n 1\\n 1630054800000\\n 1661598000000\\n \\n \\n \\n","errorExample":""}]', + ], + 'UpdateReminder' => [ + 'summary' => '更新提醒', + 'path' => '/v1.0/iap/reminder/update', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '提醒id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20***34', + ], + 'Content' => [ + 'title' => '提醒内容', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '更新提醒内容', + ], + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + 'example' => '20****01', + ], + 'UserId' => [ + 'title' => '精灵id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12****56', + ], + 'DeviceId' => [ + 'title' => '设备id', + 'type' => 'string', + 'required' => true, + 'example' => 'BED****AAC', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'default' => 'false', + ], + 'RecurrenceRule' => [ + 'title' => '提醒调度信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Year' => [ + 'title' => '触发时间的年', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2021', + ], + 'Month' => [ + 'title' => '触发时间的月', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Day' => [ + 'title' => '触发时间的日', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '25', + ], + 'Hour' => [ + 'title' => '触发时间的时', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + 'Minute' => [ + 'title' => '触发时间的分', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Second' => [ + 'title' => '触发时间的秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Freq' => [ + 'title' => '循环类型:支持单次ONCE、每天DAILY、每周WEEKLY、每月MONTHLY', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ONCE', + 'enum' => [ + 'ONCE', + 'DAILY', + 'WEEKLY', + 'MONTHLY', + ], + ], + 'StartDateTime' => [ + 'title' => '开始时间，时间戳，毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1635134400000', + ], + 'EndDateTime' => [ + 'title' => '结束时间，时间戳，毫秒', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1635134700000', + ], + 'DaysOfMonth' => [ + 'title' => '月循环相关，表示每月的几号的集合,数值范围为1-31', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + 'DaysOfWeek' => [ + 'title' => '周循环相关，表示每周几触发，数值范围为1-7', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '服务成功标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'ErrorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '不能设置过去的时间。', + ], + 'Model' => [ + 'title' => '更新提醒的id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20****1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"不能设置过去的时间。\\",\\n \\"Model\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n","errorExample":""}]', + ], + 'DeleteReminder' => [ + 'summary' => '删除提醒', + 'path' => '/v1.0/iap/reminder/delete', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_Token' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '提醒的唯一id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20****34', + ], + 'UserId' => [ + 'title' => '精灵id', + 'type' => 'string', + 'required' => true, + 'example' => '12****56', + ], + 'DeviceId' => [ + 'title' => '设备id', + 'type' => 'string', + 'required' => true, + 'example' => 'BED****AAC', + ], + 'SubjectId' => [ + 'title' => '应用id', + 'type' => 'string', + 'required' => true, + 'example' => '20****01', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'SKILL_ID', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'SKILL_ID', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '服务成功标识', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'ErrorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '参数错误。', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": 400,\\n \\"ErrorMsg\\": \\"参数错误。\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n","errorExample":""}]', + ], + 'WakeUpApp' => [ + 'summary' => '猫精应用唤起', + 'path' => '/v1.0/iap/wakeup', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '服务请求入参', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '应用拉起路径，类似在技能应用控制台中填的唤起链接。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '应用拉起路径', + ], + 'SubjectId' => [ + 'title' => '猫精应用id', + 'type' => 'string', + 'required' => true, + 'example' => '2021****001', + ], + 'TargetInfo' => [ + 'title' => '要拉起的目标设备信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TargetType' => [ + 'title' => '推送目标类型，获取到对应设备标识时的类型 DEVICE_UNION_ID：设备unionId； DEVICE_OPEN_ID：设备openId', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DEVICE_OPEN_ID', + 'enum' => [ + 'DEVICE_UNION_ID', + 'DEVICE_OPEN_ID', + ], + ], + 'TargetIdentity' => [ + 'title' => '推送目标类型对应的标识值', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=', + ], + 'OrganizationId' => [ + 'title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '11', + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型： PACKAGE_NAME：apk包名 SKILL_ID：技能id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，例如：编码类型是SKILLID，其值就为webhook服务中得到的skillId；编码类似是PACKAGENAME，其值就为对应客户端app的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'apk包名', + ], + ], + 'required' => true, + ], + 'IsDebug' => [ + 'title' => '是否调试', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.WakeUpApp.Device.Offline', + 'errorMessage' => 'The Target Device is not online.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.GenieAppId', + 'errorMessage' => 'The AliGenie app does not release.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Body', + 'errorMessage' => 'You must specify request body.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetInfo', + 'errorMessage' => 'You must specify TargetInfo.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.Path', + 'errorMessage' => 'You must specify Path.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetIdentity', + 'errorMessage' => 'You must specify TargetIdentity.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeKey', + 'errorMessage' => 'You must specify EncodeKey.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.EncodeType', + 'errorMessage' => 'You must specify EncodeType.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.TargetType', + 'errorMessage' => 'You must specify TargetType.', + ], + [ + 'errorCode' => 'AliGenie.WakeUpApp.InvalidParameter.OrganizationId', + 'errorMessage' => 'You must specify OrganizationId.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'PushNotifications' => [ + 'summary' => '猫精系统消息推送', + 'path' => '/v1.0/iap/notifications', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'NotificationUnicastRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '消息推送入参对象。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SendTarget' => [ + 'title' => '消息推送的目标信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TargetType' => [ + 'title' => '推送的目标类型，获取到对应设备或用户标识时的类型 - DEVICE_UNION_ID：设备unionId - DEVICE_OPEN_ID：设备openId - USER_UNION_ID：用户unionId - USER_OPEN_ID：用户openId', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DEVICE_OPEN_ID', + 'enum' => [ + 'DEVICE_UNION_ID', + 'DEVICE_OPEN_ID', + 'USER_UNION_ID', + 'USER_OPEN_ID', + ], + ], + 'TargetIdentity' => [ + 'title' => '推送目标类型对应的标识值。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2VpiDQ6aMjxz******Eo7r6e08oIVZ3fKrm5TyEfY=', + ], + ], + 'required' => true, + ], + 'MessageTemplateId' => [ + 'title' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2iU81*****G9elJ', + ], + 'PlaceHolder' => [ + 'title' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '', + 'description' => '', + ], + 'example' => '{"nick":"张三"}', + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型： PACKAGE_NAME：apk包名 SKILL_ID：技能id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，例如：编码类型是SKILLID，其值就为webhook服务中得到的skillId；编码类似是PACKAGENAME，其值就为对应客户端app的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'apk包名', + ], + 'OrganizationId' => [ + 'title' => '组织标识，推送类型是XX_UNION_XX时才需要配。当存在多种途径获取猫精设备或用户标识且又需要能互通的情况下需要找平台申请组织，申请通过后由平台分配得到。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TenantInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '身份信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubjectId' => [ + 'title' => '猫精应用id，【开发者平台-技能应用】创建应用后得到的应用id', + 'type' => 'string', + 'example' => '20*****01', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', + 'errorMessage' => 'The template placeholder information is missing.', + ], + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', + 'errorMessage' => 'Failed to identify message target.', + ], + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', + 'errorMessage' => 'The template information is invalid.', + ], + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.Application.Invalid', + 'errorMessage' => 'The AliGenie app info is invalid.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.Application.Status', + 'errorMessage' => 'The AliGenie app has not been released.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.Application.Url', + 'errorMessage' => 'The AliGenie app awaken url is missing.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', + 'errorMessage' => 'Failed to identify device.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', + 'errorMessage' => 'Failed to identify user.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'SendNotifications' => [ + 'summary' => '消息推送服务（普通版）', + 'path' => '/v1.0/iap/general/notifications', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'NotificationUnicastRequest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '消息推送入参对象。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SendTarget' => [ + 'title' => '消息推送的目标信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => [ + 'title' => '设备id', + 'type' => 'string', + 'required' => true, + ], + ], + 'required' => true, + ], + 'MessageTemplateId' => [ + 'title' => '消息模板，在天猫精灵应用平台中申请消息模板时得到的模板id。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2iU81*****G9elJ', + ], + 'PlaceHolder' => [ + 'title' => '占位符信息，例如：模板是【你好，{nick}！】这里可以是：{"nick":"小甜甜"}', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => '', + ], + 'example' => '{"nick":"张三"}', + ], + 'IsDebug' => [ + 'title' => '调试标识', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TenantInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '身份信息。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubjectId' => [ + 'title' => '猫精应用标识', + 'type' => 'string', + 'required' => true, + 'example' => '20********01', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '用户标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '用户标识（userOpenId或userUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HOFF****my7Iw=', + ], + 'IdType' => [ + 'title' => '用户Id的类型 - OPEN_ID：默认的用户ID标识 - UNION_ID: 组织维度的用户ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的用户标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DeviceInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '设备标识信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '设备标识（deviceOpenId或deviceUnionId）', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'DAFE****ce3ej=', + ], + 'IdType' => [ + 'title' => '设备Id的类型 - OPEN_ID：默认的设备ID标识 - UNION_ID: 组织维度的设备ID标识，在猫精技能应用开放平台申请过组织后才会有', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'OPEN_ID', + 'enum' => [ + 'OPEN_ID', + 'UNION_ID', + ], + ], + 'EncodeType' => [ + 'title' => '编码类型，获取猫精的设备标识的途径有多种，不同途径对应不同的编码类型 - PACKAGE_NAME：apk包名，Android应用客户链路的编码类型 - SKILL_ID：技能ID，云端链路的编码类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PACKAGE_NAME', + 'enum' => [ + 'PACKAGE_NAME', + 'SKILL_ID', + ], + ], + 'EncodeKey' => [ + 'title' => '编码类型对应的值，编码类型是SKILL_ID时，其值为应用的Skill ID； 编码类型是PACKAGE_NAME时，其值为对应客户端App的packageName。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12**45', + ], + 'OrganizationId' => [ + 'title' => '组织ID，如果IdType为UNION_ID时必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1**2', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.PlaceHolder', + 'errorMessage' => 'The template placeholder information is missing.', + ], + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.SendTarget', + 'errorMessage' => 'Failed to identify message target.', + ], + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter.MessageTemplateId', + 'errorMessage' => 'The template information is invalid.', + ], + [ + 'errorCode' => 'AliGenie.PushNotifications.InvalidParameter', + 'errorMessage' => 'The request parameter is invalid.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.Application.Invalid', + 'errorMessage' => 'The AliGenie app info is invalid.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.Application.Status', + 'errorMessage' => 'The AliGenie app has not been released.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.Application.Url', + 'errorMessage' => 'The AliGenie app awaken url is missing.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.InvalidParameter.DeviceInfo', + 'errorMessage' => 'Failed to identify device.', + ], + [ + 'errorCode' => 'AliGenie.Notifications.InvalidParameter.UserInfo', + 'errorMessage' => 'Failed to identify user.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'CheckThirdRightSendPlan' => [ + 'summary' => '商业化移动屏三方app领卡校验', + 'path' => '/v1.0/iap/business/CheckThirdRightSendPlan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'title' => '设备类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ailabs', + ], + ], + [ + 'name' => 'BizGroup', + 'in' => 'query', + 'schema' => [ + 'title' => '设备分组', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cc', + ], + ], + [ + 'name' => 'Sn', + 'in' => 'query', + 'schema' => [ + 'title' => '设备sn', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '01000019100307010000600', + ], + ], + [ + 'name' => 'SupplierId', + 'in' => 'query', + 'schema' => [ + 'title' => '供应商id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetCode' => [ + 'title' => '返回code', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '系统异常', + ], + 'RetValue' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CardType' => [ + 'title' => '卡种', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡', + ], + 'RightsExpiredDate' => [ + 'title' => '权益失效时间', + 'description' => '', + 'type' => 'string', + 'example' => '"1713262192005"', + ], + 'ActivateDate' => [ + 'title' => '激活时间', + 'description' => '', + 'type' => 'string', + 'example' => '"1713262192005"', + ], + 'ChannelCode' => [ + 'title' => '渠道code', + 'description' => '', + 'type' => 'string', + 'example' => 'TB', + ], + 'ChannelName' => [ + 'title' => '渠道名称', + 'description' => '', + 'type' => 'string', + 'example' => '淘宝', + ], + 'RequestId' => [ + 'title' => '请求iid', + 'description' => '', + 'type' => 'string', + 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F', + ], + 'ExtendInfo' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'AliGenie.Public.InternalError', + 'errorMessage' => 'An internal error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetCode\\": 0,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetValue\\": {\\n \\"CardType\\": 0,\\n \\"RightsExpiredDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ActivateDate\\": \\"\\\\\\"1713262192005\\\\\\"\\",\\n \\"ChannelCode\\": \\"TB\\",\\n \\"ChannelName\\": \\"淘宝\\",\\n \\"RequestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\",\\n \\"ExtendInfo\\": {}\\n }\\n}","type":"json"}]', + ], + 'CallBackThirdRightSendPlan' => [ + 'summary' => '三方领取回调接口', + 'path' => '/v1.0/iap/business/CallBackThirdRightSendPlan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'title' => '设备类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ailabs', + ], + ], + [ + 'name' => 'BizGroup', + 'in' => 'query', + 'schema' => [ + 'title' => '设备分组', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cc', + ], + ], + [ + 'name' => 'Sn', + 'in' => 'query', + 'schema' => [ + 'title' => '设备对应的sn', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '01000019100307010000600', + ], + ], + [ + 'name' => 'SupplierId', + 'in' => 'query', + 'schema' => [ + 'title' => '供应商id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'GenieOpenId', + 'in' => 'query', + 'schema' => [ + 'title' => '精灵id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1dsds2FzCXFGVA1ADS', + ], + ], + [ + 'name' => 'ReceiveStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '领取状态', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CardType', + 'in' => 'query', + 'schema' => [ + 'title' => '1001 日卡 1002 月卡 1003 季卡 1004 年卡', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'ErrorMsg', + 'in' => 'query', + 'schema' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '领取异常', + ], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RetValue' => [ + 'title' => '返回结果 true/false', + 'description' => '', + 'type' => 'boolean', + ], + 'RetMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '系统异常', + ], + 'RetCode' => [ + 'title' => '错误状态码', + 'description' => '', + 'type' => 'string', + 'example' => '400', + ], + 'requestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '908FA068-529C-0C20-8DB5-63B0EF7CFF1F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RetValue\\": true,\\n \\"RetMsg\\": \\"系统异常\\",\\n \\"RetCode\\": \\"400\\",\\n \\"requestId\\": \\"908FA068-529C-0C20-8DB5-63B0EF7CFF1F\\"\\n}","type":"json"}]', + ], + 'ThirdImmediateMsgPush' => [ + 'summary' => '三方即时信息数据变更事件推送', + 'path' => '/v1.0/iap/thirdImmediateMsgPush', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AliGenie_Auth_SPI' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'userId', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '订单id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'orderId', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'title' => '业务类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'FLIGHT', + ], + ], + [ + 'name' => 'TrafficChangeType', + 'in' => 'query', + 'schema' => [ + 'title' => '变动类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'trafficChangeType', + ], + ], + [ + 'name' => 'TrafficChangeTypeDesc', + 'in' => 'query', + 'schema' => [ + 'title' => '变动类型描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'trafficChangeTypeDesc', + ], + ], + [ + 'name' => 'ChangeDetail', + 'in' => 'query', + 'schema' => [ + 'title' => '变动信息明细', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'changeDetail', + ], + ], + [ + 'name' => 'TrafficJourneyIds', + 'in' => 'query', + 'schema' => [ + 'title' => '变更的行程id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'trafficJourneyIds', + ], + ], + [ + 'name' => 'TrafficSubOrderIds', + 'in' => 'query', + 'schema' => [ + 'title' => '变更的火车申请单子订单id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'trafficSubOrderIds', + ], + ], + [ + 'name' => 'PsgIds', + 'in' => 'query', + 'schema' => [ + 'title' => '变更的乘客id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'psgIds', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '调用是否成功', + 'description' => '', + 'type' => 'boolean', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '500000000', + ], + 'ErrorMsg' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => '服务器内部异常', + ], + 'Model' => [ + 'title' => '推送结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '2DF6FEFE-3301-16DD-ABCC-968A9524920B', + ], + 'Success' => [ + 'title' => '是否推送成功', + 'description' => '', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"500000000\\",\\n \\"ErrorMsg\\": \\"服务器内部异常\\",\\n \\"Model\\": {\\n \\"RequestId\\": \\"2DF6FEFE-3301-16DD-ABCC-968A9524920B\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'openapi.aligenie.com', + ], + ], +]; -- cgit v1.2.3