diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/notifications | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/notifications')
| -rw-r--r-- | data/en_us/notifications/2024-12-25/api-docs.php | 1556 |
1 files changed, 1554 insertions, 2 deletions
diff --git a/data/en_us/notifications/2024-12-25/api-docs.php b/data/en_us/notifications/2024-12-25/api-docs.php index 19d0733..42ffdcd 100644 --- a/data/en_us/notifications/2024-12-25/api-docs.php +++ b/data/en_us/notifications/2024-12-25/api-docs.php @@ -1,4 +1,1556 @@ <?php return [ - 'code' => 500, - 'message' => 'server error', + 'version' => '1.0', + 'info' => ['style' => 'RPC', 'product' => 'Notifications', 'version' => '2024-12-25'], + 'directories' => [ + [ + 'children' => ['ReadCategoryGroupList', 'ReadMessageLanguage', 'UpdateMessageLanguage'], + 'type' => 'directory', + 'title' => 'Subscribe', + ], + [ + 'children' => ['ReadAllMessage', 'ReadMessageNewTotal', 'ReadMessage', 'ReadMessageList', 'ReadNumGroupByClass', 'DelMessage', 'ReadNumGroupTotal', 'ReadMessageContent', 'ReadClassName', 'DeleteAllMessage'], + 'type' => 'directory', + 'title' => 'Internal message', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DelMessage' => [ + 'summary' => 'Deletes a message.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The language. Default value: zh-CN (Simplified Chinese).', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'MsgId', + 'in' => 'formData', + 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => false, 'example' => '3727683838', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'YungePopResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the deletion was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned if the call failed. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => ['description' => 'The execution result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Delete a message', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DeleteAllMessage' => [ + 'summary' => 'Deletes all in-app messages (logical deletion).', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The language. Default value: Simplified Chinese.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'ClassId', + 'in' => 'formData', + 'schema' => ['description' => 'The message category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'GroupCode', + 'in' => 'formData', + 'schema' => ['description' => 'The group code.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'YungePopResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values: true: Successful. false: Failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the deletion was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Delete all messages', + 'changeSet' => [ + ['createdAt' => '2025-09-18T08:40:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadAllMessage' => [ + 'summary' => 'Marks all messages as read. If no category is specified, all messages are marked as read.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '[]'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The language. Default value: Simplified Chinese.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'ClassId', + 'in' => 'formData', + 'schema' => ['description' => 'The message category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'GroupCode', + 'in' => 'formData', + 'schema' => ['description' => 'The group code.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'YungePopResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => ['description' => 'The execution result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Mark all messages as read', + 'changeSet' => [ + ['createdAt' => '2025-09-18T08:40:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadCategoryGroupList' => [ + 'summary' => 'Get category group list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. Application name of the requester.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. Request protocol type.', 'type' => 'string', 'required' => false, 'default' => 'pop', 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. Business line of the requester.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. Tenant information.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. User type.', 'type' => 'string', 'required' => false, 'default' => 'aliyunPk', 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. Operation terminal source.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. Source page URL.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. No need to pass for now. User cookies.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['description' => 'The language. Automatically passed through by the browser and can be manually overridden.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], + ], + [ + 'name' => 'ChannelGroupCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The channel group.', + 'enumValueTitles' => ['tts' => 'Voice reception management', 'webhook' => 'Bot reception management', 'base' => 'Basic reception management'], + 'type' => 'string', + 'required' => false, + 'example' => 'base', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'PlainResult<List<SimpleCategoryGroupDTO>>', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code returned by the system. For more information about error codes, see Error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Data' => [ + 'description' => 'The execution result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'GroupCode' => ['description' => 'The category group code.', 'type' => 'string', 'example' => 'prod_msg', 'title' => ''], + 'GroupName' => ['description' => 'The group name.', 'type' => 'string', 'example' => '产品消息', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Message' => ['description' => 'The message returned when the call fails.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Get category group list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadClassName' => [ + 'summary' => 'Retrieves the number of read messages for each category.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The language. Default value: Simplified Chinese.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'YungePopResult<List<ClassCountDo>>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The error code returned by the system. For more information about error codes, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The message returned when the call failed.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => [ + 'description' => 'The execution result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The message category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => 'The message category name.', 'type' => 'string', 'example' => '安全消息', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '73FD6AE8-898F-5D09-9763-69B8A875488A', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve category names', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadMessage' => [ + 'summary' => 'Marks a message as read.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The URL of the source page.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The language. Default value: zh-CN (Simplified Chinese).', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'MsgId', + 'in' => 'formData', + 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => false, 'example' => 'A9FEF04A004A383534AA6400092A904F', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'YungePopResult<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call failed. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call failed.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => ['description' => 'The execution result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Mark a message as read', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadMessageContent' => [ + 'summary' => 'Retrieves the body of a message.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The language. Default value: Simplified Chinese.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'MsgId', + 'in' => 'formData', + 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => false, 'example' => '3727683838', 'title' => ''], + ], + [ + 'name' => 'ClassId', + 'in' => 'formData', + 'schema' => ['description' => 'Deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => ['description' => 'The read status. Valid values:'."\n" + .'- 0: unread'."\n" + .'- 1: read.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'History', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether the message is a historical message.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'GroupCode', + 'in' => 'formData', + 'schema' => ['description' => 'The group code.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'YungePopResult<Map<String, Map<String, List<ResponseMessage>>>>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails. For more information, refer to error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + 'Data' => [ + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'Datas' => [ + 'description' => 'The list of degradation rules.', + 'type' => 'object', + 'properties' => [ + 'Item' => [ + 'description' => 'The data item.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data body.', + 'type' => 'object', + 'properties' => [ + 'CategoryName' => ['description' => 'The message category name.', 'type' => 'string', 'example' => '活动消息', 'title' => ''], + 'ClassId' => ['description' => 'The message class ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Content' => ['description' => 'The message content.', 'type' => 'string', 'example' => '"消息内容示例“', 'title' => ''], + 'Deleted' => ['description' => 'The deletion flag.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GmtCreated' => ['description' => 'The time when the message was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000', 'title' => ''], + 'GmtUpdate' => ['description' => 'The time when the message was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000', 'title' => ''], + 'MassId' => ['description' => 'A reserved field.', 'type' => 'integer', 'format' => 'int64', 'example' => '/', 'title' => ''], + 'Memo' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => '385ad715-4139-41f9-ba59-246a00bb46e0.jpg', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'AC14C11F1FF801EE00054518C220EF2C', 'title' => ''], + 'Status' => ['description' => 'The read status. Valid values:'."\n" + .'- 0: unread'."\n" + .'- 1: read.', 'type' => 'integer', 'format' => 'int64', 'example' => 'not_installed', 'title' => ''], + 'Title' => ['description' => 'The message title.', 'type' => 'string', 'example' => 'Endless', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LastItem' => [ + 'description' => '/', + 'type' => 'array', + 'items' => [ + 'description' => '/', + 'type' => 'object', + 'properties' => [ + 'CategoryName' => ['description' => 'The message category name.', 'type' => 'string', 'example' => '活动消息', 'title' => ''], + 'ClassId' => ['description' => 'The message class ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Content' => ['description' => 'The message content.', 'type' => 'string', 'example' => '"消息内容示例“', 'title' => ''], + 'Deleted' => ['description' => 'The deletion flag.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GmtCreated' => ['description' => 'The time when the message was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000', 'title' => ''], + 'GmtUpdate' => ['description' => 'The time when the message was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729758903000', 'title' => ''], + 'MassId' => ['description' => 'A reserved field.', 'type' => 'integer', 'format' => 'int64', 'example' => '/', 'title' => ''], + 'Memo' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3727683838'."\n", 'title' => ''], + 'Status' => ['description' => 'The read status. Valid values:'."\n" + .'- 0: unread'."\n" + .'- 1: read.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Title' => ['description' => 'The message title.', 'type' => 'string', 'example' => '"标题示例“', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NextItem' => [ + 'description' => '/', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CategoryName' => ['description' => 'The message category name.', 'type' => 'string', 'example' => '活动消息', 'title' => ''], + 'ClassId' => ['description' => 'The message class ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Content' => ['description' => 'The message content.', 'type' => 'string', 'example' => '”消息内容示例“', 'title' => ''], + 'Deleted' => ['description' => 'The deletion flag.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GmtCreated' => ['description' => 'The time when the message was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1663809374000', 'title' => ''], + 'GmtUpdate' => ['description' => 'The time when the message was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1663809374000', 'title' => ''], + 'MassId' => ['description' => 'A reserved field.', 'type' => 'integer', 'format' => 'int64', 'example' => '/', 'title' => ''], + 'Memo' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3727683838', 'title' => ''], + 'Status' => ['description' => 'The read status. Valid values:'."\n" + .'- 0: unread'."\n" + .'- 1: read.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Title' => ['description' => 'The message title.', 'type' => 'string', 'example' => '"标题示例“', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve message content', + 'changeSet' => [ + ['createdAt' => '2025-09-18T08:40:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadMessageLanguage' => [ + 'summary' => 'Retrieves the message language.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The application name of the requester.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The request protocol type.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The business line of the requester.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The tenant information.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The user type.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The operation terminal source.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The source page URL.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The user cookies.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignored. This parameter does not need to be specified. The page language.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'ReturnDefaultLang', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to return the default language. If the value is YES, the default language is returned.', + 'enumValueTitles' => ['NO' => 'NO', 'YES' => 'YES'], + 'type' => 'string', + 'required' => false, + 'example' => 'YES', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'PlainResult<String>', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The execution result.', 'type' => 'string', 'example' => 'zh-CN', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned if the call failed. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The message returned if the call failed.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve message language', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadMessageList' => [ + 'summary' => 'Retrieves a list of messages.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The language. Default value: Simplified Chinese.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'ClassId', + 'in' => 'formData', + 'schema' => ['description' => 'Deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => ['description' => 'The message status. A value of 1 indicates read. A value of 0 indicates unread. A value of -1 indicates all. Default value: -1.', 'type' => 'integer', 'format' => 'int32', 'default' => '-1', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['description' => 'The message title. This parameter is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => '"标题示例“', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The message content. This parameter is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => '"消息内容示例“', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'formData', + 'schema' => ['description' => 'The page number for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The page size for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '/', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], + ], + [ + 'name' => 'Loc', + 'in' => 'formData', + 'schema' => ['description' => 'The location.', 'type' => 'string', 'required' => false, 'example' => 'nav', 'title' => ''], + ], + [ + 'name' => 'History', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether the messages are historical messages.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'GroupCode', + 'in' => 'formData', + 'schema' => ['description' => 'The group code.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'YungePopResult<DataPage<ResponseMessage>>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + 'Data' => [ + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The number of messages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'MaxResults' => ['description' => 'A reserved field.', 'type' => 'integer', 'format' => 'int64', 'example' => '/', 'title' => ''], + 'NextToken' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'Page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Rows' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single record of the returned data.', + 'type' => 'object', + 'properties' => [ + 'CategoryName' => ['description' => 'The message category name.', 'type' => 'string', 'example' => '活动消息', 'title' => ''], + 'Class' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'ClassId' => ['description' => 'The message class ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Content' => ['description' => 'The message content.', 'type' => 'string', 'example' => '"消息内容示例“', 'title' => ''], + 'Deleted' => ['description' => 'The deletion flag.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GmtCreated' => ['description' => 'The time when the message was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723772244000', 'title' => ''], + 'GmtUpdate' => ['description' => 'The time when the message was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723772244000', 'title' => ''], + 'MassId' => ['description' => 'A reserved field.', 'type' => 'integer', 'format' => 'int64', 'example' => '/', 'title' => ''], + 'Memo' => ['description' => 'A reserved field.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3727683838'."\n", 'title' => ''], + 'Status' => ['description' => 'The read status. A value of 0 indicates unread. A value of 1 indicates read.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Title' => ['description' => 'The message title.', 'type' => 'string', 'example' => '"标题示例“', 'title' => ''], + 'Titleh' => ['description' => 'The highlighted title.', 'type' => 'string', 'example' => 'title', 'title' => ''], + 'CategoryCode' => ['description' => 'The category code.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve message list', + 'changeSet' => [ + ['createdAt' => '2025-12-09T02:43:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-18T08:40:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-08-07T13:32:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-20T09:45:34.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadMessageNewTotal' => [ + 'summary' => 'Retrieves the total number of unread messages.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The language. Default value: Simplified Chinese.', + 'enumValueTitles' => ['zh-TW' => 'zh-TW', 'ja' => 'ja', 'en' => 'en', 'zh-CN' => 'zh-CN'], + 'type' => 'string', + 'default' => 'zh-CN', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '/', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call failed. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The message returned when the call failed.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => ['description' => 'The total number of new messages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve total unread message count', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadNumGroupByClass' => [ + 'summary' => 'Retrieves the count of read messages for each category.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A system parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The language. Default value: Simplified Chinese.', + 'enumValueTitles' => ['zh-TW' => 'zh-TW', 'ja' => 'ja', 'en' => 'en', 'zh-CN' => 'zh-CN'], + 'type' => 'string', + 'default' => 'zh-CN', + 'required' => false, + 'example' => 'zh-CN'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '/', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The message returned when the call fails.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => [ + 'description' => 'The execution result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'ClassId' => ['title' => '', 'description' => 'The message category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MsgCount' => ['title' => '', 'description' => 'The number of unread messages in the category.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve read message count by category', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ReadNumGroupTotal' => [ + 'summary' => 'Method description: Get information under all categories', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'System parameter. You do not need to set this parameter.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The language. Default value: Simplified Chinese.', + 'enumValueTitles' => ['zh-TW' => 'zh-TW', 'ja' => 'ja', 'en' => 'en', 'zh-CN' => 'zh-CN'], + 'type' => 'string', + 'default' => 'zh-CN', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['description' => 'The message title.', 'type' => 'string', 'required' => false, 'example' => 'Can \'Financial expenses_interest income\' be considered as income?', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '/', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: true and false. true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails. For more information, see Error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => [ + 'description' => 'The execution result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The execution result.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The message category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'ReadCount' => ['description' => 'The number of read messages under the category.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'UnReadCount' => ['description' => 'The number of unread messages under the category.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of messages under the category.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GroupCode' => ['description' => 'The group code.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5F62766-1C2F-1F56-A39D-63E3D30F0633', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + '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' => 'Get information under all categories', + 'changeSet' => [ + ['createdAt' => '2025-09-18T08:40:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-08-07T13:32:07.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'UpdateMessageLanguage' => [ + 'summary' => 'Updates the message language.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The application name of the requester.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'CallerProtocol', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The request protocol type.', 'type' => 'string', 'default' => 'pop', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The business line of the requester.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'TenantCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The tenant information.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'UidType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The user type.', 'type' => 'string', 'default' => 'aliyunPk', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'ClientSource', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The operation terminal source.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SrcUrl', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The source page URL.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'Cookies', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The user cookies.', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Ignore. This parameter does not need to be specified. The page language.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'PreferLang', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The message language. This parameter is required.', + 'enumValueTitles' => ['en' => 'en', 'zh-CN' => 'zh-CN'], + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'PlainResult<Void>', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code returned if the call failed. For more information, see error codes.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '73FD6AE8-898F-5D09-9763-69B8A875488A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"73FD6AE8-898F-5D09-9763-69B8A875488A\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update message language', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'notifications-intl.aliyuncs.com', 'endpoint' => 'notifications-intl.aliyuncs.com', 'vpc' => 'notifications-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Illegal request parameters'], + ['code' => 'FORBIDDEN', 'message' => 'You are not authorized to perform this action.', 'http_code' => 403, 'description' => 'No operation permission'], + ['code' => 'LIMIT_EXCEEDED', 'message' => 'Reaching the limit on the number of resources.', 'http_code' => 422, 'description' => 'Reaching the limit on the number of resources'], + ['code' => 'LOCKED', 'message' => 'Resource is locked, please try again later.', 'http_code' => 423, 'description' => 'Resource is locked, please try again later'], + ['code' => 'SERVER_ERROR', 'message' => 'System level error occurred.', 'http_code' => 500, 'description' => 'System level error occurred'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ReadMessageList'], + ], + 'createdAt' => '2025-12-09T02:43:31.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ], + ], ]; |