summaryrefslogtreecommitdiff
path: root/data/zh_cn/notifications
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/notifications')
-rw-r--r--data/zh_cn/notifications/2024-12-25/api-docs.php2680
1 files changed, 585 insertions, 2095 deletions
diff --git a/data/zh_cn/notifications/2024-12-25/api-docs.php b/data/zh_cn/notifications/2024-12-25/api-docs.php
index 8cfd52d..4294736 100644
--- a/data/zh_cn/notifications/2024-12-25/api-docs.php
+++ b/data/zh_cn/notifications/2024-12-25/api-docs.php
@@ -1,601 +1,301 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Notifications',
- 'version' => '2024-12-25',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Notifications', 'version' => '2024-12-25'],
'directories' => [
[
- 'id' => 282468,
- 'title' => '订阅',
+ 'children' => ['ReadCategoryGroupList', 'ReadMessageLanguage', 'UpdateMessageLanguage'],
'type' => 'directory',
- 'children' => [
- 'ReadCategoryGroupList',
- 'ReadMessageLanguage',
- 'UpdateMessageLanguage',
- ],
+ 'title' => '订阅',
+ 'id' => 433493,
],
[
- 'id' => 282471,
- 'title' => '站内信',
+ 'children' => ['ReadAllMessage', 'ReadMessageNewTotal', 'ReadMessage', 'ReadMessageList', 'ReadNumGroupByClass', 'DelMessage', 'ReadNumGroupTotal', 'ReadMessageContent', 'ReadClassName', 'DeleteAllMessage'],
'type' => 'directory',
- 'children' => [
- 'ReadAllMessage',
- 'ReadMessageNewTotal',
- 'ReadMessage',
- 'ReadMessageList',
- 'ReadNumGroupByClass',
- 'DelMessage',
- 'ReadNumGroupTotal',
- 'ReadMessageContent',
- 'ReadClassName',
- 'DeleteAllMessage',
- ],
+ 'title' => '站内信',
+ 'id' => 433497,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'ReadCategoryGroupList' => [
- 'summary' => '获取分类组列表',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DelMessage' => [
+ 'summary' => '方法描述:删除消息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '忽略,暂时无需传递。请求方的应用工程名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '忽略,暂时无需传递。请求协议类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '忽略,暂时无需传递。请求方的业务线。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '忽略,暂时无需传递。租户信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '忽略,暂时无需传递。用户类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '忽略,暂时无需传递。操作终端来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '忽略,暂时无需传递。来源页面URL。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '忽略,暂时无需传递。用户cookies。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'description' => '语言。浏览器自动透传,可手动覆盖',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['title' => '语言', 'description' => '语言,默认为简体中文', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
],
[
- 'name' => 'ChannelGroupCode',
+ 'name' => 'MsgId',
'in' => 'formData',
- 'schema' => [
- 'description' => '通道组',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'tts' => '语言接收管理',
- 'webhook' => '机器人接收管理',
- 'base' => '基本接收管理',
- ],
- 'example' => 'base',
- ],
+ 'schema' => ['description' => '消息Id', 'type' => 'string', 'required' => false, 'example' => '3727683838'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<List<SimpleCategoryGroupDTO>>',
- 'description' => 'PlainResult<List<SimpleCategoryGroupDTO>>',
+ 'title' => 'YungePopResult<Boolean>',
+ 'description' => 'YungePopResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '系统返回的错误码。错误码详情,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Data' => [
- 'description' => '执行结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '执行结果',
- 'type' => 'object',
- 'properties' => [
- 'GroupCode' => [
- 'description' => '分类组code',
- 'type' => 'string',
- 'example' => 'prod_msg',
- ],
- 'GroupName' => [
- 'description' => '分组名称',
- 'type' => 'string',
- 'example' => '产品消息',
- ],
- ],
- ],
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '/',
- ],
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true'."\n",
- ],
+ 'Success' => ['description' => '删除规则是否成功。取值:true:成功false: 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => ['description' => '执行结果', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
+ 'title' => '删除消息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Data\\": [\\n {\\n \\"GroupCode\\": \\"prod_msg\\",\\n \\"GroupName\\": \\"产品消息\\"\\n }\\n ],\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"/\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取分类组列表',
],
- 'ReadMessageLanguage' => [
- 'summary' => '获取消息语言。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteAllMessage' => [
+ 'summary' => '方法描述:站内信全部删除(逻辑删除)。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '忽略,暂时无需传递。请求方的应用工程名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '忽略,暂时无需传递。请求协议类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '忽略,暂时无需传递。请求方的业务线。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '忽略,暂时无需传递。租户信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '忽略,暂时无需传递。用户类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '忽略,暂时无需传递。操作终端来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '忽略,暂时无需传递。来源页面URL。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '忽略,暂时无需传递。用户cookies。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '忽略,暂时无需传递。页面语言。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'default' => 'zh-CN',
- ],
+ 'schema' => ['title' => '语言', 'description' => '语言,默认为简体中文', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
],
[
- 'name' => 'ReturnDefaultLang',
+ 'name' => 'ClassId',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否返回默认语言,值为YES时返回默认语言。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'NO' => 'NO',
- 'YES' => 'YES',
- ],
- 'example' => 'YES',
- ],
+ 'schema' => ['description' => '消息类目Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'GroupCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分组code', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<String>',
- 'description' => 'PlainResult<String>',
+ 'title' => 'YungePopResult<Boolean>',
+ 'description' => 'YungePopResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '执行结果',
- 'type' => 'string',
- 'example' => 'zh-CN',
- ],
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
- ],
+ 'Success' => ['description' => '接口调用是否成功。取值:true:成功false: 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => ['description' => '删除是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"zh-CN\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
- 'title' => '获取消息语言',
- ],
- 'UpdateMessageLanguage' => [
- 'summary' => '更新消息语言',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
+ 'title' => '删除全部消息',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-18T08:40:41.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ReadAllMessage' => [
+ 'summary' => '方法描述:分类全部标记为已读,不填则全部标记',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '忽略,暂时无需传递。请求方的应用工程名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '忽略,暂时无需传递。请求协议类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '忽略,暂时无需传递。请求方的业务线。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '忽略,暂时无需传递。租户信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '忽略,暂时无需传递。用户类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '忽略,暂时无需传递。操作终端来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '忽略,暂时无需传递。来源页面URL。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '忽略,暂时无需传递。用户cookies。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '[]'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '忽略,暂时无需传递。页面语言。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'zh-CN',
- ],
+ 'schema' => ['title' => '语言', 'description' => '语言,默认为简体中文', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
],
[
- 'name' => 'PreferLang',
+ 'name' => 'ClassId',
'in' => 'formData',
- 'schema' => [
- 'description' => '消息语言,必填',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en' => 'en',
- 'zh-CN' => 'zh-CN',
- ],
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => '消息类目Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'GroupCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分组Code', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Void>',
- 'description' => 'PlainResult<Void>',
+ 'title' => 'YungePopResult<Boolean>',
+ 'description' => 'YungePopResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '73FD6AE8-898F-5D09-9763-69B8A875488A',
- ],
- 'Success' => [
- 'description' => '删除规则是否成功。取值:true:成功false: 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => ['description' => '执行结果', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"73FD6AE8-898F-5D09-9763-69B8A875488A\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新消息语言',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
+ 'title' => '将全部消息置为已读',
+ 'changeSet' => [],
],
- 'ReadAllMessage' => [
- 'summary' => '方法描述:分类全部标记为已读,不填则全部标记',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadCategoryGroupList' => [
+ 'summary' => '获取分类组列表',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -603,188 +303,101 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '忽略,暂时无需传递。请求方的应用工程名。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '忽略,暂时无需传递。请求协议类型。', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '忽略,暂时无需传递。请求方的业务线。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '忽略,暂时无需传递。租户信息。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '忽略,暂时无需传递。用户类型。', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '忽略,暂时无需传递。操作终端来源。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '忽略,暂时无需传递。来源页面URL。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[]',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '忽略,暂时无需传递。用户cookies。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '语言,默认为简体中文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'default' => 'zh-CN',
- ],
- ],
- [
- 'name' => 'ClassId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '消息类目Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '语言。浏览器自动透传,可手动覆盖', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
- 'name' => 'GroupCode',
+ 'name' => 'ChannelGroupCode',
'in' => 'formData',
'schema' => [
- 'description' => '分组Code',
+ 'description' => '通道组',
'type' => 'string',
'required' => false,
- 'example' => 'test',
+ 'enumValueTitles' => ['tts' => '语言接收管理', 'webhook' => '机器人接收管理', 'base' => '基本接收管理'],
+ 'example' => 'base',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<Boolean>',
- 'description' => 'YungePopResult<Boolean>',
+ 'title' => 'PlainResult<List<SimpleCategoryGroupDTO>>',
+ 'description' => 'PlainResult<List<SimpleCategoryGroupDTO>>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'Code' => ['description' => '系统返回的错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
'Data' => [
'description' => '执行结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '执行结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupCode' => ['description' => '分类组code', 'type' => 'string', 'example' => 'prod_msg'],
+ 'GroupName' => ['description' => '分组名称', 'type' => 'string', 'example' => '产品消息'],
+ ],
+ ],
],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '/'],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'."\n"],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
- 'title' => '将全部消息置为已读',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Data\\": [\\n {\\n \\"GroupCode\\": \\"prod_msg\\",\\n \\"GroupName\\": \\"产品消息\\"\\n }\\n ],\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"/\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '获取分类组列表',
+ 'changeSet' => [],
],
- 'ReadMessageNewTotal' => [
- 'summary' => '方法描述:获取未读消息总数',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadClassName' => [
+ 'summary' => '方法描述:获取各分类已读消息数',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -792,174 +405,93 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '语言,默认为简体中文',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'zh-TW' => 'zh-TW',
- 'ja' => 'ja',
- 'en' => 'en',
- 'zh-CN' => 'zh-CN',
- ],
- 'example' => 'zh-CN',
- 'default' => 'zh-CN',
- ],
+ 'schema' => ['title' => '语言', 'description' => '语言,默认为简体中文', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<Long>',
- 'description' => '/',
+ 'title' => 'YungePopResult<List<ClassCountDo>>',
+ 'description' => 'YungePopResult<List<ClassCountDo>>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['description' => '系统返回的错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '新消息总数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
+ 'description' => '执行结果',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '执行结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => 'class id', 'description' => '消息类目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Name' => ['description' => '消息类目名称', 'type' => 'string', 'example' => '安全消息'],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '73FD6AE8-898F-5D09-9763-69B8A875488A'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"安全消息\\"\\n }\\n ],\\n \\"RequestId\\": \\"73FD6AE8-898F-5D09-9763-69B8A875488A\\"\\n}","type":"json"}]',
+ 'title' => '获取类目名称',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": 1,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
- 'title' => '获取未读消息总数',
],
'ReadMessage' => [
'summary' => '方法描述:消息标记为已读',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -967,125 +499,57 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '来源页面URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '来源页面URL', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '语言,默认为简体中文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'default' => 'zh-CN',
- ],
+ 'schema' => ['title' => '语言', 'description' => '语言,默认为简体中文', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
],
[
'name' => 'MsgId',
'in' => 'formData',
- 'schema' => [
- 'description' => '消息Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A9FEF04A004A383534AA6400092A904F',
- ],
+ 'schema' => ['description' => '消息Id', 'type' => 'string', 'required' => false, 'example' => 'A9FEF04A004A383534AA6400092A904F'],
],
],
'responses' => [
@@ -1095,49 +559,24 @@
'description' => 'YungePopResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true表示调用成功,false表示调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'description' => '执行结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
- ],
+ 'Success' => ['description' => '是否调用成功。true表示调用成功,false表示调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => ['description' => '执行结果', 'type' => 'boolean', 'example' => 'true'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
'title' => '将消息置为已读',
+ 'changeSet' => [],
],
- 'ReadMessageList' => [
- 'summary' => '方法描述:获取消息列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadMessageContent' => [
+ 'summary' => '方法描述:获取消息正文',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1145,380 +584,165 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '语言,默认为简体中文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'default' => 'zh-CN',
- ],
- ],
- [
- 'name' => 'ClassId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '已废弃',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '消息状态,已读为1,未读为0,-1全部,默认值-1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- 'default' => '-1',
- ],
- ],
- [
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '消息标题,用于模糊搜索',
- 'type' => 'string',
- 'required' => false,
- 'example' => '"标题示例“',
- ],
- ],
- [
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '消息内容,用于模糊搜索',
- 'type' => 'string',
- 'required' => false,
- 'example' => '"消息内容示例“',
- ],
- ],
- [
- 'name' => 'Page',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['title' => '语言', 'description' => '语言,默认为简体中文', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'MsgId',
'in' => 'formData',
- 'schema' => [
- 'description' => '系统参数,无需填写',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['description' => '消息Id', 'type' => 'string', 'required' => false, 'example' => '3727683838'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClassId',
'in' => 'formData',
- 'schema' => [
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['description' => '已废弃', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Loc',
+ 'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'description' => '位置',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'nav',
- ],
+ 'schema' => ['description' => '阅读状态,0未读1已读', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'History',
'in' => 'formData',
'schema' => [
'description' => '是否是历史消息',
- 'type' => 'string',
+ 'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
],
],
[
'name' => 'GroupCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '分组code',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '分组code', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<DataPage<ResponseMessage>>',
- 'description' => 'YungePopResult<DataPage<ResponseMessage>>',
+ 'title' => 'YungePopResult<Map<String, Map<String, List<ResponseMessage>>>>',
+ 'description' => 'YungePopResult<Map<String, Map<String, List<ResponseMessage>>>>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
- ],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
'Data' => [
'description' => '执行结果',
'type' => 'object',
'properties' => [
- 'Count' => [
- 'description' => '消息数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MaxResults' => [
- 'description' => '保留字段',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '/',
- ],
- 'NextToken' => [
- 'description' => '保留字段',
- 'type' => 'string',
- 'example' => '/',
- ],
- 'Page' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '24',
- ],
- 'PageSize' => [
- 'description' => '分页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Rows' => [
- 'description' => '返回数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回数据单条',
- 'type' => 'object',
- 'properties' => [
- 'CategoryName' => [
- 'description' => '消息分类名称',
- 'type' => 'string',
- 'example' => '活动消息',
- ],
- 'Class' => [
- 'description' => '保留字段',
- 'type' => 'string',
- 'example' => '/',
- ],
- 'ClassId' => [
- 'description' => '消息类目Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Content' => [
- 'description' => '消息内容',
- 'type' => 'string',
- 'example' => '"消息内容示例“',
- ],
- 'Deleted' => [
- 'description' => '删除标识',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'GmtCreated' => [
- 'description' => '消息产生时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1723772244000',
- ],
- 'GmtUpdate' => [
- 'description' => '消息更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1723772244000',
- ],
- 'MassId' => [
- 'description' => '保留字段',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '/',
- ],
- 'Memo' => [
- 'description' => '保留字段',
- 'type' => 'string',
- 'example' => '/',
- ],
- 'MsgId' => [
- 'description' => '消息Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3727683838'."\n",
- ],
- 'Status' => [
- 'description' => '已读状态,未读0已读1',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'Title' => [
- 'description' => '消息标题',
- 'type' => 'string',
- 'example' => '"标题示例“',
+ 'Datas' => [
+ 'description' => '降级规则列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Item' => [
+ 'description' => '数据项',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据体',
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryName' => ['description' => '消息分类名称', 'type' => 'string', 'example' => '活动消息'],
+ 'ClassId' => ['description' => '消息类目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Content' => ['description' => '消息内容', 'type' => 'string', 'example' => '"消息内容示例“'],
+ 'Deleted' => ['description' => '删除标识', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'GmtCreated' => ['description' => '消息产生时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000'],
+ 'GmtUpdate' => ['description' => '消息更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000'],
+ 'MassId' => ['description' => '保留字段', 'type' => 'integer', 'format' => 'int64', 'example' => '/'],
+ 'Memo' => ['description' => '保留字段', 'type' => 'string', 'example' => '385ad715-4139-41f9-ba59-246a00bb46e0.jpg'],
+ 'MsgId' => ['description' => '消息Id', 'type' => 'integer', 'format' => 'int64', 'example' => 'AC14C11F1FF801EE00054518C220EF2C'],
+ 'Status' => ['description' => '已读状态,未读0已读1', 'type' => 'integer', 'format' => 'int64', 'example' => 'not_installed'],
+ 'Title' => ['description' => '消息标题', 'type' => 'string', 'example' => 'Endless'],
+ ],
],
- 'Titleh' => [
- 'description' => '高亮title',
- 'type' => 'string',
- 'example' => 'title',
+ ],
+ 'LastItem' => [
+ 'description' => '/',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '/',
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryName' => ['description' => '消息分类名称', 'type' => 'string', 'example' => '活动消息'],
+ 'ClassId' => ['description' => '消息类目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Content' => ['description' => '消息内容', 'type' => 'string', 'example' => '"消息内容示例“'],
+ 'Deleted' => ['description' => '删除标识', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'GmtCreated' => ['description' => '消息产生时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000'],
+ 'GmtUpdate' => ['description' => '消息更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000'],
+ 'MassId' => ['description' => '保留字段', 'type' => 'integer', 'format' => 'int64', 'example' => '/'],
+ 'Memo' => ['description' => '保留字段', 'type' => 'string', 'example' => '/'],
+ 'MsgId' => ['description' => '消息Id', 'type' => 'integer', 'format' => 'int64', 'example' => '3727683838'."\n"],
+ 'Status' => ['description' => '已读状态,未读0已读1', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'Title' => ['description' => '消息标题', 'type' => 'string', 'example' => '"标题示例“'],
+ ],
],
- 'CategoryCode' => [
- 'description' => '分类code',
- 'type' => 'string',
- 'example' => 'test',
+ ],
+ 'NextItem' => [
+ 'description' => '/',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryName' => ['description' => '消息分类名称', 'type' => 'string', 'example' => '活动消息'],
+ 'ClassId' => ['description' => '消息类目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Content' => ['description' => '消息内容', 'type' => 'string', 'example' => '”消息内容示例“'],
+ 'Deleted' => ['description' => '删除标识', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'GmtCreated' => ['description' => '消息产生时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1663809374000'],
+ 'GmtUpdate' => ['description' => '消息更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1663809374000'],
+ 'MassId' => ['description' => '保留字段', 'type' => 'integer', 'format' => 'int64', 'example' => '/'],
+ 'Memo' => ['description' => '保留字段', 'type' => 'string', 'example' => '/'],
+ 'MsgId' => ['description' => '消息Id', 'type' => 'integer', 'format' => 'int64', 'example' => '3727683838'],
+ 'Status' => ['description' => '已读状态,未读0已读1', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'Title' => ['description' => '消息标题', 'type' => 'string', 'example' => '"标题示例“'],
+ ],
+ 'description' => '',
],
],
],
@@ -1529,20 +753,15 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\",\\n \\"Data\\": {\\n \\"Count\\": 1,\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"/\\",\\n \\"Page\\": 24,\\n \\"PageSize\\": 10,\\n \\"Rows\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"Class\\": \\"/\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"\\\\\\"消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1723772244000,\\n \\"GmtUpdate\\": 1723772244000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"/\\",\\n \\"MsgId\\": 3727683838,\\n \\"Status\\": 0,\\n \\"Title\\": \\"\\\\\\"标题示例“\\",\\n \\"Titleh\\": \\"title\\",\\n \\"CategoryCode\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取消息列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\",\\n \\"Data\\": {\\n \\"Datas\\": {\\n \\"Item\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"\\\\\\"消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1729758903000,\\n \\"GmtUpdate\\": 1729758903000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"385ad715-4139-41f9-ba59-246a00bb46e0.jpg\\",\\n \\"MsgId\\": 0,\\n \\"Status\\": 0,\\n \\"Title\\": \\"Endless\\"\\n }\\n ],\\n \\"LastItem\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"\\\\\\"消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1729758903000,\\n \\"GmtUpdate\\": 1729758903000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"/\\",\\n \\"MsgId\\": 3727683838,\\n \\"Status\\": 0,\\n \\"Title\\": \\"\\\\\\"标题示例“\\"\\n }\\n ],\\n \\"NextItem\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"”消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1663809374000,\\n \\"GmtUpdate\\": 1663809374000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"/\\",\\n \\"MsgId\\": 3727683838,\\n \\"Status\\": 0,\\n \\"Title\\": \\"\\\\\\"标题示例“\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '获取消息内容',
+ 'changeSet' => [],
],
- 'ReadNumGroupByClass' => [
- 'summary' => '方法描述:获取各分类已读消息数',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadMessageLanguage' => [
+ 'summary' => '获取消息语言。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1550,370 +769,265 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '忽略,暂时无需传递。请求方的应用工程名', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '忽略,暂时无需传递。请求协议类型。', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '忽略,暂时无需传递。请求方的业务线。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '忽略,暂时无需传递。租户信息。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '忽略,暂时无需传递。用户类型。', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '忽略,暂时无需传递。操作终端来源。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '忽略,暂时无需传递。来源页面URL。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '忽略,暂时无需传递。用户cookies。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
+ 'schema' => ['title' => '语言', 'description' => '忽略,暂时无需传递。页面语言。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
+ ],
+ [
+ 'name' => 'ReturnDefaultLang',
+ 'in' => 'formData',
'schema' => [
- 'title' => '语言',
- 'description' => '语言,默认为简体中文',
+ 'description' => '是否返回默认语言,值为YES时返回默认语言。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'zh-TW' => 'zh-TW',
- 'ja' => 'ja',
- 'en' => 'en',
- 'zh-CN' => 'zh-CN',
- ],
- 'example' => 'zh-CN'."\n",
- 'default' => 'zh-CN',
+ 'enumValueTitles' => ['NO' => 'NO', 'YES' => 'YES'],
+ 'example' => 'YES',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<List<ClassCountDo>>',
- 'description' => '/',
+ 'title' => 'PlainResult<String>',
+ 'description' => 'PlainResult<String>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true'."\n",
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'description' => '执行结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '执行结果',
- 'type' => 'object',
- 'properties' => [
- 'ClassId' => [
- 'title' => 'class id',
- 'description' => '消息类目ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MsgCount' => [
- 'title' => '未读数量',
- 'description' => '该类目下未读消息数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
- ],
+ 'Data' => ['description' => '执行结果', 'type' => 'string', 'example' => 'zh-CN'],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"ClassId\\": 1,\\n \\"MsgCount\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
- 'title' => '获取各分类已读消息数',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"zh-CN\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
+ 'title' => '获取消息语言',
+ 'changeSet' => [],
],
- 'DelMessage' => [
- 'summary' => '方法描述:删除消息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadMessageList' => [
+ 'summary' => '方法描述:获取消息列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '语言,默认为简体中文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'default' => 'zh-CN',
- ],
+ 'schema' => ['title' => '语言', 'description' => '语言,默认为简体中文', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN'],
],
[
- 'name' => 'MsgId',
+ 'name' => 'ClassId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '已废弃', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => ['description' => '消息状态,已读为1,未读为0,-1全部,默认值-1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '-1'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['description' => '消息标题,用于模糊搜索', 'type' => 'string', 'required' => false, 'example' => '"标题示例“'],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['description' => '消息内容,用于模糊搜索', 'type' => 'string', 'required' => false, 'example' => '"消息内容示例“'],
+ ],
+ [
+ 'name' => 'Page',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分页查询页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分页查询大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '系统参数,无需填写', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '/'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
+ ],
+ [
+ 'name' => 'Loc',
+ 'in' => 'formData',
+ 'schema' => ['description' => '位置', 'type' => 'string', 'required' => false, 'example' => 'nav'],
+ ],
+ [
+ 'name' => 'History',
'in' => 'formData',
'schema' => [
- 'description' => '消息Id',
+ 'description' => '是否是历史消息',
'type' => 'string',
'required' => false,
- 'example' => '3727683838',
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
+ 'example' => 'true',
],
],
+ [
+ 'name' => 'GroupCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分组code', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<Boolean>',
- 'description' => 'YungePopResult<Boolean>',
+ 'title' => 'YungePopResult<DataPage<ResponseMessage>>',
+ 'description' => 'YungePopResult<DataPage<ResponseMessage>>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '删除规则是否成功。取值:true:成功false: 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
'Data' => [
'description' => '执行结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => ['description' => '消息数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MaxResults' => ['description' => '保留字段', 'type' => 'integer', 'format' => 'int64', 'example' => '/'],
+ 'NextToken' => ['description' => '保留字段', 'type' => 'string', 'example' => '/'],
+ 'Page' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
+ 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Rows' => [
+ 'description' => '返回数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据单条',
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryName' => ['description' => '消息分类名称', 'type' => 'string', 'example' => '活动消息'],
+ 'Class' => ['description' => '保留字段', 'type' => 'string', 'example' => '/'],
+ 'ClassId' => ['description' => '消息类目Id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Content' => ['description' => '消息内容', 'type' => 'string', 'example' => '"消息内容示例“'],
+ 'Deleted' => ['description' => '删除标识', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'GmtCreated' => ['description' => '消息产生时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1723772244000'],
+ 'GmtUpdate' => ['description' => '消息更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1723772244000'],
+ 'MassId' => ['description' => '保留字段', 'type' => 'integer', 'format' => 'int64', 'example' => '/'],
+ 'Memo' => ['description' => '保留字段', 'type' => 'string', 'example' => '/'],
+ 'MsgId' => ['description' => '消息Id', 'type' => 'integer', 'format' => 'int64', 'example' => '3727683838'."\n"],
+ 'Status' => ['description' => '已读状态,未读0已读1', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'Title' => ['description' => '消息标题', 'type' => 'string', 'example' => '"标题示例“'],
+ 'Titleh' => ['description' => '高亮title', 'type' => 'string', 'example' => 'title'],
+ 'CategoryCode' => ['description' => '分类code', 'type' => 'string', 'example' => 'test'],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
- 'title' => '删除消息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\",\\n \\"Data\\": {\\n \\"Count\\": 1,\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"/\\",\\n \\"Page\\": 24,\\n \\"PageSize\\": 10,\\n \\"Rows\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"Class\\": \\"/\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"\\\\\\"消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1723772244000,\\n \\"GmtUpdate\\": 1723772244000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"/\\",\\n \\"MsgId\\": 3727683838,\\n \\"Status\\": 0,\\n \\"Title\\": \\"\\\\\\"标题示例“\\",\\n \\"Titleh\\": \\"title\\",\\n \\"CategoryCode\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '获取消息列表',
+ 'changeSet' => [],
],
- 'ReadNumGroupTotal' => [
- 'summary' => '方法描述:获取所有分类下的信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadMessageNewTotal' => [
+ 'summary' => '方法描述:获取未读消息总数',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1921,103 +1035,47 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
@@ -2027,111 +1085,37 @@
'description' => '语言,默认为简体中文',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'zh-TW' => 'zh-TW',
- 'ja' => 'ja',
- 'en' => 'en',
- 'zh-CN' => 'zh-CN',
- ],
+ 'enumValueTitles' => ['zh-TW' => 'zh-TW', 'ja' => 'ja', 'en' => 'en', 'zh-CN' => 'zh-CN'],
'example' => 'zh-CN',
'default' => 'zh-CN',
],
],
- [
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '消息标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Can \'Financial expenses_interest income\' be considered as income?',
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<List<ResponseCountByCategory>>',
+ 'title' => 'YungePopResult<Long>',
'description' => '/',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'description' => '执行结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '执行结果',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '消息类目ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'ReadCount' => [
- 'description' => '类目下消息已读数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'UnReadCount' => [
- 'description' => '类目下消息未读数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '类目下消息总数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'GroupCode' => [
- 'description' => '分组code',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
- ],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => ['description' => '新消息总数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"ReadCount\\": 1,\\n \\"UnReadCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"GroupCode\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
- 'title' => '获取所有分类下的信息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": 1,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
+ 'title' => '获取未读消息总数',
+ 'changeSet' => [],
],
- 'ReadMessageContent' => [
- 'summary' => '方法描述:获取消息正文',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadNumGroupByClass' => [
+ 'summary' => '方法描述:获取各分类已读消息数',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2139,103 +1123,47 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
@@ -2245,339 +1173,51 @@
'description' => '语言,默认为简体中文',
'type' => 'string',
'required' => false,
- 'example' => 'zh-CN',
+ 'enumValueTitles' => ['zh-TW' => 'zh-TW', 'ja' => 'ja', 'en' => 'en', 'zh-CN' => 'zh-CN'],
+ 'example' => 'zh-CN'."\n",
'default' => 'zh-CN',
],
],
- [
- 'name' => 'MsgId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '消息Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3727683838',
- ],
- ],
- [
- 'name' => 'ClassId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '已废弃',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '阅读状态,0未读1已读',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'History',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '是否是历史消息',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'GroupCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '分组code',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<Map<String, Map<String, List<ResponseMessage>>>>',
- 'description' => 'YungePopResult<Map<String, Map<String, List<ResponseMessage>>>>',
+ 'title' => 'YungePopResult<List<ClassCountDo>>',
+ 'description' => '/',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
- ],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'."\n"],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
'Data' => [
'description' => '执行结果',
- 'type' => 'object',
- 'properties' => [
- 'Datas' => [
- 'description' => '降级规则列表',
- 'type' => 'object',
- 'properties' => [
- 'Item' => [
- 'description' => '数据项',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据体',
- 'type' => 'object',
- 'properties' => [
- 'CategoryName' => [
- 'description' => '消息分类名称',
- 'type' => 'string',
- 'example' => '活动消息',
- ],
- 'ClassId' => [
- 'description' => '消息类目Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Content' => [
- 'description' => '消息内容',
- 'type' => 'string',
- 'example' => '"消息内容示例“',
- ],
- 'Deleted' => [
- 'description' => '删除标识',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'GmtCreated' => [
- 'description' => '消息产生时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729758903000',
- ],
- 'GmtUpdate' => [
- 'description' => '消息更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729758903000',
- ],
- 'MassId' => [
- 'description' => '保留字段',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '/',
- ],
- 'Memo' => [
- 'description' => '保留字段',
- 'type' => 'string',
- 'example' => '385ad715-4139-41f9-ba59-246a00bb46e0.jpg',
- ],
- 'MsgId' => [
- 'description' => '消息Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'AC14C11F1FF801EE00054518C220EF2C',
- ],
- 'Status' => [
- 'description' => '已读状态,未读0已读1',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'not_installed',
- ],
- 'Title' => [
- 'description' => '消息标题',
- 'type' => 'string',
- 'example' => 'Endless',
- ],
- ],
- ],
- ],
- 'LastItem' => [
- 'description' => '/',
- 'type' => 'array',
- 'items' => [
- 'description' => '/',
- 'type' => 'object',
- 'properties' => [
- 'CategoryName' => [
- 'description' => '消息分类名称',
- 'type' => 'string',
- 'example' => '活动消息',
- ],
- 'ClassId' => [
- 'description' => '消息类目Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Content' => [
- 'description' => '消息内容',
- 'type' => 'string',
- 'example' => '"消息内容示例“',
- ],
- 'Deleted' => [
- 'description' => '删除标识',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'GmtCreated' => [
- 'description' => '消息产生时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729758903000',
- ],
- 'GmtUpdate' => [
- 'description' => '消息更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1729758903000',
- ],
- 'MassId' => [
- 'description' => '保留字段',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '/',
- ],
- 'Memo' => [
- 'description' => '保留字段',
- 'type' => 'string',
- 'example' => '/',
- ],
- 'MsgId' => [
- 'description' => '消息Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3727683838'."\n",
- ],
- 'Status' => [
- 'description' => '已读状态,未读0已读1',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'Title' => [
- 'description' => '消息标题',
- 'type' => 'string',
- 'example' => '"标题示例“',
- ],
- ],
- ],
- ],
- 'NextItem' => [
- 'description' => '/',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CategoryName' => [
- 'description' => '消息分类名称',
- 'type' => 'string',
- 'example' => '活动消息',
- ],
- 'ClassId' => [
- 'description' => '消息类目Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Content' => [
- 'description' => '消息内容',
- 'type' => 'string',
- 'example' => '”消息内容示例“',
- ],
- 'Deleted' => [
- 'description' => '删除标识',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'GmtCreated' => [
- 'description' => '消息产生时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1663809374000',
- ],
- 'GmtUpdate' => [
- 'description' => '消息更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1663809374000',
- ],
- 'MassId' => [
- 'description' => '保留字段',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '/',
- ],
- 'Memo' => [
- 'description' => '保留字段',
- 'type' => 'string',
- 'example' => '/',
- ],
- 'MsgId' => [
- 'description' => '消息Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3727683838',
- ],
- 'Status' => [
- 'description' => '已读状态,未读0已读1',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'Title' => [
- 'description' => '消息标题',
- 'type' => 'string',
- 'example' => '"标题示例“',
- ],
- ],
- ],
- ],
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '执行结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClassId' => ['title' => 'class id', 'description' => '消息类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MsgCount' => ['title' => '未读数量', 'description' => '该类目下未读消息数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"ClassId\\": 1,\\n \\"MsgCount\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
+ 'title' => '获取各分类已读消息数',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\",\\n \\"Data\\": {\\n \\"Datas\\": {\\n \\"Item\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"\\\\\\"消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1729758903000,\\n \\"GmtUpdate\\": 1729758903000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"385ad715-4139-41f9-ba59-246a00bb46e0.jpg\\",\\n \\"MsgId\\": 0,\\n \\"Status\\": 0,\\n \\"Title\\": \\"Endless\\"\\n }\\n ],\\n \\"LastItem\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"\\\\\\"消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1729758903000,\\n \\"GmtUpdate\\": 1729758903000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"/\\",\\n \\"MsgId\\": 3727683838,\\n \\"Status\\": 0,\\n \\"Title\\": \\"\\\\\\"标题示例“\\"\\n }\\n ],\\n \\"NextItem\\": [\\n {\\n \\"CategoryName\\": \\"活动消息\\",\\n \\"ClassId\\": 1,\\n \\"Content\\": \\"”消息内容示例“\\",\\n \\"Deleted\\": 0,\\n \\"GmtCreated\\": 1663809374000,\\n \\"GmtUpdate\\": 1663809374000,\\n \\"MassId\\": 0,\\n \\"Memo\\": \\"/\\",\\n \\"MsgId\\": 3727683838,\\n \\"Status\\": 0,\\n \\"Title\\": \\"\\\\\\"标题示例“\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取消息内容',
],
- 'ReadClassName' => [
- 'summary' => '方法描述:获取各分类已读消息数',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReadNumGroupTotal' => [
+ 'summary' => '方法描述:获取所有分类下的信息',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2585,103 +1225,47 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '系统参数,无需填写', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
@@ -2691,33 +1275,27 @@
'description' => '语言,默认为简体中文',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => ['zh-TW' => 'zh-TW', 'ja' => 'ja', 'en' => 'en', 'zh-CN' => 'zh-CN'],
'example' => 'zh-CN',
'default' => 'zh-CN',
],
],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['description' => '消息标题', 'type' => 'string', 'required' => false, 'example' => 'Can \'Financial expenses_interest income\' be considered as income?'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<List<ClassCountDo>>',
- 'description' => 'YungePopResult<List<ClassCountDo>>',
+ 'title' => 'YungePopResult<List<ResponseCountByCategory>>',
+ 'description' => '/',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否调用成功。true:调用成功。false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'description' => '系统返回的错误码。错误码详情,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Success' => ['description' => '是否调用成功。true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
'Data' => [
'description' => '执行结果',
'type' => 'array',
@@ -2725,44 +1303,34 @@
'description' => '执行结果',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => 'class id',
- 'description' => '消息类目Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Name' => [
- 'description' => '消息类目名称',
- 'type' => 'string',
- 'example' => '安全消息',
- ],
+ 'Id' => ['description' => '消息类目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
+ 'ReadCount' => ['description' => '类目下消息已读数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'UnReadCount' => ['description' => '类目下消息未读数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TotalCount' => ['description' => '类目下消息总数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'GroupCode' => ['description' => '分组code', 'type' => 'string', 'example' => 'test'],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '73FD6AE8-898F-5D09-9763-69B8A875488A',
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"安全消息\\"\\n }\\n ],\\n \\"RequestId\\": \\"73FD6AE8-898F-5D09-9763-69B8A875488A\\"\\n}","type":"json"}]',
- 'title' => '获取类目名称',
- ],
- 'DeleteAllMessage' => [
- 'summary' => '方法描述:站内信全部删除(逻辑删除)。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"ReadCount\\": 1,\\n \\"UnReadCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"GroupCode\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
+ 'title' => '获取所有分类下的信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-18T08:40:41.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-08-07T13:32:07.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'UpdateMessageLanguage' => [
+ 'summary' => '更新消息语言',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2770,189 +1338,111 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的应用工程名',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的应用工程名', 'description' => '忽略,暂时无需传递。请求方的应用工程名。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'CallerProtocol',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求协议类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'pop',
- ],
+ 'schema' => ['title' => '请求协议类型', 'description' => '忽略,暂时无需传递。请求协议类型。', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'pop'],
],
[
'name' => 'BizName',
'in' => 'formData',
- 'schema' => [
- 'title' => '请求方的业务线',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '请求方的业务线', 'description' => '忽略,暂时无需传递。请求方的业务线。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'TenantCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '租户信息',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '租户信息', 'description' => '忽略,暂时无需传递。租户信息。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'UidType',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户类型',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- 'default' => 'aliyunPk',
- ],
+ 'schema' => ['title' => '用户类型', 'description' => '忽略,暂时无需传递。用户类型。', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'aliyunPk'],
],
[
'name' => 'ClientSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作终端来源',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '操作终端来源', 'description' => '忽略,暂时无需传递。操作终端来源。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'SrcUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源页面URL',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '来源页面URL', 'description' => '忽略,暂时无需传递。来源页面URL。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'Cookies',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户cookies',
- 'description' => '系统参数,无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/',
- ],
+ 'schema' => ['title' => '用户cookies', 'description' => '忽略,暂时无需传递。用户cookies。', 'type' => 'string', 'required' => false, 'example' => '/'],
],
[
'name' => 'AcceptLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言',
- 'description' => '语言,默认为简体中文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- 'default' => 'zh-CN',
- ],
- ],
- [
- 'name' => 'ClassId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '消息类目Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '语言', 'description' => '忽略,暂时无需传递。页面语言。', 'type' => 'string', 'required' => false, 'example' => '/', 'default' => 'zh-CN'],
],
[
- 'name' => 'GroupCode',
+ 'name' => 'PreferLang',
'in' => 'formData',
'schema' => [
- 'description' => '分组code',
+ 'description' => '消息语言,必填',
'type' => 'string',
'required' => false,
- 'example' => 'test',
+ 'enumValueTitles' => ['en' => 'en', 'zh-CN' => 'zh-CN'],
+ 'example' => 'zh-CN',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'YungePopResult<Boolean>',
- 'description' => 'YungePopResult<Boolean>',
+ 'title' => 'PlainResult<Void>',
+ 'description' => 'PlainResult<Void>',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '接口调用是否成功。取值:true:成功false: 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'description' => '调用失败时,返回的错误码。更多信息,请参见错误码。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'description' => '调用失败时返回的信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'description' => '删除是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633',
- ],
+ 'Code' => ['description' => '调用失败时,返回的错误码。更多信息,请参见错误码。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['description' => '调用失败时返回的信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '73FD6AE8-898F-5D09-9763-69B8A875488A'],
+ 'Success' => ['description' => '删除规则是否成功。取值:true:成功false: 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"73FD6AE8-898F-5D09-9763-69B8A875488A\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '更新消息语言',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A5F62766-1C2F-1F56-A39D-63E3D30F0633\\"\\n}","type":"json"}]',
- 'title' => '删除全部消息',
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'notifications-intl.aliyuncs.com', 'endpoint' => 'notifications-intl.aliyuncs.com', 'vpc' => 'notifications-intl.vpc-proxy.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'notifications.aliyuncs.com', 'endpoint' => 'notifications.aliyuncs.com', 'vpc' => 'notifications.vpc-proxy.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'BAD_REQUEST', 'message' => 'Illegal request parameters.', 'http_code' => 400, 'description' => '请求参数不合法'],
+ ['code' => 'FORBIDDEN', 'message' => 'You are not authorized to perform this action.', 'http_code' => 403, 'description' => '无操作权限'],
+ ['code' => 'LIMIT_EXCEEDED', 'message' => 'Reaching the limit on the number of resources.', 'http_code' => 422, 'description' => '达到资源数量的限制'],
+ ['code' => 'LOCKED', 'message' => 'Resource is locked, please try again later.', 'http_code' => 423, 'description' => '资源被锁定,请稍后重试'],
+ ['code' => 'SERVER_ERROR', 'message' => 'System level error occurred.', 'http_code' => 500, 'description' => '发生系统级别错误'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'notifications.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ReadMessageList'],
+ ],
+ 'createdAt' => '2025-12-09T02:43:31.000Z',
+ 'description' => '',
],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'notifications-intl.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
],
];