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. Click on the method name for more information:
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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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. |
CreatePushCampaign
Back to Top ^
<CreatePushCampaign>
|
|---|
Creates a Push Campaign. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | New Campaign ID | |
| Name | Campaign Name | |
| Type | Type: 1-Image , 2-Video,3-Text,4-Settings , 5-Survey | |
| TextMessage | Campaign Message Content | |
| AlternateTextMessage | Campaign Message Alternate Content | |
| TargetUrl | Target Url | |
| AlternateTargetUrl | Alternate Target Url | |
| MediaUrl | Media Url | |
| AlternateMediaUrl | Alternate Media Url | |
| AlternateCustomParams | Alternate Custom Parameters | |
| ReportAdmins | Send Report | |
| FastListId | FL Id | |
| ReportExpireDate | Report ExpireDate | |
| DeliveryExpireDate | Campaign Expiration Date | |
| DeliveryDate | Campaign Delivery Date | |
| SpeedLimitation | Campaign Speed | |
| DailyLimit | Daily Limit | |
| AbCustomization | Enable Ab Customization | |
| CustomParams | Custom Parameters | |
| Application | Customer Application ( Name : Application Name Type : Application Type - I (IOS) -A (Android)) | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreatePushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<PushCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<Type>int</Type>
<TextMessage>string</TextMessage>
<AlternateTextMessage>string</AlternateTextMessage>
<TargetUrl>string</TargetUrl>
<AlternateTargetUrl>string</AlternateTargetUrl>
<MediaUrl>string</MediaUrl>
<AlternateMediaUrl>string</AlternateMediaUrl>
<AlternateCustomParams>string</AlternateCustomParams>
<ReportAdmins>string</ReportAdmins>
<DeliveryDate>string</DeliveryDate>
<DeliveryExpireDate>string</DeliveryExpireDate>
<ReportExpireDate>string</ReportExpireDate>
<FastListId>string</FastListId>
<SpeedLimitation>string</SpeedLimitation>
<DailyLimit>string</DailyLimit>
<AbCustomization>string</AbCustomization>
<CustomParams>string</CustomParams>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Classification1>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification1>
<Classification2>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification2>
<Classification3>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification3>
<Classification4>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification4>
<Classification5>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification5>
<IsBadge>boolean</IsBadge>
<IsMutableContent>boolean</IsMutableContent>
<MulitpleApplications>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
</MulitpleApplications>
<TimeToLive>int</TimeToLive>
</PushCampaign>
</CreatePushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreatePushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CreatePushCampaignResult />
<PushCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<Type>int</Type>
<TextMessage>string</TextMessage>
<AlternateTextMessage>string</AlternateTextMessage>
<TargetUrl>string</TargetUrl>
<AlternateTargetUrl>string</AlternateTargetUrl>
<MediaUrl>string</MediaUrl>
<AlternateMediaUrl>string</AlternateMediaUrl>
<AlternateCustomParams>string</AlternateCustomParams>
<ReportAdmins>string</ReportAdmins>
<DeliveryDate>string</DeliveryDate>
<DeliveryExpireDate>string</DeliveryExpireDate>
<ReportExpireDate>string</ReportExpireDate>
<FastListId>string</FastListId>
<SpeedLimitation>string</SpeedLimitation>
<DailyLimit>string</DailyLimit>
<AbCustomization>string</AbCustomization>
<CustomParams>string</CustomParams>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Classification1>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification1>
<Classification2>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification2>
<Classification3>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification3>
<Classification4>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification4>
<Classification5>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification5>
<IsBadge>boolean</IsBadge>
<IsMutableContent>boolean</IsMutableContent>
<MulitpleApplications>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
</MulitpleApplications>
<TimeToLive>int</TimeToLive>
</PushCampaign>
</CreatePushCampaignResponse>
</soap12:Body>
</soap12: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. |
CreateWebPushCampaign
Back to Top ^
<CreateWebPushCampaign>
|
|---|
Creates a Web Push Campaign. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | New Campaign ID | |
| Name | Campaign Name | |
| Type | Type: 1-Image , 2-Video,3-Text,4-Settings , 5-Survey | |
| TextMessage | Campaign Message Content | |
| AlternateTextMessage | Campaign Message Alternate Content | |
| TargetUrl | Target Url | |
| AlternateTargetUrl | Alternate Target Url | |
| MediaUrl | Media Url | |
| AlternateMediaUrl | Alternate Media Url | |
| AlternateCustomParams | Alternate Custom Parameters | |
| ReportAdmins | Send Report | |
| FastListId | FL Id | |
| ReportExpireDate | Report ExpireDate | |
| DeliveryExpireDate | Campaign Expiration Date | |
| DeliveryDate | Campaign Delivery Date | |
| SpeedLimitation | Campaign Speed | |
| DailyLimit | Daily Limit | |
| AbCustomization | Enable Ab Customization | |
| CustomParams | Custom Parameters | |
| Application | Customer Application ( W=Web Push)) | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreateWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<WebPushCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<Type>int</Type>
<TextMessage>string</TextMessage>
<AlternateTextMessage>string</AlternateTextMessage>
<TargetUrl>string</TargetUrl>
<AlternateTargetUrl>string</AlternateTargetUrl>
<MediaUrl>string</MediaUrl>
<AlternateMediaUrl>string</AlternateMediaUrl>
<AlternateCustomParams>string</AlternateCustomParams>
<ReportAdmins>string</ReportAdmins>
<DeliveryDate>string</DeliveryDate>
<DeliveryExpireDate>string</DeliveryExpireDate>
<ReportExpireDate>string</ReportExpireDate>
<FastListId>string</FastListId>
<SpeedLimitation>string</SpeedLimitation>
<DailyLimit>string</DailyLimit>
<AbCustomization>string</AbCustomization>
<CustomParams>string</CustomParams>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Classification1>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification1>
<Classification2>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification2>
<Classification3>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification3>
<Classification4>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification4>
<Classification5>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification5>
<IsBadge>boolean</IsBadge>
<IsMutableContent>boolean</IsMutableContent>
<MulitpleApplications>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
</MulitpleApplications>
<TimeToLive>int</TimeToLive>
</WebPushCampaign>
</CreateWebPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreateWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CreateWebPushCampaignResult />
<WebPushCampaign>
<CampaignID>string</CampaignID>
<Name>string</Name>
<Type>int</Type>
<TextMessage>string</TextMessage>
<AlternateTextMessage>string</AlternateTextMessage>
<TargetUrl>string</TargetUrl>
<AlternateTargetUrl>string</AlternateTargetUrl>
<MediaUrl>string</MediaUrl>
<AlternateMediaUrl>string</AlternateMediaUrl>
<AlternateCustomParams>string</AlternateCustomParams>
<ReportAdmins>string</ReportAdmins>
<DeliveryDate>string</DeliveryDate>
<DeliveryExpireDate>string</DeliveryExpireDate>
<ReportExpireDate>string</ReportExpireDate>
<FastListId>string</FastListId>
<SpeedLimitation>string</SpeedLimitation>
<DailyLimit>string</DailyLimit>
<AbCustomization>string</AbCustomization>
<CustomParams>string</CustomParams>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Classification1>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification1>
<Classification2>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification2>
<Classification3>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification3>
<Classification4>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification4>
<Classification5>
<ClassificationLabel>string</ClassificationLabel>
<ClassificationValue>string</ClassificationValue>
</Classification5>
<IsBadge>boolean</IsBadge>
<IsMutableContent>boolean</IsMutableContent>
<MulitpleApplications>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
<Application>
<Name>string</Name>
<Type>string</Type>
</Application>
</MulitpleApplications>
<TimeToLive>int</TimeToLive>
</WebPushCampaign>
</CreateWebPushCampaignResponse>
</soap12:Body>
</soap12: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. |
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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<SendEmailCampaignResult />
</SendEmailCampaignResponse>
</soap12:Body>
</soap12: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. |
SendPushCampaign
Back to Top ^
<SendPushCampaign>
|
|---|
Sends a Push 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 | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendPushCampaign 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>
</Preferences>
</SendPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<SendPushCampaignResult />
</SendPushCampaignResponse>
</soap12:Body>
</soap12: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. |
TestEmailCampaign
Back to Top ^
<TestEmailCampaign>
|
|---|
Tests an Email Campaign. |
Parametreler
| 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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<TestEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</TestEmailCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<TestEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<TestEmailCampaignResult />
</TestEmailCampaignResponse>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelEmailCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelEmailCampaignResult />
</CancelEmailCampaignResponse>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</QueryEmailCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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. |
QueryMemberCampaigns
Back to Top ^
<QueryMemberCampaigns>
|
|---|
Select campaign summary stats by member id |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| MemberID | The ID of the Member | |
| CampaignIds | Campaign ID(s) | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryMemberCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<MemberId>string</MemberId>
<CampaignIds>
<string>string</string>
<string>string</string>
</CampaignIds>
</QueryMemberCampaigns>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryMemberCampaignsResponse xmlns="http://ws.euromsg.com/campaign">
<QueryMemberCampaignsResult />
<CampaignList>
<CampaignSummary>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<DeliveryDate>string</DeliveryDate>
<ReadTime>string</ReadTime>
<DeliveryStatus>string</DeliveryStatus>
<ClickStatus>string</ClickStatus>
</CampaignSummary>
<CampaignSummary>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<DeliveryDate>string</DeliveryDate>
<ReadTime>string</ReadTime>
<DeliveryStatus>string</DeliveryStatus>
<ClickStatus>string</ClickStatus>
</CampaignSummary>
</CampaignList>
</QueryMemberCampaignsResponse>
</soap12:Body>
</soap12:Envelope>
Error Parameters
| Code | Error Message | Description |
|---|
| 9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SelectCanceledEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectCanceledEmailCampaigns>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SelectOngoingEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectOngoingEmailCampaigns>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SelectTestedEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectTestedEmailCampaigns>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<SendSmsCampaignResult />
</SendSmsCampaignResponse>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<TestSmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</TestSmsCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<TestSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<TestSmsCampaignResult />
</TestSmsCampaignResponse>
</soap12:Body>
</soap12: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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QuerySmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</QuerySmsCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12:Envelope>
Error Parameters
| Code | Error Message | Description |
|---|
| 9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
AppendListToCampaign
Back to Top ^
<AppendListToCampaign>
|
|---|
Append a list to a specific campaign. (For MSCRM integration) |
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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AppendListToCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</AppendListToCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AppendListToCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<AppendListToCampaignResult />
</AppendListToCampaignResponse>
</soap12:Body>
</soap12: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. |
LockCampaign
Back to Top ^
<LockCampaign>
|
|---|
Locks a ready-to-go campaign |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | The ID of the Campaign to be updated | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<LockCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</LockCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<LockCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<LockCampaignResult />
</LockCampaignResponse>
</soap12:Body>
</soap12: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. |
SelectCreatedEmailCampaigns
Back to Top ^
<SelectCreatedEmailCampaigns>
|
|---|
Select new email campaigns within specific days. |
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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SelectCreatedEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectCreatedEmailCampaigns>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SelectCreatedEmailCampaignsResponse xmlns="http://ws.euromsg.com/campaign">
<SelectCreatedEmailCampaignsResult />
<CampaignList>
<CreatedEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<Message>string</Message>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
</CreatedEmailCampaign>
<CreatedEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<Message>string</Message>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
</CreatedEmailCampaign>
</CampaignList>
</SelectCreatedEmailCampaignsResponse>
</soap12:Body>
</soap12:Envelope>
Error Parameters
| Code | Error Message | Description |
|---|
| 9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
SelectScheduledEmailCampaigns
Back to Top ^
<SelectScheduledEmailCampaigns>
|
|---|
Select scheduled email campaigns and their status within specific days. |
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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SelectScheduledEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectScheduledEmailCampaigns>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SelectScheduledEmailCampaignsResponse xmlns="http://ws.euromsg.com/campaign">
<SelectScheduledEmailCampaignsResult />
<CampaignList>
<ScheduledEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<Message>string</Message>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
<DeliveryDate>string</DeliveryDate>
</ScheduledEmailCampaign>
<ScheduledEmailCampaign>
<Id>string</Id>
<Name>string</Name>
<Subject>string</Subject>
<Message>string</Message>
<ProcessedMessage>string</ProcessedMessage>
<Created>string</Created>
<Updated>string</Updated>
<LanguageID>string</LanguageID>
<DeliveryDate>string</DeliveryDate>
</ScheduledEmailCampaign>
</CampaignList>
</SelectScheduledEmailCampaignsResponse>
</soap12:Body>
</soap12:Envelope>
Error Parameters
| Code | Error Message | Description |
|---|
| 9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
SendEmailCampaignWithExtendedOptions
Back to Top ^
<SendEmailCampaignWithExtendedOptions>
|
|---|
Sends an Email Campaign with external options |
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 | |
| ExtendedOptions | Defines a key value pair to send an email campaign with external parameters. | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendEmailCampaignWithExtendedOptions 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>
<ExtendedOptions>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</ExtendedOptions>
</SendEmailCampaignWithExtendedOptions>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendEmailCampaignWithExtendedOptionsResponse xmlns="http://ws.euromsg.com/campaign">
<SendEmailCampaignWithExtendedOptionsResult />
</SendEmailCampaignWithExtendedOptionsResponse>
</soap12:Body>
</soap12: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. |
StartEmailCampaign
Back to Top ^
<StartEmailCampaign>
|
|---|
Starts an e-mail which is stopped before. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | The ID of the Campaign to cancel | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StartEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StartEmailCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StartEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StartEmailCampaignResult />
</StartEmailCampaignResponse>
</soap12:Body>
</soap12: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. |
StopEmailCampaign
Back to Top ^
<StopEmailCampaign>
|
|---|
Stops an e-mail campaign which is in send status. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | The ID of the Campaign to cancel | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StopEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StopEmailCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StopEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StopEmailCampaignResult />
</StopEmailCampaignResponse>
</soap12:Body>
</soap12: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. |
UnlockCampaign
Back to Top ^
<UnlockCampaign>
|
|---|
Unlocks a ready-to-go campaign. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | The ID of the Campaign to cancel | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<UnlockCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</UnlockCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<UnlockCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<UnlockCampaignResult />
</UnlockCampaignResponse>
</soap12:Body>
</soap12: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. |
UpdateSmsCampaign
Back to Top ^
<UpdateSmsCampaign>
|
|---|
Updates an SMS campaign. If the campaign does not exist, it creates a new one. |
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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<UpdateSmsCampaign 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>
</UpdateSmsCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<UpdateSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<UpdateSmsCampaignResult />
<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>
</UpdateSmsCampaignResponse>
</soap12:Body>
</soap12: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. |
Back to Top ^
<CancelSmsCampaign>
|
|---|
Cancels SMS campaigns. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | ID for the new SMS Campaign | |
| ForceCancelIfCampStarted | Forces to cancel | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelSmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelSmsCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelSmsCampaignResult />
</CancelSmsCampaignResponse>
</soap12:Body>
</soap12: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 parameter does not comply with 32 byte, GUID and uppercase criteria. |
| 99 | Campaign in wrong state | Campaign state must be LIVE, PREPARING or PREPARED |
| 99 | Campaign cancel started already | Campaign cancel process started |
Back to Top ^
<CancelPushCampaign>
|
|---|
Cancels push campaigns. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | ID for the new SMS Campaign | |
| ForceCancelIfCampStarted | Forces to cancel | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelPushCampaignResult />
</CancelPushCampaignResponse>
</soap12:Body>
</soap12: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 parameter does not comply with 32 byte, GUID and uppercase criteria. |
| 99 | Campaign in wrong state | Campaign state must be LIVE, PREPARING or PREPARED |
| 99 | Campaign cancel started already | Campaign cancel process started |
Back to Top ^
<StopPushCampaign>
|
|---|
Stops a push which is in send status. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | ID for the new SMS Campaign | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StopPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StopPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StopPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StopPushCampaignResult />
</StopPushCampaignResponse>
</soap12:Body>
</soap12: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 parameter does not comply with 32 byte, GUID and uppercase criteria. |
| 99 | Campaign in wrong state | Campaign state must be LIVE, PREPARING or PREPARED |
StartPushCampaign
Back to Top ^
<StartPushCampaign>
|
|---|
Restarts a previously stopped push campaign. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | ID for the new SMS Campaign | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StartPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StartPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StartPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StartPushCampaignResult />
</StartPushCampaignResponse>
</soap12:Body>
</soap12: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 parameter does not comply with 32 byte, GUID and uppercase criteria. |
| 99 | Campaign in wrong state | Campaign state must be LIVE, PREPARING or PREPARED |
CancelWebPushCampaign
Back to Top ^
<CancelWebPushCampaign>
|
|---|
Cancels web push campaigns. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | ID for the new SMS Campaign | |
| ForceCancelIfCampStarted | Forces to cancel | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelWebPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelWebPushCampaignResult />
</CancelWebPushCampaignResponse>
</soap12:Body>
</soap12: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 parameter does not comply with 32 byte, GUID and uppercase criteria. |
| 99 | Campaign in wrong state | Campaign state must be LIVE, PREPARING or PREPARED |
| 99 | Campaign cancel started already | Campaign cancel process started |
StopWebPushCampaign
Back to Top ^
<StopWebPushCampaign>
|
|---|
Stops a web push which is in send status. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | ID for the new Web Push Campaign | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StopWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StopWebPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StopWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StopWebPushCampaignResult />
</StopWebPushCampaignResponse>
</soap12:Body>
</soap12: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 parameter does not comply with 32 byte, GUID and uppercase criteria. |
| 99 | Campaign in wrong state | Campaign state must be LIVE, PREPARING or PREPARED |
Back to Top ^
<StartWebPushCampaign>
|
|---|
Restarts a previously stopped Web Push campaign. |
Parameters
| Parameter | Value |
|
|---|
| ServiceTicket | ServiceTicket obtained through Login | |
| CampaignID | ID for the new Web Push Campaign | |
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StartWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StartWebPushCampaign>
</soap12:Body>
</soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<StartWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StartWebPushCampaignResult />
</StartWebPushCampaignResponse>
</soap12:Body>
</soap12: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 parameter does not comply with 32 byte, GUID and uppercase criteria. |
| 99 | Campaign in wrong state | Campaign state must be LIVE, PREPARING or PREPARED |
Parent Topic: SOAP Web Service