Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 59
Next »
Campaign Web Services allow you to perform many operations:
- Create a new Email or SMS Campaign
- Update Email or SMS Campaigns
- Inquire about existing or cancelled Email or SMS Campaigns
- Stop Email Campaigns in send status
- Send Test Emails
Campaign Web Service Methods
The following table lists supported methods in Campaign Web Service and provides a brief description of each method. For more detail on each method, click the method name.
Method | Description |
---|
AppendListToCampaign | Appends a list to a specific campaign. |
CancelEmailCampaign | Cancels an email that is in send status. |
CreateEmailCampaign | Creates an email campaign. If the campaign already exists, it updates it. |
CreateSmsCampaign | Creates an SMS campaign. If the campaign already exists, it updates it. |
LockCampaign | Locks a ready-to-go campaign. |
QueryEmailCampaign | Queries an email campaign. |
QuerySmsCampaign | Queries an SMS campaign. |
SelectCanceledEmailCampaigns | Selects cancelled email campaigns and their status within specific days. |
SelectCreatedEmailCampaigns | Selects new email campaigns within specific days. |
SelectOngoingEmailCampaigns | Selects ready-to-go ongoing email campaigns within specific days. |
SelectScheduledEmailCampaigns | Selects scheduled email campaigns and their status within specific days. |
SelectTestedEmailCampaigns | Selects ready-to-go email campaigns within specific days. |
SendEmailCampaign | Sets an email campaign to prod. |
SendEmailCampaignWithExtendedOptions | Sets an email campaign to prod. |
SendSmsCampaign | Sets an SMS campaign to prod. |
StartEmailCampaign | Restarts a previously stopped email. |
StopEmailCampaign | Stops an email in send status. |
TestEmailCampaign | Sets an email campaign for test. |
TestSmsCampaign | Sets an SMS campaign for test. |
UnlockCampaign | Unlocks a ready-to-go campaign. |
UpdateEmailCampaign | Updates an email campaign. If the campaign does not exist, it creates it. |
UpdateSmsCampaign | Updates an SMS campaign. If the campaign does not exist, it creates it. |
CreateEmailCampaign
Back to Top ^
<CreateEmailCampaign>
|
---|
Creates an Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | New Campaign ID | |
Name | Campaign Name | |
CampaignType | Campaign Type: SingleShot , Template or Automatic | |
FromName | Campaign Sender's Name | |
FromAddress | Campaign Sender's email address | |
ReplyAddress | Reply Email Address | |
Subject | Campaign Subject Line | |
ReadFlag | Keep Read Report for the Campaign, if false the Read Report will not be kept | |
ClickThroughFlag | Keep Click Report for the Campaign, if false Click Report will not be kept | |
ShareThisFlag | Place "Share" links in the email | |
UniqueEmailFlag | If the identifier of your account is something other than EMAIL, this function makes them unique at the time of sending | |
HtmlMessage | Campaign HTML content | |
PreHeaderText | Preview Text | |
ExpireDate | Campaign Expiration Date | |
DeliveryDate | Campaign Delivery Date | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<EmailCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>
<string>string</string>
<string>string</string>
</Subject>
<Locked>boolean</Locked>
<ReadFlag>boolean</ReadFlag>
<ClickThroughFlag>boolean</ClickThroughFlag>
<ShareThisFlag>boolean</ShareThisFlag>
<UniqueEmailFlag>boolean</UniqueEmailFlag>
<RateFlag>boolean</RateFlag>
<OmnitureFlag>boolean</OmnitureFlag>
<GoogleAnalytics>boolean</GoogleAnalytics>
<GoogleUtmSource>string</GoogleUtmSource>
<GoogleUtmMedium>string</GoogleUtmMedium>
<GoogleUtmTerm>string</GoogleUtmTerm>
<GoogleUtmContent>string</GoogleUtmContent>
<GoogleUtmCampaign>string</GoogleUtmCampaign>
<Speed>int</Speed>
<SpamAnalysisScore>string</SpamAnalysisScore>
<SpamAnalysisDetail>string</SpamAnalysisDetail>
<ExpireDate>string</ExpireDate>
<HtmlMessage>string</HtmlMessage>
<PreHeaderText>string</PreHeaderText>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryDate>string</DeliveryDate>
<Status>string</Status>
<PreparedEmailCount>int</PreparedEmailCount>
<RelayedEmailCount>int</RelayedEmailCount>
<SentEmailCount>int</SentEmailCount>
<ReadCount>int</ReadCount>
<TotalRead>int</TotalRead>
<SpamCount>int</SpamCount>
<ClickCount>int</ClickCount>
<TotalClick>int</TotalClick>
<HUCount>int</HUCount>
<SUCount>int</SUCount>
<TotalUnsubscribed>int</TotalUnsubscribed>
</EmailCampaign>
</CreateEmailCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CreateEmailCampaignResult />
<EmailCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>
<string>string</string>
<string>string</string>
</Subject>
<Locked>boolean</Locked>
<ReadFlag>boolean</ReadFlag>
<ClickThroughFlag>boolean</ClickThroughFlag>
<ShareThisFlag>boolean</ShareThisFlag>
<UniqueEmailFlag>boolean</UniqueEmailFlag>
<RateFlag>boolean</RateFlag>
<OmnitureFlag>boolean</OmnitureFlag>
<GoogleAnalytics>boolean</GoogleAnalytics>
<GoogleUtmSource>string</GoogleUtmSource>
<GoogleUtmMedium>string</GoogleUtmMedium>
<GoogleUtmTerm>string</GoogleUtmTerm>
<GoogleUtmContent>string</GoogleUtmContent>
<GoogleUtmCampaign>string</GoogleUtmCampaign>
<Speed>int</Speed>
<SpamAnalysisScore>string</SpamAnalysisScore>
<SpamAnalysisDetail>string</SpamAnalysisDetail>
<ExpireDate>string</ExpireDate>
<HtmlMessage>string</HtmlMessage>
<PreHeaderText>string</PreHeaderText>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryDate>string</DeliveryDate>
<Status>string</Status>
<PreparedEmailCount>int</PreparedEmailCount>
<RelayedEmailCount>int</RelayedEmailCount>
<SentEmailCount>int</SentEmailCount>
<ReadCount>int</ReadCount>
<TotalRead>int</TotalRead>
<SpamCount>int</SpamCount>
<ClickCount>int</ClickCount>
<TotalClick>int</TotalClick>
<HUCount>int</HUCount>
<SUCount>int</SUCount>
<TotalUnsubscribed>int</TotalUnsubscribed>
</EmailCampaign>
</CreateEmailCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | CampaignID already exist! | The sent CampID value already exists in the database. |
99 | Campaign ID must be 32 byte guid! | CampID parameter does not comply with 32 byte, GUID and uppercase criteria. |
99 | Invalid from address! | The FromAddress parameter is not registered in your account. |
99 | Invalid from name! | The FromName parameter is not registered in your account. |
99 | Not a valid HTML! | HtmlMessage parameter does not contain HTML, head and/or body tags or the HTML format is incorrect. |
SendEmailCampaign
Back to Top ^
<SendEmailCampaign>
|
---|
Sends an Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | New Campaign ID | |
DeliveryDateTime | Campaign Sending Time | |
DemograficFilters | Demographic criteria selected in campaign | |
GroupList | Interest lists recipient source | |
MarketingPDFTo | Email address to send campaign reports to | |
MarketingPDFLanguage | Language selection for PDF reports | |
AdminReportTo | Email address to send administrative campaign reports to | |
SubjectOptimization | Subject Optimization Parameter | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<Preferences>
<DeliveryDateTime>string</DeliveryDateTime>
<DemograficFilters>
<EmFilter>
<Key>string</Key>
<Operator>string</Operator>
<Value>string</Value>
</EmFilter>
<EmFilter>
<Key>string</Key>
<Operator>string</Operator>
<Value>string</Value>
</EmFilter>
</DemograficFilters>
<Lists>
<GroupList>
<GroupName>string</GroupName>
<ListName>string</ListName>
</GroupList>
<GroupList>
<GroupName>string</GroupName>
<ListName>string</ListName>
</GroupList>
</Lists>
<MarketingPDFTo>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</MarketingPDFTo>
<MarketingPDFLanguage>Turkish or English</MarketingPDFLanguage>
<AdminReportTo>string</AdminReportTo>
<SubjectOptimization>
<Target>short</Target>
<WaitInHour>short</WaitInHour>
</SubjectOptimization>
</Preferences>
</SendEmailCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<SendEmailCampaignResult />
</SendEmailCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | CampaignID already exist! | The sent CampID value already exists in the database. |
99 | Campaign ID must be 32 byte guid! | CampID parameter does not comply with 32 byte, GUID and uppercase criteria. |
99 | Not a valid HTML! | HtmlMessage parameter does not contain HTML, head and/or body tags or the HTML format is incorrect. |
|
|
|
TestEmailCampaign
Back to Top ^
<TestEmailCampaign>
|
---|
Tests an Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | The ID of the Campaign to be updated | |
ListGroup | ListGroup Name | |
ListName | ListName Name | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</TestEmailCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<TestEmailCampaignResult />
</TestEmailCampaignResponse>
</soap:Body>
</soap:Envelope>
UpdateEmailCampaign
Back to Top ^
<UpdateEmailCampaign>
|
---|
Updates the draft of an Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | The ID of the Campaign to be updated | |
Name | Campaign Name | |
CampaignType | Campaign Type: SingleShot , Template or Automatic | |
FromName | Campaign Sender's Name | |
FromAddress | Campaign Sender's email address | |
ReplyAddress | Reply Email Address | |
Subject | Campaign Subject Line | |
ReadFlag | Keep Read Report for the Campaign, if false the Read Report will not be kept | |
ClickThroughFlag | Keep Click Report for the Campaign, if false Click Report will not be kept | |
ShareThisFlag | Place "Share" links in the email | |
UniqueEmailFlag | If the identifier of your account is something other than EMAIL, this function makes them unique at the time of sending | |
HtmlMessage | Campaign HTML content | |
PreHeaderText | Preview Text | |
ExpireDate | Campaign Expiration Date | |
DeliveryDate | Campaign Delivery Date | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<UpdateEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<EmailCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>
<string>string</string>
<string>string</string>
</Subject>
<Locked>boolean</Locked>
<ReadFlag>boolean</ReadFlag>
<ClickThroughFlag>boolean</ClickThroughFlag>
<ShareThisFlag>boolean</ShareThisFlag>
<UniqueEmailFlag>boolean</UniqueEmailFlag>
<RateFlag>boolean</RateFlag>
<OmnitureFlag>boolean</OmnitureFlag>
<GoogleAnalytics>boolean</GoogleAnalytics>
<GoogleUtmSource>string</GoogleUtmSource>
<GoogleUtmMedium>string</GoogleUtmMedium>
<GoogleUtmTerm>string</GoogleUtmTerm>
<GoogleUtmContent>string</GoogleUtmContent>
<GoogleUtmCampaign>string</GoogleUtmCampaign>
<Speed>int</Speed>
<SpamAnalysisScore>string</SpamAnalysisScore>
<SpamAnalysisDetail>string</SpamAnalysisDetail>
<ExpireDate>string</ExpireDate>
<HtmlMessage>string</HtmlMessage>
<PreHeaderText>string</PreHeaderText>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryDate>string</DeliveryDate>
<Status>string</Status>
<PreparedEmailCount>int</PreparedEmailCount>
<RelayedEmailCount>int</RelayedEmailCount>
<SentEmailCount>int</SentEmailCount>
<ReadCount>int</ReadCount>
<TotalRead>int</TotalRead>
<SpamCount>int</SpamCount>
<ClickCount>int</ClickCount>
<TotalClick>int</TotalClick>
<HUCount>int</HUCount>
<SUCount>int</SUCount>
<TotalUnsubscribed>int</TotalUnsubscribed>
</EmailCampaign>
</UpdateEmailCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<UpdateEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<UpdateEmailCampaignResult />
<EmailCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>
<string>string</string>
<string>string</string>
</Subject>
<Locked>boolean</Locked>
<ReadFlag>boolean</ReadFlag>
<ClickThroughFlag>boolean</ClickThroughFlag>
<ShareThisFlag>boolean</ShareThisFlag>
<UniqueEmailFlag>boolean</UniqueEmailFlag>
<RateFlag>boolean</RateFlag>
<OmnitureFlag>boolean</OmnitureFlag>
<GoogleAnalytics>boolean</GoogleAnalytics>
<GoogleUtmSource>string</GoogleUtmSource>
<GoogleUtmMedium>string</GoogleUtmMedium>
<GoogleUtmTerm>string</GoogleUtmTerm>
<GoogleUtmContent>string</GoogleUtmContent>
<GoogleUtmCampaign>string</GoogleUtmCampaign>
<Speed>int</Speed>
<SpamAnalysisScore>string</SpamAnalysisScore>
<SpamAnalysisDetail>string</SpamAnalysisDetail>
<ExpireDate>string</ExpireDate>
<HtmlMessage>string</HtmlMessage>
<PreHeaderText>string</PreHeaderText>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryDate>string</DeliveryDate>
<Status>string</Status>
<PreparedEmailCount>int</PreparedEmailCount>
<RelayedEmailCount>int</RelayedEmailCount>
<SentEmailCount>int</SentEmailCount>
<ReadCount>int</ReadCount>
<TotalRead>int</TotalRead>
<SpamCount>int</SpamCount>
<ClickCount>int</ClickCount>
<TotalClick>int</TotalClick>
<HUCount>int</HUCount>
<SUCount>int</SUCount>
<TotalUnsubscribed>int</TotalUnsubscribed>
</EmailCampaign>
</UpdateEmailCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | CampaignID already exist! | The sent CampID value already exists in the database. |
99 | Campaign ID must be 32 byte guid! | CampID parameter does not comply with 32 byte, GUID and uppercase criteria. |
99 | Invalid from address! | The FromAddress parameter is not registered in your account. |
99 | Invalid from name! | The FromName parameter is not registered in your account. |
99 | Not a valid HTML! | HtmlMessage parameter does not contain HTML, head and/or body tags or the HTML format is incorrect. |
CancelEmailCampaign
Back to Top ^
<CancelEmailCampaign>
|
---|
Cancels an Email Campaign for which sending is not yet complete. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | The ID of the Campaign to cancel | |
ForceCancelIfCampStarted | If this parameter is sent as true, Campaign sending will be canceled even if it has already started. | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CancelEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelEmailCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CancelEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelEmailCampaignResult />
</CancelEmailCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid Campaign ID! | The CampID value does not exist in the database. |
QueryEmailCampaign
Back to Top ^
<QueryEmailCampaign>
|
---|
Lists the parameters of an existing Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | Campaign ID | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<QueryEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</QueryEmailCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<QueryEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<QueryEmailCampaignResult />
<EmailCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>
<string>string</string>
<string>string</string>
</Subject>
<Locked>boolean</Locked>
<ReadFlag>boolean</ReadFlag>
<ClickThroughFlag>boolean</ClickThroughFlag>
<ShareThisFlag>boolean</ShareThisFlag>
<UniqueEmailFlag>boolean</UniqueEmailFlag>
<RateFlag>boolean</RateFlag>
<OmnitureFlag>boolean</OmnitureFlag>
<GoogleAnalytics>boolean</GoogleAnalytics>
<GoogleUtmSource>string</GoogleUtmSource>
<GoogleUtmMedium>string</GoogleUtmMedium>
<GoogleUtmTerm>string</GoogleUtmTerm>
<GoogleUtmContent>string</GoogleUtmContent>
<GoogleUtmCampaign>string</GoogleUtmCampaign>
<Speed>int</Speed>
<SpamAnalysisScore>string</SpamAnalysisScore>
<SpamAnalysisDetail>string</SpamAnalysisDetail>
<ExpireDate>string</ExpireDate>
<HtmlMessage>string</HtmlMessage>
<PreHeaderText>string</PreHeaderText>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryDate>string</DeliveryDate>
<Status>string</Status>
<PreparedEmailCount>int</PreparedEmailCount>
<RelayedEmailCount>int</RelayedEmailCount>
<SentEmailCount>int</SentEmailCount>
<ReadCount>int</ReadCount>
<TotalRead>int</TotalRead>
<SpamCount>int</SpamCount>
<ClickCount>int</ClickCount>
<TotalClick>int</TotalClick>
<HUCount>int</HUCount>
<SUCount>int</SUCount>
<TotalUnsubscribed>int</TotalUnsubscribed>
</EmailCampaign>
</QueryEmailCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid Campaign ID! | CampID value does not exist in the database. |
SelectCanceledEmailCampaigns
Back to Top ^
<CancelEmailCampaign>
|
---|
Lists Cancelled Email Campaigns in a selected date range. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
SinceDayAgo | Determine how many days in retrospect the query will run | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SelectCanceledEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectCanceledEmailCampaigns>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SelectCanceledEmailCampaignsResponse xmlns="http://ws.euromsg.com/campaign">
<SelectCanceledEmailCampaignsResult />
<CampaignList>
<CanceledEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<Message>string</Message>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
<CancelStatus>string</CancelStatus>
</CanceledEmailCampaign>
<CanceledEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<Message>string</Message>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
<CancelStatus>string</CancelStatus>
</CanceledEmailCampaign>
</CampaignList>
</SelectCanceledEmailCampaignsResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
SelectOngoingEmailCampaigns
Back to Top ^
<SelectOngoingEmailCampaigns>
|
---|
Lists the Ongoing Email Campaigns in a selected date range. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
SinceDayAgo | Determine how many days in retrospect the query will run | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SelectOngoingEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectOngoingEmailCampaigns>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SelectOngoingEmailCampaignsResponse xmlns="http://ws.euromsg.com/campaign">
<SelectOngoingEmailCampaignsResult />
<CampaignList>
<OngoingEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
</OngoingEmailCampaign>
<OngoingEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
</OngoingEmailCampaign>
</CampaignList>
</SelectOngoingEmailCampaignsResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
SelectTestedEmailCampaigns
Back to Top ^
<SelectTestedEmailCampaigns>
|
---|
Lists the Campaigns for which Test sending was done in a selected date range. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
SinceDayAgo | Determine how many days in retrospect the query will run | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SelectTestedEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectTestedEmailCampaigns>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SelectTestedEmailCampaignsResponse xmlns="http://ws.euromsg.com/campaign">
<SelectTestedEmailCampaignsResult />
<CampaignList>
<TestedEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
</TestedEmailCampaign>
<TestedEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
</TestedEmailCampaign>
</CampaignList>
</SelectTestedEmailCampaignsResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
CreateSmsCampaign
Back to Top ^
<CreateSmsCampaign>
|
---|
Creates an SMS Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | ID for the new SMS Campaign | |
Name | Campaign Name | |
CampaignType | Campaign Type: SingleShot or Template or Automatic | |
Originator | SMS Campaign Sender's Name | |
SmsMessage | Message Text | |
AlternateSmsMessage | Alternative Message Text | |
UniqueSmsFlag | If this parameter is true, the repeated GSM numbers in the selected audience are de-duplicated at the time of sending. | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateSmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SmsCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<Originator>string</Originator>
<Locked>boolean</Locked>
<SmsMessage>string</SmsMessage>
<AlternateSmsMessage>string</AlternateSmsMessage>
<UniqueSmsFlag>boolean</UniqueSmsFlag>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryStartDate>string</DeliveryStartDate>
<Status>string</Status>
</SmsCampaign>
</CreateSmsCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CreateSmsCampaignResult />
<SmsCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<Originator>string</Originator>
<Locked>boolean</Locked>
<SmsMessage>string</SmsMessage>
<AlternateSmsMessage>string</AlternateSmsMessage>
<UniqueSmsFlag>boolean</UniqueSmsFlag>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryStartDate>string</DeliveryStartDate>
<Status>string</Status>
</SmsCampaign>
</CreateSmsCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | CampaignID already exist! | CampID value already exists in the database. |
99 | Campaign ID must be 32 byte guid! | CampID parameter does not comply with 32 byte, GUID and uppercase criteria. |
SendSmsCampaign
Back to Top ^
<SendSmsCampaign>
|
---|
Sends an Sms Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | ID for the new SMS Campaign | |
DeliveryStartDateTime | Campaign is start date | |
DeliveryEndDateTime | Campaign is finish date | |
GroupName | GroupName | |
ListName | ListName | |
MarketingPDFLanguage | Language selection for PDF reports | |
AdminReportTo | Email address to send administrative campaign reports to | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendSmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<Preferences>
<DeliveryStartDateTime>string</DeliveryStartDateTime>
<DeliveryEndDateTime>string</DeliveryEndDateTime>
<DemograficFilters>
<EmFilter>
<Key>string</Key>
<Operator>string</Operator>
<Value>string</Value>
</EmFilter>
<EmFilter>
<Key>string</Key>
<Operator>string</Operator>
<Value>string</Value>
</EmFilter>
</DemograficFilters>
<Lists>
<GroupList>
<GroupName>string</GroupName>
<ListName>string</ListName>
</GroupList>
<GroupList>
<GroupName>string</GroupName>
<ListName>string</ListName>
</GroupList>
</Lists>
<MarketingPDFTo>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</MarketingPDFTo>
<MarketingPDFLanguage>Turkish or English</MarketingPDFLanguage>
<AdminReportTo>string</AdminReportTo>
</Preferences>
</SendSmsCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SendSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<SendSmsCampaignResult />
</SendSmsCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | CampaignID already exist! | CampID value already exists in the database. |
99 | Campaign ID must be 32 byte guid! | CampID parameter does not comply with 32 byte, GUID and uppercase criteria. |
TestSmsCampaign
Back to Top ^
<TestSmsCampaign>
|
---|
Test an Sms Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | ID for the new SMS Campaign | |
GroupName | GroupName | |
ListName | ListName | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestSmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</TestSmsCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<TestSmsCampaignResult />
</TestSmsCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | CampaignID already exist! | CampID value already exists in the database. |
99 | Campaign ID must be 32 byte guid! | CampID parameter does not comply with 32 byte, GUID and uppercase criteria. |
QuerySmsCampaign
Back to Top ^
<QuerySmsCampaign>
|
---|
Lists the parameters of an existing Sms Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | |
CampaignID | ID for the new SMS Campaign | |
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<QuerySmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</QuerySmsCampaign>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<QuerySmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<QuerySmsCampaignResult />
<SmsCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<CampaignType>SingleShot or Template or Automatic</CampaignType>
<Originator>string</Originator>
<Locked>boolean</Locked>
<SmsMessage>string</SmsMessage>
<AlternateSmsMessage>string</AlternateSmsMessage>
<UniqueSmsFlag>boolean</UniqueSmsFlag>
<Created>string</Created>
<Updated>string</Updated>
<DeliveryStartDate>string</DeliveryStartDate>
<Status>string</Status>
</SmsCampaign>
</QuerySmsCampaignResponse>
</soap:Body>
</soap:Envelope>
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | CampaignID already exist! | CampID value already exists in the database. |
99 | Campaign ID must be 32 byte guid! | CampID parameter does not comply with 32 byte, GUID and uppercase criteria. |
Parent Topic: RMC REST API