diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/dm/2016-08-25 | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/dm/2016-08-25')
| -rw-r--r-- | data/en_us/dm/2016-08-25/api-docs.php | 5240 |
1 files changed, 0 insertions, 5240 deletions
diff --git a/data/en_us/dm/2016-08-25/api-docs.php b/data/en_us/dm/2016-08-25/api-docs.php deleted file mode 100644 index 8472347..0000000 --- a/data/en_us/dm/2016-08-25/api-docs.php +++ /dev/null @@ -1,5240 +0,0 @@ -<?php return [ - 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Dm', - 'version' => '2016-08-25', - ], - 'directories' => [ - [ - 'id' => 60726, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'ModifyMailAddress', - 'DescAccountSummary', - ], - ], - [ - 'id' => 60729, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateMailAddress', - 'QueryInvalidAddress', - 'QueryMailAddressByParam', - 'ApproveReplyMailAddress', - ], - ], - [ - 'id' => 60734, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateReceiver', - 'DeleteReceiver', - 'DeleteReceiverDetail', - 'QueryReceiverByParam', - 'QueryReceiverDetail', - 'SaveReceiverDetail', - ], - ], - [ - 'id' => 60741, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateDomain', - 'DeleteDomain', - 'QueryDomainByParam', - 'CheckDomain', - ], - ], - [ - 'id' => 60746, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'QuerySmsStatistics', - 'QueryTaskByParam', - 'BatchSendMail', - 'CheckReplyToMailAddress', - 'SenderStatisticsByTagNameAndBatchID', - 'SenderStatisticsDetailByParam', - 'SendTestByTemplate', - 'SingleSendMail', - 'SingleSendSms', - ], - ], - [ - 'id' => 60756, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateTag', - 'DeleteTag', - 'ModifyTag', - ], - ], - [ - 'id' => 60760, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateSign', - 'DeleteSign', - 'QuerySignByParam', - 'QueryTagByParam', - ], - ], - [ - 'id' => 60765, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateTemplate', - 'DeleteTemplate', - 'ModifyTemplate', - 'QueryTemplateByParam', - 'ApproveMailTemplate', - 'ApproveSmsTemplate', - 'DescTemplate', - ], - ], - [ - 'id' => 0, - 'title' => '其它', - 'type' => 'directory', - 'children' => [ - 'CreateDayu', - ], - ], - ], - 'components' => [ - 'schemas' => [], - ], - 'apis' => [ - 'ModifyMailAddress' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'MailAddressId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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.', - ], - ], - 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' => null, - ], - 'DescAccountSummary' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - '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', - ], - 'Domains' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'SmsTemplates' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => null, - ], - 'CreateMailAddress' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'ReplyAddress', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Sendtype', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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.', - ], - ], - 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' => null, - ], - 'QueryInvalidAddress' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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' => null, - ], - 'QueryMailAddressByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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' => '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - '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' => 'InvalidKeyword.Malformed', - 'errorMessage' => 'The specified keyword is wrongly formed.', - ], - ], - 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' => null, - ], - 'ApproveReplyMailAddress' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'Ticket', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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.', - ], - ], - 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' => null, - ], - 'CreateReceiver' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'ReceiversName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'ReceiversAlias', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'Desc', - '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' => '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' => null, - ], - 'DeleteReceiver' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'ReceiverId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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' => null, - ], - 'DeleteReceiverDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'ReceiverId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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' => null, - ], - 'QueryReceiverByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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', - ], - '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' => null, - ], - 'QueryReceiverDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'ReceiverId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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', - ], - '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' => null, - ], - 'SaveReceiverDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ReceiverId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'Detail', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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' => null, - ], - 'CreateDomain' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDomainName.Duplicate', - 'errorMessage' => 'The specified domain name is already existed', - ], - [ - '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' => null, - ], - 'DeleteDomain' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'DomainId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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' => null, - ], - 'QueryDomainByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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' => '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', - ], - 'ConfirmStatus' => [ - 'type' => 'string', - ], - '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.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => null, - ], - 'CheckDomain' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'DomainId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDomainId.Malformed', - 'errorMessage' => 'The specified domainId does not exist.', - ], - ], - 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' => null, - ], - 'QuerySmsStatistics' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'FromType', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2', - 'minimum' => '1', - 'default' => '1', - ], - ], - ], - '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' => [ - 'faildCount' => [ - 'type' => 'string', - ], - 'successCount' => [ - 'type' => 'string', - ], - 'CreateTime' => [ - '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.', - ], - [ - 'errorCode' => 'InvalidDayuStatus.Malformed', - 'errorMessage' => 'The specified dayu status is wrongly formed.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => null, - ], - 'QueryTaskByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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', - ], - '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' => null, - ], - 'BatchSendMail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'TemplateName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'ReceiversName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'AddressType', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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, - ], - ], - ], - '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.', - ], - ], - ], - 'responseDemo' => null, - ], - 'CheckReplyToMailAddress' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'MailAddressId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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.', - ], - ], - 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' => null, - ], - 'SenderStatisticsByTagNameAndBatchID' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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' => null, - ], - 'SenderStatisticsDetailByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - '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', - ], - 'Message' => [ - 'type' => 'string', - ], - 'LastUpdateTime' => [ - 'type' => 'string', - ], - 'ToAddress' => [ - 'type' => 'string', - ], - 'AccountName' => [ - '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' => null, - ], - 'SendTestByTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'UserName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'NickName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Birthday', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Gender', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Mobile', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Email', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidTemplateVariable.Malformed', - 'errorMessage' => 'The specified template variable 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' => 'InvalidTemplateId.Malformed', - 'errorMessage' => 'TemplateId does not exist.', - ], - [ - 'errorCode' => 'InvalidMailAddressId.Malformed', - 'errorMessage' => 'The specified MailAddressId does not exist.', - ], - [ - 'errorCode' => 'InvalidMailAddressName.Malformed', - 'errorMessage' => 'The specified MailAddress accountName is wrongly formed.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidTemplate.NotFound', - 'errorMessage' => 'The specified template does not found.', - ], - [ - 'errorCode' => 'InvalidMailAddress.NotFound', - 'errorMessage' => 'The specified mailAddress does not found.', - ], - ], - ], - 'responseDemo' => null, - ], - 'SingleSendMail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'AddressType', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1', - 'minimum' => '0', - ], - ], - [ - 'name' => 'TagName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'ReplyToAddress', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => true, - ], - ], - [ - 'name' => 'ToAddress', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'Subject', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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, - ], - ], - ], - '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.', - ], - ], - ], - 'responseDemo' => null, - ], - 'SingleSendSms' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'SignName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'TemplateCode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'RecNum', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'ParamString', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidSignName.Malformed', - 'errorMessage' => 'The specified sign name is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidTemplateCode.Malformed', - 'errorMessage' => 'The specified templateCode is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidRecNum.Malformed', - 'errorMessage' => 'The specified recNum is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidParamString.Malformed', - 'errorMessage' => 'The specified paramString is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidParamStringTemplate.Malformed', - 'errorMessage' => 'The specified paramString and template is wrongly formed.', - ], - [ - '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' => 'InvalidDayuStatus.Malformed', - 'errorMessage' => 'The specified dayu status is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidSendSms', - 'errorMessage' => 'Frequency limit reaches.', - ], - [ - '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.', - ], - ], - ], - 'responseDemo' => null, - ], - 'CreateTag' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'TagName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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' => null, - ], - 'DeleteTag' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'TagId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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' => null, - ], - 'ModifyTag' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'TagId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - ], - ], - [ - 'name' => 'TagName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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' => null, - ], - 'CreateSign' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'SignName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'Remark', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'SignType', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3', - 'minimum' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'FileNames', - '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', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidSignName.Malformed', - 'errorMessage' => 'The specified sign name is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidSignName.Duplicate', - 'errorMessage' => 'The specified sign name is already existed.', - ], - [ - 'errorCode' => 'InvalidSignNumber.Malformed', - 'errorMessage' => 'The amount of sign exceeds the limit.', - ], - [ - 'errorCode' => 'InvalidSignFileNames.Malformed', - 'errorMessage' => 'The specified sign fileNames does not found.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidSign.NotFound', - 'errorMessage' => 'The specified sign does not found.', - ], - [ - 'errorCode' => 'InvalidDayuStatus.Malformed', - 'errorMessage' => 'The specified dayu status is wrongly formed.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => null, - ], - 'DeleteSign' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'SignId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => 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' => 'InvalidKeyword.Malformed', - 'errorMessage' => 'The specified keyword is wrongly formed.', - ], - [ - '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' => null, - ], - 'QuerySignByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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' => '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', - ], - 'PageNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'data' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'sign' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Remark' => [ - 'type' => 'string', - ], - 'AuditState' => [ - 'type' => 'string', - ], - 'GmtCreate' => [ - 'type' => 'string', - ], - 'SignId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'SignName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'RejectInfo' => [ - 'type' => 'string', - ], - 'SignType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidKeyword.Malformed', - 'errorMessage' => 'The specified keyword is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidSignName.Malformed', - 'errorMessage' => 'The specified sign name is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidSignName.Duplicate', - 'errorMessage' => 'The specified sign name is already existed.', - ], - [ - 'errorCode' => 'InvalidSignNumber.Malformed', - 'errorMessage' => 'The amount of sign exceeds the limit.', - ], - [ - 'errorCode' => 'InvalidSignFileNames.Malformed', - 'errorMessage' => 'The specified sign fileNames does not found.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidSign.NotFound', - 'errorMessage' => 'The specified sign does not found.', - ], - [ - 'errorCode' => 'InvalidDayuStatus.Malformed', - 'errorMessage' => 'The specified dayu status is wrongly formed.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => null, - ], - 'QueryTagByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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, - ], - ], - ], - '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' => [ - 'tag' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TagName' => [ - 'type' => 'string', - ], - 'TagId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidKeyword.Malformed', - 'errorMessage' => 'The specified keyword is wrongly formed.', - ], - [ - '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' => null, - ], - 'CreateTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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, - ], - ], - [ - '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' => null, - ], - 'DeleteTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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' => null, - ], - 'ModifyTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - ], - ], - [ - 'name' => 'TemplateName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => 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', - ], - ], - ], - ], - ], - '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' => 'InvalidTemplateRemark.Malformed', - 'errorMessage' => 'The specified template remark is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidTemplateSmsContent.Malformed', - 'errorMessage' => 'The specified template smsContent is wrongly formed.', - ], - [ - 'errorCode' => 'InvalidTemplateSmsType.Malformed', - 'errorMessage' => 'The specified template smsType 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.', - ], - [ - 'errorCode' => 'MissingTemplateText', - 'errorMessage' => 'TemplateText is mandatory for this action.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => null, - ], - 'QueryTemplateByParam' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - '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', - ], - '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' => null, - ], - 'ApproveMailTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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' => null, - ], - 'ApproveSmsTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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' => null, - ], - 'DescTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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' => null, - ], - 'CreateDayu' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'AccountType', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => 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' => null, - ], - ], - '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', - ], - ], -]; |