'1.0', 'info' => ['style' => 'RPC', 'product' => 'Dm', 'version' => '2017-06-22'], 'directories' => [ [ 'id' => 60684, 'title' => null, 'type' => 'directory', 'children' => ['CreateMailAddress', 'DeleteMailAddress', 'QueryInvalidAddress', 'QueryMailAddressByParam'], ], [ 'id' => 60689, 'title' => null, 'type' => 'directory', 'children' => ['ModifyMailAddress', 'GetAccountList', 'DescAccountSummary'], ], [ 'id' => 60694, 'title' => null, 'type' => 'directory', 'children' => ['CreateTag', 'DeleteTag', 'ModifyTag', 'QueryTagByParam'], ], [ 'id' => 60699, 'title' => null, 'type' => 'directory', 'children' => ['CreateReceiver', 'DeleteReceiver', 'DeleteReceiverDetail', 'QueryReceiverByParam', 'QueryReceiverDetail', 'SaveReceiverDetail'], ], [ 'id' => 60707, 'title' => null, 'type' => 'directory', 'children' => ['CreateTemplate', 'DeleteTemplate', 'ModifyTemplate', 'QueryTemplateByParam', 'DescTemplate'], ], [ 'id' => 60713, 'title' => null, 'type' => 'directory', 'children' => ['CreateDomain', 'DeleteDomain', 'QueryDomainByParam', 'CheckDomain', 'DescDomain'], ], [ 'id' => 60719, 'title' => null, 'type' => 'directory', 'children' => ['GetTrackList', 'QueryTaskByParam', 'BatchSendMail', 'SenderStatisticsByTagNameAndBatchID', 'SenderStatisticsDetailByParam', 'SingleSendMail'], ], [ 'id' => 0, 'title' => '其它', 'type' => 'directory', 'children' => ['AddIpfilter'], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateMailAddress' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ReplyAddress', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Sendtype', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MailAddressId' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'responseDemo' => null, ], 'DeleteMailAddress' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'MailAddressId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidMailAddressName.Duplicate', 'errorMessage' => 'The specified mailAddress accountName is already existed'], ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified MailAddress accountName is wrongly formed.'], ['errorCode' => 'InvalidMailAddressNumber.Malformed', 'errorMessage' => 'The amount of MailAddress exceeds the limit.'], ['errorCode' => 'InvalidMailAddressId.Malformed', 'errorMessage' => 'The specified MailAddressId does not exist.'], ['errorCode' => 'InvalidMailAddressReplyName.Malformed', 'errorMessage' => 'The specified mailAddress replyAddress is wrongly formed.'], ['errorCode' => 'InvalidMailAddressSendType.Malformed', 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.'], ['errorCode' => 'InvalidMailAddressDomain.Malformed', 'errorMessage' => 'The specified mailAddress domain does not exist.'], ['errorCode' => 'InvalidMailAddressDomainStatus.Malformed', 'errorMessage' => 'The mailAddress domain Status is wrongly formed.'], ['errorCode' => 'InvalidMailAddressStatus.Malformed', 'errorMessage' => 'The specified mailAddress status is wrongly formed.'], ['errorCode' => 'InvalidMailAddressTicket.Malformed', 'errorMessage' => 'The specified mailAddress ticket does not exist.'], ['errorCode' => 'InvalidMailAddress.delteTimes', 'errorMessage' => 'Maximum number of deletion'], ], 404 => [ ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryInvalidAddress' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10'], ], [ 'name' => 'NextStart', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextStart' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'mailDetail' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LastUpdateTime' => ['type' => 'string'], 'ToAddress' => ['type' => 'string'], 'UtcLastUpdateTime' => ['type' => 'integer', 'format' => 'int64'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDate.Malformed', 'errorMessage' => 'The specified date is wrongly formed.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'Start time should earlyer than end time.'], ['errorCode' => 'InvalidBetweenTime.Malformed', 'errorMessage' => 'More than seven days between start time and end time.'], ['errorCode' => 'InvalidYear.Malformed', 'errorMessage' => 'The specified year is invalid.'], ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.'], ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not exist.'], ['errorCode' => 'InvalidKeyword.Malformed', 'errorMessage' => 'The specified keyword is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidDate.NotFound', 'errorMessage' => 'The specified date does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryMailAddressByParam' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'default' => '500'], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Sendtype', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'mailAddress' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MailAddressId' => ['type' => 'string'], 'MonthCount' => ['type' => 'string'], 'AccountStatus' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], 'ReplyStatus' => ['type' => 'string'], 'Sendtype' => ['type' => 'string'], 'MonthReqCount' => ['type' => 'string'], 'ReplyAddress' => ['type' => 'string'], 'DailyReqCount' => ['type' => 'string'], 'DailyCount' => ['type' => 'string'], 'DomainStatus' => ['type' => 'string'], 'AccountName' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'responseDemo' => null, ], 'ModifyMailAddress' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'MailAddressId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ReplyAddress', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidMailAddressName.Duplicate', 'errorMessage' => 'The specified mailAddress accountName is already existed'], ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified MailAddress accountName is wrongly formed.'], ['errorCode' => 'InvalidMailAddressNumber.Malformed', 'errorMessage' => 'The amount of MailAddress exceeds the limit.'], ['errorCode' => 'InvalidMailAddressId.Malformed', 'errorMessage' => 'The specified MailAddressId does not exist.'], ['errorCode' => 'InvalidMailAddressReplyName.Malformed', 'errorMessage' => 'The specified mailAddress replyAddress is wrongly formed.'], ['errorCode' => 'InvalidMailAddressSendType.Malformed', 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.'], ['errorCode' => 'InvalidMailAddressDomain.Malformed', 'errorMessage' => 'The specified mailAddress domain does not exist.'], ['errorCode' => 'InvalidMailAddressDomainStatus.Malformed', 'errorMessage' => 'The mailAddress domain Status is wrongly formed.'], ['errorCode' => 'InvalidMailAddressStatus.Malformed', 'errorMessage' => 'The specified mailAddress status is wrongly formed.'], ['errorCode' => 'InvalidMailAddressTicket.Malformed', 'errorMessage' => 'The specified mailAddress ticket does not exist.'], ['errorCode' => 'InvalidMailAddressPassword.Malformed', 'errorMessage' => 'The specified mailAddress password is wrongly formed.'], ['errorCode' => 'InvalidMailAddressPassword.equalcurrent', 'errorMessage' => 'The password can not equal current one.'], ], 404 => [ ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'GetAccountList' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Total', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Offset', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'OffsetCreateTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'OffsetCreateTimeDesc', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNo' => ['type' => 'integer', 'format' => 'int32'], 'PageSize' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'Total' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'accountNotificationInfo' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['type' => 'string'], 'UpdateTime' => ['type' => 'string'], 'Region' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDate.Malformed', 'errorMessage' => 'The specified date is wrongly formed.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'Start time should earlyer than end time.'], ['errorCode' => 'InvalidBetweenTime.Malformed', 'errorMessage' => 'More than seven days between start time and end time.'], ['errorCode' => 'InvalidYear.Malformed', 'errorMessage' => 'The specified year is invalid.'], ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.'], ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not exist.'], ], 404 => [ ['errorCode' => 'InvalidDate.NotFound', 'errorMessage' => 'The specified date does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DescAccountSummary' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EnableTimes' => ['type' => 'integer', 'format' => 'int32'], 'SmsSign' => ['type' => 'integer', 'format' => 'int32'], 'MonthQuota' => ['type' => 'integer', 'format' => 'int32'], 'Receivers' => ['type' => 'integer', 'format' => 'int32'], 'DayuStatus' => ['type' => 'integer', 'format' => 'int32'], 'DailyQuota' => ['type' => 'integer', 'format' => 'int32'], 'SmsRecord' => ['type' => 'integer', 'format' => 'int32'], 'Tags' => ['type' => 'integer', 'format' => 'int32'], 'Templates' => ['type' => 'integer', 'format' => 'int32'], 'MailAddresses' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'QuotaLevel' => ['type' => 'integer', 'format' => 'int32'], 'MaxQuotaLevel' => ['type' => 'integer', 'format' => 'int32'], 'Domains' => ['type' => 'integer', 'format' => 'int32'], 'UserStatus' => ['type' => 'integer', 'format' => 'int32'], 'SmsTemplates' => ['type' => 'integer', 'format' => 'int32'], 'RemainFreeQuota' => ['type' => 'integer', 'format' => 'int32'], 'DailyRemainFreeQuota' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'User.Blacklisted', 'errorMessage' => 'The specified user is in the blacklist.'], ['errorCode' => 'User.RegisterTooMuch', 'errorMessage' => 'The specified user has registered more than one DirectMail account.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'CreateTag' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ 'name' => 'TagDescription', 'in' => 'query', 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'test description'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TagId' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTagName.Malformed', 'errorMessage' => 'The specified tag name is wrongly formed.'], ['errorCode' => 'InvalidTagName.Duplicate', 'errorMessage' => 'The specified tag name is already existed.'], ['errorCode' => 'InvalidTagNumber.Malformed', 'errorMessage' => 'The amount of tag exceeds the limit.'], ['errorCode' => 'InvalidTagId.Malformed', 'errorMessage' => 'The specified tagId does not exist.'], ], 404 => [ ['errorCode' => 'InvalidTag.NotFound', 'errorMessage' => 'The specified tag does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagId\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', ], 'DeleteTag' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TagId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTagName.Malformed', 'errorMessage' => 'The specified tag name is wrongly formed.'], ['errorCode' => 'InvalidTagName.Duplicate', 'errorMessage' => 'The specified tag name is already existed.'], ['errorCode' => 'InvalidTagNumber.Malformed', 'errorMessage' => 'The amount of tag exceeds the limit.'], ['errorCode' => 'InvalidTagId.Malformed', 'errorMessage' => 'The specified tagId does not exist.'], ], 404 => [ ['errorCode' => 'InvalidTag.NotFound', 'errorMessage' => 'The specified tag does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'ModifyTag' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TagId', 'in' => 'query', 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '123'], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ 'name' => 'TagDescription', 'in' => 'query', 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'test description'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTagName.Malformed', 'errorMessage' => 'The specified tag name is wrongly formed.'], ['errorCode' => 'InvalidTagName.Duplicate', 'errorMessage' => 'The specified tag name is already existed.'], ['errorCode' => 'InvalidTagNumber.Malformed', 'errorMessage' => 'The amount of tag exceeds the limit.'], ['errorCode' => 'InvalidTagId.Malformed', 'errorMessage' => 'The specified tagId does not exist.'], ], 404 => [ ['errorCode' => 'InvalidTag.NotFound', 'errorMessage' => 'The specified tag does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', ], 'QueryTagByParam' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'default' => '500'], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837'], 'PageNumber' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'tag' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TagName' => ['description' => '', 'type' => 'string', 'example' => 'test'], 'TagId' => ['description' => '', 'type' => 'string', 'example' => '52366'], 'TagDescription' => ['description' => '', 'type' => 'string', 'example' => 'test description'], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"PageNumber\\": 5,\\n \\"TotalCount\\": 2,\\n \\"data\\": {\\n \\"tag\\": [\\n {\\n \\"TagName\\": \\"test\\",\\n \\"TagId\\": \\"52366\\",\\n \\"TagDescription\\": \\"test description\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'CreateReceiver' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ReceiversName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ReceiversAlias', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Desc', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ReceiverId' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidReceiverName.Duplicate', 'errorMessage' => 'The specified receiver name is already existed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidReceiverNumber.Malformed', 'errorMessage' => 'The amount of receiver exceeds the limit.'], ['errorCode' => 'InvalidReceiverId.Malformed', 'errorMessage' => 'The specified receiverId does not exist.'], ['errorCode' => 'InvalidReceiverStatus.Malformed', 'errorMessage' => 'The specified receivers status is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetailMax.Malformed', 'errorMessage' => 'The amount of receivers detail exceeds the limit.'], ['errorCode' => 'InvalidReceiverDesc.Malformed', 'errorMessage' => 'The specified receiversDesc is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Malformed', 'errorMessage' => 'The specified receivers detail is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Spam', 'errorMessage' => 'The specified receiver detail rejected by spam filter.'], ['errorCode' => 'InvalidReceiverAlias.Malformed', 'errorMessage' => 'The specified receiversAlias is wrongly formed.'], ['errorCode' => 'InvalidReceiverAlias.Duplicate', 'errorMessage' => 'The specified receiversAlias is already existed.'], ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied'], ], 404 => [ ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DeleteReceiver' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ReceiverId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidReceiverName.Duplicate', 'errorMessage' => 'The specified receiver name is already existed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidReceiverNumber.Malformed', 'errorMessage' => 'The amount of receiver exceeds the limit.'], ['errorCode' => 'InvalidReceiverId.Malformed', 'errorMessage' => 'The specified receiverId does not exist.'], ['errorCode' => 'InvalidReceiverStatus.Malformed', 'errorMessage' => 'The specified receivers status is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetailMax.Malformed', 'errorMessage' => 'The amount of receivers detail exceeds the limit.'], ['errorCode' => 'InvalidReceiverDesc.Malformed', 'errorMessage' => 'The specified receiversDesc is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Malformed', 'errorMessage' => 'The specified receivers detail is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Spam', 'errorMessage' => 'The specified receiver detail rejected by spam filter.'], ['errorCode' => 'InvalidReceiverAlias.Malformed', 'errorMessage' => 'The specified receiversAlias is wrongly formed.'], ['errorCode' => 'InvalidReceiverAlias.Duplicate', 'errorMessage' => 'The specified receiversAlias is already existed.'], ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied'], ], 404 => [ ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DeleteReceiverDetail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ReceiverId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidReceiverName.Duplicate', 'errorMessage' => 'The specified receiver name is already existed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidReceiverNumber.Malformed', 'errorMessage' => 'The amount of receiver exceeds the limit.'], ['errorCode' => 'InvalidReceiverId.Malformed', 'errorMessage' => 'The specified receiverId does not exist.'], ['errorCode' => 'InvalidReceiverStatus.Malformed', 'errorMessage' => 'The specified receivers status is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetailMax.Malformed', 'errorMessage' => 'The amount of receivers detail exceeds the limit.'], ['errorCode' => 'InvalidReceiverDesc.Malformed', 'errorMessage' => 'The specified receiversDesc is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Malformed', 'errorMessage' => 'The specified receivers detail is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Spam', 'errorMessage' => 'The specified receiver detail rejected by spam filter.'], ['errorCode' => 'InvalidReceiverAlias.Malformed', 'errorMessage' => 'The specified receiversAlias is wrongly formed.'], ['errorCode' => 'InvalidReceiverAlias.Duplicate', 'errorMessage' => 'The specified receiversAlias is already existed.'], ['errorCode' => 'InvalidStatus.Malformed', 'errorMessage' => 'The specified status is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetatil.NotFound', 'errorMessage' => 'The specified receiver detail does not found.'], ['errorCode' => 'InvalidReceiverEmail.Malformed', 'errorMessage' => 'The specified receiver email is wrongly formed.'], ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied'], ], 404 => [ ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryReceiverByParam' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'default' => '40'], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextStart' => ['type' => 'string'], 'PageSize' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'receiver' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReceiversAlias' => ['type' => 'string'], 'ReceiversName' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], 'ReceiverId' => ['type' => 'string'], 'UtcCreateTime' => ['type' => 'integer', 'format' => 'int64'], 'ReceiversStatus' => ['type' => 'string'], 'Count' => ['type' => 'string'], 'Desc' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidReceiverName.Duplicate', 'errorMessage' => 'The specified receiver name is already existed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidReceiverNumber.Malformed', 'errorMessage' => 'The amount of receiver exceeds the limit.'], ['errorCode' => 'InvalidReceiverId.Malformed', 'errorMessage' => 'The specified receiverId does not exist.'], ['errorCode' => 'InvalidReceiverStatus.Malformed', 'errorMessage' => 'The specified receivers status is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetailMax.Malformed', 'errorMessage' => 'The amount of receivers detail exceeds the limit.'], ['errorCode' => 'InvalidReceiverDesc.Malformed', 'errorMessage' => 'The specified receiversDesc is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Malformed', 'errorMessage' => 'The specified receivers detail is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Spam', 'errorMessage' => 'The specified receiver detail rejected by spam filter.'], ['errorCode' => 'InvalidReceiverAlias.Malformed', 'errorMessage' => 'The specified receiversAlias is wrongly formed.'], ['errorCode' => 'InvalidReceiverAlias.Duplicate', 'errorMessage' => 'The specified receiversAlias is already existed.'], ['errorCode' => 'InvalidStatus.Malformed', 'errorMessage' => 'The specified status is wrongly formed.'], ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied'], ], 404 => [ ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryReceiverDetail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ReceiverId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'default' => '40'], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'NextStart', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DataSchema' => ['type' => 'string'], 'NextStart' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'detail' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Data' => ['type' => 'string'], 'UtcCreateTime' => ['type' => 'integer', 'format' => 'int64'], 'Email' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidReceiverName.Duplicate', 'errorMessage' => 'The specified receiver name is already existed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidReceiverNumber.Malformed', 'errorMessage' => 'The amount of receiver exceeds the limit.'], ['errorCode' => 'InvalidReceiverId.Malformed', 'errorMessage' => 'The specified receiverId does not exist.'], ['errorCode' => 'InvalidReceiverStatus.Malformed', 'errorMessage' => 'The specified receivers status is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetailMax.Malformed', 'errorMessage' => 'The amount of receivers detail exceeds the limit.'], ['errorCode' => 'InvalidReceiverDesc.Malformed', 'errorMessage' => 'The specified receiversDesc is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Malformed', 'errorMessage' => 'The specified receivers detail is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Spam', 'errorMessage' => 'The specified receiver detail rejected by spam filter.'], ['errorCode' => 'InvalidReceiverAlias.Malformed', 'errorMessage' => 'The specified receiversAlias is wrongly formed.'], ['errorCode' => 'InvalidReceiverAlias.Duplicate', 'errorMessage' => 'The specified receiversAlias is already existed.'], ['errorCode' => 'InvalidStatus.Malformed', 'errorMessage' => 'The specified status is wrongly formed.'], ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied'], ], 404 => [ ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'SaveReceiverDetail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'ReceiverId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Detail', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ErrorCount' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'SuccessCount' => ['type' => 'integer', 'format' => 'int32'], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Detail' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Email' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidReceiverName.Duplicate', 'errorMessage' => 'The specified receiver name is already existed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidReceiverNumber.Malformed', 'errorMessage' => 'The amount of receiver exceeds the limit.'], ['errorCode' => 'InvalidReceiverId.Malformed', 'errorMessage' => 'The specified receiverId does not exist.'], ['errorCode' => 'InvalidReceiverStatus.Malformed', 'errorMessage' => 'The specified receivers status is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetailMax.Malformed', 'errorMessage' => 'The amount of receivers detail exceeds the limit.'], ['errorCode' => 'InvalidReceiverDesc.Malformed', 'errorMessage' => 'The specified receiversDesc is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Malformed', 'errorMessage' => 'The specified receivers detail is wrongly formed.'], ['errorCode' => 'InvalidReceiverDetail.Spam', 'errorMessage' => 'The specified receiver detail rejected by spam filter.'], ['errorCode' => 'InvalidReceiverAlias.Malformed', 'errorMessage' => 'The specified receiversAlias is wrongly formed.'], ['errorCode' => 'InvalidReceiverAlias.Duplicate', 'errorMessage' => 'The specified receiversAlias is already existed.'], ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied'], ], 404 => [ ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'CreateTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '0', 'default' => '0'], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'TemplateSubject', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TemplateNickName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TemplateText', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SmsType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'SmsContent', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'FromType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TemplateId' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTemplateName.Duplicate', 'errorMessage' => 'The specified template name is already existed.'], ['errorCode' => 'InvalidTemplateName.Malformed', 'errorMessage' => 'The specified template name is wrongly formed.'], ['errorCode' => 'InvalidTemplateNumber.Malformed', 'errorMessage' => 'The amount of template exceeds the limit.'], ['errorCode' => 'InvalidTemplateId.Malformed', 'errorMessage' => 'TemplateId does not exist.'], ['errorCode' => 'InvalidTemplateNickName.Malformed', 'errorMessage' => 'The specified template nickName is wrongly formed.'], ['errorCode' => 'InvalidTemplateSubject.Malformed', 'errorMessage' => 'The specified template subject is wrongly formed.'], ['errorCode' => 'InvalidTemplateRemark.Malformed', 'errorMessage' => 'The specified template remark is wrongly formed.'], ['errorCode' => 'InvalidTemplateSmsContent.Malformed', 'errorMessage' => 'The specified template smsContent is wrongly formed.'], ['errorCode' => 'InvalidTemplateType.Malformed', 'errorMessage' => 'The specified template type is wrongly formed.'], ['errorCode' => 'InvalidTemplateSmsType.Malformed', 'errorMessage' => 'The specified template smsType is wrongly formed.'], ['errorCode' => 'InvalidTemplateStatus.Malformed', 'errorMessage' => 'The specified template status is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'The specified template does not found.'], ['errorCode' => 'MissingTemplateText', 'errorMessage' => 'TemplateText is mandatory for this action.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DeleteTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], [ 'name' => 'FromType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTemplateName.Duplicate', 'errorMessage' => 'The specified template name is already existed.'], ['errorCode' => 'InvalidTemplateName.Malformed', 'errorMessage' => 'The specified template name is wrongly formed.'], ['errorCode' => 'InvalidTemplateNumber.Malformed', 'errorMessage' => 'The amount of template exceeds the limit.'], ['errorCode' => 'InvalidTemplateId.Malformed', 'errorMessage' => 'TemplateId does not exist.'], ['errorCode' => 'InvalidTemplateNickName.Malformed', 'errorMessage' => 'The specified template nickName is wrongly formed.'], ['errorCode' => 'InvalidTemplateSubject.Malformed', 'errorMessage' => 'The specified template subject is wrongly formed.'], ['errorCode' => 'InvalidTemplateStatus.Malformed', 'errorMessage' => 'The specified template status is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidDayuStatus.Malformed', 'errorMessage' => 'The specified dayu status is wrongly formed.'], ['errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'The specified template does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'ModifyTemplate' => [ 'summary' => '修改模板信息', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'TemplateSubject', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TemplateNickName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TemplateText', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SmsType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'SmsContent', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'FromType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'responseDemo' => null, ], 'QueryTemplateByParam' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'default' => '40'], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4', 'minimum' => '0'], ], [ 'name' => 'FromType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'template' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TemplateComment' => ['type' => 'string'], 'UtcCreatetime' => ['type' => 'integer', 'format' => 'int64'], 'Smsrejectinfo' => ['type' => 'integer', 'format' => 'int32'], 'SmsTemplateCode' => ['type' => 'integer', 'format' => 'int32'], 'CreateTime' => ['type' => 'string'], 'TemplateStatus' => ['type' => 'string'], 'TemplateType' => ['type' => 'integer', 'format' => 'int32'], 'TemplateName' => ['type' => 'string'], 'SmsStatus' => ['type' => 'integer', 'format' => 'int32'], 'TemplateId' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTemplateName.Duplicate', 'errorMessage' => 'The specified template name is already existed.'], ['errorCode' => 'InvalidTemplateName.Malformed', 'errorMessage' => 'The specified template name is wrongly formed.'], ['errorCode' => 'InvalidTemplateNumber.Malformed', 'errorMessage' => 'The amount of template exceeds the limit.'], ['errorCode' => 'InvalidTemplateId.Malformed', 'errorMessage' => 'TemplateId does not exist.'], ['errorCode' => 'InvalidTemplateNickName.Malformed', 'errorMessage' => 'The specified template nickName is wrongly formed.'], ['errorCode' => 'InvalidTemplateSubject.Malformed', 'errorMessage' => 'The specified template subject is wrongly formed.'], ['errorCode' => 'InvalidTemplateStatus.Malformed', 'errorMessage' => 'The specified template status is wrongly formed.'], ['errorCode' => 'InvalidKeyword.Malformed', 'errorMessage' => 'The specified keyword is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidDayuStatus.Malformed', 'errorMessage' => 'The specified dayu status is wrongly formed.'], ['errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'The specified template does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DescTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], [ 'name' => 'FromType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SmsContent' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], 'Remark' => ['type' => 'string'], 'SmsType' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], 'TemplateSubject' => ['type' => 'string'], 'TemplateStatus' => ['type' => 'string'], 'TemplateNickName' => ['type' => 'string'], 'TemplateType' => ['type' => 'string'], 'TemplateName' => ['type' => 'string'], 'TemplateText' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTemplateName.Duplicate', 'errorMessage' => 'The specified template name is already existed.'], ['errorCode' => 'InvalidTemplateName.Malformed', 'errorMessage' => 'The specified template name is wrongly formed.'], ['errorCode' => 'InvalidTemplateNumber.Malformed', 'errorMessage' => 'The amount of template exceeds the limit.'], ['errorCode' => 'InvalidTemplateId.Malformed', 'errorMessage' => 'TemplateId does not exist.'], ['errorCode' => 'InvalidTemplateNickName.Malformed', 'errorMessage' => 'The specified template nickName is wrongly formed.'], ['errorCode' => 'InvalidTemplateSubject.Malformed', 'errorMessage' => 'The specified template subject is wrongly formed.'], ['errorCode' => 'InvalidTemplateStatus.Malformed', 'errorMessage' => 'The specified template status is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidDayuStatus.Malformed', 'errorMessage' => 'The specified dayu status is wrongly formed.'], ['errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'The specified template does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'CreateDomain' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DomainId' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDomainName.Duplicate', 'errorMessage' => 'The specified domain name is already existed'], ['errorCode' => 'InvalidDomainName.DuplicateTLD', 'errorMessage' => 'The specified domain of top-level domain name already exists.'], ['errorCode' => 'InvalidDomainName.TimeOut', 'errorMessage' => 'The current response timeout, please try again later.'], ['errorCode' => 'InvalidDomainName.Malformed', 'errorMessage' => 'The specified domain name is wrongly formed.'], ['errorCode' => 'InvalidDomainNumber.Malformed', 'errorMessage' => 'The amount of domain exceeds the limit.'], ['errorCode' => 'InvalidDomainName.Conflict', 'errorMessage' => 'The specified domain name is already used by other user'], ], 404 => [ ['errorCode' => 'InvalidDomain.NotFound', 'errorMessage' => 'The specified domain does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'DeleteDomain' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'DomainId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDomainId.Malformed', 'errorMessage' => 'The specified domainId does not exist.'], ['errorCode' => 'InvalidDomain.Using', 'errorMessage' => 'The specified domain has been used to create mailAddress.'], ], 404 => [ ['errorCode' => 'InvalidDomain.NotFound', 'errorMessage' => 'The specified domain does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'QueryDomainByParam' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'default' => '20'], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'domain' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DomainRecord' => ['type' => 'string'], 'SpfAuthStatus' => ['type' => 'string'], 'MxAuthStatus' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], 'CnameAuthStatus' => ['type' => 'string'], 'ConfirmStatus' => ['type' => 'string'], 'IcpStatus' => ['type' => 'string'], 'UtcCreateTime' => ['type' => 'integer', 'format' => 'int64'], 'DomainStatus' => ['type' => 'string'], 'DomainName' => ['type' => 'string'], 'DomainId' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidKeyword.Malformed', 'errorMessage' => 'The specified keyword is wrongly formed.'], ['errorCode' => 'InvalidStatus.Malformed', 'errorMessage' => 'The specified status is wrongly formed.'], ], 403 => [ ['errorCode' => 'User.Blacklisted', 'errorMessage' => 'The specified user is in the blacklist.'], ['errorCode' => 'User.RegisterTooMuch', 'errorMessage' => 'The specified user has registered more than one DirectMail account.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'CheckDomain' => [ 'summary' => '校验域名状态', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DomainId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DomainStatus' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'responseDemo' => null, ], 'DescDomain' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DomainId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], [ 'name' => 'RequireRealTimeDnsRecords', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SpfRecord' => ['type' => 'string'], 'CnameConfirmStatus' => ['type' => 'string'], 'DefaultDomain' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], 'CnameRecord' => ['type' => 'string'], 'CnameAuthStatus' => ['type' => 'string'], 'IcpStatus' => ['type' => 'string'], 'DnsTxt' => ['type' => 'string'], 'DomainName' => ['type' => 'string'], 'DomainId' => ['type' => 'string'], 'DnsSpf' => ['type' => 'string'], 'SpfAuthStatus' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], 'MxRecord' => ['type' => 'string'], 'MxAuthStatus' => ['type' => 'string'], 'DnsMx' => ['type' => 'string'], 'DomainStatus' => ['type' => 'string'], 'TlDomainName' => ['type' => 'string'], 'TracefRecord' => ['type' => 'string'], 'DomainType' => ['type' => 'string'], 'SpfRecordV2' => ['type' => 'string'], 'DkimRR' => ['type' => 'string'], 'DkimPublicKey' => ['type' => 'string'], 'DkimAuthStatus' => ['type' => 'string'], 'HostRecord' => ['type' => 'string'], 'DnsDmarc' => ['type' => 'string'], 'DmarcRecord' => ['type' => 'string'], 'DmarcAuthStatus' => ['type' => 'integer', 'format' => 'int32'], 'DmarcHostRecord' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDomainId.Malformed', 'errorMessage' => 'The specified domainId does not exist.'], ['errorCode' => 'InvalidDomain.Using', 'errorMessage' => 'The specified domain has been used to create mailAddress.'], ], 404 => [ ['errorCode' => 'InvalidDomain.NotFound', 'errorMessage' => 'The specified domain does not found.'], ['errorCode' => 'InvalidDomainId.NotFound', 'errorMessage' => 'The specified domainId is not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'GetTrackList' => [ 'summary' => '获取打开、点击等跟踪行为的统计结果', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => '', 'docRequired' => true, 'example' => '2022-09-29', 'required' => true, 'type' => 'string'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => '', 'docRequired' => true, 'example' => '2022-09-29', 'required' => true, 'type' => 'string'], ], [ 'name' => 'Total', 'in' => 'query', 'schema' => ['description' => '', 'example' => '', 'required' => false, 'type' => 'string'], ], [ 'name' => 'Offset', 'in' => 'query', 'schema' => ['description' => '', 'example' => '', 'required' => false, 'type' => 'string'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => '', 'example' => '10', 'required' => false, 'type' => 'string'], ], [ 'name' => 'OffsetCreateTime', 'in' => 'query', 'schema' => ['description' => '', 'example' => '', 'required' => false, 'type' => 'string'], ], [ 'name' => 'OffsetCreateTimeDesc', 'in' => 'query', 'schema' => ['description' => '', 'example' => '', 'required' => false, 'type' => 'string'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => '', 'example' => '1', 'required' => false, 'type' => 'string'], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['type' => 'string'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ 'RequestId' => ['description' => '', 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', 'type' => 'string'], 'OffsetCreateTime' => ['description' => '', 'example' => '', 'type' => 'string'], 'PageNo' => ['description' => '', 'example' => '1', 'format' => 'int32', 'type' => 'integer'], 'PageSize' => ['description' => '', 'example' => '10', 'format' => 'int32', 'type' => 'integer'], 'Total' => ['description' => '', 'example' => '100', 'format' => 'int32', 'type' => 'integer'], 'OffsetCreateTimeDesc' => ['description' => '', 'example' => '', 'type' => 'string'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'stat' => [ 'description' => '', 'type' => 'array', 'items' => [ 'properties' => [ 'RcptClickRate' => ['description' => '', 'example' => '0', 'type' => 'string'], 'RcptUniqueOpenCount' => ['description' => '', 'example' => '0', 'format' => 'int64', 'type' => 'integer'], 'RcptClickCount' => ['description' => '', 'example' => '0', 'format' => 'int64', 'type' => 'integer'], 'RcptUniqueClickCount' => ['description' => '', 'example' => '0', 'format' => 'int64', 'type' => 'integer'], 'CreateTime' => ['description' => '', 'example' => '2019-09-29T13:28Z', 'format' => 'int64', 'type' => 'integer'], 'RcptUniqueOpenRate' => ['description' => '', 'example' => '0', 'type' => 'string'], 'RcptUniqueClickRate' => ['description' => '', 'example' => '0', 'type' => 'string'], 'TotalNumber' => ['description' => '', 'example' => '0', 'format' => 'int64', 'type' => 'integer'], 'RcptOpenRate' => ['description' => '', 'example' => '0', 'type' => 'string'], 'RcptOpenCount' => ['description' => '', 'example' => '0', 'format' => 'int64', 'type' => 'integer'], ], 'type' => 'object', ], ], ], ], ], 'type' => 'object', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"OffsetCreateTime\\": \\"（本字段已废弃）\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"OffsetCreateTimeDesc\\": \\"（本字段已废弃）\\",\\n \\"data\\": {\\n \\"stat\\": [\\n {\\n \\"RcptClickRate\\": \\"0\\",\\n \\"RcptUniqueOpenCount\\": 0,\\n \\"RcptClickCount\\": 0,\\n \\"RcptUniqueClickCount\\": 0,\\n \\"CreateTime\\": 0,\\n \\"RcptUniqueOpenRate\\": \\"0\\",\\n \\"RcptUniqueClickRate\\": \\"0\\",\\n \\"TotalNumber\\": 0,\\n \\"RcptOpenRate\\": \\"0\\",\\n \\"RcptOpenCount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'QueryTaskByParam' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'default' => '10'], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'task' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReceiversName' => ['type' => 'string'], 'TagName' => ['type' => 'string'], 'TaskStatus' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], 'RequestCount' => ['type' => 'string'], 'AddressType' => ['type' => 'string'], 'UtcCreateTime' => ['type' => 'integer', 'format' => 'int64'], 'TemplateName' => ['type' => 'string'], 'TaskId' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidKeyword.Malformed', 'errorMessage' => 'The specified keyword is wrongly formed.'], ['errorCode' => 'InvalidStatus.Malformed', 'errorMessage' => 'The specified status is wrongly formed.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'BatchSendMail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ReceiversName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'AddressType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1', 'minimum' => '0'], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ReplyAddress', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ReplyAddressAlias', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ClickTrace', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'UnSubscribeLinkType', 'in' => 'query', 'schema' => ['type' => 'string'], ], [ 'name' => 'UnSubscribeFilterLevel', 'in' => 'query', 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EnvId' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified MailAddress name is wrongly formed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidTemplateName.Malformed', 'errorMessage' => 'The specified template name is wrongly formed.'], ['errorCode' => 'InvalidSendMail.Spam', 'errorMessage' => 'Sendmail rejected by spam filter.'], ['errorCode' => 'InvalidMailAddressSendType.Malformed', 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.'], ['errorCode' => 'InvalidMailAddressStatus.Malformed', 'errorMessage' => 'The specified mailAddress status is wrongly formed.'], ['errorCode' => 'InvalidMailAddressDomain.Malformed', 'errorMessage' => 'The specified mailAddress domain does not exist.'], ['errorCode' => 'InvalidTemplateStatus.Malformed', 'errorMessage' => 'The specified template status is wrongly formed.'], ['errorCode' => 'InvalidReceiverStatus.Malformed', 'errorMessage' => 'The specified receivers status is wrongly formed.'], ['errorCode' => 'InvalidReplyAddressAlias.Malformed', 'errorMessage' => 'The specified replyAddressAlias is wrongly formed.'], ['errorCode' => 'InvalidReplyAddress.Malformed', 'errorMessage' => 'The specified replyAddress is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not exist.'], ['errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'The specified template does not exist.'], ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not exist.'], ['errorCode' => 'InvalidIP.NotFound', 'errorMessage' => 'Invalid IP'], ], ], 'responseDemo' => null, ], 'SenderStatisticsByTagNameAndBatchID' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'stat' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'unavailablePercent' => ['type' => 'string'], 'CreateTime' => ['type' => 'string'], 'succeededPercent' => ['type' => 'string'], 'faildCount' => ['type' => 'string'], 'unavailableCount' => ['type' => 'string'], 'successCount' => ['type' => 'string'], 'requestCount' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDate.Malformed', 'errorMessage' => 'The specified date is wrongly formed.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'Start time should earlyer than end time.'], ['errorCode' => 'InvalidBetweenTime.Malformed', 'errorMessage' => 'More than seven days between start time and end time.'], ['errorCode' => 'InvalidYear.Malformed', 'errorMessage' => 'The specified year is invalid.'], ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.'], ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not exist.'], ], 404 => [ ['errorCode' => 'InvalidDate.NotFound', 'errorMessage' => 'The specified date does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'SenderStatisticsDetailByParam' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ToAddress', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4', 'minimum' => '0'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Length', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10'], ], [ 'name' => 'NextStart', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextStart' => ['type' => 'integer', 'format' => 'int32'], 'RequestId' => ['type' => 'string'], 'data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'mailDetail' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['type' => 'integer', 'format' => 'int32'], 'LastUpdateTime' => ['type' => 'string'], 'Message' => ['type' => 'string'], 'ToAddress' => ['type' => 'string'], 'UtcLastUpdateTime' => ['type' => 'string'], 'AccountName' => ['type' => 'string'], 'Subject' => ['type' => 'string'], 'ErrorClassification' => ['type' => 'string'], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDate.Malformed', 'errorMessage' => 'The specified date is wrongly formed.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'Start time should earlyer than end time.'], ['errorCode' => 'InvalidBetweenTime.Malformed', 'errorMessage' => 'More than seven days between start time and end time.'], ['errorCode' => 'InvalidYear.Malformed', 'errorMessage' => 'The specified year is invalid.'], ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified mailAddress accountName is wrongly formed.'], ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not exist.'], ['errorCode' => 'InvalidKeyword.Malformed', 'errorMessage' => 'The specified keyword is wrongly formed.'], ['errorCode' => 'InvalidTagName.Malformed', 'errorMessage' => 'The specified tag name is wrongly formed.'], ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The input parameter is mandatory for processing this request is not supplied'], ['errorCode' => 'InvalidToAddress', 'errorMessage' => 'The specified toAddress is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidDate.NotFound', 'errorMessage' => 'The specified date does not found.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'], ], ], 'responseDemo' => null, ], 'SingleSendMail' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'AddressType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1', 'minimum' => '0'], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ReplyToAddress', 'in' => 'query', 'schema' => ['type' => 'boolean', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ToAddress', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Subject', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'HtmlBody', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TextBody', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'FromAlias', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ReplyAddress', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ReplyAddressAlias', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ClickTrace', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'UnSubscribeLinkType', 'in' => 'query', 'schema' => ['type' => 'string'], ], [ 'name' => 'UnSubscribeFilterLevel', 'in' => 'query', 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EnvId' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidMailAddressName.Malformed', 'errorMessage' => 'The specified mailAddress name is wrongly formed.'], ['errorCode' => 'InvalidReceiverName.Malformed', 'errorMessage' => 'The specified receiver name is wrongly formed.'], ['errorCode' => 'InvalidTemplateName.Malformed', 'errorMessage' => 'The specified template name is wrongly formed.'], ['errorCode' => 'InvalidToAddress', 'errorMessage' => 'The specified toAddress is wrongly formed.'], ['errorCode' => 'InvalidToAddress.Spam', 'errorMessage' => 'Sendmail rejected by invalid address.'], ['errorCode' => 'InvalidBody', 'errorMessage' => 'The specified textBody or htmlBody is wrongly formed.'], ['errorCode' => 'InvalidSendMail.Spam', 'errorMessage' => 'Sendmail rejected by spam filter.'], ['errorCode' => 'InvalidMailAddressSendType.Malformed', 'errorMessage' => 'The specified mailAddress sendType is wrongly formed.'], ['errorCode' => 'InvalidMailAddressStatus.Malformed', 'errorMessage' => 'The specified mailAddress status is wrongly formed.'], ['errorCode' => 'InvalidMailAddressDomain.Malformed', 'errorMessage' => 'The specified mailAddress domain does not exist.'], ['errorCode' => 'InvalidSubject.Malformed', 'errorMessage' => 'The specified subject is wrongly formed.'], ['errorCode' => 'InvalidFromAlias.Malformed', 'errorMessage' => 'The specified fromAlias is wrongly formed.'], ['errorCode' => 'InvalidReplyAddressAlias.Malformed', 'errorMessage' => 'The specified replyAddressAlias is wrongly formed.'], ['errorCode' => 'InvalidReplyAddress.Malformed', 'errorMessage' => 'The specified replyAddress is wrongly formed.'], ], 404 => [ ['errorCode' => 'InvalidMailAddress.NotFound', 'errorMessage' => 'The specified mailAddress does not exist.'], ['errorCode' => 'InvalidTemplate.NotFound', 'errorMessage' => 'The specified template does not exist.'], ['errorCode' => 'InvalidReceiver.NotFound', 'errorMessage' => 'The specified receiver does not exist.'], ['errorCode' => 'InvalidIP.NotFound', 'errorMessage' => 'Invalid IP'], ], ], 'responseDemo' => null, ], 'AddIpfilter' => [ 'summary' => '添加IP白名单', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'IpAddress', 'in' => 'query', 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'F814E960-5AEE-5CB1-881B-6F1A3250B55A'], 'IpFilterId' => ['description' => '', 'type' => 'string', 'example' => '10795'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F814E960-5AEE-5CB1-881B-6F1A3250B55A\\",\\n \\"IpFilterId\\": \\"10795\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F814E960-5AEE-5CB1-881B-6F1A3250B55A\\n 10795\\n","errorExample":""}]', ], ], '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'], ], ];