Rules

API Request Format

https://api.sendcloud.net/apiv2/<module>/<action>

Module: name of function module, e.g. mail module, addresslist module.

Action: action of each module, e.g. send, add.

API Return Code

API is returned in the format of JSON.Sample is as below:

# 请求成功
{
  "result": true,
  "statusCode": 200,
  "message": "请求成功",
  "info": {}
}
# 认证失败
{
  "result": false,
  "statusCode": 40005,
  "message": "认证失败",
  "info": {}
}
# 数据获取成功
{
  "statusCode": 200,
  "info": {
    "data": {
      "gmtCreated": "2015-10-19 15:39:27",
      "gmtUpdated": "2015-10-19 15:39:27",
      "labelId": ***,
      "labelName": "test"
    }
  },
  "message": "请求成功",
  "result": true
}

API return codes are as follows:

API Return Code Meaning
200 request was successful
40000 duplicate request
40001 start cannot be empty
40002 invalid start
40003 limit cannot be empty
40004 invalid limit
40005 authentication failed
40006 invalid days format, it must be a positive integer within [1, 92]
400061 invalid days format, it must be a positive integer within [1, 3]
40007 invalid startDate format (e.g. "2013-03-19")
40008 invalid endDate format (e.g. "2013-03-19")
40009 labelIdList cannot be empty
40010 apiUserList cannot be empty
40011 email cannot be empty
40012 invalid email format
40013 domainList cannot be empty
40014 label ID cannot be empty
40015 invalid label ID format
40016 invalid apiUserList format
40017 invalid format of aggregation parameters
40018 no permission to invoke this API
40019 maillistTaskId cannot be empty or incorrect
40020 maillistTaskId does not exist
40021 startDate and endDate cannot be more than three months (92 days) apart
40022 days or (startDate and endDate) cannot be empty
40023 startDate and endDate cannot be more than 3 days apart
40024 emailIds cannot be empty
40025 this APIUSER is manually locked, please contact the platform administrator
40026 this APIUSER is automatically locked, please check the domain configuration
40027 emailId cannot be empty
40028 email addresses should be no more than 100
40029 ID cannot be empty; requestId cannot be empty
40030 requestId cannot be longer than 128 characters
40031 startDate and endDate cannot be empty
40032 labelId and the combination of startDate and endDate cannot both be empty
40033 the number of sendTags should be no more than 5
40034 each sendTag should be longer than 0 and no longer than 20 characters
40035 invalid sendTags format
40036 invalid request format
40100 label was successfully created
40101 failed to create label; failed to create sender
40102 label ID cannot be empty
40103 invalid label ID
40104 label name cannot be empty
40105 label name should be 1-255 characters
40106 the label corresponding to label ID does not exist
40107 label was successfully deleted
40108 failed to delete label
40109 label was successfully updated
40110 failed to update label
40111 query cannot be empty
40112 query should be 1-255 characters
40113 label name already exists
40114 label ID or label name cannot be empty
40115 label not exceed 110000
40116 label name does not exist
40117 label not exceed 500000
40201 invokeName cannot be empty
40202 invalid invokeName format
40203 template type cannot be empty
40204 invalid template type, it can only be 0 or 1
40205 templateStat cannot be empty
40206 invalid templateStat, it can only be one of -1, -2, 1, 0
40207 name cannot be empty
40208 invalid name format, no more than 64 English characters
40209 subject cannot be empty
40210 invalid subject format
40211 html cannot be empty
40212 invalid html format
40213 text cannot be empty
40214 invalid text format
40215 failed to create template
40216 the template corresponding to invokeName does not exist
40217 failed to delete template
40218 failed to update template
40219 user can have no more than 1000 templates
40220 invokeName already exists
40221 isSubmitAudit cannot be empty
40222 invalid isSubmitAudit format
40223 template is pending approval and cannot be modified
40224 cancel cannot be empty
40225 invalid cancel format
40226 template is pending approval, do not submit again
40227 template has been approved, do not submit again
40228 template not approved, do not withdraw the approval request
40229 template not submitted for approval, unable to withdraw approval request
40230 invokeName and (startDate, endDate) cannot be empty both
40231 taskId must be a number
40232 taskName cannot be empty
40233 taskName exceeds 256 characters
40234 runTime cannot be empty
40235 invalid runTime format, it should be yyyy-MM-dd HH:mm:ss
40236 runTime must be later than the current time
40237 upload file name not specified
40238 file name cannot exceed 255 characters
40239 file name suffix cannot be empty
40240 files in formats js, com, exe, sh, cs cannot be uploaded
40241 insufficient storage space, please delete some files before uploading
40242 scheduled task was successfully created
40243 failed to create scheduled task
40244 scheduled task was successfully deleted
40245 failed to delete scheduled task
40246 scheduled task was successfully updated
40247 failed to update scheduled task
40248 file upload failed
40249 email attachments need to be uploaded, runTime should be 5 minutes later than the current time
40250 duplicate creation of scheduled task
40251 frequent update of scheduled task
40252 the scheduled task corresponding to taskId does not exist
40253 only scheduled tasks that have not started can be deleted
40254 only scheduled tasks that have not started can be updated
40255 the number of member addresses in the address list cannot be 0
40256 email attachment upload timed out
40257 from address should be no longer than 128 characters
40258 emptyExistedAttachments cannot be empty and can only be 0 or 1
40301 user does not exist
40401 unsubscribe record was successfully created
40402 failed to create unsubscribe record
40403 unsubscribe record was successfully deleted
40404 failed to delete unsubscribe record
40501 name cannot be empty
40502 address list name should be 1-48 characters
40503 address cannot be empty
40504 address list alias should be 1-64 characters
40505 address list alias already exists
40506 desc cannot be empty
40507 address list description should be 1-255 characters
40508 failed to create address list
40509 newAddress cannot be empty
40510 new address list alias should be 1-64 characters
40511 invalid address parameter
40512 members cannot be empty
40513 member address should be 1-64 characters
40514 number of member addresses cannot be less than 0
40515 number of member addresses should be no more than 1000
40516 failed to add member
40517 address list does not belong to the user
40518 member address does not conform to the email address specification (non-empty and no more than 127 characters)
40519 failed to delete member
40520 vars cannot be empty
40521 variables in vars parameter are not equal to member addresses
40522 vars parameter does not adhere to JSON string syntax
40523 listType cannot be empty
40524 invalid listType parameter
40525 listType permission error
40526 variable names of address member cannot be empty
40527 variable name of address member cannot exceed 127
40528 the number of names is not equal to the number of member addresses
40529 the number of new member addresses is not equal to the number of old member addresses in newMembers
40530 invalid address format
40531 the maximum length of a single member variable is 1024 characters
40532 desc cannot contain special characters such as emoji
40601 bounce record was successfully deleted
40602 failed to delete bounce record
40603 email address already exists
40604 expire time format: 2018-03-19
40610 apiUserBlock cannot be an empty string
40611 invalid apiUserBlock, it should be a 6-32 character string containing only (A-Z, a-z, 0-9, _)
40612 apiUserBlock is invalid
40613 email and domainName cannot be empty at the same time
40620 apiUserName cannot be an empty string
40621 invalid apiUserName, it should be a 6-32 character string containing only (A-Z, a-z, 0-9, _)
40622 apiUserName is invalid
40623 email and domainName cannot be empty at the same time
40624 type can only be 1, 2, 4, 8, multiple values separated by ;
40625 type cannot be empty
40701 webhookId cannot be empty
40702 invalid webhookId format
40703 event type cannot be empty
40704 invalid event type format, no event type available
40705 url cannot be empty
40706 invalid url format
40707 url test failed
40708 url already exists
40709 webhook configuration corresponding to groupId not found
40710 failed to create webhook configuration
40711 failed to delete webhook configuration
40712 failed to modify webhook configuration
40713 the specified API_USER cannot be empty
40714 the specified API_USER does not exist
40715 cannot find the ApiUser corresponding to the CategoryName
40716 cannot find the corresponding webhook configuration
40717 url should be no more than 200 characters
40801 from address cannot be empty
40802 invalid from address format
40803 fromName cannot be empty
40804 invalid fromName format, no more than 128 characters
40805 recipient address cannot be empty
40806 illegal addresses in the recipient address list
40807 recipient addresses should be no more than 100
40808 subject cannot be empty
40809 subject length does not conform to the specification
40810 replyto cannot be empty
40811 invalid replyto format
40812 xsmtpapi cannot be empty
40813 invalid xsmtpapi format
40814 xsmtpapi parse cannot be empty
40815 xsmtpapi must contain field "to"
40816 parse of field "to" cannot be empty
40817 xsmtpapi parsing error
40818 attachments cannot be empty
40819 attachment should be no larger than 10485760 bytes
408191 attachment should be no larger than 52428800 bytes
40820 no permission to use address list
40821 address list task was successfully created
40822 failed to create address list task
40823 mail template does not exist
40824 template not approved
40825 mail template does not match API_USER type
40826 parameter subject and template subject cannot be empty both
40827 array "to" in xsmtpapi should be no longer than 100
40828 useNotification cannot be empty
40829 invalid useNotification format
40830 plain cannot be empty
40831 invalid plain format
40832 startTime cannot be empty
40833 invalid startTime format
40834 endTime cannot be empty
40835 invalid endTime format
40836 title cannot be empty
40837 title should be no longer than 128 characters
40838 organizer cannot be empty
40839 invalid organizer format
40840 organizer email address cannot be empty
40841 invalid format of organizer email address
40842 location cannot be empty
40843 location should be no longer than 1024 characters
40844 description cannot be empty
40845 description should be no longer than 1024 characters
40846 participant cannot be empty
40847 invalid participant format
40848 participant email address cannot be empty
40849 invalid format of participant email address
40850 the number of participants is not equal to the number of email addresses
40851 failed to assemble calendar email
40852 cc address cannot be empty
40853 invalid cc address format
40854 cc addresses should be no more than 100
40855 bcc address cannot be empty
40856 invalid bcc address format
40857 bcc addresses should be no more than 100
40858 respEmailId cannot be empty
40859 invalid respEmailId format
40860 gzipCompress cannot be empty
40861 invalid gzipCompress format
40862 address lists with format error in "to"
40863 nonexistent address lists in "to"
40864 address lists should be no more than 5
40865 failed to decompress html
40866 failed to decompress plain
40867 abnormal attachment processing
40868 headers cannot be empty
40869 invalid headers format
40870 html and plain cannot be empty both
40871 html format error
40872 address list cannot be empty
40873 useAddressList cannot be empty
40874 invalid useAddressList format
40875 the length of embedded picture IDs is not equal to the length of the attachments
40876 invalid format of isCancel parameter
40877 summary cannot be empty
40878 summary cannot be longer than 255 bytes
40879 replyto cannot be more than 3
40880 invalid email format in field "to" of xsmtpapi
40881 visibility cannot be empty
40882 invalid visibility format
40883 sendTime cannot be empty
40884 invalid sendTime format
40885 xsmtpapi exceeds the length limit
40901 email sending failed
40902 unknown error when processing email
40903 email sent successfully
40904 insufficient quota
40905 quota check passed
40906 quota check temporarily passed
40907 no need to match template for corresponding content of the API_USER
40908 email content does not match template
40909 email content matches template
40910 email content temporarily matches template
40911 error occurred when matching email content and template
41001 name cannot be an empty string
41002 name should be 1-255 characters
41003 name does not conform to domain specification
41004 newName cannot be an empty string
41005 newName should be 1-255 characters
41006 newName does not conform to domain specification
41007 type cannot be an empty string
41008 type does not conform to specification
41009 verify cannot be an empty string
41010 verify does not conform to specification
41011 verify parsing error
41012 user can create no more than 5 domains
41013 name parameter error, multiple domains
41014 domain does not exist
41015 failed to create domain
41016 failed to modify domain
41017 multiple domain checks should be no more than 5; tracking domain ID cannot be empty
41018 test domain cannot be deleted; tracking domain does not exist; invalid tracking domain ID
41019 bound with API_USER, cannot be deleted; cname is not configured; tracking domain cannot be the root domain
41020 domains in use and verified cannot be deleted; CNAME has passed, modification is not allowed
41021 tracking domain ID or name cannot be empty
41022 CNAME configured successfully, deletion is not allowed
41023 test domain cannot be deleted
41024 domain bound with API_USER cannot be deleted
41025 domain configuration has been approved, modification is not allowed
41026 the current API_USER is in the API_USERs to be deleted, please modify the domain of the current API_USER first
41027 target domain is required to migrate API_USER
41028 invalid migration domain
41101 emailType cannot be an empty string
41102 emailType does not conform to specification
41103 cType cannot be an empty string
41104 cType does not conform to specification
41105 domainName cannot be an empty string
41106 domainName does not conform to specification
41107 domainName should be 1-250 characters
41108 domain of domainName does not exist
41109 user information does not exist
41110 name cannot be an empty string; newName cannot be empty
41111 name does not conform to specification (name should be 6-64 characters; only A-Z, a-z, 0-9, _, @, ., - can be included)
41112 apiUser should be no more than 10; unsubscribe page does not exist
41113 open cannot be an empty string; invalid unsubscribe page format
41114 open does not conform to specification; unsubscribe page cannot be empty
41115 click cannot be an empty string
41116 click does not conform to specification
41117 unsubscribe cannot be an empty string
41118 unsubscribe does not conform to specification
41119 failed to create apiUser
41120 invalid event type
41121 invalid time type, it can only be 0 or 1; apiUser does not exist
41122 API_USER already exists; free users cannot disable unsubscribe
41123 the domain bound to API_USER must be a non-test domain; click tracking cannot be enabled for non-custom domains
41124 the domain bound to API_USER must be verified
41125 failed to update sending domain
41126 failed to update API_USER
41127 tracking domain cannot be empty
41128 invalid tracking domain format
41129 tracking domain length should be within 4-250
41130 newName is duplicated
41201 only 5 tracking domains can be created
41202 duplicate tracking domain
41203 tracking domain cannot be a sending domain
41204 tracking domain certificate is empty
41205 tracking domain certificate contains redundant content
41206 tracking domain certificate length cannot exceed 65530
41207 certificate key cannot be empty
41208 the ending of the certificate key contains redundant content
41209 certificate key length cannot exceed 8192
41210 public key error, please check the certificate content
41211 private key error, please check the key content
41212 public key and private key do not match
41213 certificate parsing error
41214 the input domain does not match the domain of the certificate
41215 certificate domain does not match the tracking domain, please upload a new certificate
41216 the certificate has expired
49901 invalid url format
49902 abnormal http request
49903 http request failed
49904 http request was successful
49905 http result parsing error
49906 other http errors
50000 API rate limited (non-email-sending APIs: per account per minute, data statistics APIs no more than 600 calls, other APIs no more than 6,000 calls)
50001 email sending failed. 536 Frequency limited (email sending APIs: each API_USER no more than 60,000 calls per minute)
51001 sender cannot be empty
51002 sender should be no longer than 250 characters
51003 sender prefix cannot contain @
51004 domain should be no longer than 250 characters
51005 data does not exist
51006 successfully deleted
51007 categoryName cannot be empty; categoryName does not exist
51008 reminder time should be within 0-60 minutes; reminder time and calendar cancellation cannot exist at the same time
51009 email log query is not enabled
51010 ID cannot be empty; fromStatus cannot be empty; mailfromStatus cannot be empty
51011 ID must be an integer; fromStatus must be an integer and can only be 0, 1, 2; mailfromStatus must be an integer and can only be 0, 1, 2
51012 receiving domain cannot be empty
51013 receiving domain should be 1-255 characters
51014 receiving domain does not conform to domain specification
51015 from cannot be empty; from should be no longer than 128 characters
51016 mailfrom cannot be empty
51017 mailfrom should be no longer than 128 characters; mailfromStatus must be set to 2
51101 ID cannot be empty
51102 ID does not exist
51103 domain cannot be empty
51104 receiving domain does not exist
51105 domain is unavailable
51106 expression cannot be empty
51107 invalid expression format
51108 action cannot be empty
51109 invalid action format
51110 apiUserRoute cannot be empty
51111 invalid apiUserRoute
51112 route already exists
51113 no more than 1000 receiving routes can be added
51114 failed to create route
501 abnormal server
6001 no permission to access