diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/dm/2017-06-22 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/dm/2017-06-22')
| -rw-r--r-- | data/zh_cn/dm/2017-06-22/api-docs.php | 4712 |
1 files changed, 4712 insertions, 0 deletions
diff --git a/data/zh_cn/dm/2017-06-22/api-docs.php b/data/zh_cn/dm/2017-06-22/api-docs.php new file mode 100644 index 0000000..bb0daca --- /dev/null +++ b/data/zh_cn/dm/2017-06-22/api-docs.php @@ -0,0 +1,4712 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dm', + 'version' => '2017-06-22', + ], + 'directories' => [ + [ + 'id' => 60684, + 'title' => '地址', + 'type' => 'directory', + 'children' => [ + 'CreateMailAddress', + 'DeleteMailAddress', + 'QueryInvalidAddress', + 'QueryMailAddressByParam', + ], + ], + [ + 'id' => 60689, + 'title' => '账户', + 'type' => 'directory', + 'children' => [ + 'ModifyMailAddress', + 'GetAccountList', + 'DescAccountSummary', + ], + ], + [ + 'id' => 60694, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'CreateTag', + 'DeleteTag', + 'ModifyTag', + 'QueryTagByParam', + ], + ], + [ + 'id' => 60699, + 'title' => '收件人', + 'type' => 'directory', + 'children' => [ + 'CreateReceiver', + 'DeleteReceiver', + 'DeleteReceiverDetail', + 'QueryReceiverByParam', + 'QueryReceiverDetail', + 'SaveReceiverDetail', + ], + ], + [ + 'id' => 60707, + 'title' => '模板', + 'type' => 'directory', + 'children' => [ + 'CreateTemplate', + 'DeleteTemplate', + 'ModifyTemplate', + 'QueryTemplateByParam', + 'DescTemplate', + ], + ], + [ + 'id' => 60713, + 'title' => '域名', + 'type' => 'directory', + 'children' => [ + 'CreateDomain', + 'DeleteDomain', + 'QueryDomainByParam', + 'CheckDomain', + 'DescDomain', + ], + ], + [ + 'id' => 60719, + 'title' => '发送信息', + 'type' => 'directory', + 'children' => [ + 'GetTrackList', + 'QueryTaskByParam', + 'BatchSendMail', + 'SenderStatisticsByTagNameAndBatchID', + 'SenderStatisticsDetailByParam', + 'SingleSendMail', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'AddIpfilter', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateMailAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Sendtype', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MailAddressId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteMailAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'MailAddressId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMailAddressName.Duplicate', + 'errorMessage' => 'The specified mailAddress accountName is already existed', + ], + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified MailAddress accountName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressNumber.Malformed', + 'errorMessage' => 'The amount of MailAddress exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidMailAddressId.Malformed', + 'errorMessage' => 'The specified MailAddressId does not exist.', + ], + [ + 'errorCode' => 'InvalidMailAddressReplyName.Malformed', + 'errorMessage' => 'The specified mailAddress replyAddress is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressSendType.Malformed', + 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressDomain.Malformed', + 'errorMessage' => 'The specified mailAddress domain does not exist.', + ], + [ + 'errorCode' => 'InvalidMailAddressDomainStatus.Malformed', + 'errorMessage' => 'The mailAddress domain Status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressStatus.Malformed', + 'errorMessage' => 'The specified mailAddress status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressTicket.Malformed', + 'errorMessage' => 'The specified mailAddress ticket does not exist.', + ], + [ + 'errorCode' => 'InvalidMailAddress.delteTimes', + 'errorMessage' => 'Maximum number of deletion', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryInvalidAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'NextStart', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextStart' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'mailDetail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LastUpdateTime' => [ + 'type' => 'string', + ], + 'ToAddress' => [ + 'type' => 'string', + ], + 'UtcLastUpdateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDate.Malformed', + 'errorMessage' => 'The specified date is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Start time should earlyer than end time.', + ], + [ + 'errorCode' => 'InvalidBetweenTime.Malformed', + 'errorMessage' => 'More than seven days between start time and end time.', + ], + [ + 'errorCode' => 'InvalidYear.Malformed', + 'errorMessage' => 'The specified year is invalid.', + ], + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not exist.', + ], + [ + 'errorCode' => 'InvalidKeyword.Malformed', + 'errorMessage' => 'The specified keyword is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDate.NotFound', + 'errorMessage' => 'The specified date does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMailAddressByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'default' => '500', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Sendtype', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'mailAddress' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MailAddressId' => [ + 'type' => 'string', + ], + 'MonthCount' => [ + 'type' => 'string', + ], + 'AccountStatus' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'ReplyStatus' => [ + 'type' => 'string', + ], + 'Sendtype' => [ + 'type' => 'string', + ], + 'MonthReqCount' => [ + 'type' => 'string', + ], + 'ReplyAddress' => [ + 'type' => 'string', + ], + 'DailyReqCount' => [ + 'type' => 'string', + ], + 'DailyCount' => [ + 'type' => 'string', + ], + 'DomainStatus' => [ + 'type' => 'string', + ], + 'AccountName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'ModifyMailAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MailAddressId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMailAddressName.Duplicate', + 'errorMessage' => 'The specified mailAddress accountName is already existed', + ], + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified MailAddress accountName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressNumber.Malformed', + 'errorMessage' => 'The amount of MailAddress exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidMailAddressId.Malformed', + 'errorMessage' => 'The specified MailAddressId does not exist.', + ], + [ + 'errorCode' => 'InvalidMailAddressReplyName.Malformed', + 'errorMessage' => 'The specified mailAddress replyAddress is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressSendType.Malformed', + 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressDomain.Malformed', + 'errorMessage' => 'The specified mailAddress domain does not exist.', + ], + [ + 'errorCode' => 'InvalidMailAddressDomainStatus.Malformed', + 'errorMessage' => 'The mailAddress domain Status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressStatus.Malformed', + 'errorMessage' => 'The specified mailAddress status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressTicket.Malformed', + 'errorMessage' => 'The specified mailAddress ticket does not exist.', + ], + [ + 'errorCode' => 'InvalidMailAddressPassword.Malformed', + 'errorMessage' => 'The specified mailAddress password is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressPassword.equalcurrent', + 'errorMessage' => 'The password can not equal current one.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'GetAccountList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Total', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OffsetCreateTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OffsetCreateTimeDesc', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Total' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'accountNotificationInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'UpdateTime' => [ + 'type' => 'string', + ], + 'Region' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDate.Malformed', + 'errorMessage' => 'The specified date is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Start time should earlyer than end time.', + ], + [ + 'errorCode' => 'InvalidBetweenTime.Malformed', + 'errorMessage' => 'More than seven days between start time and end time.', + ], + [ + 'errorCode' => 'InvalidYear.Malformed', + 'errorMessage' => 'The specified year is invalid.', + ], + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDate.NotFound', + 'errorMessage' => 'The specified date does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DescAccountSummary' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnableTimes' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SmsSign' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MonthQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Receivers' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'DayuStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'DailyQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SmsRecord' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Tags' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Templates' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MailAddresses' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'QuotaLevel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaxQuotaLevel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Domains' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'UserStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SmsTemplates' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RemainFreeQuota' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'DailyRemainFreeQuota' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'User.Blacklisted', + 'errorMessage' => 'The specified user is in the blacklist.', + ], + [ + 'errorCode' => 'User.RegisterTooMuch', + 'errorMessage' => 'The specified user has registered more than one DirectMail account.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'CreateTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称', + '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' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagName.Malformed', + 'errorMessage' => 'The specified tag name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTagName.Duplicate', + 'errorMessage' => 'The specified tag name is already existed.', + ], + [ + 'errorCode' => 'InvalidTagNumber.Malformed', + 'errorMessage' => 'The amount of tag exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTagId.Malformed', + 'errorMessage' => 'The specified tagId does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidTag.NotFound', + 'errorMessage' => 'The specified tag does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagId\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '创建标签', + ], + 'DeleteTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagName.Malformed', + 'errorMessage' => 'The specified tag name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTagName.Duplicate', + 'errorMessage' => 'The specified tag name is already existed.', + ], + [ + 'errorCode' => 'InvalidTagNumber.Malformed', + 'errorMessage' => 'The amount of tag exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTagId.Malformed', + 'errorMessage' => 'The specified tagId does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidTag.NotFound', + 'errorMessage' => 'The specified tag does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'ModifyTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称', + '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' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTagName.Malformed', + 'errorMessage' => 'The specified tag name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTagName.Duplicate', + 'errorMessage' => 'The specified tag name is already existed.', + ], + [ + 'errorCode' => 'InvalidTagNumber.Malformed', + 'errorMessage' => 'The amount of tag exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTagId.Malformed', + 'errorMessage' => 'The specified tagId does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidTag.NotFound', + 'errorMessage' => 'The specified tag does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '修改标签', + ], + 'QueryTagByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'default' => '500', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + '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' => 'test', + ], + 'TagId' => [ + 'description' => '标签ID', + 'type' => 'string', + 'example' => '52366', + ], + 'TagDescription' => [ + 'description' => '标签描述', + 'type' => 'string', + 'example' => 'test description', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test\\",\\n \\"TagId\\": \\"52366\\",\\n \\"TagDescription\\": \\"test description\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取标签', + ], + 'CreateReceiver' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ReceiversName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ReceiversAlias', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReceiverName.Duplicate', + 'errorMessage' => 'The specified receiver name is already existed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverNumber.Malformed', + 'errorMessage' => 'The amount of receiver exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverId.Malformed', + 'errorMessage' => 'The specified receiverId does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiverStatus.Malformed', + 'errorMessage' => 'The specified receivers status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetailMax.Malformed', + 'errorMessage' => 'The amount of receivers detail exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverDesc.Malformed', + 'errorMessage' => 'The specified receiversDesc is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Malformed', + 'errorMessage' => 'The specified receivers detail is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Spam', + 'errorMessage' => 'The specified receiver detail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Malformed', + 'errorMessage' => 'The specified receiversAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Duplicate', + 'errorMessage' => 'The specified receiversAlias is already existed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteReceiver' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReceiverName.Duplicate', + 'errorMessage' => 'The specified receiver name is already existed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverNumber.Malformed', + 'errorMessage' => 'The amount of receiver exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverId.Malformed', + 'errorMessage' => 'The specified receiverId does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiverStatus.Malformed', + 'errorMessage' => 'The specified receivers status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetailMax.Malformed', + 'errorMessage' => 'The amount of receivers detail exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverDesc.Malformed', + 'errorMessage' => 'The specified receiversDesc is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Malformed', + 'errorMessage' => 'The specified receivers detail is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Spam', + 'errorMessage' => 'The specified receiver detail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Malformed', + 'errorMessage' => 'The specified receiversAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Duplicate', + 'errorMessage' => 'The specified receiversAlias is already existed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteReceiverDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReceiverName.Duplicate', + 'errorMessage' => 'The specified receiver name is already existed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverNumber.Malformed', + 'errorMessage' => 'The amount of receiver exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverId.Malformed', + 'errorMessage' => 'The specified receiverId does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiverStatus.Malformed', + 'errorMessage' => 'The specified receivers status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetailMax.Malformed', + 'errorMessage' => 'The amount of receivers detail exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverDesc.Malformed', + 'errorMessage' => 'The specified receiversDesc is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Malformed', + 'errorMessage' => 'The specified receivers detail is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Spam', + 'errorMessage' => 'The specified receiver detail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Malformed', + 'errorMessage' => 'The specified receiversAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Duplicate', + 'errorMessage' => 'The specified receiversAlias is already existed.', + ], + [ + 'errorCode' => 'InvalidStatus.Malformed', + 'errorMessage' => 'The specified status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetatil.NotFound', + 'errorMessage' => 'The specified receiver detail does not found.', + ], + [ + 'errorCode' => 'InvalidReceiverEmail.Malformed', + 'errorMessage' => 'The specified receiver email is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryReceiverByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'default' => '40', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextStart' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'receiver' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiversAlias' => [ + 'type' => 'string', + ], + 'ReceiversName' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'ReceiverId' => [ + 'type' => 'string', + ], + 'UtcCreateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ReceiversStatus' => [ + 'type' => 'string', + ], + 'Count' => [ + 'type' => 'string', + ], + 'Desc' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReceiverName.Duplicate', + 'errorMessage' => 'The specified receiver name is already existed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverNumber.Malformed', + 'errorMessage' => 'The amount of receiver exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverId.Malformed', + 'errorMessage' => 'The specified receiverId does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiverStatus.Malformed', + 'errorMessage' => 'The specified receivers status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetailMax.Malformed', + 'errorMessage' => 'The amount of receivers detail exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverDesc.Malformed', + 'errorMessage' => 'The specified receiversDesc is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Malformed', + 'errorMessage' => 'The specified receivers detail is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Spam', + 'errorMessage' => 'The specified receiver detail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Malformed', + 'errorMessage' => 'The specified receiversAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Duplicate', + 'errorMessage' => 'The specified receiversAlias is already existed.', + ], + [ + 'errorCode' => 'InvalidStatus.Malformed', + 'errorMessage' => 'The specified status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryReceiverDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'default' => '40', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NextStart', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataSchema' => [ + 'type' => 'string', + ], + 'NextStart' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'detail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + ], + 'UtcCreateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Email' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReceiverName.Duplicate', + 'errorMessage' => 'The specified receiver name is already existed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverNumber.Malformed', + 'errorMessage' => 'The amount of receiver exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverId.Malformed', + 'errorMessage' => 'The specified receiverId does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiverStatus.Malformed', + 'errorMessage' => 'The specified receivers status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetailMax.Malformed', + 'errorMessage' => 'The amount of receivers detail exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverDesc.Malformed', + 'errorMessage' => 'The specified receiversDesc is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Malformed', + 'errorMessage' => 'The specified receivers detail is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Spam', + 'errorMessage' => 'The specified receiver detail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Malformed', + 'errorMessage' => 'The specified receiversAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Duplicate', + 'errorMessage' => 'The specified receiversAlias is already existed.', + ], + [ + 'errorCode' => 'InvalidStatus.Malformed', + 'errorMessage' => 'The specified status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'SaveReceiverDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Detail', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'SuccessCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Detail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Email' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReceiverName.Duplicate', + 'errorMessage' => 'The specified receiver name is already existed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverNumber.Malformed', + 'errorMessage' => 'The amount of receiver exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverId.Malformed', + 'errorMessage' => 'The specified receiverId does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiverStatus.Malformed', + 'errorMessage' => 'The specified receivers status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetailMax.Malformed', + 'errorMessage' => 'The amount of receivers detail exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidReceiverDesc.Malformed', + 'errorMessage' => 'The specified receiversDesc is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Malformed', + 'errorMessage' => 'The specified receivers detail is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverDetail.Spam', + 'errorMessage' => 'The specified receiver detail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Malformed', + 'errorMessage' => 'The specified receiversAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverAlias.Duplicate', + 'errorMessage' => 'The specified receiversAlias is already existed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'CreateTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateSubject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TemplateNickName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TemplateText', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SmsType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'SmsContent', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTemplateName.Duplicate', + 'errorMessage' => 'The specified template name is already existed.', + ], + [ + 'errorCode' => 'InvalidTemplateName.Malformed', + 'errorMessage' => 'The specified template name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateNumber.Malformed', + 'errorMessage' => 'The amount of template exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTemplateId.Malformed', + 'errorMessage' => 'TemplateId does not exist.', + ], + [ + 'errorCode' => 'InvalidTemplateNickName.Malformed', + 'errorMessage' => 'The specified template nickName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateSubject.Malformed', + 'errorMessage' => 'The specified template subject is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateRemark.Malformed', + 'errorMessage' => 'The specified template remark is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateSmsContent.Malformed', + 'errorMessage' => 'The specified template smsContent is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateType.Malformed', + 'errorMessage' => 'The specified template type is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateSmsType.Malformed', + 'errorMessage' => 'The specified template smsType is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateStatus.Malformed', + 'errorMessage' => 'The specified template status is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidTemplate.NotFound', + 'errorMessage' => 'The specified template does not found.', + ], + [ + 'errorCode' => 'MissingTemplateText', + 'errorMessage' => 'TemplateText is mandatory for this action.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTemplateName.Duplicate', + 'errorMessage' => 'The specified template name is already existed.', + ], + [ + 'errorCode' => 'InvalidTemplateName.Malformed', + 'errorMessage' => 'The specified template name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateNumber.Malformed', + 'errorMessage' => 'The amount of template exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTemplateId.Malformed', + 'errorMessage' => 'TemplateId does not exist.', + ], + [ + 'errorCode' => 'InvalidTemplateNickName.Malformed', + 'errorMessage' => 'The specified template nickName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateSubject.Malformed', + 'errorMessage' => 'The specified template subject is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateStatus.Malformed', + 'errorMessage' => 'The specified template status is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDayuStatus.Malformed', + 'errorMessage' => 'The specified dayu status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplate.NotFound', + 'errorMessage' => 'The specified template does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'ModifyTemplate' => [ + 'summary' => '修改模板信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateSubject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TemplateNickName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TemplateText', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SmsType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'SmsContent', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryTemplateByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'default' => '40', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4', + 'minimum' => '0', + ], + ], + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'template' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateComment' => [ + 'type' => 'string', + ], + 'UtcCreatetime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Smsrejectinfo' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SmsTemplateCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'TemplateStatus' => [ + 'type' => 'string', + ], + 'TemplateType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TemplateName' => [ + 'type' => 'string', + ], + 'SmsStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TemplateId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTemplateName.Duplicate', + 'errorMessage' => 'The specified template name is already existed.', + ], + [ + 'errorCode' => 'InvalidTemplateName.Malformed', + 'errorMessage' => 'The specified template name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateNumber.Malformed', + 'errorMessage' => 'The amount of template exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTemplateId.Malformed', + 'errorMessage' => 'TemplateId does not exist.', + ], + [ + 'errorCode' => 'InvalidTemplateNickName.Malformed', + 'errorMessage' => 'The specified template nickName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateSubject.Malformed', + 'errorMessage' => 'The specified template subject is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateStatus.Malformed', + 'errorMessage' => 'The specified template status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidKeyword.Malformed', + 'errorMessage' => 'The specified keyword is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDayuStatus.Malformed', + 'errorMessage' => 'The specified dayu status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplate.NotFound', + 'errorMessage' => 'The specified template does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DescTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'FromType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SmsContent' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Remark' => [ + 'type' => 'string', + ], + 'SmsType' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'TemplateSubject' => [ + 'type' => 'string', + ], + 'TemplateStatus' => [ + 'type' => 'string', + ], + 'TemplateNickName' => [ + 'type' => 'string', + ], + 'TemplateType' => [ + 'type' => 'string', + ], + 'TemplateName' => [ + 'type' => 'string', + ], + 'TemplateText' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTemplateName.Duplicate', + 'errorMessage' => 'The specified template name is already existed.', + ], + [ + 'errorCode' => 'InvalidTemplateName.Malformed', + 'errorMessage' => 'The specified template name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateNumber.Malformed', + 'errorMessage' => 'The amount of template exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTemplateId.Malformed', + 'errorMessage' => 'TemplateId does not exist.', + ], + [ + 'errorCode' => 'InvalidTemplateNickName.Malformed', + 'errorMessage' => 'The specified template nickName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateSubject.Malformed', + 'errorMessage' => 'The specified template subject is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateStatus.Malformed', + 'errorMessage' => 'The specified template status is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDayuStatus.Malformed', + 'errorMessage' => 'The specified dayu status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplate.NotFound', + 'errorMessage' => 'The specified template does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'CreateDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Duplicate', + 'errorMessage' => 'The specified domain name is already existed', + ], + [ + 'errorCode' => 'InvalidDomainName.DuplicateTLD', + 'errorMessage' => 'The specified domain of top-level domain name already exists.', + ], + [ + 'errorCode' => 'InvalidDomainName.TimeOut', + 'errorMessage' => 'The current response timeout, please try again later.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified domain name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidDomainNumber.Malformed', + 'errorMessage' => 'The amount of domain exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidDomainName.Conflict', + 'errorMessage' => 'The specified domain name is already used by other user', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The specified domain does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainId.Malformed', + 'errorMessage' => 'The specified domainId does not exist.', + ], + [ + 'errorCode' => 'InvalidDomain.Using', + 'errorMessage' => 'The specified domain has been used to create mailAddress.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The specified domain does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryDomainByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'default' => '20', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'domain' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DomainRecord' => [ + 'type' => 'string', + ], + 'SpfAuthStatus' => [ + 'type' => 'string', + ], + 'MxAuthStatus' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'CnameAuthStatus' => [ + 'type' => 'string', + ], + 'ConfirmStatus' => [ + 'type' => 'string', + ], + 'IcpStatus' => [ + 'type' => 'string', + ], + 'UtcCreateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DomainStatus' => [ + 'type' => 'string', + ], + 'DomainName' => [ + 'type' => 'string', + ], + 'DomainId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKeyword.Malformed', + 'errorMessage' => 'The specified keyword is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidStatus.Malformed', + 'errorMessage' => 'The specified status is wrongly formed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'User.Blacklisted', + 'errorMessage' => 'The specified user is in the blacklist.', + ], + [ + 'errorCode' => 'User.RegisterTooMuch', + 'errorMessage' => 'The specified user has registered more than one DirectMail account.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'CheckDomain' => [ + 'summary' => '校验域名状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainStatus' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'DescDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DomainId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'RequireRealTimeDnsRecords', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SpfRecord' => [ + 'type' => 'string', + ], + 'CnameConfirmStatus' => [ + 'type' => 'string', + ], + 'DefaultDomain' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'CnameRecord' => [ + 'type' => 'string', + ], + 'CnameAuthStatus' => [ + 'type' => 'string', + ], + 'IcpStatus' => [ + 'type' => 'string', + ], + 'DnsTxt' => [ + 'type' => 'string', + ], + 'DomainName' => [ + 'type' => 'string', + ], + 'DomainId' => [ + 'type' => 'string', + ], + 'DnsSpf' => [ + 'type' => 'string', + ], + 'SpfAuthStatus' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'MxRecord' => [ + 'type' => 'string', + ], + 'MxAuthStatus' => [ + 'type' => 'string', + ], + 'DnsMx' => [ + 'type' => 'string', + ], + 'DomainStatus' => [ + 'type' => 'string', + ], + 'TlDomainName' => [ + 'type' => 'string', + ], + 'TracefRecord' => [ + 'type' => 'string', + ], + 'DomainType' => [ + 'type' => 'string', + ], + 'SpfRecordV2' => [ + 'type' => 'string', + ], + 'DkimRR' => [ + 'type' => 'string', + ], + 'DkimPublicKey' => [ + 'type' => 'string', + ], + 'DkimAuthStatus' => [ + 'type' => 'string', + ], + 'HostRecord' => [ + 'type' => 'string', + ], + 'DnsDmarc' => [ + 'type' => 'string', + ], + 'DmarcRecord' => [ + 'type' => 'string', + ], + 'DmarcAuthStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'DmarcHostRecord' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainId.Malformed', + 'errorMessage' => 'The specified domainId does not exist.', + ], + [ + 'errorCode' => 'InvalidDomain.Using', + 'errorMessage' => 'The specified domain has been used to create mailAddress.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The specified domain does not found.', + ], + [ + 'errorCode' => 'InvalidDomainId.NotFound', + 'errorMessage' => 'The specified domainId is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'GetTrackList' => [ + 'summary' => '调用GetTrackList邮件跟踪获取发送数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间，时间不能早于30日，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-09-29', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，和起始时间跨度不能超出7天，格式yyyy-MM-dd。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-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中sOffsetCreateTime值（本字段已废弃）', + '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' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', + ], + 'OffsetCreateTime' => [ + 'description' => '分页用，第一次查询不设置，后续查询设置为上一次Response中sOffsetCreateTime值（本字段已废弃）', + 'type' => 'string', + 'example' => '（本字段已废弃）', + ], + 'PageNo' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'OffsetCreateTimeDesc' => [ + 'description' => '（本字段已废弃）', + 'type' => 'string', + 'example' => '（本字段已废弃）', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'stat' => [ + 'description' => '跟踪数据记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RcptClickRate' => [ + 'description' => '点击率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueOpenCount' => [ + 'description' => '独立打开数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RcptClickCount' => [ + 'description' => '点击量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RcptUniqueClickCount' => [ + 'description' => '独立点击数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2019-09-29T13:28Z', + ], + 'RcptUniqueOpenRate' => [ + 'description' => '独立打开率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptUniqueClickRate' => [ + 'description' => '独立点击率', + 'type' => 'string', + 'example' => '0', + ], + 'TotalNumber' => [ + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RcptOpenRate' => [ + 'description' => '打开率', + 'type' => 'string', + 'example' => '0', + ], + 'RcptOpenCount' => [ + 'description' => '打开量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"OffsetCreateTime\\": \\"（本字段已废弃）\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"OffsetCreateTimeDesc\\": \\"（本字段已废弃）\\",\\n \\"data\\": {\\n \\"stat\\": [\\n {\\n \\"RcptClickRate\\": \\"0\\",\\n \\"RcptUniqueOpenCount\\": 0,\\n \\"RcptClickCount\\": 0,\\n \\"RcptUniqueClickCount\\": 0,\\n \\"CreateTime\\": 0,\\n \\"RcptUniqueOpenRate\\": \\"0\\",\\n \\"RcptUniqueClickRate\\": \\"0\\",\\n \\"TotalNumber\\": 0,\\n \\"RcptOpenRate\\": \\"0\\",\\n \\"RcptOpenCount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '邮件跟踪获取发送数据', + ], + 'QueryTaskByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'task' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiversName' => [ + 'type' => 'string', + ], + 'TagName' => [ + 'type' => 'string', + ], + 'TaskStatus' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'RequestCount' => [ + 'type' => 'string', + ], + 'AddressType' => [ + 'type' => 'string', + ], + 'UtcCreateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TemplateName' => [ + 'type' => 'string', + ], + 'TaskId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKeyword.Malformed', + 'errorMessage' => 'The specified keyword is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidStatus.Malformed', + 'errorMessage' => 'The specified status is wrongly formed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'BatchSendMail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ReceiversName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AddressType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1', + 'minimum' => '0', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ReplyAddressAlias', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClickTrace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'UnSubscribeLinkType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'UnSubscribeFilterLevel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnvId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified MailAddress name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateName.Malformed', + 'errorMessage' => 'The specified template name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidSendMail.Spam', + 'errorMessage' => 'Sendmail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidMailAddressSendType.Malformed', + 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressStatus.Malformed', + 'errorMessage' => 'The specified mailAddress status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressDomain.Malformed', + 'errorMessage' => 'The specified mailAddress domain does not exist.', + ], + [ + 'errorCode' => 'InvalidTemplateStatus.Malformed', + 'errorMessage' => 'The specified template status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverStatus.Malformed', + 'errorMessage' => 'The specified receivers status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReplyAddressAlias.Malformed', + 'errorMessage' => 'The specified replyAddressAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReplyAddress.Malformed', + 'errorMessage' => 'The specified replyAddress is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not exist.', + ], + [ + 'errorCode' => 'InvalidTemplate.NotFound', + 'errorMessage' => 'The specified template does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not exist.', + ], + [ + 'errorCode' => 'InvalidIP.NotFound', + 'errorMessage' => 'Invalid IP', + ], + ], + ], + 'responseDemo' => '', + ], + 'SenderStatisticsByTagNameAndBatchID' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'stat' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'unavailablePercent' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'succeededPercent' => [ + 'type' => 'string', + ], + 'faildCount' => [ + 'type' => 'string', + ], + 'unavailableCount' => [ + 'type' => 'string', + ], + 'successCount' => [ + 'type' => 'string', + ], + 'requestCount' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDate.Malformed', + 'errorMessage' => 'The specified date is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Start time should earlyer than end time.', + ], + [ + 'errorCode' => 'InvalidBetweenTime.Malformed', + 'errorMessage' => 'More than seven days between start time and end time.', + ], + [ + 'errorCode' => 'InvalidYear.Malformed', + 'errorMessage' => 'The specified year is invalid.', + ], + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDate.NotFound', + 'errorMessage' => 'The specified date does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'SenderStatisticsDetailByParam' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ToAddress', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4', + 'minimum' => '0', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'NextStart', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextStart' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'mailDetail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LastUpdateTime' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'ToAddress' => [ + 'type' => 'string', + ], + 'UtcLastUpdateTime' => [ + 'type' => 'string', + ], + 'AccountName' => [ + 'type' => 'string', + ], + 'Subject' => [ + 'type' => 'string', + ], + 'ErrorClassification' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDate.Malformed', + 'errorMessage' => 'The specified date is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Start time should earlyer than end time.', + ], + [ + 'errorCode' => 'InvalidBetweenTime.Malformed', + 'errorMessage' => 'More than seven days between start time and end time.', + ], + [ + 'errorCode' => 'InvalidYear.Malformed', + 'errorMessage' => 'The specified year is invalid.', + ], + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not exist.', + ], + [ + 'errorCode' => 'InvalidKeyword.Malformed', + 'errorMessage' => 'The specified keyword is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTagName.Malformed', + 'errorMessage' => 'The specified tag name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied', + ], + [ + 'errorCode' => 'InvalidToAddress', + 'errorMessage' => 'The specified toAddress is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDate.NotFound', + 'errorMessage' => 'The specified date does not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'SingleSendMail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AddressType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1', + 'minimum' => '0', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ReplyToAddress', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ToAddress', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Subject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'HtmlBody', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TextBody', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'FromAlias', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ReplyAddress', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ReplyAddressAlias', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClickTrace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'UnSubscribeLinkType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'UnSubscribeFilterLevel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnvId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMailAddressName.Malformed', + 'errorMessage' => 'The specified mailAddress name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReceiverName.Malformed', + 'errorMessage' => 'The specified receiver name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidTemplateName.Malformed', + 'errorMessage' => 'The specified template name is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidToAddress', + 'errorMessage' => 'The specified toAddress is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidToAddress.Spam', + 'errorMessage' => 'Sendmail rejected by invalid address.', + ], + [ + 'errorCode' => 'InvalidBody', + 'errorMessage' => 'The specified textBody or htmlBody is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidSendMail.Spam', + 'errorMessage' => 'Sendmail rejected by spam filter.', + ], + [ + 'errorCode' => 'InvalidMailAddressSendType.Malformed', + 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressStatus.Malformed', + 'errorMessage' => 'The specified mailAddress status is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidMailAddressDomain.Malformed', + 'errorMessage' => 'The specified mailAddress domain does not exist.', + ], + [ + 'errorCode' => 'InvalidSubject.Malformed', + 'errorMessage' => 'The specified subject is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidFromAlias.Malformed', + 'errorMessage' => 'The specified fromAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReplyAddressAlias.Malformed', + 'errorMessage' => 'The specified replyAddressAlias is wrongly formed.', + ], + [ + 'errorCode' => 'InvalidReplyAddress.Malformed', + 'errorMessage' => 'The specified replyAddress is wrongly formed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidMailAddress.NotFound', + 'errorMessage' => 'The specified mailAddress does not exist.', + ], + [ + 'errorCode' => 'InvalidTemplate.NotFound', + 'errorMessage' => 'The specified template does not exist.', + ], + [ + 'errorCode' => 'InvalidReceiver.NotFound', + 'errorMessage' => 'The specified receiver does not exist.', + ], + [ + 'errorCode' => 'InvalidIP.NotFound', + 'errorMessage' => 'Invalid IP', + ], + ], + ], + 'responseDemo' => '', + ], + 'AddIpfilter' => [ + 'summary' => '调用dipfilter接口筛选条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP地址/IP区间/IP段', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '单个IP格式，如：xxx.xxx.xxx.xxxIP区间格式，如：xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxxIP段格式，如：xxx.xxx.xxx.xxx/xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F814E960-5AEE-5CB1-881B-6F1A3250B55A', + ], + 'IpFilterId' => [ + 'description' => 'ip对应的ID', + 'type' => 'string', + 'example' => '10795', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F814E960-5AEE-5CB1-881B-6F1A3250B55A\\",\\n \\"IpFilterId\\": \\"10795\\"\\n}","errorExample":""},{"type":"xml","example":"<AddIpfilterResponse>\\n <RequestId>F814E960-5AEE-5CB1-881B-6F1A3250B55A</RequestId>\\n <IpFilterId>10795</IpFilterId>\\n</AddIpfilterResponse>","errorExample":""}]', + 'title' => '添加IP白名单', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dm.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dm.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'dm.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dm.eu-central-1.aliyuncs.com', + ], + ], +]; |