diff options
Diffstat (limited to 'data/zh_cn/dm/2015-11-23/api-docs.php')
| -rw-r--r-- | data/zh_cn/dm/2015-11-23/api-docs.php | 11828 |
1 files changed, 11828 insertions, 0 deletions
diff --git a/data/zh_cn/dm/2015-11-23/api-docs.php b/data/zh_cn/dm/2015-11-23/api-docs.php new file mode 100644 index 0000000..7c38251 --- /dev/null +++ b/data/zh_cn/dm/2015-11-23/api-docs.php @@ -0,0 +1,11828 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dm', + 'version' => '2015-11-23', + ], + 'directories' => [ + [ + 'children' => [ + 'DescAccountSummary', + 'UpdateUser', + 'GetUser', + ], + 'type' => 'directory', + 'title' => '账户', + 'id' => 47003, + ], + [ + 'children' => [ + 'AddIpfilter', + 'DeleteIpfilterByEdmId', + ], + 'type' => 'directory', + 'title' => '白名单', + 'id' => 47081, + ], + [ + 'children' => [ + 'UpdateIpProtection', + 'GetIpProtection', + 'GetIpfilterList', + ], + 'type' => 'directory', + 'title' => 'IP防护', + 'id' => 47084, + ], + [ + 'children' => [ + 'QueryTaskByParam', + ], + 'type' => 'directory', + 'title' => '任务', + 'id' => 47088, + ], + [ + 'children' => [ + [ + 'children' => [ + 'SenderStatisticsByTagNameAndBatchID', + 'SenderStatisticsDetailByParam', + ], + 'type' => 'directory', + 'title' => '统计', + 'id' => 47091, + ], + 'GetTrackList', + 'GetTrackListByMailFromAndTagName', + 'SingleSendMail', + 'BatchSendMail', + 'SendTestByTemplate', + ], + 'type' => 'directory', + 'title' => '邮件', + 'id' => 47090, + ], + [ + 'children' => [ + 'CreateDomain', + 'DeleteDomain', + 'ModifyPWByDomain', + 'QueryDomainByParam', + 'CheckDomain', + 'DescDomain', + ], + 'type' => 'directory', + 'title' => '域名', + 'id' => 47099, + ], + [ + 'children' => [ + 'CreateMailAddress', + 'DeleteMailAddress', + 'ModifyMailAddress', + 'QueryInvalidAddress', + 'QueryMailAddressByParam', + 'ApproveReplyMailAddress', + 'CheckReplyToMailAddress', + 'DeleteInvalidAddress', + ], + 'type' => 'directory', + 'title' => '地址', + 'id' => 47106, + ], + [ + 'children' => [ + 'CreateReceiver', + 'DeleteReceiver', + 'DeleteReceiverDetail', + 'QueryReceiverByParam', + 'QueryReceiverDetail', + 'SaveReceiverDetail', + ], + 'type' => 'directory', + 'title' => '收件人', + 'id' => 47115, + ], + [ + 'children' => [ + 'CreateTag', + 'DeleteTag', + 'ModifyTag', + 'QueryTagByParam', + ], + 'type' => 'directory', + 'title' => '标签', + 'id' => 47122, + ], + [ + 'children' => [ + 'DedicatedIpPoolCreate', + 'DedicatedIpPoolDelete', + 'DedicatedIpPoolUpdate', + 'DedicatedIpPoolList', + 'DedicatedIpNonePoolList', + 'DedicatedIpAutoRenewal', + 'DedicatedIpChangeWarmupType', + 'DedicatedIpList', + ], + 'type' => 'directory', + 'title' => '独立IP', + 'id' => 139769, + ], + [ + 'children' => [ + 'ListUserSuppression', + 'CreateUserSuppression', + 'RemoveUserSuppression', + 'UnblockSending', + 'ListBlockSending', + ], + 'type' => 'directory', + 'title' => '无效地址', + 'id' => 139778, + ], + [ + 'children' => [ + 'ConfigSetCreate', + 'ConfigSetDelete', + 'ConfigSetUpdate', + 'ConfigSetDetail', + 'ConfigSetList', + 'ConfigSetRelationFromAddress', + 'ConfigSetCancelRelationFromAddress', + ], + 'type' => 'directory', + 'title' => '配置集', + 'id' => 139784, + ], + [ + 'children' => [ + 'DescTemplate', + 'QueryTemplateByParam', + ], + 'type' => 'directory', + 'title' => '模版', + 'id' => 165553, + ], + [ + 'children' => [ + 'GetValidationQuota', + 'ValidateEmail', + 'SendValidateFile', + 'GetValidateFileStatus', + 'GetValidateFile', + 'DeleteValidateFile', + ], + 'type' => 'directory', + 'title' => '地址校验', + 'id' => 246023, + ], + [ + 'children' => [ + 'ListValidateFile', + ], + 'title' => '其他', + 'type' => 'directory', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AddIpfilter' => [ + 'summary' => '添加 IP 白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP地址/IP区间/IP段', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '单个IP格式，如：xxx.xxx.xxx.xxx'."\n" + .'IP区间格式，如：xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx'."\n" + .'IP段格式，如：xxx.xxx.xxx.xxx/xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '0E9282E8-DC08-5445-8FB0-B9F0CA28B249', + ], + 'IpFilterId' => [ + 'description' => 'ip对应的ID', + 'type' => 'string', + 'example' => '10795', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '添加IP白名单', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:AddIpfilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0E9282E8-DC08-5445-8FB0-B9F0CA28B249\\",\\n \\"IpFilterId\\": \\"10795\\"\\n}","errorExample":""},{"type":"xml","example":"<AddIpfilterResponse>\\n <RequestId>F814E960-5AEE-5CB1-881B-6F1A3250B55A</RequestId>\\n <IpFilterId>10795</IpFilterId>\\n</AddIpfilterResponse>","errorExample":""}]', + ], + 'ApproveReplyMailAddress' => [ + 'summary' => '验证回信地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Ticket', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱地址Ticket凭证，验证邮件的URL 中带的部分字符串。', + 'type' => 'string', + 'required' => true, + 'example' => 'a724068dac9a45d19574375adeca0d7d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '验证回信地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:ApproveReplyMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","type":"json"}]', + ], + 'BatchSendMail' => [ + 'summary' => '批量发送邮件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '预先创建且通过审核的模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '管理控制台中配置的发信地址。', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'ReceiversName', + 'in' => 'query', + 'schema' => [ + 'description' => '预先创建且上传了收件人的收件人列表名称。'."\n" + ."\n" + .'注意：'."\n" + ."\n" + .'收件人列表人数不得高于剩余日额度，否则会发信失败。'."\n" + ."\n" + .'收信人列表需要在触发任务之后至少10分钟后再删除，否则容易引起发信失败。', + 'type' => 'string', + 'required' => true, + 'example' => 'test2', + ], + ], + [ + 'name' => 'AddressType', + 'in' => 'query', + 'schema' => [ + 'description' => '- 0：为随机账号'."\n" + .'- 1：为发信地址', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '邮件标签名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test3', + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '回信地址', + 'type' => 'string', + 'required' => false, + 'example' => 'test2***@example.net', + ], + ], + [ + 'name' => 'ReplyAddressAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '回信地址别称', + 'type' => 'string', + 'required' => false, + 'example' => '小红', + ], + ], + [ + 'name' => 'ClickTrace', + 'in' => 'query', + 'schema' => [ + 'description' => '- 1：为打开数据跟踪功能'."\n" + .'- 0（默认）：为关闭数据跟踪功能', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UnSubscribeLinkType', + 'in' => 'query', + 'schema' => [ + 'description' => '生成的退订链接类型。参照[退订功能生成链接和过滤机制](~~2689048~~)文档'."\n" + .'- disabled: 不生成'."\n" + .'- default: 采用默认策略：对批量类型的发信地址发给特定域名时会生成退订链接，如带有关键字"gmail", "yahoo",'."\n" + .'"google", "aol.com", "hotmail",'."\n" + .'"outlook", "ymail.com"等'."\n" + ."\n" + .'显示语言根据收件人的浏览器设置自动识别', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'UnSubscribeFilterLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤级别。参照[退订功能生成链接和过滤机制](~~2689048~~)文档'."\n" + .'- disabled: 不过滤'."\n" + .'- default: 采用默认策略，批量地址采用发信地址级别过滤'."\n" + .'- mailfrom: 发信地址级别过滤'."\n" + .'- mailfrom_domain: 发信域名级别过滤'."\n" + .'- edm_id: 账号级别过滤', + 'type' => 'string', + 'required' => false, + 'example' => 'mailfrom_domain', + ], + ], + [ + 'name' => 'Headers', + 'in' => 'query', + 'schema' => [ + 'description' => '邮件头设置'."\n" + ."\n" + .'标准字段和非标准字段都需要符合标准中对头的语法要求，API 发信最多可通过 headers 字段传入 10 个标头，超出限制会被忽略，SMTP 没有限制。'."\n" + ."\n" + .'1、标准字段'."\n" + ."\n" + .'Message-ID，List-Unsubscribe，List-Unsubscribe-Post'."\n" + ."\n" + .'标准字段会覆盖掉邮件头中原有的值。'."\n" + ."\n" + .'2、非标准字段'."\n" + ."\n" + .'不区分大小写'."\n" + ."\n" + .'a、以 X-User- 开头（不推送到事件总线EB、消息服务MNS。仅API要求，SMTP任意自定义）'."\n" + ."\n" + .'b、以 X-User-Notify- 开头（推送到事件总线EB、消息服务MNS。API和SMTP都支持）'."\n" + ."\n\n" + .'推动到EB或MNS时，header字段下会包含这些字段', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Message-ID": "<[email protected]>",'."\n" + .' "X-User-UID1": "UID-1-000001",'."\n" + .' "X-User-UID2": "UID-2-000001",'."\n" + .' "X-User-Notify-UID1": "UID-3-000001",'."\n" + .' "X-User-Notify-UID2": "UID-4-000001"'."\n" + .' '."\n" + .'}', + ], + ], + [ + 'name' => 'IpPoolId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '独立IP地址池ID。购买了独立IP的用户可以通过这个参数指定本次发信出口IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef', + ], + ], + [ + 'name' => 'DomainAuth', + 'in' => 'query', + 'schema' => [ + 'title' => '启用域级别认证', + 'description' => '启用域级别认证'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'仅在域级别认证时使用，发信地址级别认证请忽略。'."\n" + ."\n" + .'1、[email protected] 控制台创建这个地址，@前缀保持固定不变，后缀用自己域名。'."\n" + ."\n" + .'2、'."\n" + ."\n" + .'**API场景**'."\n" + ."\n" + .'AccountName填域名，收件人看到的发件人是[email protected]。'."\n" + ."\n" + .'**SMTP场景**'."\n" + ."\n" + .'a.通过 ModifyPWByDomain 接口设置域名密码。'."\n" + ."\n" + .'b.使用域名和设置的密码认证，真实发件人mailfrom传自定义的地址，如[email protected]，收件人看到的发件人是[email protected]。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnvId' => [ + 'description' => '事件ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '12D086F6-8F31-4658-84C1-006DED011A85', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EnvId\\": \\"xxx\\",\\n \\"RequestId\\": \\"12D086F6-8F31-4658-84C1-006DED011A85\\"\\n}","type":"json"}]', + 'title' => '批量发送邮件', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:BatchSendMail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CheckDomain' => [ + 'summary' => '验证域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => '域名ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '153345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainStatus' => [ + 'description' => '域名状态。说明是否验证成功，取值：'."\n" + .'- **1**：不可用，验证未通过'."\n" + .'- **非1**：可用，已验证通过。由于历史原因，实际上可能会返回0、2、3、4，只要非1的值即认为通过。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F0B82E83-A1D9-4FE6-97D2-F4B231F80B02', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '验证域名', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:CheckDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainStatus\\": 1,\\n \\"RequestId\\": \\"F0B82E83-A1D9-4FE6-97D2-F4B231F80B02\\"\\n}","type":"json"}]', + ], + 'CheckReplyToMailAddress' => [ + 'summary' => '验证回信地址发送邮件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。'."\n" + ."\n" + .'en是English，空或者其他值都是Chinese', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MailAddressId', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '126545', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '验证回信地址发送邮件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:CheckReplyToMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckReplyToMailAddressResponse>\\r\\n\\t<RequestId>10A1AD70-E48E-476D-98D9-39BD92193837</RequestId>\\r\\n</CheckReplyToMailAddressResponse>","errorExample":""}]', + ], + 'ConfigSetCancelRelationFromAddress' => [ + 'summary' => '取消配置集关联发信地址。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '配置集ID，必填', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'FromAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址，必填', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Result' => [ + 'description' => '请求结果', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '配置集取消关联发信地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ConfigSetCancelRelationFromAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"Result\\": true\\n}","type":"json"}]', + ], + 'ConfigSetCreate' => [ + 'summary' => '创建配置集，上限100个。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '配置名称：必填。最多 50 个字符，名称不允许重复', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + ], + ], + [ + 'name' => 'IpPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联IP池ID，选填', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '描述，最多50个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'XXX', + ], + 'Id' => [ + 'description' => '配置集ID', + 'type' => 'string', + 'example' => 'XXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建配置集', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:ConfigSetCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXX\\",\\n \\"Id\\": \\"XXX\\"\\n}","type":"json"}]', + ], + 'ConfigSetDelete' => [ + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '配置集ID，多个英文逗号隔开。必填', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'IsForce', + 'in' => 'query', + 'schema' => [ + 'description' => '强制删除发信地址关联', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除配置集', + 'summary' => '配置集删除。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:ConfigSetDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'ConfigSetDetail' => [ + 'summary' => '获取配置集详情。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '配置集ID，必填', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Detail' => [ + 'description' => '配置集信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '配置集ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Name' => [ + 'description' => '配置集名称', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'xxx', + ], + 'IpPool' => [ + 'description' => '关联IP池', + 'type' => 'object', + 'properties' => [ + 'IpPoolId' => [ + 'description' => '关联IP池ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'IpPoolName' => [ + 'description' => '关联IP池名称', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取配置集', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:ConfigSetDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"Detail\\": {\\n \\"Id\\": \\"xxx\\",\\n \\"Name\\": \\"xxx\\",\\n \\"Description\\": \\"xxx\\",\\n \\"IpPool\\": {\\n \\"IpPoolId\\": \\"xxx\\",\\n \\"IpPoolName\\": \\"xxx\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'ConfigSetList' => [ + 'summary' => '列出配置集列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '分页索引，从1开始。必填', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数目，必填', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '名称搜索关键字', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '查询所有，选填', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'TotalCounts' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'CurrentPage' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '当前页', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HasMore' => [ + 'description' => '是否有下一页', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'false', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ConfigSets' => [ + 'description' => '配置集列表', + 'type' => 'array', + 'items' => [ + 'description' => '配置集信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '配置集ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Name' => [ + 'description' => '配置集名称', + 'type' => 'string', + 'example' => 'xxx', + ], + 'IpPool' => [ + 'description' => 'IP池', + 'type' => 'object', + 'properties' => [ + 'IpPoolId' => [ + 'description' => '关联IP池ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'IpPoolName' => [ + 'description' => '关联IP池名称', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'FromAddresses' => [ + 'description' => '关联发信地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '发信地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + 'Description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出配置集列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:ConfigSetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCounts\\": 5,\\n \\"RequestId\\": \\"xxx\\",\\n \\"CurrentPage\\": 1,\\n \\"HasMore\\": false,\\n \\"PageSize\\": 10,\\n \\"ConfigSets\\": [\\n {\\n \\"Id\\": \\"xxx\\",\\n \\"Name\\": \\"xxx\\",\\n \\"IpPool\\": {\\n \\"IpPoolId\\": \\"xxx\\",\\n \\"IpPoolName\\": \\"xxx\\"\\n },\\n \\"FromAddresses\\": [\\n \\"[email protected]\\"\\n ],\\n \\"Description\\": \\"xxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ConfigSetRelationFromAddress' => [ + 'summary' => '关联配置集和发信地址。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '发信配置ID，必填', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'FromAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址，必填', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Result' => [ + 'description' => '操作结果', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '配置集关联发信地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:ConfigSetRelationFromAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"Result\\": true\\n}","type":"json"}]', + ], + 'ConfigSetUpdate' => [ + 'summary' => '更新配置集。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '配置集ID，必填', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '配置名称：必填。最多 50 个字符，名称不允许重复', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + ], + ], + [ + 'name' => 'IpPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联IP池ID，选填', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '描述，最多50个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Id' => [ + 'description' => '配置集ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新配置集', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ConfigSetUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"Id\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'CreateDomain' => [ + 'summary' => '创建域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名，长度1-50，可以包含数字、大写字母、小写字母、.、-。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sub.example.com', + ], + ], + [ + 'name' => 'dkimSelector', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'DKIM协议中的selector字段，用于标识特定公钥的字段。'."\n" + .'建议为空，系统会根据集群信息自动生成。'."\n" + .'如果用户手工指定，比如发信域名是sub.example.com，dkimSelector填写的是default，那么主机记录就是default._domainkey.sub'."\n" + ."\n" + .'约束：'."\n" + .'1. 长度不能大于60'."\n" + .'2. 必须是可见字符'."\n" + .'3. 不能以-打头'."\n" + .'4. 不能以-结尾'."\n" + .'5. 不能包含以下字符_ :;/!*~.@#$%^&()+=[{]}|?<>,"\'\\', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainId' => [ + 'description' => '域名ID', + 'type' => 'string', + 'example' => '158910', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B49AD828-25D1-488C-90B7-8853C1944486', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '创建域名', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainId\\": \\"158910\\",\\n \\"RequestId\\": \\"B49AD828-25D1-488C-90B7-8853C1944486\\"\\n}","type":"json"}]', + ], + 'CreateMailAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '账号+@+域名', + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '回信地址', + 'type' => 'string', + 'required' => false, + 'example' => 'test1***@example.net', + ], + ], + [ + 'name' => 'Sendtype', + 'in' => 'query', + 'schema' => [ + 'description' => '发信类型。取值：'."\n" + ."\n" + .'- batch：批量邮件'."\n" + ."\n" + .'- trigger：触发邮件', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'batch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MailAddressId' => [ + 'description' => '发信地址ID', + 'type' => 'string', + 'example' => '15123', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '95A7D497-F8DD-4834-B81E-C1783236E55F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMailAddressName.Duplicate', + 'errorMessage' => 'The specified email address already exists. Please change to another one.', + 'description' => '输入的email地址已经存在，请更换为另外一个。', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'The specified user does not exist. Please contact your master account to activate the Direct Mail service.', + 'description' => '账户不存在。请联系您访问凭证或者子账号对应主账号开通邮件推送服务。', + ], + ], + ], + 'title' => '创建发信地址', + 'summary' => '创建发信地址。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MailAddressId\\": \\"15123\\",\\n \\"RequestId\\": \\"95A7D497-F8DD-4834-B81E-C1783236E55F\\"\\n}","type":"json"}]', + ], + 'CreateReceiver' => [ + 'summary' => '创建收件人列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ReceiversName', + 'in' => 'query', + 'schema' => [ + 'description' => '列表名称，不能重复的，长度为1-30个字符', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ReceiversAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '列表别称，长度小于30个字符的Email地址', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a***@example.net', + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => '列表描述', + 'type' => 'string', + 'required' => false, + 'example' => '描述', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverId' => [ + 'description' => '收件人列表ID', + 'type' => 'string', + 'example' => '7312e09b8fffc5c7b2e2fbf5b6dc2073', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '创建收件人列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateReceiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReceiverId\\": \\"7312e09b8fffc5c7b2e2fbf5b6dc2073\\",\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","type":"json"}]', + ], + 'CreateTag' => [ + 'summary' => '创建标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称。限制说明：长度为1-128个字符，允许英文字母、数字、下划线。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TagDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '标签描述', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '标签ID', + 'type' => 'string', + 'example' => '91141', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '创建标签', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TagId\\": \\"91141\\",\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTagResponse>\\r\\n <RequestId>10A1AD70-E48E-476D-98D9-39BD92193837</RequestId>\\r\\n <TagId>xxxx</TagId>\\r\\n</CreateTagResponse>","errorExample":""}]', + ], + 'CreateUserSuppression' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱地址或域名', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]或example.net', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1A846D66-5EC7-551B-9687-5BF1963DCFC1', + ], + 'SuppressionId' => [ + 'description' => '无效地址编号', + 'type' => 'string', + 'example' => '59511', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建无效地址或域名', + 'summary' => '创建无效地址或域名。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateUserSuppression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A846D66-5EC7-551B-9687-5BF1963DCFC1\\",\\n \\"SuppressionId\\": \\"59511\\"\\n}","type":"json"}]', + ], + 'DedicatedIpAutoRenewal' => [ + 'summary' => '设置IP自动续费。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BuyResourceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '购买实例ID，多个英文逗号隔开', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx,xxx', + ], + ], + [ + 'name' => 'AutoRenewal', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动续费', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '设置IP自动续费', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpAutoRenewal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'DedicatedIpChangeWarmupType' => [ + 'summary' => '更新已购买IP预热方式。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '独立IP ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'WarmupType', + 'in' => 'query', + 'schema' => [ + 'description' => '预热方式', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'sysCusStream' => '系统预热', + 'cusSelfManager' => '手动预热', + ], + 'example' => 'sysCusStream', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新已购买IP预热方式', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpChangeWarmupType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'DedicatedIpList' => [ + 'summary' => '列出购买IP列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '分页索引，从1开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP搜索关键字', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'TotalCounts' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '已购买IP数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'HasMore' => [ + 'description' => '是否有下一页', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CurrentPage' => [ + 'description' => '当前页', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Ips' => [ + 'description' => 'IP列表', + 'type' => 'array', + 'items' => [ + 'description' => '购买IP信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'IP ID，与购买实例ID一致', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Ip' => [ + 'description' => 'IP', + 'type' => 'string', + 'example' => 'xxx', + ], + 'InstanceId' => [ + 'description' => '购买实例ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'StartTime' => [ + 'description' => '购买时间', + 'type' => 'string', + 'example' => '2025-05-12T09:19:20Z', + ], + 'ExpiredTime' => [ + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2025-06-12T09:19:20Z', + ], + 'Status' => [ + 'description' => 'IP状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'sold' => '已购买', + 'expired' => '已过期', + ], + 'example' => 'sold', + ], + 'WarmupStatus' => [ + 'description' => '预热状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '待处理', + 'processing' => '处理中', + 'finish' => '完成', + ], + 'example' => 'finish', + ], + 'WarmupType' => [ + 'description' => '预热方式', + 'type' => 'string', + 'enumValueTitles' => [ + 'sysCusStream' => '系统预热', + 'cusSelfManager' => '手动预热', + ], + 'example' => 'cusSelfManager', + ], + 'IpPoolName' => [ + 'description' => '所在IP池名称', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'xxx', + ], + 'IpExt' => [ + 'description' => '扩展信息', + 'type' => 'object', + 'properties' => [ + 'HasSendMail' => [ + 'description' => '是否已发送邮件', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'AutoRenewal' => [ + 'description' => '是否自动续费', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'false', + ], + 'LastWarmUpTypeChangedTime' => [ + 'type' => 'string', + ], + ], + ], + 'ZoneId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出购买IP列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCounts\\": 5,\\n \\"RequestId\\": \\"xxx\\",\\n \\"HasMore\\": false,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Ips\\": [\\n {\\n \\"Id\\": \\"xxx\\",\\n \\"Ip\\": \\"xxx\\",\\n \\"InstanceId\\": \\"xxx\\",\\n \\"StartTime\\": \\"2025-05-12T09:19:20Z\\",\\n \\"ExpiredTime\\": \\"2025-06-12T09:19:20Z\\",\\n \\"Status\\": \\"sold\\",\\n \\"WarmupStatus\\": \\"finish\\",\\n \\"WarmupType\\": \\"cusSelfManager\\",\\n \\"IpPoolName\\": \\"xxx\\",\\n \\"IpExt\\": {\\n \\"HasSendMail\\": true,\\n \\"AutoRenewal\\": false,\\n \\"LastWarmUpTypeChangedTime\\": \\"\\"\\n },\\n \\"ZoneId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DedicatedIpNonePoolList' => [ + 'summary' => '列出未加入IP池IP，用于IP池设置。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'Ips' => [ + 'description' => '未加入IP池IP信息', + 'type' => 'array', + 'items' => [ + 'description' => '购买实例与IP地址关系', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '购买实例ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Ip' => [ + 'description' => 'IP地址', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ZoneId' => [ + 'description' => '可用区ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出未加入IP池IP', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpNonePoolList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ips\\": [\\n {\\n \\"Id\\": \\"xxx\\",\\n \\"Ip\\": \\"xxx\\",\\n \\"ZoneId\\": \\"xxx\\"\\n }\\n ],\\n \\"RequestId\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'DedicatedIpPoolCreate' => [ + 'summary' => 'IP池创建。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP池名称；'."\n" + .'长度为1-50个字符，允许英文字母、数字、_、-，IP池创建后，名称不可修改', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xxx', + 'maxLength' => 50, + 'minLength' => 1, + ], + ], + [ + 'name' => 'BuyResourceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '购买IP实例ID,多个英文逗号隔开；来源于DedicatedIpNonePoolList接口返回IP购买实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx,xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Id' => [ + 'description' => 'IP池ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建IP池', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"Id\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'DedicatedIpPoolDelete' => [ + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP池ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除IP池', + 'summary' => 'IP池删除。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'DedicatedIpPoolList' => [ + 'summary' => '列出IP池。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '分页索引，从1开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数目', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '名称搜索关键字', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'title' => '全量查询标识', + 'description' => '全量查询标识', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'HasMore' => [ + 'description' => '是否有下一页', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'false' => '否', + 'true' => '是', + ], + 'example' => 'false', + ], + 'CurrentPage' => [ + 'description' => '当前页', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'string', + 'example' => '10', + ], + 'TotalCounts' => [ + 'description' => '本次请求条件下的数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'IpPools' => [ + 'description' => 'IP池列表', + 'type' => 'array', + 'items' => [ + 'description' => 'IP池信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'IP池ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-05-23T07:41:43Z', + ], + 'Name' => [ + 'description' => 'IP池名称', + 'type' => 'string', + 'example' => 'xxx', + ], + 'IpCount' => [ + 'description' => '源IP地址数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Ips' => [ + 'description' => 'IP列表', + 'type' => 'array', + 'items' => [ + 'description' => 'IP信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '购买实例ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Ip' => [ + 'description' => 'IP地址', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ZoneId' => [ + 'description' => '可用区ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出IP池', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"HasMore\\": false,\\n \\"CurrentPage\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCounts\\": 5,\\n \\"IpPools\\": [\\n {\\n \\"Id\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2025-05-23T07:41:43Z\\",\\n \\"Name\\": \\"xxx\\",\\n \\"IpCount\\": 1,\\n \\"Ips\\": [\\n {\\n \\"Id\\": \\"xxx\\",\\n \\"Ip\\": \\"xxx\\",\\n \\"ZoneId\\": \\"xxx\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DedicatedIpPoolUpdate' => [ + 'summary' => '更新IP池。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP池ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'BuyResourceIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '购买IP实例ID,多个英文逗号隔开；来源于DedicatedIpNonePoolList接口返回IP购买实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx,xxx', + ], + ], + [ + 'name' => 'UpdateResource', + 'in' => 'query', + 'schema' => [ + 'description' => '是否更改关联IP,填写true', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Id' => [ + 'description' => 'IP池ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新IP池', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"Id\\": \\"xxx\\"\\n}","type":"json"}]', + ], + 'DeleteDomain' => [ + 'summary' => '删除域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => '域名ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '326***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E3DFF97B-00CF-5333-8125-3D6819471984', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除域名', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3DFF97B-00CF-5333-8125-3D6819471984\\"\\n}","type":"json"}]', + ], + 'DeleteInvalidAddress' => [ + 'summary' => '从全局无效地址库移除无效地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ToAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '目标地址', + 'type' => 'string', + 'required' => false, + 'example' => 'test1***@example.net'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '2D086F6-xxxx-xxxx-xxxx-006DED011A85', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除无效地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:DeleteInvalidAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D086F6-xxxx-xxxx-xxxx-006DED011A85\\"\\n}","type":"json"}]', + ], + 'DeleteIpfilterByEdmId' => [ + 'summary' => '删除IP保护信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '废弃，历史原因兼容'."\n", + 'default' => '1', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '记录id', + 'type' => 'string', + 'required' => false, + 'example' => '10120', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E3DFF97B-00CF-5333-8125-3D6819471984', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除IP白名单', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteIpfilterByEdmId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3DFF97B-00CF-5333-8125-3D6819471984\\"\\n}","type":"json"}]', + ], + 'DeleteMailAddress' => [ + 'summary' => '删除发信地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'MailAddressId', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '23457', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除发信地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","type":"json"}]', + ], + 'DeleteReceiver' => [ + 'summary' => '删除收件人列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'description' => '收件人列表ID', + 'type' => 'string', + 'required' => true, + 'example' => '144adfa772cfe47631de7e86d7da13ae', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除收件人列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteReceiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","type":"json"}]', + ], + 'DeleteReceiverDetail' => [ + 'summary' => '删除单个收件人。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'description' => '收件人列表ID', + 'type' => 'string', + 'required' => true, + 'example' => '53228b7d80c36257927ecd029ccd3c9a', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '收件人列表中需要删除的单个收件人', + 'type' => 'string', + 'required' => false, + 'example' => '账号+@+域名', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除单个收件人', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteReceiverDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","type":"json"}]', + ], + 'DeleteTag' => [ + 'summary' => '删除标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '删除标签', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","type":"json"}]', + ], + 'DeleteValidateFile' => [ + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'title' => '提交任务返回的文件Id', + 'description' => '提交任务返回的文件Id', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'yyyy-yyyy-yyyy-yyyy', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除校验结果文件', + 'summary' => '在校验完成后，删除校验文件。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteValidateFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"yyyy-yyyy-yyyy-yyyy\\"\\n}","type":"json"}]', + ], + 'DescAccountSummary' => [ + 'summary' => '获取账户信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnableTimes' => [ + 'description' => '生效时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SmsSign' => [ + 'description' => '已废弃，兼容性原因保留。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MonthQuota' => [ + 'description' => '月额度', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60000', + ], + 'Receivers' => [ + 'description' => '收件人数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DayuStatus' => [ + 'description' => '大鱼状态（已废弃，兼容性原因保留。）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DailyQuota' => [ + 'description' => '日额度', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'SmsRecord' => [ + 'description' => '已废弃，兼容性原因保留。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tags' => [ + 'description' => '标签数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Templates' => [ + 'description' => '模板数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MailAddresses' => [ + 'description' => '发信地址数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '82B295BB-7E69-491F-9896-ECEAFF09E1A4', + ], + 'QuotaLevel' => [ + 'description' => '信誉度等级', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'MaxQuotaLevel' => [ + 'description' => '最高等级', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Domains' => [ + 'description' => '域名数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UserStatus' => [ + 'description' => '用户状态：'."\n" + .'0 正常'."\n" + .'1 冻结'."\n" + .'2 欠费'."\n" + .'4 限制外发'."\n" + .'8 逻辑删除', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SmsTemplates' => [ + 'description' => '已废弃，兼容性原因保留。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RemainFreeQuota' => [ + 'description' => '总免费额度剩余量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1910', + ], + 'DailyRemainFreeQuota' => [ + 'description' => '日免费额度剩余量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'IpChannelType' => [ + 'description' => '所在出口IP通道类型。'."\n" + .'1. backup：备用IP通道，不进行日常维护。使用该通道的客户建议购买独立IP以确保稳定性。'."\n" + .'2. normal：正常IP通道，由邮件推送团队持续维护，保障通道稳定可靠。', + 'type' => 'string', + 'example' => 'normal', + 'enum' => [ + 'backup', + 'normal', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'User.Blacklisted', + 'errorMessage' => 'The specified user is in the blacklist.', + 'description' => '', + ], + [ + 'errorCode' => 'User.RegisterTooMuch', + 'errorMessage' => 'The specified user has registered more than one DirectMail account.', + 'description' => '', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'description' => '', + ], + ], + ], + 'title' => '获取账户信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:DescAccountSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableTimes\\": 0,\\n \\"SmsSign\\": 0,\\n \\"MonthQuota\\": 60000,\\n \\"Receivers\\": 0,\\n \\"DayuStatus\\": 0,\\n \\"DailyQuota\\": 2000,\\n \\"SmsRecord\\": 0,\\n \\"Tags\\": 0,\\n \\"Templates\\": 1,\\n \\"MailAddresses\\": 0,\\n \\"RequestId\\": \\"82B295BB-7E69-491F-9896-ECEAFF09E1A4\\",\\n \\"QuotaLevel\\": 2,\\n \\"MaxQuotaLevel\\": 10,\\n \\"Domains\\": 1,\\n \\"UserStatus\\": 0,\\n \\"SmsTemplates\\": 0,\\n \\"RemainFreeQuota\\": 1910,\\n \\"DailyRemainFreeQuota\\": 100,\\n \\"IpChannelType\\": \\"normal\\"\\n}","errorExample":""},{"type":"xml","example":"<DescAccountSummaryResponse>\\r\\n <DayuStatus>0</DayuStatus>\\r\\n <SmsRecord>0</SmsRecord>\\r\\n <SmsSign>0</SmsSign>\\r\\n <UserStatus>0</UserStatus>\\r\\n <SmsTemplates>0</SmsTemplates>\\r\\n <Templates>1</Templates>\\r\\n <Domains>1</Domains>\\r\\n <MonthQuota>60000</MonthQuota>\\r\\n <Tags>0</Tags>\\r\\n <QuotaLevel>2</QuotaLevel>\\r\\n <EnableTimes>0</EnableTimes>\\r\\n <RequestId>82B295BB-7E69-491F-9896-ECEAFF09E1A4</RequestId>\\r\\n <MaxQuotaLevel>10</MaxQuotaLevel>\\r\\n <MailAddresses>0</MailAddresses>\\r\\n <DailyQuota>2000</DailyQuota>\\r\\n <Receivers>0</Receivers>\\r\\n</DescAccountSummaryResponse> ","errorExample":""}]', + ], + 'DescDomain' => [ + 'summary' => '配置域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'description' => '域名ID。可以通过QueryDomainByParam获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '13464', + ], + ], + [ + 'name' => 'RequireRealTimeDnsRecords', + 'in' => 'query', + 'schema' => [ + 'description' => '判断是否要实时DNS解析', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SpfRecord' => [ + 'description' => '邮件推送控制台提供的spf记录值', + 'type' => 'string', + 'example' => 'include:spf1.dm.aliyun.com', + ], + 'CnameConfirmStatus' => [ + 'description' => '是否改动了CNAME的主机记录，已改动：1（改回原来值也算改动），未改动：0。', + 'type' => 'string', + 'example' => '0', + ], + 'DefaultDomain' => [ + 'description' => '是否为默认域名，'."\n" + ."\n" + .'值：0 否（该字段已弃用）', + 'type' => 'string', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-19T12:49Z', + ], + 'CnameRecord' => [ + 'description' => 'CNAME主机记录自定义部分', + 'type' => 'string', + 'example' => 'dmtrace', + ], + 'CnameAuthStatus' => [ + 'description' => 'CNAME验证标志，成功：0，失败：1。', + 'type' => 'string', + 'example' => '1', + ], + 'IcpStatus' => [ + 'description' => '备案状态。**1**表示已备案，**0**表示未备案。', + 'type' => 'string', + 'example' => '1', + ], + 'DnsTxt' => [ + 'description' => '通过公网域名解析到的所有权记录值', + 'type' => 'string', + 'example' => '0c40d5f125af4e42892a', + ], + 'DomainName' => [ + 'description' => '域名', + 'type' => 'string', + 'example' => 'test.example.net', + ], + 'DomainId' => [ + 'description' => '域名ID', + 'type' => 'string', + 'example' => '158910', + ], + 'DnsSpf' => [ + 'description' => '通过公网域名解析到的spf记录值', + 'type' => 'string', + 'example' => 'v=xxxx', + ], + 'SpfAuthStatus' => [ + 'description' => 'spf验证标志，成功：0，失败：1。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '51B74264-46B4-43C8-A9A0-6B8E8BC04F34', + ], + 'MxRecord' => [ + 'description' => '邮件推送控制台提供的MX记录值', + 'type' => 'string', + 'example' => 'mx01.dm.aliyun.com', + ], + 'MxAuthStatus' => [ + 'description' => 'mx验证标志，成功：0，失败：1。', + 'type' => 'string', + 'example' => '1', + ], + 'DnsMx' => [ + 'description' => '通过公网域名解析到的MX记录值', + 'type' => 'string', + 'example' => 'mx01.dm.aliyun.com', + ], + 'DomainStatus' => [ + 'description' => '域名状态。说明是否验证成功，取值：'."\n" + ."\n" + .'- **0**：可用，已验证通过'."\n" + .'- **1**：不可用，验证未通过', + 'type' => 'string', + 'example' => '1', + ], + 'TlDomainName' => [ + 'description' => '主域名', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TracefRecord' => [ + 'description' => '邮件推送控制台提供的CNAME记录值', + 'type' => 'string', + 'example' => 'tracedm.aliyuncs.com', + ], + 'DomainType' => [ + 'description' => '邮件推送控制台提供的所有权记录', + 'type' => 'string', + 'example' => '0c40d5f125af4e42892a', + ], + 'SpfRecordV2' => [ + 'description' => 'spf记录，以前spf展示内容需要调用端根据响应中的spfRecord计算得出，新增字段spfRecordV2取代spfRecord， 调用端拿到该字段后可以直接进行展示；', + 'type' => 'string', + 'example' => 'v=spf1 include:spf1.dm.aliyun.com -all', + ], + 'DkimRR' => [ + 'description' => 'DKIM主机记录，用户需要在dns上设置的dkim记录的key', + 'type' => 'string', + 'example' => 'aliyun-cn-hangzhou._domainkey.hangzhou26', + ], + 'DkimPublicKey' => [ + 'description' => 'DKIM公钥值，用户需要在dns上设置的dkim记录的value', + 'type' => 'string', + 'example' => 'v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...', + ], + 'DkimAuthStatus' => [ + 'description' => 'DKIM 验证标志，用户在dns设置的dkim记录是否已经校验通过, 0:通过， 1:未通过', + 'type' => 'string', + 'example' => '0', + ], + 'HostRecord' => [ + 'description' => '主机记录', + 'type' => 'string', + 'example' => 'xxx', + ], + 'DmarcRecord' => [ + 'description' => 'DMARC记录值', + 'type' => 'string', + 'example' => 'v=DMARC1;p=none;rua=mailto:[email protected]', + ], + 'DnsDmarc' => [ + 'description' => '通过公网域名解析到的DMARC记录值', + 'type' => 'string', + 'example' => 'v=DMARC1;p=none;rua=mailto:[email protected]', + ], + 'DmarcAuthStatus' => [ + 'description' => 'DMARC 验证标志，用户在dns设置的DMARC记录是否已经校验通过, 0:通过， 1:未通过', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DmarcHostRecord' => [ + 'description' => 'DMARC主机记录值', + 'type' => 'string', + 'example' => '_dmarc.xxx', + ], + 'DkimRsaLength' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '配置域名', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:DescDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SpfRecord\\": \\"include:spf1.dm.aliyun.com\\",\\n \\"CnameConfirmStatus\\": \\"0\\",\\n \\"DefaultDomain\\": \\"0\\",\\n \\"CreateTime\\": \\"2025-03-19T12:49Z\\",\\n \\"CnameRecord\\": \\"dmtrace\\",\\n \\"CnameAuthStatus\\": \\"1\\",\\n \\"IcpStatus\\": \\"1\\",\\n \\"DnsTxt\\": \\"0c40d5f125af4e42892a\\",\\n \\"DomainName\\": \\"test.example.net\\",\\n \\"DomainId\\": \\"158910\\",\\n \\"DnsSpf\\": \\"v=xxxx\\",\\n \\"SpfAuthStatus\\": \\"1\\",\\n \\"RequestId\\": \\"51B74264-46B4-43C8-A9A0-6B8E8BC04F34\\",\\n \\"MxRecord\\": \\"mx01.dm.aliyun.com\\",\\n \\"MxAuthStatus\\": \\"1\\",\\n \\"DnsMx\\": \\"mx01.dm.aliyun.com\\",\\n \\"DomainStatus\\": \\"1\\",\\n \\"TlDomainName\\": \\"example.com\\",\\n \\"TracefRecord\\": \\"tracedm.aliyuncs.com\\",\\n \\"DomainType\\": \\"0c40d5f125af4e42892a\\",\\n \\"SpfRecordV2\\": \\"v=spf1 include:spf1.dm.aliyun.com -all\\",\\n \\"DkimRR\\": \\"aliyun-cn-hangzhou._domainkey.hangzhou26\\",\\n \\"DkimPublicKey\\": \\"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...\\",\\n \\"DkimAuthStatus\\": \\"0\\",\\n \\"HostRecord\\": \\"xxx\\",\\n \\"DmarcRecord\\": \\"v=DMARC1;p=none;rua=mailto:[email protected]\\",\\n \\"DnsDmarc\\": \\"v=DMARC1;p=none;rua=mailto:[email protected]\\",\\n \\"DmarcAuthStatus\\": 1,\\n \\"DmarcHostRecord\\": \\"_dmarc.xxx\\",\\n \\"DkimRsaLength\\": 0\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'DescTemplate' => [ + 'summary' => '查看模板信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3xxxx2', + ], + ], + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'example' => 'Abandoned, historical reasons for compatibility', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SmsContent' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'string', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '95xxx5F', + ], + 'Remark' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'string', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'SmsType' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'string', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-11-14T13:28Z', + ], + 'TemplateSubject' => [ + 'description' => '模版主题，组建邮件主题', + 'type' => 'string', + 'example' => 'test', + ], + 'TemplateStatus' => [ + 'description' => '模板状态，取值和说明如下：'."\n" + .'- 0是草稿'."\n" + .'- 1是待审核'."\n" + .'- 2是已通过审核'."\n" + .'- 3是未通过审核', + 'type' => 'string', + 'example' => '2', + ], + 'TemplateNickName' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'string', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'TemplateType' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'string', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'TemplateName' => [ + 'description' => '模版名称', + 'type' => 'string', + 'example' => 'test1', + ], + 'TemplateText' => [ + 'description' => '模版内容', + 'type' => 'string', + 'example' => '<p>1</p>', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查看模板信息', + 'description' => '查看模板信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:DescTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SmsContent\\": \\"Abandoned, historical reasons for compatibility\\",\\n \\"RequestId\\": \\"95xxx5F\\",\\n \\"Remark\\": \\"Abandoned, historical reasons for compatibility\\",\\n \\"SmsType\\": \\"Abandoned, historical reasons for compatibility\\",\\n \\"CreateTime\\": \\"2025-11-14T13:28Z\\",\\n \\"TemplateSubject\\": \\"test\\",\\n \\"TemplateStatus\\": \\"2\\",\\n \\"TemplateNickName\\": \\"Abandoned, historical reasons for compatibility\\",\\n \\"TemplateType\\": \\"Abandoned, historical reasons for compatibility\\",\\n \\"TemplateName\\": \\"test1\\",\\n \\"TemplateText\\": \\"<p>1</p>\\"\\n}","type":"json"}]', + ], + 'GetIpProtection' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详细记录', + 'type' => 'object', + 'properties' => [ + 'IpProtection' => [ + 'description' => 'IP防护开关，打开：1 关闭：0', + 'type' => 'string', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B30E5A62-2E64-577D-A70E-8C6781D6C975', + ], + ], + ], + ], + ], + 'title' => '获取IP防护功能是否开启', + 'summary' => '获取IP防护功能是否开启。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetIpProtection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpProtection\\": \\"0\\",\\n \\"RequestId\\": \\"B30E5A62-2E64-577D-A70E-8C6781D6C975\\"\\n}","type":"json"}]', + ], + 'GetIpfilterList' => [ + 'summary' => '获取 IP 筛选器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '84DD77C7-A091-5139-9530-2D1F7CCE59E0', + ], + 'PageNumber' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ipfilters' => [ + 'description' => '数据记录', + 'type' => 'array', + 'items' => [ + 'description' => '详细记录', + 'type' => 'object', + 'properties' => [ + 'IpAddress' => [ + 'description' => 'IP地址/IP区间/IP段', + 'type' => 'string', + 'example' => '单个IP格式，如：xxx.xxx.xxx.xxx'."\n" + .'IP区间格式，如：xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx'."\n" + .'IP段格式，如：xxx.xxx.xxx.xxx/xxx', + ], + 'Id' => [ + 'description' => '记录ID', + 'type' => 'string', + 'example' => '10083', + ], + 'CreateTime' => [ + 'description' => '时间戳', + 'type' => 'string', + 'example' => '1653547140', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取 IP 筛选器列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetIpfilterList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"84DD77C7-A091-5139-9530-2D1F7CCE59E0\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"data\\": {\\n \\"ipfilters\\": [\\n {\\n \\"IpAddress\\": \\"单个IP格式，如：xxx.xxx.xxx.xxx\\\\nIP区间格式，如：xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx\\\\nIP段格式，如：xxx.xxx.xxx.xxx/xxx\\",\\n \\"Id\\": \\"10083\\",\\n \\"CreateTime\\": \\"1653547140\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetTrackList' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间，时间不能早于30日，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，和起始时间跨度不能超出7天，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'Total', + 'in' => 'query', + 'schema' => [ + 'description' => '（本字段已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '第一次查询为0，后续固定为1。1为按照时间正序分页查询。（本字段已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OffsetCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '分页用，第一次查询不设置，后续查询设置为上一次Response中OffsetCreateTime值（本字段已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）', + ], + ], + [ + 'name' => 'OffsetCreateTimeDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '（本字段已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址。'."\n" + ."\n" + .'> 不填，代表所有地址；若有TagName，此参数不为空。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称', + 'type' => 'string', + 'required' => false, + 'example' => 'tagname', + ], + ], + [ + 'name' => 'DedicatedIpPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的独立IP池ID的数据'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'DedicatedIp', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的独立IP的数据。'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'Esp', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '对于独立IP用户，查询特定的ESP数据的数据，可以填写的值如下'."\n" + .'- gmail.com'."\n" + .'- yahoo.com'."\n" + .'- outlook.com'."\n" + .'- icloud.com'."\n" + .'- others（对应其他的非上述ESP的数据）'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmail.com', + ], + ], + [ + 'name' => 'ConfigSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置集ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OffsetCreateTimeDesc' => [ + 'description' => '（本字段已废弃）', + 'type' => 'string', + 'example' => '（本字段已废弃）', + ], + 'OffsetCreateTime' => [ + 'description' => '分页用，第一次查询不设置，后续查询设置为上一次Response中OffsetCreateTime值（本字段已废弃）', + 'type' => 'string', + 'example' => '（本字段已废弃）', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'PageNo' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'stat' => [ + 'description' => '跟踪数据记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RcptClickRate' => [ + 'description' => '点击率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueOpenCount' => [ + 'description' => '独立打开数', + 'type' => 'string', + 'example' => '0', + ], + 'RcptClickCount' => [ + 'description' => '点击量', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueClickCount' => [ + 'description' => '独立点击数', + 'type' => 'string', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-09-29T13:28Z', + ], + 'RcptUniqueOpenRate' => [ + 'description' => '独立打开率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueClickRate' => [ + 'description' => '独立点击率', + 'type' => 'string', + 'example' => '0', + ], + 'TotalNumber' => [ + 'description' => '总数', + 'type' => 'string', + 'example' => '0', + ], + 'RcptOpenRate' => [ + 'description' => '打开率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptOpenCount' => [ + 'description' => '打开量', + 'type' => 'string', + 'example' => '0', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '邮件跟踪获取发送数据', + 'summary' => '邮件跟踪获取发送数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:GetTrackList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OffsetCreateTimeDesc\\": \\"（本字段已废弃）\\",\\n \\"OffsetCreateTime\\": \\"（本字段已废弃）\\",\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"TotalPages\\": 2,\\n \\"data\\": {\\n \\"stat\\": [\\n {\\n \\"RcptClickRate\\": \\"0\\",\\n \\"RcptUniqueOpenCount\\": \\"0\\",\\n \\"RcptClickCount\\": \\"0\\",\\n \\"RcptUniqueClickCount\\": \\"0\\",\\n \\"CreateTime\\": \\"2019-09-29T13:28Z\\",\\n \\"RcptUniqueOpenRate\\": \\"0\\",\\n \\"RcptUniqueClickRate\\": \\"0\\",\\n \\"TotalNumber\\": \\"0\\",\\n \\"RcptOpenRate\\": \\"0\\",\\n \\"RcptOpenCount\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetTrackListByMailFromAndTagName' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Total', + 'in' => 'query', + 'schema' => [ + 'description' => '（本字段已废弃）'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）'."\n", + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间，时间不能早于30日，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，和起始时间跨度不能超出15天，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '第一次查询为0，后续固定为1。1为按照时间正序分页查询。（本字段已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）'."\n", + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OffsetCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '分页用，第一次查询不设置，后续查询设置为上一次Response中OffsetCreateTime值（本字段已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）'."\n", + ], + ], + [ + 'name' => 'OffsetCreateTimeDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '（本字段已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '（本字段已废弃）'."\n", + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址。'."\n" + ."\n" + .'> 不填，代表所有地址；若有TagName，此参数不为空。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '邮件标签。不填，代表所有标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'DedicatedIpPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的独立IP池ID的数据'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'DedicatedIp', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的独立IP的数据。'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'Esp', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的ESP数据的数据，可以填写的值如下'."\n" + .'- gmail.com'."\n" + .'- yahoo.com'."\n" + .'- outlook.com'."\n" + .'- icloud.com'."\n" + .'- others（对应其他的非上述ESP的数据）'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmail.com', + ], + ], + [ + 'name' => 'ConfigSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置集ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'OffsetCreateTime' => [ + 'description' => '分页用，第一次查询不设置，后续查询设置为上一次Response中OffsetCreateTime值（本字段已废弃）', + 'type' => 'string', + 'example' => '（本字段已废弃）', + ], + 'PageNo' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '(本字段已废弃）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'OffsetCreateTimeDesc' => [ + 'description' => '（本字段已废弃）', + 'type' => 'string', + 'example' => '（本字段已废弃）', + ], + 'TrackList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Stat' => [ + 'description' => '跟踪数据记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RcptClickRate' => [ + 'description' => '点击率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueOpenCount' => [ + 'description' => '独立打开数', + 'type' => 'string', + 'example' => '0', + ], + 'RcptClickCount' => [ + 'description' => '点击量', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueClickCount' => [ + 'description' => '独立点击数', + 'type' => 'string', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-01-11T10:11Z', + ], + 'RcptUniqueOpenRate' => [ + 'description' => '独立打开率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueClickRate' => [ + 'description' => '独立点击率', + 'type' => 'string', + 'example' => '0', + ], + 'TotalNumber' => [ + 'description' => '总数', + 'type' => 'string', + 'example' => '0', + ], + 'RcptOpenRate' => [ + 'description' => '打开率'."\n" + ."\n", + 'type' => 'string', + 'example' => '0', + ], + 'RcptOpenCount' => [ + 'description' => '打开量', + 'type' => 'string', + 'example' => '0', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'string', + 'example' => '2', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '根据发信地址和标签获取邮件跟踪发送数据', + 'summary' => '邮件跟踪获取指定条件下的发送数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:GetTrackListByMailFromAndTagName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"OffsetCreateTime\\": \\"（本字段已废弃）\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 4,\\n \\"OffsetCreateTimeDesc\\": \\"（本字段已废弃）\\",\\n \\"TrackList\\": {\\n \\"Stat\\": [\\n {\\n \\"RcptClickRate\\": \\"0\\",\\n \\"RcptUniqueOpenCount\\": \\"0\\",\\n \\"RcptClickCount\\": \\"0\\",\\n \\"RcptUniqueClickCount\\": \\"0\\",\\n \\"CreateTime\\": \\"2025-01-11T10:11Z\\",\\n \\"RcptUniqueOpenRate\\": \\"0\\",\\n \\"RcptUniqueClickRate\\": \\"0\\",\\n \\"TotalNumber\\": \\"0\\",\\n \\"RcptOpenRate\\": \\"0\\",\\n \\"RcptOpenCount\\": \\"0\\"\\n }\\n ]\\n },\\n \\"TotalPages\\": \\"2\\"\\n}","type":"json"}]', + ], + 'GetUser' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'Data' => [ + 'description' => '返回内容', + 'type' => 'object', + 'properties' => [ + 'EnableEventbridge' => [ + 'description' => '是否启用了EventBridge', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取用户信息', + 'summary' => '获取用户相关的信息，包含设置等信息。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:GetUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"Data\\": {\\n \\"EnableEventbridge\\": true\\n }\\n}","type":"json"}]', + ], + 'GetValidateFile' => [ + 'summary' => '获取批量校验任务的结果文件。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'title' => '提交任务返回的文件Id', + 'description' => '提交任务返回的文件Id', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'yyyy-yyyy-yyyy-yyyy', + ], + 'FileUrl' => [ + 'title' => '结果文件下载url', + 'description' => '结果文件下载url', + 'type' => 'string', + 'example' => 'https://xxxxxx/yyy', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取校验结果文件', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetValidateFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"yyyy-yyyy-yyyy-yyyy\\",\\n \\"FileUrl\\": \\"https://xxxxxx/yyy\\"\\n}","type":"json"}]', + ], + 'GetValidateFileStatus' => [ + 'summary' => '获取校验文件的状态。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'title' => '提交任务返回的文件Id', + 'description' => '提交任务返回的文件Id', + 'type' => 'string', + 'required' => true, + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'yyyy-yyyy-yyyy-yyyy', + ], + 'FileName' => [ + 'title' => '提交任务时上传的文件名', + 'description' => '提交任务时上传的文件名', + 'type' => 'string', + 'example' => 'file.txt', + ], + 'UploadTime' => [ + 'title' => '文件提交时间', + 'description' => '文件提交时间', + 'type' => 'string', + 'example' => '2000-01-01T00:00:00Z', + ], + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'deleted' => '已删除', + 'processing' => '处理中', + 'completed' => '已完成', + ], + 'example' => 'completed', + ], + 'Percentage' => [ + 'title' => '任务执行进度', + 'description' => '任务执行进度', + 'type' => 'string', + 'example' => '100%', + ], + 'CompleteTime' => [ + 'title' => '任务完成时间', + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2000-01-01T00:00:00Z', + ], + 'TotalNum' => [ + 'title' => '任务需要校验的地址数量', + 'description' => '任务需要校验的地址数量', + 'type' => 'string', + 'example' => '10', + ], + 'ProcessedNum' => [ + 'title' => '任务已经校验完成的地址数量', + 'description' => '任务已经校验完成的地址数量', + 'type' => 'string', + 'example' => '10', + ], + 'ValidNum' => [ + 'title' => '校验结果为Valid的地址数量', + 'description' => '校验结果为Valid的地址数量', + 'type' => 'string', + 'example' => '4', + ], + 'InvalidNum' => [ + 'title' => '校验结果为Invalid的地址数量', + 'description' => '校验结果为Invalid的地址数量', + 'type' => 'string', + 'example' => '2', + ], + 'CatchAllNum' => [ + 'title' => '校验结果为的CatchAll地址数量', + 'description' => '校验结果为的CatchAll地址数量', + 'type' => 'string', + 'example' => '2', + ], + 'DoNotMailNum' => [ + 'title' => '校验结果为DoNotMail的地址数量', + 'description' => '校验结果为DoNotMail的地址数量', + 'type' => 'string', + 'example' => '1', + ], + 'UnknownNum' => [ + 'title' => '校验结果为Unknown的地址数量', + 'description' => '校验结果为Unknown的地址数量', + 'type' => 'string', + 'example' => '1', + ], + 'FileId' => [ + 'title' => '文件Id', + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取校验结果文件状态', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetValidateFileStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"yyyy-yyyy-yyyy-yyyy\\",\\n \\"FileName\\": \\"file.txt\\",\\n \\"UploadTime\\": \\"2000-01-01T00:00:00Z\\",\\n \\"Status\\": \\"completed\\",\\n \\"Percentage\\": \\"100%\\",\\n \\"CompleteTime\\": \\"2000-01-01T00:00:00Z\\",\\n \\"TotalNum\\": \\"10\\",\\n \\"ProcessedNum\\": \\"10\\",\\n \\"ValidNum\\": \\"4\\",\\n \\"InvalidNum\\": \\"2\\",\\n \\"CatchAllNum\\": \\"2\\",\\n \\"DoNotMailNum\\": \\"1\\",\\n \\"UnknownNum\\": \\"1\\",\\n \\"FileId\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetValidationQuota' => [ + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + 'UsedQuota' => [ + 'title' => '已经使用的额度', + 'description' => '已经使用的额度', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalQuota' => [ + 'title' => '总共可用的额度', + 'description' => '总共可用的额度', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取校验额度', + 'summary' => '获取电子邮件校验额度。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetValidationQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx-xxxx\\",\\n \\"UsedQuota\\": 1,\\n \\"TotalQuota\\": 10\\n}","type":"json"}]', + ], + 'ListBlockSending' => [ + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '游标，不传为从头开始拉取', + 'description' => '游标，不传为从头开始拉取', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxyyyyyy', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '接口返回的最大数量', + 'description' => '接口返回的最大数量 '."\n" + .'取值范围 (0，500]', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'BlockType', + 'in' => 'query', + 'schema' => [ + 'title' => 'Block类型', + 'description' => 'Block类型'."\n" + .'- UNSUB: 退订'."\n" + .'- REPORT: 举报', + 'type' => 'string', + 'required' => true, + 'example' => 'UNSUB', + 'enum' => [ + 'UNSUB', + 'REPORT', + ], + ], + ], + [ + 'name' => 'SenderEmail', + 'in' => 'query', + 'schema' => [ + 'title' => '发信人地址', + 'description' => '发信人地址', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'BlockEmail', + 'in' => 'query', + 'schema' => [ + 'title' => '收信人地址', + 'description' => '收信人地址', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'Block时间的起始时间', + 'description' => '查询Block时间的开始范围', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1763973206', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'Block时间的结束时间', + 'description' => '查询Block时间的结束范围', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1764146006', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数的schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', + ], + 'NextToken' => [ + 'title' => '拉取下一段数据的游标，空字符串说明已经没有数据', + 'description' => '拉取下一段数据的游标，空字符串说明已经没有数据', + 'type' => 'string', + 'example' => 'xxxxyyyy', + ], + 'Data' => [ + 'title' => 'Block的详细信息', + 'description' => '退订或举报数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SenderEmail' => [ + 'title' => '发信人地址', + 'description' => '发信人地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'SendTime' => [ + 'title' => '发信时间', + 'description' => '发信时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1723249364', + ], + 'BlockEmail' => [ + 'title' => '收信人地址', + 'description' => '收信人地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'BlockTime' => [ + 'title' => 'Block开始的时间', + 'description' => 'Block开始的时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1723259364', + ], + 'Reason' => [ + 'title' => 'Block的原因。值为一个bitset，下面是每个位置bit的含义'."\n" + .'0: 原因未指定'."\n" + .'1: 对内容不感兴趣'."\n" + .'2: 内容重复'."\n" + .'3: 内容推送频繁'."\n", + 'description' => 'Block的原因。值为一个bitset，下面是每个位置bit的含义 '."\n" + .'- 0: 原因未指定'."\n" + .'- 1: 对内容不感兴趣'."\n" + .'- 2: 内容重复'."\n" + .'- 3: 内容推送频繁', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + 'MaxResults' => [ + 'description' => '接口返回的最大数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取发信黑名单', + 'summary' => '获取发信黑名单列表。', + 'description' => '获取退订或举报的数据', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:ListBlockSending', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\\",\\n \\"NextToken\\": \\"xxxxyyyy\\",\\n \\"Data\\": [\\n {\\n \\"SenderEmail\\": \\"[email protected]\\",\\n \\"SendTime\\": 1723249364,\\n \\"BlockEmail\\": \\"[email protected]\\",\\n \\"BlockTime\\": 1723259364,\\n \\"Reason\\": 1\\n }\\n ],\\n \\"MaxResults\\": 50\\n}","type":"json"}]', + ], + 'ListUserSuppression' => [ + 'summary' => '列出用户手动录入和系统判别的无效地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'StartCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录入开始时间，时间戳，精确到秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1715668852', + ], + ], + [ + 'name' => 'EndCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录入结束时间，时间戳，精确到秒，和开始时间跨度不能超出 7 天', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1715669077', + ], + ], + [ + 'name' => 'StartBounceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '退信最后一次命中开始时间，时间戳，精确到秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1715668852', + ], + ], + [ + 'name' => 'EndBounceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '退信最后一次命中结束时间，时间戳，精确到秒，和开始时间跨度不能超出 7 天', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1715669077', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱地址或域名', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1A846D66-5EC7-551B-9687-5BF1963DCFC1', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserSuppressions' => [ + 'description' => '返回的结果。', + 'type' => 'array', + 'items' => [ + 'description' => '详细信息', + 'type' => 'object', + 'properties' => [ + 'SuppressionId' => [ + 'description' => '无效地址编号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '59511', + ], + 'Address' => [ + 'description' => '邮箱地址或域名', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'LastBounceTime' => [ + 'description' => '退信最后一次命中时间，时间戳，精确到秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1715667451', + ], + 'CreateTime' => [ + 'description' => '创建时间，时间戳，精确到秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1715667435', + ], + 'Type' => [ + 'description' => '录入来源，无效地址类型'."\n" + .'- system'."\n" + .'- user', + 'type' => 'string', + 'example' => 'user', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出个人和系统无效地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:ListUserSuppression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"1A846D66-5EC7-551B-9687-5BF1963DCFC1\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"Data\\": {\\n \\"UserSuppressions\\": [\\n {\\n \\"SuppressionId\\": 59511,\\n \\"Address\\": \\"[email protected]\\",\\n \\"LastBounceTime\\": 1715667451,\\n \\"CreateTime\\": 1715667435,\\n \\"Type\\": \\"user\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListValidateFile' => [ + 'summary' => '获取上传的校验文件的列表', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间(RFC 3339的UTC时间)', + 'description' => '开始时间(RFC 3339的UTC时间)', + 'type' => 'string', + 'required' => true, + 'example' => '2025-12-19T08:30:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间(RFC 3339的UTC时间)', + 'description' => '结束时间(RFC 3339的UTC时间)', + 'type' => 'string', + 'required' => true, + 'example' => '2025-12-19T20:30:00Z', + ], + ], + [ + 'name' => 'FileKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名关键词', + 'type' => 'string', + 'required' => false, + 'example' => 'keyword', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应描述', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'HasNext' => [ + 'description' => '是否有下一页数据', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Page' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalSize' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalPages' => [ + 'description' => '总页数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Files' => [ + 'description' => '文件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'description' => '文件名', + 'type' => 'string', + 'example' => 'test.csv', + ], + 'UploadTime' => [ + 'description' => '文件提交时间', + 'type' => 'string', + 'example' => '2000-01-01T00:00:00Z', + ], + 'Status' => [ + 'description' => '任务状态', + 'type' => 'string', + 'example' => 'completed', + ], + 'Percentage' => [ + 'description' => '任务执行进度', + 'type' => 'string', + 'example' => '100%', + ], + 'CompleteTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2000-01-01T00:00:00Z', + ], + 'TotalNum' => [ + 'description' => '任务需要校验的地址数量', + 'type' => 'string', + 'example' => '10', + ], + 'ProcessedNum' => [ + 'description' => '任务已经校验完成的地址数量', + 'type' => 'string', + 'example' => '10', + ], + 'ValidNum' => [ + 'description' => '校验结果为 Valid 的地址数量', + 'type' => 'string', + 'example' => '5', + ], + 'InvalidNum' => [ + 'description' => '校验结果为 Invalid 的地址数量', + 'type' => 'string', + 'example' => '4', + ], + 'CatchAllNum' => [ + 'description' => '校验结果为的 CatchAll 地址数量', + 'type' => 'string', + 'example' => '1', + ], + 'DoNotMailNum' => [ + 'description' => '校验结果为 DoNotMail 的地址数量', + 'type' => 'string', + 'example' => '0', + ], + 'UnknownNum' => [ + 'description' => '校验结果为 Unknown 的地址数量', + 'type' => 'string', + 'example' => '0', + ], + 'IsDownloadable' => [ + 'description' => '结果是否可以下载', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FileId' => [ + 'description' => '文件ID', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '列出上传的校验文件', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx\\",\\n \\"HasNext\\": true,\\n \\"Page\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 100,\\n \\"TotalPages\\": 10,\\n \\"Files\\": [\\n {\\n \\"FileName\\": \\"test.csv\\",\\n \\"UploadTime\\": \\"2000-01-01T00:00:00Z\\",\\n \\"Status\\": \\"completed\\",\\n \\"Percentage\\": \\"100%\\",\\n \\"CompleteTime\\": \\"2000-01-01T00:00:00Z\\",\\n \\"TotalNum\\": \\"10\\",\\n \\"ProcessedNum\\": \\"10\\",\\n \\"ValidNum\\": \\"5\\",\\n \\"InvalidNum\\": \\"4\\",\\n \\"CatchAllNum\\": \\"1\\",\\n \\"DoNotMailNum\\": \\"0\\",\\n \\"UnknownNum\\": \\"0\\",\\n \\"IsDownloadable\\": true,\\n \\"FileId\\": \\"xxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ModifyMailAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MailAddressId', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1344565', + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '回信地址', + 'type' => 'string', + 'required' => false, + 'example' => 'a***@example.net', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '- 长度为 10~20 位，且必须包含数字、大写字母、小写字母。'."\n" + ."\n" + .'- 至少包含 2 位数字、2 位大写字母和 2 位小写字母，并且数字和字母均不能只由单一字符重复组成。'."\n" + ."\n" + .'- 不能与上一次设置密码相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'DM1mail1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '设置发信地址SMTP密码和回信地址', + 'summary' => '设置发信地址SMTP密码和回信地址。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ModifyMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyMailAddressResponse>\\r\\n\\t<RequestId>10A1AD70-E48E-476D-98D9-39BD92193837</RequestId>\\r\\n</ModifyMailAddressResponse>","errorExample":""}]', + ], + 'ModifyPWByDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名，长度1-50，可以为数字、大写字母、小写字母、.、-。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '- 长度为10~20位，且必须包含数字、大写字母、小写字母。'."\n" + ."\n" + .'- 至少包含2位数字、2位大写字母和2位小写字母，并且数字和字母均不能只由单一字符重复组成。'."\n" + ."\n" + .'- 不能与上一次设置密码相同。', + 'type' => 'string', + 'required' => true, + 'example' => 'DM1mail1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述', + 'type' => 'string', + 'example' => '请求成功', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '02B2A890-CBD8-4806-9BCA-C93190CE7EF6', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '设置域名的 SMTP 的密码', + 'summary' => '设置域名的SMTP的密码。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ModifyPWByDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"02B2A890-CBD8-4806-9BCA-C93190CE7EF6\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100674', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TagDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '标签描述', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '00BD30D8-2E86-523A-BFC7-63B7FF931A06', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '修改标签', + 'summary' => '修改标签。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ModifyTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"00BD30D8-2E86-523A-BFC7-63B7FF931A06\\"\\n}","type":"json"}]', + ], + 'QueryDomainByParam' => [ + 'summary' => '查询域名列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量，默认：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '10', + 'default' => '50', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '域名，长度1-50，可以包含数字、大写字母、小写字母、.、-。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '- 0表示正常'."\n" + .'- 1表示不正常', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8C90CCD3-627C-4F87-AD8C-2F03146071EB', + ], + 'PageNumber' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'domain' => [ + 'description' => '域名列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DomainRecord' => [ + 'description' => '域名记录', + 'type' => 'string', + 'example' => '6bd86901b9fe4618a046', + ], + 'SpfAuthStatus' => [ + 'description' => 'spf验证标志，成功：0，失败：1。', + 'type' => 'string', + 'example' => '0', + ], + 'MxAuthStatus' => [ + 'description' => 'mx验证标志，成功：0，失败：1。', + 'type' => 'string', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-09-29T13:28Z', + ], + 'CnameAuthStatus' => [ + 'description' => 'track验证', + 'type' => 'string', + 'example' => '0', + ], + 'ConfirmStatus' => [ + 'description' => 'CName验证标志，成功：0； 失败：1', + 'type' => 'string', + 'example' => '0', + ], + 'IcpStatus' => [ + 'description' => '备案状态。'."\n" + ."\n" + .'- 1表示备案'."\n" + .'- 0表示未备案', + 'type' => 'string', + 'example' => '1', + ], + 'UtcCreateTime' => [ + 'description' => '创建时间，UTC格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1569734892', + ], + 'DomainStatus' => [ + 'description' => '域状态。'."\n" + ."\n" + .'- 0：可用，已验证通过'."\n" + .'- 1：不可用，验证未通过', + 'type' => 'string', + 'example' => '0', + ], + 'DomainName' => [ + 'description' => '域名', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DomainId' => [ + 'description' => '域名ID', + 'type' => 'string', + 'example' => '158923', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询域名列表信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryDomainByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"8C90CCD3-627C-4F87-AD8C-2F03146071EB\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"data\\": {\\n \\"domain\\": [\\n {\\n \\"DomainRecord\\": \\"6bd86901b9fe4618a046\\",\\n \\"SpfAuthStatus\\": \\"0\\",\\n \\"MxAuthStatus\\": \\"0\\",\\n \\"CreateTime\\": \\"2019-09-29T13:28Z\\",\\n \\"CnameAuthStatus\\": \\"0\\",\\n \\"ConfirmStatus\\": \\"0\\",\\n \\"IcpStatus\\": \\"1\\",\\n \\"UtcCreateTime\\": 1569734892,\\n \\"DomainStatus\\": \\"0\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DomainId\\": \\"158923\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'QueryInvalidAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，时间不能早于30日，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，和起始时间跨度不能超出30天,格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '关键词。不填，代表所有无效地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'info', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每次请求数目', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '100', + 'default' => '10', + ], + ], + [ + 'name' => 'NextStart', + 'in' => 'query', + 'schema' => [ + 'description' => '请求开始位置', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextStart' => [ + 'description' => '下次请求开始位置', + 'type' => 'string', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '95A7D497-F8DD-4834-B81E-C1783236E55F', + ], + 'TotalCount' => [ + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'mailDetail' => [ + 'description' => '记录', + 'type' => 'array', + 'items' => [ + 'description' => '详细记录', + 'type' => 'object', + 'properties' => [ + 'LastUpdateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2021-04-28T17:11Z', + ], + 'ToAddress' => [ + 'description' => '收信地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'UtcLastUpdateTime' => [ + 'description' => '更新时间（时间戳格式）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1619601108', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取无效地址信息', + 'summary' => '获取无效地址信息。', + 'description' => '获取去重的无效地址信息，如果给同一个无效地址发送邮件多次，也会记录第一次，需要根据第一次被判断为无效地址分类的时间来查询', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryInvalidAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextStart\\": \\"2\\",\\n \\"RequestId\\": \\"95A7D497-F8DD-4834-B81E-C1783236E55F\\",\\n \\"TotalCount\\": 3,\\n \\"data\\": {\\n \\"mailDetail\\": [\\n {\\n \\"LastUpdateTime\\": \\"2021-04-28T17:11Z\\",\\n \\"ToAddress\\": \\"[email protected]\\",\\n \\"UtcLastUpdateTime\\": 1619601108\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryMailAddressByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码，默认：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '10', + 'default' => '500', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '邮件地址，长度1-60，支持数字、字母、.、-、@。', + 'type' => 'string', + 'required' => false, + 'example' => '账号+@+域名', + ], + ], + [ + 'name' => 'Sendtype', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址类型。取值：'."\n" + ."\n" + .'- batch：批量邮件'."\n" + .'- trigger：触发邮件', + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '95A7D497-F8DD-4834-B81E-C1783236E55F', + ], + 'PageNumber' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'mailAddress' => [ + 'description' => '发信地址列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MailAddressId' => [ + 'description' => '发信地址ID', + 'type' => 'string', + 'example' => '12122', + ], + 'MonthCount' => [ + 'description' => '月额度限额', + 'type' => 'string', + 'example' => '300000', + ], + 'AccountStatus' => [ + 'description' => '账号状态，冻结：1，正常：0。', + 'type' => 'string', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-09-29T13:28Z', + ], + 'ReplyStatus' => [ + 'description' => '回信地址状态', + 'type' => 'string', + 'example' => '0', + ], + 'Sendtype' => [ + 'description' => '发信地址类型。取值：'."\n" + ."\n" + .'- batch：批量邮件'."\n" + .'- trigger：触发邮件', + 'type' => 'string', + 'example' => 'batch', + ], + 'MonthReqCount' => [ + 'description' => '月额度', + 'type' => 'string', + 'example' => '20000', + ], + 'ReplyAddress' => [ + 'description' => '回信地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'DailyReqCount' => [ + 'description' => '日额度', + 'type' => 'string', + 'example' => '100', + ], + 'DailyCount' => [ + 'description' => '日额度限额', + 'type' => 'string', + 'example' => '10000', + ], + 'DomainStatus' => [ + 'description' => '域名状态，0表示正常，1表示异常。', + 'type' => 'string', + 'example' => '0', + ], + 'AccountName' => [ + 'description' => '发信地址', + 'type' => 'string', + 'example' => '账户+@+域名', + ], + 'ConfigSetId' => [ + 'description' => '关联配置集ID', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ConfigSetName' => [ + 'description' => '关联配置集名称', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询发信地址列表', + 'summary' => '查询发信地址列表。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryMailAddressByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"95A7D497-F8DD-4834-B81E-C1783236E55F\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"data\\": {\\n \\"mailAddress\\": [\\n {\\n \\"MailAddressId\\": \\"12122\\",\\n \\"MonthCount\\": \\"300000\\",\\n \\"AccountStatus\\": \\"0\\",\\n \\"CreateTime\\": \\"2019-09-29T13:28Z\\",\\n \\"ReplyStatus\\": \\"0\\",\\n \\"Sendtype\\": \\"batch\\",\\n \\"MonthReqCount\\": \\"20000\\",\\n \\"ReplyAddress\\": \\"[email protected]\\",\\n \\"DailyReqCount\\": \\"100\\",\\n \\"DailyCount\\": \\"10000\\",\\n \\"DomainStatus\\": \\"0\\",\\n \\"AccountName\\": \\"账户+@+域名\\",\\n \\"ConfigSetId\\": \\"xxx\\",\\n \\"ConfigSetName\\": \\"xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryReceiverByParam' => [ + 'summary' => '查询收件人列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数目，默认：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '40', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '关键词，默认所有信息', + 'type' => 'string', + 'required' => false, + 'example' => 'mesh-notification', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '列表状态。取值：'."\n" + ."\n" + .'- 0：正在上传'."\n" + .'- 1：上传完成', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextStart' => [ + 'description' => '分页使用。如果还有更多结果，下次请求将该返回值设置到请求中的NextStart', + 'type' => 'string', + 'example' => '6aec200853#102#1638894326#[email protected]', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'receiver' => [ + 'description' => '收件人列表详细信息', + 'type' => 'array', + 'items' => [ + 'description' => '详细记录', + 'type' => 'object', + 'properties' => [ + 'ReceiversAlias' => [ + 'description' => '收件人列表别名', + 'type' => 'string', + 'example' => '10***@example.com', + ], + 'ReceiversName' => [ + 'description' => '收件人列表名称', + 'type' => 'string', + 'example' => 'TKP000442-333', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-09-29T13:28Z', + ], + 'ReceiverId' => [ + 'description' => '收件人列表ID', + 'type' => 'string', + 'example' => '0c910a7143044b1e116719eb678907b3', + ], + 'UtcCreateTime' => [ + 'description' => 'UTC格式的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1569734892', + ], + 'ReceiversStatus' => [ + 'description' => '列表状态。取值：'."\n" + ."\n" + .'- 0：正在上传'."\n" + .'- 1：上传完成', + 'type' => 'string', + 'example' => '0', + ], + 'Count' => [ + 'description' => '收件人地址总数', + 'type' => 'string', + 'example' => '3', + ], + 'Desc' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '通知', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextStart\\": \\"6aec200853#102#1638894326#[email protected]\\",\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"TotalCount\\": 15,\\n \\"data\\": {\\n \\"receiver\\": [\\n {\\n \\"ReceiversAlias\\": \\"10***@example.com\\",\\n \\"ReceiversName\\": \\"TKP000442-333\\",\\n \\"CreateTime\\": \\"2019-09-29T13:28Z\\",\\n \\"ReceiverId\\": \\"0c910a7143044b1e116719eb678907b3\\",\\n \\"UtcCreateTime\\": 1569734892,\\n \\"ReceiversStatus\\": \\"0\\",\\n \\"Count\\": \\"3\\",\\n \\"Desc\\": \\"通知\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询收件人列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryReceiverByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'QueryReceiverDetail' => [ + 'summary' => '查询某个收件人列表详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'description' => '收件人列表ID（CreateReceiver接口创建收件人列表时会返回该值）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1235', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数目，默认：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '40', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '收件人地址，长度0-50', + 'type' => 'string', + 'required' => false, + 'example' => 'b***@example.net', + ], + ], + [ + 'name' => 'NextStart', + 'in' => 'query', + 'schema' => [ + 'description' => '下一条开始位置，默认：0', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataSchema' => [ + 'description' => 'Data收件人内容的字段名', + 'type' => 'string', + 'example' => 'UserName,NickName,Gender,Birthday,Mobile', + ], + 'NextStart' => [ + 'description' => '分页使用。如果还有更多结果，下次请求将该返回值设置到请求中的NextStart', + 'type' => 'string', + 'example' => '90f0243616#[email protected]', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'TotalCount' => [ + 'description' => '总数量（废弃字段，历史原因兼容）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '361', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'detail' => [ + 'description' => '详情信息', + 'type' => 'array', + 'items' => [ + 'description' => '详情信息', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '内容', + 'type' => 'string', + 'example' => '{\'Domains\': [\'a.example.net\', \'b.example.net\', \'c.example.net\', \'d.example.net\']}', + ], + 'UtcCreateTime' => [ + 'description' => 'UTC格式的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1569734892', + ], + 'Email' => [ + 'description' => '收件人地址', + 'type' => 'string', + 'example' => 'a***@example.net', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-09-29T13:28Z', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询某个收件人列表详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryReceiverDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSchema\\": \\"UserName,NickName,Gender,Birthday,Mobile\\",\\n \\"NextStart\\": \\"90f0243616#[email protected]\\",\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"TotalCount\\": 361,\\n \\"data\\": {\\n \\"detail\\": [\\n {\\n \\"Data\\": \\"{\'Domains\': [\'a.example.net\', \'b.example.net\', \'c.example.net\', \'d.example.net\']}\\",\\n \\"UtcCreateTime\\": 1569734892,\\n \\"Email\\": \\"a***@example.net\\",\\n \\"CreateTime\\": \\"2019-09-29T13:28Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryTagByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '10', + 'default' => '500', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称，长度1-50，默认为所有标签。', + 'type' => 'string', + 'required' => false, + 'example' => '1aTag', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'PageNumber' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'tag' => [ + 'description' => '数据记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '标签名称', + 'type' => 'string', + 'example' => 'hellopal', + ], + 'TagId' => [ + 'description' => '标签ID', + 'type' => 'string', + 'example' => '52366', + ], + 'TagDescription' => [ + 'description' => '标签描述', + 'type' => 'string', + 'example' => 'test description', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取标签', + 'summary' => '获取标签。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryTagByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"PageNumber\\": 5,\\n \\"TotalCount\\": 2,\\n \\"data\\": {\\n \\"tag\\": [\\n {\\n \\"TagName\\": \\"hellopal\\",\\n \\"TagId\\": \\"52366\\",\\n \\"TagDescription\\": \\"test description\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryTaskByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码，默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '关键词，默认所有信息', + 'type' => 'string', + 'required' => false, + 'example' => 'mesh-notification-788717', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态，默认所有状态', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'PageNumber' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'task' => [ + 'description' => '返回的结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiversName' => [ + 'description' => '收件人名称', + 'type' => 'string', + 'example' => 'TKP000442-333', + ], + 'TagName' => [ + 'description' => '标签', + 'type' => 'string', + 'example' => '202201', + ], + 'TaskStatus' => [ + 'description' => '任务状态，发送成功：1', + 'type' => 'string', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-04-18T10:36Z', + ], + 'RequestCount' => [ + 'description' => '请求数', + 'type' => 'string', + 'example' => '1', + ], + 'AddressType' => [ + 'description' => '地址类型，发信地址：1；随机地址：0；', + 'type' => 'string', + 'example' => '0', + ], + 'UtcCreateTime' => [ + 'description' => '创建时间的UTC格式', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1569734892', + ], + 'TemplateName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'Short Simple', + ], + 'TaskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '1054296', + ], + 'IpPoolId' => [ + 'description' => '独立IP地址池ID。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'IpPoolName' => [ + 'description' => '独立IP地址池名称。', + 'type' => 'string', + 'example' => '测试专属IP地址池1', + ], + 'ConfigSetId' => [ + 'description' => '配置集ID。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ConfigSetName' => [ + 'description' => '配置集名称。', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKeyword.Malformed', + 'errorMessage' => 'The specified keyword is wrongly formed.', + 'description' => '', + ], + [ + 'errorCode' => 'InvalidStatus.Malformed', + 'errorMessage' => 'The specified status is wrongly formed.', + 'description' => '', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询任务', + 'summary' => '查询任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryTaskByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"PageNumber\\": 3,\\n \\"TotalCount\\": 15,\\n \\"data\\": {\\n \\"task\\": [\\n {\\n \\"ReceiversName\\": \\"TKP000442-333\\",\\n \\"TagName\\": \\"202201\\",\\n \\"TaskStatus\\": \\"1\\",\\n \\"CreateTime\\": \\"2022-04-18T10:36Z\\",\\n \\"RequestCount\\": \\"1\\",\\n \\"AddressType\\": \\"0\\",\\n \\"UtcCreateTime\\": 1569734892,\\n \\"TemplateName\\": \\"Short Simple\\",\\n \\"TaskId\\": \\"1054296\\",\\n \\"IpPoolId\\": \\"xxx\\",\\n \\"IpPoolName\\": \\"测试专属IP地址池1\\",\\n \\"ConfigSetId\\": \\"xxx\\",\\n \\"ConfigSetName\\": \\"xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryTemplateByParam' => [ + 'summary' => '模板列表信息分页查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认是1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认是20', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '20', + 'default' => '40', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '指定模版名称关键字。默认分页查询所有模版列表', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4', + 'minimum' => '0', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + ], + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'example' => 'Abandoned, historical reasons for compatibility', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10Axxxxxxxxxxxx37', + ], + 'PageNumber' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'template' => [ + 'description' => '模板信息列表数组', + 'type' => 'array', + 'items' => [ + 'description' => '模板信息', + 'type' => 'object', + 'properties' => [ + 'TemplateComment' => [ + 'description' => '模板审核意见', + 'type' => 'string', + 'example' => 'pass', + ], + 'UtcCreatetime' => [ + 'description' => '创建时间，utc格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1661830382', + ], + 'Smsrejectinfo' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'SmsTemplateCode' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-09-29T13:28Z', + ], + 'TemplateStatus' => [ + 'description' => '模板状态，取值和说明如下：'."\n" + .'- 0是草稿'."\n" + .'- 1是待审核'."\n" + .'- 2是已通过审核'."\n" + .'- 3是未通过审核', + 'type' => 'string', + 'example' => '2', + ], + 'TemplateType' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'TemplateName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'test', + ], + 'SmsStatus' => [ + 'description' => '废弃，历史原因兼容', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Abandoned, historical reasons for compatibility', + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => '3xxxx8', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'title' => '分页查询模板列表信息', + 'description' => '分页查询模板列表信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryTemplateByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"10Axxxxxxxxxxxx37\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 21,\\n \\"data\\": {\\n \\"template\\": [\\n {\\n \\"TemplateComment\\": \\"pass\\",\\n \\"UtcCreatetime\\": 1661830382,\\n \\"Smsrejectinfo\\": 0,\\n \\"SmsTemplateCode\\": 0,\\n \\"CreateTime\\": \\"2019-09-29T13:28Z\\",\\n \\"TemplateStatus\\": \\"2\\",\\n \\"TemplateType\\": 0,\\n \\"TemplateName\\": \\"test\\",\\n \\"SmsStatus\\": 0,\\n \\"TemplateId\\": \\"3xxxx8\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'RemoveUserSuppression' => [ + 'summary' => '删除个人级别无效地址库（“系统判别”和“个人录入”）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SuppressionIds', + 'in' => 'query', + 'schema' => [ + 'description' => '无效地址编号'."\n" + ."\n" + .'支持多个值，用逗号","隔开'."\n" + ."\n" + .'可以通过ListUserSuppression获取SuppressionId', + 'type' => 'string', + 'required' => false, + 'example' => '59511', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1A846D66-5EC7-551B-9687-5BF1963DCFC1', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '移除个人和系统无效地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:RemoveUserSuppression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A846D66-5EC7-551B-9687-5BF1963DCFC1\\"\\n}","type":"json"}]', + ], + 'SaveReceiverDetail' => [ + 'summary' => '创建单个收件人。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'description' => '收件人列表ID', + 'type' => 'string', + 'required' => true, + 'example' => '34642', + ], + ], + [ + 'name' => 'Detail', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '内容，支持一次上传多个收件人，每次限制500 条记录，每个用{}和逗号隔开，示例：'."\n" + ."\n" + .'[{ },{ },{ }...]，{}中的内容格式。如下：'."\n" + ."\n" + .'[{"b":"birthday","e":"[email protected]","g":"gender","m":"mobile","n":"nickname","u":"name"}]，传值时传字符串，非列表。'."\n" + ."\n" + .'若插入重复收件人地址，会返回"ErrorCount": 1', + 'type' => 'string', + 'required' => false, + 'example' => '[{"b":"birthday","e":"[email protected]","g":"gender","m":"mobile","n":"nickname","u":"name"}]', + ], + ], + [ + 'name' => 'CustomDetail', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '收件人邮箱及模版参数，数组格式', + 'description' => '收件人邮箱及模版参数，数组格式', + 'type' => 'string', + 'required' => false, + 'example' => '[{ "Email": "[email protected]","CustomData": {"name":"Tom","age":"30"}}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorCount' => [ + 'description' => '错误次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '638', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'SuccessCount' => [ + 'description' => '成功数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '274', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Detail' => [ + 'description' => '上传失败的收件人地址列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Email' => [ + 'description' => '收件人地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ErrMessage' => [ + 'title' => '错误信息'."\n", + 'description' => '错误信息'."\n", + 'type' => 'string', + 'example' => 'XXX', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '创建单个收件人', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:SaveReceiverDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorCount\\": 638,\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"SuccessCount\\": 274,\\n \\"Data\\": {\\n \\"Detail\\": [\\n {\\n \\"Email\\": \\"[email protected]\\",\\n \\"ErrMessage\\": \\"XXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'SendTestByTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址，长度限制60', + 'type' => 'string', + 'required' => true, + 'example' => '账号+@+域名', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'UserName，长度限制30', + 'type' => 'string', + 'required' => false, + 'example' => '姓名', + ], + ], + [ + 'name' => 'NickName', + 'in' => 'query', + 'schema' => [ + 'description' => 'NickName，长度限制30', + 'type' => 'string', + 'required' => false, + 'example' => '昵称', + ], + ], + [ + 'name' => 'Birthday', + 'in' => 'query', + 'schema' => [ + 'description' => 'Birthday，长度限制30', + 'type' => 'string', + 'required' => false, + 'example' => '2000/01/01', + ], + ], + [ + 'name' => 'Gender', + 'in' => 'query', + 'schema' => [ + 'description' => 'Gender，长度限制30', + 'type' => 'string', + 'required' => false, + 'example' => '先生', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'Mobile，长度限制30', + 'type' => 'string', + 'required' => false, + 'example' => '1380000****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '收信地址，长度限制60', + 'type' => 'string', + 'required' => true, + 'example' => '账号+@+域名', + ], + ], + [ + 'name' => 'TemplateParams', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + 'example' => '{"age":"20","nickName":"tom"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详细信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + ], + ], + ], + 'title' => '发送测试邮件', + 'summary' => '发送测试邮件。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:SendTestByTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","errorExample":""},{"type":"xml","example":"<SendTestByTemplateResponse>\\r\\n\\t<RequestId>10A1AD70-E48E-476D-98D9-39BD92193837</RequestId>\\r\\n</SendTestByTemplateResponse>","errorExample":""}]', + ], + 'SendValidateFile' => [ + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FileUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '地址列表的url', + 'description' => '地址列表的url', + 'type' => 'string', + 'required' => true, + 'example' => 'http://xxxx.oss-xxx.com/file.txt', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'title' => '地址列表的文件名', + 'description' => '地址列表的文件名', + 'type' => 'string', + 'required' => true, + 'example' => 'file.txt', + ], + ], + [ + 'name' => 'AddressColumn', + 'in' => 'query', + 'schema' => [ + 'title' => '文件里电子邮件地址所在的列，从1开始索引', + 'description' => '文件里电子邮件地址所在的列，从1开始索引', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'HasHeaderRow', + 'in' => 'query', + 'schema' => [ + 'title' => '第一行是否是表头', + 'description' => '第一行是否是表头', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'RemoveDuplicate', + 'in' => 'query', + 'schema' => [ + 'title' => '输出文件结果里是否需要对电子邮件进行去重', + 'description' => '输出文件结果里是否需要对电子邮件进行去重', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + 'FileId' => [ + 'title' => '文件ID，作为后续查询结果的标识', + 'description' => '文件ID，作为后续查询结果的标识', + 'type' => 'string', + 'example' => 'yyyy-yyyy-yyyy-yyyy', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '上传检验文件', + 'summary' => '上传所需校验的地址列表。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:SendValidateFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx-xxxx\\",\\n \\"FileId\\": \\"yyyy-yyyy-yyyy-yyyy\\"\\n}","type":"json"}]', + ], + 'SenderStatisticsByTagNameAndBatchID' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址。不填，代表所有地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间，时间不能早于30日，格式yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，和起始时间跨度不能超出7天，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-09-29', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '邮件标签。不填，代表所有标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'DedicatedIpPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的独立IP池ID的数据'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'DedicatedIp', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的独立IP的数据。'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.xxx.xxx.xxx'."\n", + ], + ], + [ + 'name' => 'Esp', + 'in' => 'query', + 'schema' => [ + 'description' => '对于独立IP用户，查询特定的ESP数据的数据，可以填写的值如下'."\n" + .'- gmail.com'."\n" + .'- yahoo.com'."\n" + .'- outlook.com'."\n" + .'- icloud.com'."\n" + .'- others（对应其他的非上述ESP的数据）'."\n" + ."\n" + .'不填写此参数时默认查询所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmail.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'stat' => [ + 'description' => '数据记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'unavailablePercent' => [ + 'description' => '无效率', + 'type' => 'string', + 'example' => '0%', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-02', + ], + 'succeededPercent' => [ + 'description' => '成功率', + 'type' => 'string', + 'example' => '100.00%', + ], + 'faildCount' => [ + 'description' => '失败数量', + 'type' => 'string', + 'example' => '0', + ], + 'unavailableCount' => [ + 'description' => '无效数量', + 'type' => 'string', + 'example' => '0', + ], + 'successCount' => [ + 'description' => '成功数量', + 'type' => 'string', + 'example' => '4', + ], + 'requestCount' => [ + 'description' => '请求数量', + 'type' => 'string', + 'example' => '4', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取指定条件下的发送数据', + 'summary' => '获取指定条件下的发送数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:SenderStatisticsByTagNameAndBatchID', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"data\\": {\\n \\"stat\\": [\\n {\\n \\"unavailablePercent\\": \\"0%\\",\\n \\"CreateTime\\": \\"2025-03-02\\",\\n \\"succeededPercent\\": \\"100.00%\\",\\n \\"faildCount\\": \\"0\\",\\n \\"unavailableCount\\": \\"0\\",\\n \\"successCount\\": \\"4\\",\\n \\"requestCount\\": \\"4\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'SenderStatisticsDetailByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址。不填，代表所有地址。'."\n" + ."\n" + .'> **AccountName**、**TagName**、**ToAddress**可以都不填写。若填写，只能传递其中一个参数，不能同时传递两个或以上组合的参数。', + 'type' => 'string', + 'required' => false, + 'example' => 's***@example.net', + ], + ], + [ + 'name' => 'ToAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '收信地址。不填，代表所有收信地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'b***@example.net', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '投递结果。不填，代表所有状态。取值：'."\n" + ."\n" + .'- 0：成功'."\n" + .'- 2：无效地址'."\n" + .'- 3：垃圾邮件'."\n" + .'- 4：失败', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间，和结束时间跨度不能超出30天，格式yyyy-MM-dd HH:mm', + 'type' => 'string', + 'required' => false, + 'example' => '2021-04-28 00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，和起始时间跨度不能超出30天, 格式yyyy-MM-dd HH:mm。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-04-29 00:00', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '邮件标签。不填，代表所有标签。'."\n" + .'SMTP发信时，请参考邮件跟踪示例，对“X-AliDM-Trace”字段，指定标签字段"TagName"和对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'EmailQuestionnaireHelioscam', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '指定本次请求返回结果数目。范围是1~100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '5', + 'default' => '10', + ], + ], + [ + 'name' => 'NextStart', + 'in' => 'query', + 'schema' => [ + 'description' => '分页用，指定本次请求的偏移量。如果还有更多结果，下次请求将该返回值设置到请求中的NextStart', + 'type' => 'string', + 'required' => false, + 'example' => '90f0243616#203#a***@example.net-1658817837#a***@example.net.247475288187', + ], + ], + [ + 'name' => 'IpPoolId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '独立IP地址池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e42a4d8e-66e0-4ea3-88aa-74c66c661cef', + ], + ], + [ + 'name' => 'ConfigSetId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '配置集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '95437e39-5433-4c6c-8b66-0c4eac2f4d97', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextStart' => [ + 'description' => '分页使用。如果还有更多结果，下次请求将该返回值设置到请求中的NextStart', + 'type' => 'string', + 'example' => '90f0243616#203#a***@example.net-1658817689#a***@example.net.247141122178', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B5AB8EBB-EE64-4BB2-B085-B92CC5DEDC41', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'mailDetail' => [ + 'description' => '详细记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '投递状态：0 成功，2 无效地址，3 垃圾邮件，4 其余失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'LastUpdateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2021-04-28T17:11Z', + ], + 'Message' => [ + 'description' => '投递详情信息', + 'type' => 'string', + 'example' => '250 Send Mail OK', + ], + 'ToAddress' => [ + 'description' => '收信地址', + 'type' => 'string', + 'example' => 'b***@example.net', + ], + 'UtcLastUpdateTime' => [ + 'description' => 'UTC格式的更新时间', + 'type' => 'string', + 'example' => '1619601108', + ], + 'AccountName' => [ + 'description' => '发信地址', + 'type' => 'string', + 'example' => 's***@example.net', + ], + 'Subject' => [ + 'description' => '邮件主题', + 'type' => 'string', + 'example' => 'test subject', + ], + 'ErrorClassification' => [ + 'description' => '错误原因的详细分类：'."\n" + .'- SendOk：投递成功'."\n" + ."\n" + .'- SmtpNxBox：收信系统认定为无效地址，会进入您的账号级别无效地址库。'."\n" + ."\n" + .'- SysOutRcptOnAccountLevelBounceList：命中账号级别无效地址库，如您确认该地址有效，可在无效地址库页面进行删除，或选择不启用账号级别无效地址库。'."\n" + ."\n" + .'更多错误描述请参考[关于常见failed_type的解释](~~52048~~)', + 'type' => 'string', + 'example' => 'SendOk', + ], + 'IpPoolId' => [ + 'description' => '独立IP地址池ID。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'IpPoolName' => [ + 'description' => '独立IP地址池名称。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ConfigSetId' => [ + 'description' => '配置集ID。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ConfigSetName' => [ + 'description' => '配置集名称。', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '获取发送详情', + 'summary' => '获取发送详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:SenderStatisticsDetailByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextStart\\": \\"90f0243616#203#a***@example.net-1658817689#a***@example.net.247141122178\\",\\n \\"RequestId\\": \\"B5AB8EBB-EE64-4BB2-B085-B92CC5DEDC41\\",\\n \\"data\\": {\\n \\"mailDetail\\": [\\n {\\n \\"Status\\": 0,\\n \\"LastUpdateTime\\": \\"2021-04-28T17:11Z\\",\\n \\"Message\\": \\"250 Send Mail OK\\",\\n \\"ToAddress\\": \\"b***@example.net\\",\\n \\"UtcLastUpdateTime\\": \\"1619601108\\",\\n \\"AccountName\\": \\"s***@example.net\\",\\n \\"Subject\\": \\"test subject\\",\\n \\"ErrorClassification\\": \\"SendOk\\",\\n \\"IpPoolId\\": \\"xxx\\",\\n \\"IpPoolName\\": \\"xxx\\",\\n \\"ConfigSetId\\": \\"xxx\\",\\n \\"ConfigSetName\\": \\"xxx\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B5AB8EBB-EE64-4BB2-B085-B92CC5DEDC41</RequestId>\\n<data>\\n <mailDetail>\\n <Status>0</Status>\\n <UtcLastUpdateTime>1619591119</UtcLastUpdateTime>\\n <Message>250 Send Mail OK</Message>\\n <LastUpdateTime>2021-04-28T14:25Z</LastUpdateTime>\\n <ToAddress>[email protected]</ToAddress>\\n <AccountName>[email protected]</AccountName>\\n </mailDetail>\\n <mailDetail>\\n <Status>0</Status>\\n <UtcLastUpdateTime>1619591006</UtcLastUpdateTime>\\n <Message>250 Send Mail OK</Message>\\n <LastUpdateTime>2021-04-28T14:23Z</LastUpdateTime>\\n <ToAddress>[email protected]</ToAddress>\\n <AccountName>[email protected]</AccountName>\\n </mailDetail>\\n</data>\\n<NextStart>90f0243616#203#[email protected]#[email protected]</NextStart>","errorExample":""}]', + ], + 'SingleSendMail' => [ + 'summary' => '发送单条邮件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '管理控制台中配置的发信地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test***@example.net', + ], + ], + [ + 'name' => 'AddressType', + 'in' => 'formData', + 'schema' => [ + 'description' => '地址类型。取值：'."\n" + ."\n" + .'0：为随机账号'."\n" + ."\n" + .'1：为发信地址', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'formData', + 'schema' => [ + 'description' => '在邮件推送控制台创建的标签，用于分类所发送的邮件批次，可以通过标签来查询每批邮件的发送情况，另外如果开启邮件跟踪功能，发信必须使用邮件标签。'."\n" + .'长度为1-128个字符，允许英文字母、数字、_、-', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ReplyToAddress', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用管理控制台中配置好回信地址（状态须验证通过），取值范围是字符串true或者false。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ToAddress', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标地址，多个 email 地址可以用逗号分隔，最多100个地址（支持邮件组）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test1***@example.net', + ], + ], + [ + 'name' => 'Subject', + 'in' => 'formData', + 'schema' => [ + 'description' => '邮件主题，长度不大于256个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subject', + ], + ], + [ + 'name' => 'HtmlBody', + 'in' => 'formData', + 'schema' => [ + 'description' => '邮件 html 正文。'."\n" + ."\n" + .'注意：HtmlBody和TextBody是针对不同类型的邮件内容，两者必须传其一。'."\n" + ."\n" + .'- URL传参限制约80KB'."\n" + .'- 新版SDK采用Body传参限制约8MB（'."\n" + .'java 1.4.0及以上，'."\n" + .'python3 1.4.0及以上，'."\n" + .'php 1.4.0及以上'."\n" + .'）', + 'type' => 'string', + 'required' => false, + 'example' => 'body', + ], + ], + [ + 'name' => 'TextBody', + 'in' => 'formData', + 'schema' => [ + 'description' => '邮件 text 正文。'."\n" + ."\n" + .'注意：HtmlBody和TextBody是针对不同类型的邮件内容，两者必须传其一。'."\n" + ."\n" + .'- URL传参限制约80KB'."\n" + .'- 新版SDK采用Body传参限制约8MB（'."\n" + .'java 1.4.0及以上，'."\n" + .'python3 1.4.0及以上，'."\n" + .'php 1.4.0及以上'."\n" + .'）', + 'type' => 'string', + 'required' => false, + 'example' => 'body', + ], + ], + [ + 'name' => 'FromAlias', + 'in' => 'formData', + 'schema' => [ + 'description' => '发信人昵称，长度小于15个字符。'."\n" + ."\n" + .'例如：发信人昵称设置为”小红”，发信地址为 test***@example.net，收信人看到的发信地址为“小红”test***@example.net。', + 'type' => 'string', + 'required' => false, + 'example' => '小红', + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'formData', + 'schema' => [ + 'description' => '回信地址', + 'type' => 'string', + 'required' => false, + 'example' => 'test2***@example.net', + ], + ], + [ + 'name' => 'ReplyAddressAlias', + 'in' => 'formData', + 'schema' => [ + 'description' => '回信地址昵称', + 'type' => 'string', + 'required' => false, + 'example' => '小红', + ], + ], + [ + 'name' => 'ClickTrace', + 'in' => 'formData', + 'schema' => [ + 'description' => '1：为打开数据跟踪功能'."\n" + ."\n" + .'0（默认）：为关闭数据跟踪功能。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UnSubscribeLinkType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'disabled: 不生成'."\n" + ."\n" + .'default: 采用默认策略：对批量类型的发信地址发给特定域名时会生成退订链接，如带有关键字"gmail", "yahoo",'."\n" + ."\n" + .'"google", "aol.com", "hotmail",'."\n" + ."\n" + .'"outlook", "ymail.com"等，具体参照[退订功能生成链接和过滤机制](~~2689048~~)文档'."\n" + ."\n" + .'显示语言根据收件人的浏览器设置自动识别', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'UnSubscribeFilterLevel', + 'in' => 'formData', + 'schema' => [ + 'description' => '过滤级别。参照[退订功能生成链接和过滤机制](~~2689048~~)文档'."\n" + ."\n" + .'disabled: 不过滤'."\n" + ."\n" + .'default: 采用默认策略，批量地址采用发信地址级别过滤'."\n" + ."\n" + .'mailfrom: 发信地址级别过滤'."\n" + ."\n" + .'mailfrom_domain: 发信域名级别过滤'."\n" + ."\n" + .'edm_id: 账号级别过滤', + 'type' => 'string', + 'required' => false, + 'example' => 'mailfrom_domain', + ], + ], + [ + 'name' => 'Headers', + 'in' => 'formData', + 'schema' => [ + 'description' => '邮件头设置'."\n" + ."\n" + .'标准字段和非标准字段都需要符合标准中对头的语法要求，API 发信最多可通过 headers 字段传入 10 个标头，超出限制会被忽略，SMTP 没有限制。'."\n" + ."\n" + .'1、标准字段'."\n" + ."\n" + .'Message-ID，List-Unsubscribe，List-Unsubscribe-Post'."\n" + ."\n" + .'标准字段会覆盖掉邮件头中原有的值。'."\n" + ."\n" + .'2、非标准字段'."\n" + ."\n" + .'不区分大小写'."\n" + ."\n" + .'a、以 X-User- 开头（不推送到事件总线EB、消息服务MNS。仅API要求，SMTP任意自定义）'."\n" + ."\n" + .'b、以 X-User-Notify- 开头（推送到事件总线EB、消息服务MNS。API和SMTP都支持）'."\n" + ."\n\n" + .'推动到EB或MNS时，header字段下会包含这些字段', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Message-ID": "<[email protected]>",'."\n" + .' "X-User-UID1": "UID-1-000001",'."\n" + .' "X-User-UID2": "UID-2-000001",'."\n" + .' "X-User-Notify-UID1": "UID-3-000001",'."\n" + .' "X-User-Notify-UID2": "UID-4-000001"'."\n" + .' '."\n" + .'}', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'IpPoolId', + 'in' => 'formData', + 'schema' => [ + 'description' => '独立IP地址池ID。购买了独立IP的用户可以通过这个参数指定本次发信出口IP。 参照[独立IP](~~2932088~~)文档。', + 'type' => 'string', + 'required' => false, + 'example' => 'e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef', + ], + ], + [ + 'name' => 'Attachments', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '仅支持下载新版SDK使用，openapi和签名机制方式暂不支持。 参照[如何通过SDK方式发送带附件的邮件？](~~2937843~~)文档。', + 'type' => 'array', + 'items' => [ + 'description' => '仅支持下载新版SDK使用，openapi和签名机制方式暂不支持。', + 'type' => 'object', + 'properties' => [ + 'AttachmentName' => [ + 'description' => '仅支持下载新版SDK使用，openapi和签名机制方式暂不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.txt', + 'isFileTransferUrl' => false, + ], + 'AttachmentUrl' => [ + 'description' => '仅支持下载新版SDK使用，openapi和签名机制方式暂不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'C:\\Users\\Downloads\\test.txt', + 'isFileTransferUrl' => true, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Template', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '模版发送，模版信息'."\n", + 'description' => '模版发送，模版信息'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模版ID'."\n", + 'description' => '模版ID'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'TemplateData' => [ + 'title' => '模版变量与值', + 'description' => '模版变量与值', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'title' => '参数变量', + 'description' => '模版变量参数与值', + 'type' => 'string', + 'example' => '{ "name": "Tom", "age": "22" }', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'BccAddress', + 'in' => 'formData', + 'schema' => [ + 'title' => '密送邮件地址', + 'description' => '- 指定邮件的密送收件人列表。'."\n" + .'- 系统会将与主邮件内容一致的副本分别发送至每个密送地址，但密送信息对所有收件人（含ToAddress、BccAddress）均不可见。'."\n" + .'- 为了保护密送收件人的隐私，发送给密送收件人的邮件将默认不开启任何邮件追踪功能。 这意味着，对于密送邮件，系统不会记录打开率、点击率等行为数据。但发送量的计费、和发送详情、和发送状态的统计与正常邮件一致。'."\n" + .'- 每次发送最多可指定2个密送收件人。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected],[email protected]', + ], + ], + [ + 'name' => 'DomainAuth', + 'in' => 'formData', + 'schema' => [ + 'title' => '启用域级别认证', + 'description' => '启用域级别认证'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'仅在域级别认证时使用，发信地址级别认证请忽略。'."\n" + ."\n" + .'1、[email protected] 控制台创建这个地址，@前缀保持固定不变，后缀用自己域名。'."\n" + ."\n" + .'2、'."\n" + ."\n" + .'**API场景**'."\n" + ."\n" + .'AccountName填域名，收件人看到的发件人是[email protected]。'."\n" + ."\n" + .'**SMTP场景**'."\n" + ."\n" + .'a.通过 ModifyPWByDomain 接口设置域名密码。'."\n" + ."\n" + .'b.使用域名和设置的密码认证，真实发件人mailfrom传自定义的地址，如[email protected]，收件人看到的发件人是[email protected]。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnvId' => [ + 'description' => '事件ID', + 'type' => 'string', + 'example' => '600000xxxxxxxxxx642', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '2D086F6-xxxx-xxxx-xxxx-006DED011A85', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The format of the receiver name is invalid. It must contain the @ sign. The domain must only contain numbers, letters, underscores, minus signs, and periods. The account name must only contain numbers, letters, underscores, minus signs, and periods.', + 'description' => '收件人格式不正确，必须有@符号，域名组成为数字，字母，下划线，减号和点，账号组成为数字，字母，下划线，减号和点', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mail address is not found.', + 'description' => '发信地址未找到', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EnvId\\": \\"600000xxxxxxxxxx642\\",\\n \\"RequestId\\": \\"2D086F6-xxxx-xxxx-xxxx-006DED011A85\\"\\n}","type":"json"}]', + 'title' => '发送单条邮件', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:SingleSendMail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'UnblockSending' => [ + 'summary' => '解除退订、举报等发信限制。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SenderEmail', + 'in' => 'query', + 'schema' => [ + 'description' => '发信地址', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'BlockEmail', + 'in' => 'query', + 'schema' => [ + 'description' => '被列黑的收件地址', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'BlockType', + 'in' => 'query', + 'schema' => [ + 'description' => '列黑类型'."\n" + .'- UNSUB：退订'."\n" + .'- REPORT：举报', + 'type' => 'string', + 'required' => true, + 'example' => 'UNSUB', + 'enum' => [ + 'UNSUB', + 'REPORT', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值的schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '解除发信限制', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:UnblockSending', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\"\\n}","type":"json"}]', + ], + 'UpdateIpProtection' => [ + 'summary' => '开启或者关闭IP保护功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IpProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP防护开关，打开：1 关闭：0', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B653A6FC-D1AD-5936-A262-F50994ED2574', + ], + ], + 'description' => '', + ], + ], + ], + 'title' => '开启或者关闭IP保护功能', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:UpdateIpProtection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B653A6FC-D1AD-5936-A262-F50994ED2574\\"\\n}","type":"json"}]', + ], + 'UpdateUser' => [ + 'summary' => '更新用户相关的信息，包括设置等信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'User', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '用户信息', + 'type' => 'object', + 'properties' => [ + 'EnableEventbridge' => [ + 'description' => '是否启用了EventBridge', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '7BC346F6-1092-5852-B6E2-CCE2E5AAE51F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '更新用户信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:UpdateUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC346F6-1092-5852-B6E2-CCE2E5AAE51F\\"\\n}","type":"json"}]', + ], + 'ValidateEmail' => [ + 'summary' => '校验电子邮件地址。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'title' => '待校验的电子邮件地址', + 'description' => '待校验的电子邮件地址', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'description' => '超时时间，默认60秒', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + 'default' => '60', + ], + ], + [ + 'name' => 'CheckGraylist', + 'in' => 'query', + 'schema' => [ + 'title' => '是否检查灰名单，默认为否。结果将通过eventbridge异步通知', + 'description' => '是否检查灰名单，默认为否。结果将通过eventbridge异步通知', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'xxxx-xxxx-xxxx-xxxx', + ], + 'Status' => [ + 'title' => '校验得到的电子邮件地址状态', + 'description' => '校验得到的电子邮件地址状态', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'VALID' => '有效地址', + 'CATCHALL' => 'CatchAll地址，表明该域接收发往该域名下所有不存在邮箱地址的邮件', + 'UNKNOWN' => '未知状态地址', + 'INVALID' => '无效地址', + 'DONOTMAIL' => '非正常地址，营销场景可以剔除', + ], + 'example' => 'VALID', + ], + 'SubStatus' => [ + 'title' => '校验得到的电子邮件地址子状态，是对状态的详细描述', + 'description' => '校验得到的电子邮件地址子状态，是对状态的详细描述', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NO_DNS_ENTRIES' => '无效地址，没有DNS记录', + 'MISSPELLED' => '无效地址，拼写错误', + 'MAILBOX_NOT_EXISTS' => '无效地址，邮箱不存在', + 'SYSTEM_ERROR' => '未知状态，系统错误', + 'SYNTAX_INVALID' => '无效地址，语法错误', + 'ROLE_ACCOUNT' => '非正常地址，角色账号', + 'SMTP_CONNECT_FAILED' => '未知状态，连接对方SMTP服务器失败', + 'DISABLED' => '无效地址，邮箱已被禁用', + 'UNSPECIFIED' => '没有说明，有效、CatchAll、未知状态可能返回', + 'IP_UNROUTABLE' => '无效地址，邮件服务器IP不可达', + 'MAILBOX_FULL' => '无效地址，邮箱已满', + 'DISPOSABLE' => '非正常地址，临时邮箱', + 'TIMEOUT_EXCEEDED' => '未知状态，超过指定的超时时间', + ], + 'example' => 'UNSPECIFIED', + ], + 'Provider' => [ + 'title' => '地址的电子邮件提供商分类', + 'description' => '地址的电子邮件提供商分类', + 'type' => 'string', + 'enumValueTitles' => [ + 'Others' => '其他', + 'Yahoo' => 'Yahoo', + 'Gmx' => 'Gmx', + 'MailDotCom' => 'MailDotCom', + 'Tencent' => 'Tencent', + 'Gmail' => 'Gmail', + 'Outlook' => 'Outlook', + 'Zoho' => 'Zoho', + 'Proton' => 'Proton', + 'Netease' => 'Netease', + 'Icloud' => 'Icloud', + 'Webde' => 'Webde', + ], + 'example' => 'Gmail', + ], + 'IsFreeMail' => [ + 'title' => '地址是否为免费邮箱', + 'description' => '地址是否为免费邮箱', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'LocalPart' => [ + 'title' => '语法校验解析得到的电子邮件地址的本地部分', + 'description' => '语法校验解析得到的电子邮件地址的本地部分（经过小写化与去掉+号部分）', + 'type' => 'string', + 'example' => 'xxx', + ], + 'DomainPart' => [ + 'title' => '语法校验解析得到的电子邮件地址的域名部分', + 'description' => '语法校验解析得到的电子邮件地址的域名部分（经过小写化）', + 'type' => 'string', + 'example' => 'yyy.com', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '校验电子邮件', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:ValidateEmail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx-xxxx\\",\\n \\"Status\\": \\"VALID\\",\\n \\"SubStatus\\": \\"UNSPECIFIED\\",\\n \\"Provider\\": \\"Gmail\\",\\n \\"IsFreeMail\\": true,\\n \\"LocalPart\\": \\"xxx\\",\\n \\"DomainPart\\": \\"yyy.com\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => '新加坡', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'dm.ap-southeast-1.aliyuncs.com', + 'endpoint' => 'dm.ap-southeast-1.aliyuncs.com', + 'vpc' => 'dm-vpc.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'regionName' => '华东1（杭州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'dm.aliyuncs.com', + 'endpoint' => 'dm.aliyuncs.com', + 'vpc' => 'dm-vpc.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'regionName' => '美国（弗吉尼亚）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + 'public' => 'dm.us-east-1.aliyuncs.com', + 'endpoint' => 'dm.us-east-1.aliyuncs.com', + 'vpc' => 'dm-vpc.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'regionName' => '德国（法兰克福）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + 'public' => 'dm.eu-central-1.aliyuncs.com', + 'endpoint' => 'dm.eu-central-1.aliyuncs.com', + 'vpc' => 'dm-vpc.eu-central-1.aliyuncs.com', + ], + ], + 'errorCodes' => [ + [ + 'code' => 'Abs.InvalidNetworkType.NotFound', + 'message' => 'The specified InstanceNetworkType is not found.', + 'http_code' => 404, + 'description' => '没有找到指定的InstanceNetworkType', + ], + [ + 'code' => 'AvailableSubDomain.GetFailed', + 'message' => 'Failed to get the available subdomain name.', + 'http_code' => 400, + 'description' => '未能获得可用的域名。', + ], + [ + 'code' => 'AvailableSubDomain.Limit', + 'message' => 'The maximum number of available subdomain specifying prefixes is exceeded.', + 'http_code' => 400, + 'description' => '可用的子域指定前缀数量超过限制。', + ], + [ + 'code' => 'CheckDomain.Failed', + 'message' => 'Domain check failed.', + 'http_code' => 400, + 'description' => '域名检测失败', + ], + [ + 'code' => 'EmailFormatError', + 'message' => 'The Email format is invalid. It must only contain numbers, letters, underscores, minus sign, plus sign, and period.', + 'http_code' => 400, + 'description' => 'email地址格式非法，组成应为数字，字母，下划线，减号，加号和点。', + ], + [ + 'code' => 'EmailLengthError', + 'message' => 'The maximum length of Email is 192 characters.', + 'http_code' => 400, + 'description' => 'email地址过长，超过192个字符，请减少字符数目。', + ], + [ + 'code' => 'FastConfigFlow.Create.Failed', + 'message' => 'Failed to create the quick configuration flow.', + 'http_code' => 400, + 'description' => '指定的快速配置流创建失败了。', + ], + [ + 'code' => 'FastConfigFlow.Exist', + 'message' => 'The specified quick configuration flow already exists.', + 'http_code' => 400, + 'description' => '指定的快速配置流已经存在。', + ], + [ + 'code' => 'FastConfigFlow.NotFound', + 'message' => 'The specified quick configuration flow is not found.', + 'http_code' => 400, + 'description' => '没有找到指定的快速配置流。', + ], + [ + 'code' => 'Forbidden', + 'message' => 'The user is not authorized to operate on the specified resource.', + 'http_code' => 400, + 'description' => '用户未授权操作指定的资源。', + ], + [ + 'code' => 'InternalServiceError', + 'message' => 'Failed to call the internal service. Please try again later.', + 'http_code' => 500, + 'description' => '访问内部服务临时错误，请稍后重试。', + ], + [ + 'code' => 'InvalidAddress.Locked', + 'message' => 'The specified address is already locked.', + 'http_code' => 400, + 'description' => '指定的地址已被锁定。', + ], + [ + 'code' => 'InvalidAddress.NotFound', + 'message' => 'The invalid address is not in the invalid address database.', + 'http_code' => 400, + 'description' => '无效地址已不在无效地址库中。', + ], + [ + 'code' => 'InvalidAddressNumber.Malformed', + 'message' => 'The maximum number of invalid addresses is exceeded.', + 'http_code' => 400, + 'description' => '无效地址数已超过限制。', + ], + [ + 'code' => 'InvalidAuth.Malformed', + 'message' => 'The specified auth is invalid.', + 'http_code' => 400, + 'description' => '指定的身份验证无效。', + ], + [ + 'code' => 'InvalidBeginTime.Malformed', + 'message' => 'The interval between start time and current time should be less than 30 days.', + 'http_code' => 400, + 'description' => '开始时间与当前时间之间的间隔应小于30天。', + ], + [ + 'code' => 'InvalidBetweenTime.Malformed', + 'message' => 'The start time must be at least seven days earlier than the end time.', + 'http_code' => 400, + 'description' => '开始时间应该至少提前于结束时间7天。', + ], + [ + 'code' => 'InvalidBody', + 'message' => 'The format of the specified textBody or htmlBody is invalid.', + 'http_code' => 400, + 'description' => 'textBody或textBody格式错误,请重新填写内容。', + ], + [ + 'code' => 'InvalidDate.Malformed', + 'message' => 'The specified date is invalid.', + 'http_code' => 400, + 'description' => '指定的日期无效。', + ], + [ + 'code' => 'InvalidDate.NotFound', + 'message' => 'The specified date does not exist.', + 'http_code' => 404, + 'description' => '指定的日期不存在。', + ], + [ + 'code' => 'InvalidDayu.Malformed', + 'message' => 'The specified template type is invalid.', + 'http_code' => 400, + 'description' => '模板不对', + ], + [ + 'code' => 'InvalidDayuParamString.Malformed', + 'message' => 'The maximum length of paramString is exceeded.', + 'http_code' => 400, + 'description' => '指定参数过长', + ], + [ + 'code' => 'InvalidDayuStatus.Malformed', + 'message' => 'The Dayu status is invalid.', + 'http_code' => 400, + 'description' => 'Dayu状态无效。', + ], + [ + 'code' => 'InvalidDkimSelector.Malformed', + 'message' => 'The specified dkim selector is wrongly formed.', + 'http_code' => 400, + 'description' => 'dkim的selector格式不正确。', + ], + [ + 'code' => 'InvalidDomain.Malformed', + 'message' => 'The specified domain is invalid.', + 'http_code' => 400, + 'description' => '指定的域无效。', + ], + [ + 'code' => 'InvalidDomain.NotFound', + 'message' => 'The specified domain does not exist.', + 'http_code' => 404, + 'description' => '指定的域名不存在。', + ], + [ + 'code' => 'InvalidDomain.Using', + 'message' => 'The specified domain has been used to create another sender address.', + 'http_code' => 400, + 'description' => '指定的域名已被用于创建发信地址。', + ], + [ + 'code' => 'InvalidDomainId.Malformed', + 'message' => 'The specified domain ID does not exist.', + 'http_code' => 404, + 'description' => '指定的域名ID不存在。', + ], + [ + 'code' => 'InvalidDomainId.NotFound', + 'message' => 'The specified domainId is not found.', + 'http_code' => 404, + 'description' => '未找到指定域名ID。', + ], + [ + 'code' => 'InvalidDomainMail.Malformed', + 'message' => 'The specified domainId and mailId are invalid.', + 'http_code' => 400, + 'description' => '指定的domainId和mailId无效。', + ], + [ + 'code' => 'InvalidDomainName.Conflict', + 'message' => 'The specified domain name is in use.', + 'http_code' => 400, + 'description' => '指定的域名已被占用。', + ], + [ + 'code' => 'InvalidDomainName.Duplicate', + 'message' => 'The specified domain name already exists.', + 'http_code' => 400, + 'description' => '指定的域名已存在。', + ], + [ + 'code' => 'InvalidDomainName.DuplicateTLD', + 'message' => 'The top-level domain of the specified domain name already exists.', + 'http_code' => 400, + 'description' => '指定域名的一级域名已存在。', + ], + [ + 'code' => 'InvalidDomainName.Malformed', + 'message' => 'The specified domain name is invalid.', + 'http_code' => 400, + 'description' => '指定的域名无效。', + ], + [ + 'code' => 'InvalidDomainNumber.Malformed', + 'message' => 'The maximum number of domains is exceeded.', + 'http_code' => 400, + 'description' => '域名数量超过限制。', + ], + [ + 'code' => 'InvalidDomainPassword.EqualCurrent', + 'message' => 'The password must be different from the current password.', + 'http_code' => 400, + 'description' => '密码不能相同', + ], + [ + 'code' => 'InvalidDomainPassword.Malformed', + 'message' => 'The specified domain password is incorrect.', + 'http_code' => 400, + 'description' => '密码错误', + ], + [ + 'code' => 'InvalidDomainStatus.Malformed', + 'message' => 'The specified domain status is invalid.', + 'http_code' => 400, + 'description' => '域状态错误.', + ], + [ + 'code' => 'InvalidFlowType.Malformed', + 'message' => 'The specified flowType is invalid.', + 'http_code' => 400, + 'description' => '指定的flowType无效。', + ], + [ + 'code' => 'InvalidFromAlias.Malformed', + 'message' => 'The specified fromAlias is invalid. The length must not exceed 15 characters.', + 'http_code' => 400, + 'description' => '发信人别名格式错误，长度不超过15个符。', + ], + [ + 'code' => 'InvalidHtmlBodyPlaceHolderKey.Malformed', + 'message' => 'The HTML body placeholder must start with user Defined.', + 'http_code' => 400, + 'description' => '占位符key必须以userDefined_开头', + ], + [ + 'code' => 'InvalidIntervalTime.Malformed', + 'message' => 'The interval between start time and end time should be less than 15 days.', + 'http_code' => 400, + 'description' => '开始时间与结束时间之间的间隔应小于15天。', + ], + [ + 'code' => 'InvalidIP.NotFound', + 'message' => 'The specified IP address is invalid.', + 'http_code' => 404, + 'description' => '指定的IP无效。', + ], + [ + 'code' => 'InvalidKeyword.Malformed', + 'message' => 'The specified keyword is invalid.', + 'http_code' => 400, + 'description' => '指定的关键词无效。', + ], + [ + 'code' => 'InvalidMail.Malformed', + 'message' => 'The specified mail is invalid.', + 'http_code' => 400, + 'description' => '指定的邮件是错误的。', + ], + [ + 'code' => 'InvalidMailAddress.DeleteTimes', + 'message' => 'The maximum number of delete times is exceeded. Please try again in the next calendar month.', + 'http_code' => 400, + 'description' => '已达到最大删除数，请下一个自然月再进行删除。', + ], + [ + 'code' => 'InvalidMailAddress.DelteTimes', + 'message' => 'The maximum number of delete times is exceeded. Please try again in the next calendar month.', + 'http_code' => 400, + 'description' => '已达到最大删除数，请下一个自然月再进行删除', + ], + [ + 'code' => 'InvalidMailAddress.NotFound', + 'message' => 'The specified mail address is not found.', + 'http_code' => 404, + 'description' => '发信地址未找到', + ], + [ + 'code' => 'InvalidMailAddressDomain.Malformed', + 'message' => 'The format of the specified mail address domain is invalid. It must only contain numbers, letters, underscores, minus signs, and periods.', + 'http_code' => 400, + 'description' => '域名格式不正确，请使用数字，字母，下划线，减号和点', + ], + [ + 'code' => 'InvalidMailAddressDomainStatus.Malformed', + 'message' => 'The status of the specified mail address domain is invalid.', + 'http_code' => 400, + 'description' => '指定的发信域名状态无效。', + ], + [ + 'code' => 'InvalidMailAddressId.Malformed', + 'message' => 'The specified sender address ID does not exist.', + 'http_code' => 404, + 'description' => '指定的发信地址ID不存在。', + ], + [ + 'code' => 'InvalidMailAddressName.Duplicate', + 'message' => 'The specified email address already exists. Please change to another one.', + 'http_code' => 400, + 'description' => '输入的email地址已经存在，请更换为另外一个。', + ], + [ + 'code' => 'InvalidMailAddressName.Malformed', + 'message' => 'The specified MailAddress name is wrongly formed.', + 'http_code' => null, + 'description' => '发信地址格式不正确，必须有@符号，域名组成为数字，字母，下划线，减号和点，账号组成为数字，字母，下划线，减号和点', + ], + [ + 'code' => 'InvalidMailAddressName.Malformed', + 'message' => 'The specified account name is invalid. It must only contain numbers, letters, underscores, minus signs, plus signs, and periods.', + 'http_code' => 400, + 'description' => '账号格式不正确，组成为数字，字母，下划线，减号，加号和点', + ], + [ + 'code' => 'InvalidMailAddressNumber.Malformed', + 'message' => 'The maximum number of sender addresses is exceeded.', + 'http_code' => 400, + 'description' => '发信地址数超过限制。', + ], + [ + 'code' => 'InvalidMailAddressPassword.EqualCurrent', + 'message' => 'The password must be different from the current password.', + 'http_code' => 400, + 'description' => '密码不能相同', + ], + [ + 'code' => 'InvalidMailAddressPassword.Malformed', + 'message' => 'The format of the specified mail address password is invalid.', + 'http_code' => 400, + 'description' => '指定的发信地址密码无效。', + ], + [ + 'code' => 'InvalidMailAddressReplyName.Malformed', + 'message' => 'The reply address set by the sender address is invalid.', + 'http_code' => 404, + 'description' => '发信地址设置的回信地址错误', + ], + [ + 'code' => 'InvalidMailAddressSendType.Malformed', + 'message' => 'The specified send type is invalid.', + 'http_code' => 400, + 'description' => '发送类型不正确，请去控制台检查类型，设置相应的值', + ], + [ + 'code' => 'InvalidMailAddressStatus.Malformed', + 'message' => 'The status of the sender address is invalid.', + 'http_code' => 400, + 'description' => '发信地址状态不对，请检查是否可用，是否是被冻结状态', + ], + [ + 'code' => 'InvalidMailAddressTicket.Malformed', + 'message' => 'No ticket exists under the specified mail address.', + 'http_code' => 404, + 'description' => '此发信地址没有指定的工单。', + ], + [ + 'code' => 'InvalidNode.Malformed', + 'message' => 'The specified node is invalid.', + 'http_code' => 400, + 'description' => '指定的节点无效。', + ], + [ + 'code' => 'InvalidNotifyUrl.Malformed', + 'message' => 'The specified notifyUrl is invalid.', + 'http_code' => 400, + 'description' => '指定的notifyUrl无效。', + ], + [ + 'code' => 'InvalidParameter', + 'message' => 'You must specify the parameter. Please check the API documentation.', + 'http_code' => 400, + 'description' => '必填参数没有填写，请参照文档补充。', + ], + [ + 'code' => 'InvalidParamString.Malformed', + 'message' => 'The specified paramString is invalid.', + 'http_code' => 400, + 'description' => '指定的参数字段无效。', + ], + [ + 'code' => 'InvalidParamStringTemplate.Malformed', + 'message' => 'The specified paramString and template are invalid.', + 'http_code' => 400, + 'description' => '指定的参数字段和模板无效。', + ], + [ + 'code' => 'InvalidQuota', + 'message' => 'The mail sending quota is exceeded.', + 'http_code' => 400, + 'description' => '发送邮件数超出额度限制，若满足发送量达到日额度的 90% 以上且无效地址率低于 5%，可以提交工单申请提升额度。', + ], + [ + 'code' => 'InvalidQuotaLevel', + 'message' => 'The format of credit rating is invalid.', + 'http_code' => 400, + 'description' => '信誉等级格式无效。', + ], + [ + 'code' => 'InvalidReceiver.NotFound', + 'message' => 'The specified receiver is invalid.', + 'http_code' => 404, + 'description' => '收件人不存在，请检查收件人是否存在', + ], + [ + 'code' => 'InvalidReceiverAlias.Duplicate', + 'message' => 'The specified receiverAlias already exists.', + 'http_code' => 400, + 'description' => '指定的收件人列表别名已存在。', + ], + [ + 'code' => 'InvalidReceiverAlias.Malformed', + 'message' => 'The specified receiverAlias is invalid.', + 'http_code' => 400, + 'description' => '指定的收件人列表别名无效。', + ], + [ + 'code' => 'InvalidReceiverDesc.Malformed', + 'message' => 'The specified receiverDesc is invalid.', + 'http_code' => 400, + 'description' => '格式错误', + ], + [ + 'code' => 'InvalidReceiverDetail.Malformed', + 'message' => 'The specified receiver detail is invalid.', + 'http_code' => 400, + 'description' => '收件人列表中指定的地址无效。', + ], + [ + 'code' => 'InvalidReceiverDetail.Spam', + 'message' => 'The email that was sent to the specified address in the receiver detail is rejected by spam filter.', + 'http_code' => 400, + 'description' => '发送到收件人列表中的指定地址的邮件因被识别为垃圾邮件而退回。', + ], + [ + 'code' => 'InvalidReceiverDetailMax.Malformed', + 'message' => 'The maximum number of addresses in the receiver detail is exceeded.', + 'http_code' => 400, + 'description' => '收件人列表中的地址数超过限制。', + ], + [ + 'code' => 'InvalidReceiverDetatil.NotFound', + 'message' => 'The specified address is not found in the receiver detail.', + 'http_code' => 404, + 'description' => '收件人列表中没有指定的地址。', + ], + [ + 'code' => 'InvalidReceiverEmail.Malformed', + 'message' => 'The specified receiver email address is invalid.', + 'http_code' => 400, + 'description' => '指定的接收方的邮箱地址错', + ], + [ + 'code' => 'InvalidReceiverId.Malformed', + 'message' => 'The specified recipient list ID does not exist.', + 'http_code' => 404, + 'description' => '指定的收件人列表ID不存在。', + ], + [ + 'code' => 'InvalidReceiverName.Duplicate', + 'message' => 'The specified recipient list name already exists.', + 'http_code' => 400, + 'description' => '指定的收件人列表名称已存在。', + ], + [ + 'code' => 'InvalidReceiverName.Malformed', + 'message' => 'The format of the receiver name is invalid. It must contain the @ sign. The domain must only contain numbers, letters, underscores, minus signs, and periods. The account name must only contain numbers, letters, underscores, minus signs, and periods.', + 'http_code' => 400, + 'description' => '收件人格式不正确，必须有@符号，域名组成为数字，字母，下划线，减号和点，账号组成为数字，字母，下划线，减号和点', + ], + [ + 'code' => 'InvalidReceiverNumber.Malformed', + 'message' => 'The maximum number of receivers is exceeded.', + 'http_code' => 400, + 'description' => '收件人列表数超过限制。', + ], + [ + 'code' => 'InvalidReceiverStatus.Malformed', + 'message' => 'The specified receiver status is invalid. Please check whether a receiver is uploaded on the console.', + 'http_code' => 400, + 'description' => '收件人状态不正确，请去控制台检查是否已上传收件人', + ], + [ + 'code' => 'InvalidRecNum.Malformed', + 'message' => 'The specified recNum is invalid.', + 'http_code' => 400, + 'description' => '指定的recNum无效。', + ], + [ + 'code' => 'InvalidReplyAddress.Malformed', + 'message' => 'The specified replyAddress is invalid. It must contain the @ sign. The domain must consist of numbers, letters, underscores, minus signs, and periods. The account name must consist of numbers, letters, underscores, minus signs, and periods.', + 'http_code' => 400, + 'description' => '回信地址格式不正确，必须有@符号，域名组成为数字，字母，下划线，减号和点，账号组成为数字，字母，下划线，减号和点', + ], + [ + 'code' => 'InvalidReplyAddressAlias.Malformed', + 'message' => 'The format of the specified replyAddressAlias is invalid. The length must not exceed 15 characters.', + 'http_code' => 400, + 'description' => '回信地址别名格式不正确，长度不超过15个符', + ], + [ + 'code' => 'InvalidSendMail.Spam', + 'message' => 'The email you sent was rejected by spam filter.', + 'http_code' => 400, + 'description' => '发信被拒绝，请检查用户状态，是否是频率超限，额度，内容反垃圾等问题', + ], + [ + 'code' => 'InvalidSendSms', + 'message' => 'The frequency limit is exceeded.', + 'http_code' => 400, + 'description' => '超频', + ], + [ + 'code' => 'InvalidSign.NotFound', + 'message' => 'The specified signature is not found.', + 'http_code' => 400, + 'description' => '指定的签名不存在。', + ], + [ + 'code' => 'InvalidSignFileNames.Malformed', + 'message' => 'The specified signature file is not found.', + 'http_code' => 404, + 'description' => '指定的签名文件不存在。', + ], + [ + 'code' => 'InvalidSignName.Duplicate', + 'message' => 'The specified signature already exists.', + 'http_code' => 400, + 'description' => '指定的签名已存在。', + ], + [ + 'code' => 'InvalidSignName.Malformed', + 'message' => 'The specified signature is invalid.', + 'http_code' => 400, + 'description' => '指定的签名无效。', + ], + [ + 'code' => 'InvalidSignNumber.Malformed', + 'message' => 'The maximum number of signatures is exceeded.', + 'http_code' => 400, + 'description' => '签名数超过限制。', + ], + [ + 'code' => 'InvalidSource.Malformed', + 'message' => 'The specified source is invalid.', + 'http_code' => 400, + 'description' => '指定的Source无效。', + ], + [ + 'code' => 'InvalidStartTime.Malformed', + 'message' => 'The start time must be earlier than the end time.', + 'http_code' => 400, + 'description' => '开始时间应该早于结束时间。', + ], + [ + 'code' => 'InvalidStatus.Malformed', + 'message' => 'The specified status is invalid.', + 'http_code' => 400, + 'description' => '指定的状态无效。', + ], + [ + 'code' => 'InvalidStatus.Update.Failed', + 'message' => 'The specified quick configuration update failed.', + 'http_code' => 400, + 'description' => '指定的快速配置流动更新失败。', + ], + [ + 'code' => 'InvalidSubject.Malformed', + 'message' => 'The specified subject is invalid. It must not exceed 100 characters.', + 'http_code' => 400, + 'description' => '主题错误，主题不能超过256个字符', + ], + [ + 'code' => 'InvalidTag.NotFound', + 'message' => 'The specified tag does not exist.', + 'http_code' => 404, + 'description' => '指定的标签不存在。', + ], + [ + 'code' => 'InvalidTagId.Malformed', + 'message' => 'The specified tag ID does not exist.', + 'http_code' => 400, + 'description' => '指定的标签ID不存在。', + ], + [ + 'code' => 'InvalidTagName.Duplicate', + 'message' => 'The specified tag name already exists.', + 'http_code' => 400, + 'description' => '指定的标签名称已存在。', + ], + [ + 'code' => 'InvalidTagName.Malformed', + 'message' => 'The specified tag name is invalid.', + 'http_code' => 404, + 'description' => '指定的标签名称无效。', + ], + [ + 'code' => 'InvalidTagNumber.Malformed', + 'message' => 'The maximum number of tags is exceeded.', + 'http_code' => 400, + 'description' => '标签数超过限制。', + ], + [ + 'code' => 'InvalidTask.NotFound', + 'message' => 'The specified task is not found.', + 'http_code' => 404, + 'description' => '指定的任务不存在。', + ], + [ + 'code' => 'InvalidTemplate.NotFound', + 'message' => 'The specified template is not found.', + 'http_code' => 404, + 'description' => '指定的模板不存在。', + ], + [ + 'code' => 'InvalidTemplateCode.Malformed', + 'message' => 'The specified template code is invalid.', + 'http_code' => 400, + 'description' => '指定的模板代码无效。', + ], + [ + 'code' => 'InvalidTemplateId.Malformed', + 'message' => 'The specified templateId does not exist.', + 'http_code' => 404, + 'description' => '指定的模板ID不存在。', + ], + [ + 'code' => 'InvalidTemplateName.Duplicate', + 'message' => 'The specified template name already exists.', + 'http_code' => 400, + 'description' => '指定的模板名称已存在。', + ], + [ + 'code' => 'InvalidTemplateName.Malformed', + 'message' => 'The length of the template name must not exceed 30 characters.', + 'http_code' => 400, + 'description' => '模板名格式不正确，模板名不能大于30个字符', + ], + [ + 'code' => 'InvalidTemplateNickName.Malformed', + 'message' => 'The specified TemplateNickName is invalid.', + 'http_code' => 400, + 'description' => '指定的模板别名无效。', + ], + [ + 'code' => 'InvalidTemplateNumber.Malformed', + 'message' => 'The maximum number of templates is exceeded.', + 'http_code' => 400, + 'description' => '模板数量超过限制。', + ], + [ + 'code' => 'InvalidTemplateRemark.Malformed', + 'message' => 'The specified template remark is invalid.', + 'http_code' => 400, + 'description' => '指定的模板备注无效。', + ], + [ + 'code' => 'InvalidTemplateSmsContent.Malformed', + 'message' => 'The specified template smsContent is invalid.', + 'http_code' => 400, + 'description' => '指定模板错误', + ], + [ + 'code' => 'InvalidTemplateSmsType.Malformed', + 'message' => 'The format of the specified template smsType is invalid.', + 'http_code' => 400, + 'description' => '类型错误', + ], + [ + 'code' => 'InvalidTemplateStatus.Malformed', + 'message' => 'The specified template status is invalid. Please check whether the template has passed verification.', + 'http_code' => 400, + 'description' => '模板状态不正确，请检查模板是否已通过审核', + ], + [ + 'code' => 'InvalidTemplateSubject.Malformed', + 'message' => 'The specified template subject is invalid.', + 'http_code' => 400, + 'description' => '指定模板错误', + ], + [ + 'code' => 'InvalidTemplateText.Malformed', + 'message' => 'The specified template text must not exceed 1 MB.', + 'http_code' => 400, + 'description' => '指定模板文本过长，超过1MB。', + ], + [ + 'code' => 'InvalidTemplateType.Malformed', + 'message' => 'The specified template type is invalid.', + 'http_code' => 400, + 'description' => '指定的模板类型无效。', + ], + [ + 'code' => 'InvalidTemplateVariable.Malformed', + 'message' => 'The specified template variable is invalid.', + 'http_code' => 400, + 'description' => '指定的模板变量无效。', + ], + [ + 'code' => 'InvalidToAddress', + 'message' => 'The specified toAddress is invalid. It must contain the @ sign. The domain must consist of numbers, letters, underscores, minus signs, and periods. The account name must consist of numbers, letters, underscores, minus signs, and periods.', + 'http_code' => 400, + 'description' => '收件人格式不正确，必须有@符号，域名组成为数字，字母，下划线，减号和点，账号组成为数字，字母，下划线，减号和点', + ], + [ + 'code' => 'InvalidToAddress.Spam', + 'message' => 'The email you sent was rejected due to invalid address.', + 'http_code' => 400, + 'description' => '因地址无效，邮件被退回。', + ], + [ + 'code' => 'InvalidUser.NotFound', + 'message' => 'The specified user does not exist. Please contact your master account to activate the Direct Mail service.', + 'http_code' => 404, + 'description' => '账户不存在。请联系您访问凭证或者子账号对应主账号开通邮件推送服务。', + ], + [ + 'code' => 'InvalidUserStatus.Malformed', + 'message' => 'The specified user status is abnormal.', + 'http_code' => 400, + 'description' => '状态异常。因为欠费、发垃圾邮件或者多账户注册等原因被封禁，请提交工单核查。', + ], + [ + 'code' => 'InvalidYear.Malformed', + 'message' => 'The specified year is invalid.', + 'http_code' => 400, + 'description' => '指定的年份无效。', + ], + [ + 'code' => 'ListAlibabaCloudDomains.GetFailed', + 'message' => 'Failed to get Alibaba Cloud domains.', + 'http_code' => 404, + 'description' => '未能获得阿里云的域。', + ], + [ + 'code' => 'LogicalDeleteUserStatus', + 'message' => 'The specified user status is deleted.', + 'http_code' => 400, + 'description' => '用户状态被删除', + ], + [ + 'code' => 'MissingTemplateText', + 'message' => 'You must specify TemplateText.', + 'http_code' => 400, + 'description' => '请输入模板正文。', + ], + [ + 'code' => 'notification.errorparam', + 'message' => 'The specified parameter is invalid.', + 'http_code' => 400, + 'description' => '指定的参数无效。', + ], + [ + 'code' => 'RAM.ApiNotSupported', + 'message' => 'The API does not support RAM access.', + 'http_code' => 400, + 'description' => '这个api不支持访问。', + ], + [ + 'code' => 'RecordDuplicated', + 'message' => 'The specified record already exists.', + 'http_code' => 400, + 'description' => 'record已存在。', + ], + [ + 'code' => 'RecordLimit', + 'message' => 'The maximum number of records is exceeded.', + 'http_code' => 400, + 'description' => 'record超过限制。', + ], + [ + 'code' => 'UnsupportedSourceControl', + 'message' => 'You are not authorized to perform the operation.', + 'http_code' => 400, + 'description' => '没有使用权限', + ], + [ + 'code' => 'User.Blacklisted', + 'message' => 'The specified user is in the blacklist.', + 'http_code' => 400, + 'description' => '指定的用户在黑名单中。', + ], + [ + 'code' => 'User.RegisterTooMuch', + 'message' => 'The specified user has registered more than one DirectMail account.', + 'http_code' => 400, + 'description' => '指定的用户已经注册多个DirectMail帐户。', + ], + [ + 'code' => 'UserSuppressionList.AddressExists', + 'message' => 'The address already exists.', + 'http_code' => 400, + 'description' => '邮件地址或者域已存在', + ], + [ + 'code' => 'UserSuppressionList.AddressOverLength', + 'message' => 'The address length should less than 60.', + 'http_code' => 400, + 'description' => '无效地址的长度应小于60个字符', + ], + [ + 'code' => 'UserSuppressionList.AddressWithSpecialChar', + 'message' => 'Please remove special characters.', + 'http_code' => 400, + 'description' => '无效地址仅支持邮件地址或者域名，不支持特殊字符', + ], + [ + 'code' => 'UserSuppressionList.EmptyAddress', + 'message' => 'Please enter the address.', + 'http_code' => 400, + 'description' => '无效地址不能为空', + ], + [ + 'code' => 'UserSuppressionList.InvalidAddress', + 'message' => 'Invalid address, please enter domain or email.', + 'http_code' => 400, + 'description' => '无效地址格式错误，只能是域或者邮箱', + ], + [ + 'code' => 'InvalidSubject.Malformed', + 'message' => 'The specified subject is invalid. It exceeds the allowed length limit.', + 'http_code' => 400, + 'description' => '主题错误，超出了允许的长度限制', + ], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'DirectMail', + 'productName' => '邮件推送', + 'ramCodes' => [ + 'dm', + ], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DeleteIpfilterByEdmId', + 'description' => '删除IP白名单', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteIpfilterByEdmId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CheckDomain', + 'description' => '验证域名', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:CheckDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'RemoveUserSuppression', + 'description' => '移除个人和系统无效地址', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:RemoveUserSuppression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateMailAddress', + 'description' => '创建发信地址', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyTag', + 'description' => '修改标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ModifyTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateDomain', + 'description' => '创建域名', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteMailAddress', + 'description' => '删除发信地址', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListUserSuppression', + 'description' => '列出个人和系统无效地址', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:ListUserSuppression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SenderStatisticsByTagNameAndBatchID', + 'description' => '获取指定条件下的发送数据', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:SenderStatisticsByTagNameAndBatchID', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetIpProtection', + 'description' => '获取IP防护功能是否开启', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetIpProtection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetTrackListByMailFromAndTagName', + 'description' => '根据发信地址和标签获取邮件跟踪发送数据', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:GetTrackListByMailFromAndTagName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigSetDelete', + 'description' => '删除配置集', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:ConfigSetDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetUser', + 'description' => '获取用户信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:GetUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigSetRelationFromAddress', + 'description' => '配置集关联发信地址', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:ConfigSetRelationFromAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ApproveReplyMailAddress', + 'description' => '验证回信地址', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:ApproveReplyMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CheckReplyToMailAddress', + 'description' => '验证回信地址发送邮件', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:CheckReplyToMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpNonePoolList', + 'description' => '列出未加入IP池IP', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpNonePoolList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpPoolList', + 'description' => '列出IP池', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListValidateFile', + 'description' => '列出上传的校验文件', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:ListValidateFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'BatchSendMail', + 'description' => '批量发送邮件', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:BatchSendMail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigSetDetail', + 'description' => '获取配置集', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:ConfigSetDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescAccountSummary', + 'description' => '获取账户信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:DescAccountSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveReceiverDetail', + 'description' => '创建单个收件人', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:SaveReceiverDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpAutoRenewal', + 'description' => '设置IP自动续费', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpAutoRenewal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryMailAddressByParam', + 'description' => '查询发信地址列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryMailAddressByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetTrackList', + 'description' => '邮件跟踪获取发送数据', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:GetTrackList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryDomainByParam', + 'description' => '查询域名列表信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryDomainByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetValidationQuota', + 'description' => '获取校验额度', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetValidationQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteReceiver', + 'description' => '删除收件人列表', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteReceiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteReceiverDetail', + 'description' => '删除单个收件人', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteReceiverDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteTag', + 'description' => '删除标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescTemplate', + 'description' => '查看模板信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:DescTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryReceiverByParam', + 'description' => '查询收件人列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryReceiverByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateTag', + 'description' => '创建标签', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetIpfilterList', + 'description' => '获取 IP 筛选器列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetIpfilterList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateReceiver', + 'description' => '创建收件人列表', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateReceiver', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetValidateFile', + 'description' => '获取校验结果文件', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetValidateFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpPoolUpdate', + 'description' => '更新IP池', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SendTestByTemplate', + 'description' => '发送测试邮件', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:SendTestByTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SenderStatisticsDetailByParam', + 'description' => '获取发送详情', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:SenderStatisticsDetailByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryTaskByParam', + 'description' => '查询任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryTaskByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigSetCreate', + 'description' => '创建配置集', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:ConfigSetCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetValidateFileStatus', + 'description' => '获取校验结果文件状态', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:GetValidateFileStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SingleSendMail', + 'description' => '发送单条邮件', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:SingleSendMail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListBlockSending', + 'description' => '获取发信黑名单', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dm:ListBlockSending', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteInvalidAddress', + 'description' => '删除无效地址', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dm:DeleteInvalidAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyPWByDomain', + 'description' => '设置域名的 SMTP 的密码', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ModifyPWByDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpChangeWarmupType', + 'description' => '更新已购买IP预热方式', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpChangeWarmupType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'AddIpfilter', + 'description' => '添加IP白名单', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:AddIpfilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigSetList', + 'description' => '列出配置集列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:ConfigSetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryTemplateByParam', + 'description' => '分页查询模板列表信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryTemplateByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyMailAddress', + 'description' => '设置发信地址SMTP密码和回信地址', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ModifyMailAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryReceiverDetail', + 'description' => '查询某个收件人列表详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryReceiverDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteDomain', + 'description' => '删除域名', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SendValidateFile', + 'description' => '上传检验文件', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:SendValidateFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpPoolDelete', + 'description' => '删除IP池', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ValidateEmail', + 'description' => '校验电子邮件', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:ValidateEmail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateIpProtection', + 'description' => '开启或者关闭IP保护功能', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:UpdateIpProtection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UpdateUser', + 'description' => '更新用户信息', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:UpdateUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigSetUpdate', + 'description' => '更新配置集', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ConfigSetUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UnblockSending', + 'description' => '解除发信限制', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:UnblockSending', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryTagByParam', + 'description' => '获取标签', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryTagByParam', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryInvalidAddress', + 'description' => '获取无效地址信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:QueryInvalidAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateUserSuppression', + 'description' => '创建无效地址或域名', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:CreateUserSuppression', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpList', + 'description' => '列出购买IP列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescDomain', + 'description' => '配置域名', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dm:DescDomain', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ConfigSetCancelRelationFromAddress', + 'description' => '配置集取消关联发信地址', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dm:ConfigSetCancelRelationFromAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteValidateFile', + 'description' => '删除校验结果文件', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dm:DeleteValidateFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DedicatedIpPoolCreate', + 'description' => '创建IP池', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dm:DedicatedIpPoolCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'DirectMail', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'resourceTypes' => [], + ], +]; |