The following operations are supported. For a formal definition, please review the Service Description.

• ActivationCampaignByFtpFile
  Activation campaign by ftp file.
  Arguments:
  
  loginEmail: Login Email of Spread.
  loginPassword: Login Password of Spread.
  fileType: Type of upload data, include ".xls", ".csv", ".xlsx"
  ContactListName: the name of contact list .
  
  campaignId: Need to be activated by the campaignId
  ftpIp: Ftp IP
  ftpUser: Ftp User
  ftpPassword: Ftp Password
  ftpFilePath: Ftp FilePath
  return: result
• AddSenderEmail
  Add Sender Email .
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  SenderEmail: New Sender Email To Add.
  return true if success.
• ChangePublishStatus
  Publish or not publish Newsletters
• CreateCampaignBySimpleType
  Create a new email campaign and send it out.
• CreateNewAccount
  Create a new account.(This method is only for reseller.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  loginPassword: Login Password of Spread.
  newAccountName: New account name
  newAccountEmail: New account email
  
  newAccountPassword:New account password
  
  return true if succeed.
• DeleteSubscribers
  delete existing subscribers.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  subscriberEmails: Subscriber's emails to be deleted.
  subscription: The subscription which contains the emails. if subscription is not specified, emails will delete from account.
  
• EmailExists
  Validate Email exists(This method is only for reseller.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  accountEmail:New account name
  return: true if exists.Otherwise,false
• EmailSend
  Send email , return email id
• ExcludeContactList
  Set exclude lists to a campaign.
  Arguments:
  
  LoginEmail: Login Email of Spread.
  Password: Login Password of Spread.
  CampaignNamedListName:The name of campaign
  ExcludeLists: Name of contact list.if more than one list,use ";" as seperator.e.g. listA;listB;listC
  
  return count of list excluded.
• GetAPIKey
  Get APIKey
  Arguments:
  
  loginEmail: Login Email of Spread.
  loginPassword: Login Password of Spread.
  return:APIKey
• GetAccessToken
  Get access token
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  return:access token
• GetAccountInfo
  Get Account detail information
  Arguments:
  
  loginEmail: Login Email of Spread.
  loginPassword: Login Password of Spread.
  return:table column:EmailCredit,SentCount,MaxSubscriber,CurrentSubscribers,ExpiryDate,Status
• GetAccountUnsubscribes
  Get Unsubscribe report in a period of time for a account.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email, date
• GetAccountUnsubscribesToFtp
  Get Unsubscribe report in a period of time for a account.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return string.
  
  String message:
  success or fail
• GetCampaignAbuses
  Get abuse report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email, date
• GetCampaignBounces
  Get Bounces report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email,type_name,chkdate
• GetCampaignClicks
  Get clicks report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email,date_clicked ,url
• GetCampaignClicksWithName
  Get clicks report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email,date_clicked ,url,first_name,middle_name,last_name
• GetCampaignConversions
  Get Conversion report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email, conversion_time,value,type,url
• GetCampaignConvertions
  Please use GetCampaignConversions instead.
• GetCampaignOpens
  Get open report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email, email_opening_time
• GetCampaignOpensWithName
  Get open report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email, email_opening_time,first_name,middle_name,last_name
• GetCampaignSents
  Get send report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email, isSuccess,sending_status_time
• GetCampaignSubscriberDetail
  GetCampaignSubscriberDetail
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  subscriber_email: The email of subscriber.
  campaign_id: The ID of campaign.
  return dataset.
  
  Dataset Columns:
  Credit,Sent,ExpiryDate
• GetCampaignUnsubscribes
  Get Unsubscribe report in a period of time for a campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  subscriber_email, date
• GetEmailStatus
  Get email status(Request\Delivered\Opened\Clicked\Bounce\SPAM\Invalid)
  Return emailId$status (123-456$Opened)
  
  LoginEmail: Login Email of Spread.
  Password: Login Password of Spread.
  EmailIds: EmailId, semicolon(;) as delimiter.
• GetSMSStatus
  Get SMS status (0: unsuccessfully \ 1: successfully)
  Return Phone number$status (85212345678$1)
  
  LoginEmail: Login Email of Spread.
  Password: Login Password of Spread.
  CampaignId: Campaign id
• GetSmsReplies
  Get Sms Replies
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: The APIKey of your Spread account which you can retrieve from your Spread account (My account=> Settings).
  campaignId: Campaign Id
  return table, column: phone\content\time.
• GetSubscriberDetail
  GetSubscriberDetail
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  subscriber_email: The email of subscriber.
  return dataset.
  
  Dataset Columns:
  Credit,Sent,ExpiryDate
• GetSubscriberReport
  Get the Report of an Email Subscriber.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  
• GetSubscribers
  Get specified status's subscribers in subscription.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  subscription: Subscription Name
  status: subscriber status
  
  return dataset.
  
  Dataset Columns:
  subscriber_email,Status
• GetUploadRequestStatus
  GetUploadRequestStatus
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  RequestID: The request of SpreadWebServcie.UploadContactListFile return .
  return dataset.
  
  Dataset Columns:
  RequestID, UploadStatus(Complete or Error or Uploading), ContactList, UploadTime, TotalCount, NewCount, DuplicateCount,DeletedCount, ExistingCount, SpamCount, UnsubscribedCount, DoNotMailCount, UndeliverableCount, asUnconfirmedCount, InvalidCount
• GetUserCredit
  GetUserCredit
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  accountType: The type of account.
  return dataset.
  
  Dataset Columns:
  Credit,Sent,ExpiryDate
• HelloWorld
• NameExists
  Validate Name exists(This method is only for reseller.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  accountName:New account name
  return: true if exists.Otherwise,false
• SearchContacts
  Get if subscribers satified the conditions,it is only for internal use currently
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  Criteria: A string represent the Conditions in Json Formate.
  TopN: Quantity of subscribers needed
  SaveAsList: Name of subscription to be created.if more than one list,use ";" as seperator.e.g. listA;listB;listC
  ForceCreate: TRUE or FALSE. When number of subscribers returned less than TopN,if TRUE then will create new list and FALSE will not.
  
  Return the number of subscribers that meet the condition.
  
  Remark: This function is currently for internal use.
• Send
  Send email one to one
• Send2
  The same function as Send but you can specify campaign name instead of today as default campaign name.
• Send3
  The same function as Send but you can specify campaign name instead of today as default campaign name.
• SendBatch
  Send Batch
• SendSMS
  Create a new sms campaign
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: The APIKey of your Spread account which you can retrieve from your Spread account (My account=> Settings).
  SMSContent: The content of SMS campaign.
  sender:The sender of SMS campaign.
  schedule: The date of when to establish the email campaign.
  campaignStatus: The status of the email campaign.
  phoneSubscribers: An array of string contains the phone number added to this email campaign.
  category: An array of string contains the names of categories added to this email campaign.
  return campaignID.
• SendTemplateEmail
  Send email by Template, return email id
• SetCampaignDailyLimit
  Setting Campaign DailyLimit(It is only for internal use currently.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  campaignID:The Campaign ID which you want to set.
  return true if success.
• SetCampaignTimeLimit
  Setting Campaign TimeLimit(It is only for internal use currently.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  campaignID: The Campaign ID which you want to set.
  TimeSpan: Send time limit of campaign. format like: [ { '1': ['01:00-02:00','01:00-02:00'] }, { '2': ['01:00-02:00','01:00-02:00'] } ]
  '0' means every day, '1': Monday, '2': Tuesday,'3': Wednesday, '4': Thursday,'5': Friday, '6': Saturday, '7': Sunday
  return true if success.
• SplitContactListByRange
  SplitContactListByRange(It is only for internal use currently.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  SourceContactListName: The Contact List which you want to split.
  Range: The Range of Contact List, format like: 0~10
  TargetContactListName: The Contact List Which you want to insert.
  return true if success.
• SplitContacts
  Split the contact list.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  oldListName:The name of old list name
  SaveAsList: Name of subscription to be created.if more than one list,use ";" as seperator.e.g. listA;listB;listC
  
  return true if succeed.
• TransferCredit
  Transfer credit to another account.(This method is only for reseller.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  loginPassword: Login Password of Spread.
  transferToEmail: Email of transfer credit to user
  creditCount: Total amount of transfer credit
  
  return true if succeed.
• UnsubscribeEmailInAccount
  UnsubscribeEmailInAccount
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  subscriberEmail: The email of subscriber.
  return true if success.
  
  
• UnsubscribeEmailInContactList
  UnsubscribeEmailInContactList
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  subscriberEmail: The email of subscriber.
  contactListName: The name of contactlist.
  return true if success.
  
  
• UpdateCampaignStatus
  Create a new email campaign and campaign creatives .
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  campaignID: The ID of the email campaign.
  campaignStatus: The status of the email campaign.
  return true if succeed.
• UpdateMemberEmail
  Update member email
• UploadContactListFile
  Upload contact file .
  Arguments:
  
  loginEmail: Login Email of Spread.
  loginPassword: Login Password of Spread.
  fileType: Type of upload data, include ".xls", ".csv", ".xlsx"
  fileStream: The upload file stream ( length<100MB )
  ContactListName: the name of contact list .
  
  return: result
• UplodeZipFile
  Upload zip files as mail contents.
  Arguments:
  
  loginEmail: Login Email of Spread.
  loginPassword: Login Password of Spread.
  fileStream: The zip file stream
  campaignId: Campaign ID.If campaignid is nothing,create new campaign.
  
  return true if succeed.
• VerifyAccessToken
  Verify access token
  Arguments:
  
  emailAddress:The emailAddress of user
  token: Access token
  return true if succeed.
• addSubscriberByEmail
  Add new/existing subscriber into a subscription.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  subscriptionEmail: Subscriber's email to be added.
  subscription: The subscription where the subscriber being added.
  optInType: Double Opt-In Option.
  
  return true if the subscriber need to be confirmed.
  
  Remarks: Subscriber would receive confirmation email if user's Double Opt-in option is ON.
• addSubscriberByInfo
  Add new/existing subscriber into a subscription.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  SubscriberArgs: email, firstName, middleName, lastName, jobTitle, company, homePhone, address1, address2, address3, city, state, country,postalCode, subPostalCode, customField1, customField2, customField3.
  subscription: The subscription where the subscriber being added.
  optInType: Double Opt-In Option.
  
  return true if the subscriber need to be confirmed.
  
  Remarks: Subscriber would receive confirmation email if user's Double Opt-in option is ON.
• addSubscriberByInfoSerialize
  (It is only for internal use currently.)
• addSubscribersByInfo
  Add new/existing subscribers into a subscription.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  SubscriberArgs(): email, firstName, middleName, lastName, jobTitle, company, homePhone, address1, address2, address3, city, state, country,postalCode, subPostalCode, customField1, customField2, customField3.
  subscription: The subscription where the subscriber being added.
  optInType: Double Opt-In Option.
  
  return dataset containing error messages if any.
  
  Remarks: Subscriber would receive confirmation email if user's Double Opt-in option is ON.
• addSubscribersByInfo2
  Add new/existing subscribers into a subscription.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  SubscriberArgs(): email, firstName, middleName, lastName, jobTitle, company, homePhone, address1, address2, address3, city, state, country,postalCode, subPostalCode, customField1, customField2, customField3.
  subscription: The subscription where the subscriber being added.
  optInType: Double Opt-In Option.
  
  return dataset containing error messages if any.
  
  Remarks: Subscriber would receive confirmation email if user's Double Opt-in option is ON.
• addSubscribersByInfoSerialize
  (It is only for internal use currently.)
• createCampaign
  Create a new email campaign and send it out.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  campaignArgs: Campaign Class, includes campaignName, fromEmail, from, subject, content, signature and schedule
  category: An array of string contains the names of categories added to this email campaign.
  interval: Type of email Campaign. -1, send for once only. Non-negetive number, n days after subscribers subscribe.
  
  return campaignID.
• createCampaign2
  Create a new email campaign and campaign creatives .
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  campaignName: The name of the email campaign.
  campaignCreatives: campaignCreatives Array, CampaignCreatives Class includes displayName, fromAddress, replyTo, subject, creativeContent, target and isCampaignDefault.
  category: An array of string contains the names of categories added to this email campaign.
  interval: Type of email Campaign. -1, send for once only. Non-negetive number, n days after subscribers subscribe.
  
  schedule: The date of when to establish the email campaign.
  signature: The signature of the email campaign.
  campaignStatus: The status of the email campaign.
  return campaignID.
• createCampaign2Serialize
  (It is only for internal use currently.)
• createCampaignDraft
  Create a new email campaign draft.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  campaignArgs: Campaign Class, includes campaignName, fromEmail, from, subject, content, signature and schedule
  category: An array of string contains the names of categories added to this email campaign.
  interval: Type of email Campaign. -1, send for once only. Non-negetive number, n days after subscribers subscribe.
  
  return campaignID.
• createCampaignDraft2
  Create a new email campaign draft.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  campaignArgs: Campaign Class, includes campaignName, fromEmail, from, subject, content, signature and schedule
  category: An array of string contains the names of categories added to this email campaign.
  interval: Type of email Campaign. -1, send for once only. Non-negetive number, n days after subscribers subscribe.
  
  return campaignID.
• createCampaignDraftSerialize
  (It is only for internal use currently.)
• createCampaignSerialize
  (It is only for internal use currently.)
• createContactList
  Create a new Contact List.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  subscriptionName: Subscription Name
  description: Description of the new subscription.
  
  return true if succeed.
• createSubscription
  Create a new subscription.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  subscriptionName: Subscription Name
  description: Description of the new subscription.
  
  return true if succeed.
• getActiveSubscribersByContactList
  getActiveSubscribersByContactList(It is only for internal use currently.)
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  contactListName: The Contact List you want to do.
  return the count of active subscribers.
• getAllSubscription
  Get all subscriptions.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  
  return dataset.
  
  Dataset Columns:
  Subscription Name, description, status, no. of subscribers
• getCampaignID
  Validate Campaign exists
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  campaignName: Name of the campaign
  return:campaign ID
• getCampaignReport
  Get the Report of an Email Campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  CampaignID
  
  return CampaignReport.
• getCampaignReportSerialize
  (It is only for internal use currently.)
• getCampaignStatus
  Get the Status of an Email Campaign.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  CampaignID
  
  return Status.
• getSubscription
  Get subscriptions in particular Status.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  status
  
  return dataset.
  
  Dataset Columns:
  Subscription Name, description, status, no. of subscribers
• getSubscriptions2String
  Get subscriptions in particular Status.
  Arguments:
  
  loginEmail: Login Email of Spread.
  password: Login Password of Spread.
  status
  
  return string.
  
  
• getUserSentReport
  getUserSentReport
  Arguments:
  
  loginEmail: Login Email of Spread.
  APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
  campaignType: The type of campaign.
  startDate:Starting time
  endDate:End time
  
  return dataset.
  
  Dataset Columns:
  Year,Month,Sent