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:
...
Note |
---|
If Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CampaignType |
---|
| parameter is SingleShot, then a campaign is prepared for one time only send. If this parameter is sent as Template, an operation campaign is created. If it is sent as Automatic, a scheduled campaign will be created. |
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromName |
---|
| and Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromAddress |
---|
| parameters are pre-defined in your account. You can access these information from settings>sending path.
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
|
the parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| createpushcampaign |
---|
| createpushcampaign |
---|
|
Back to Top ^
<CreatePushCampaign>
|
---|
Creates a Push Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | New Campaign ID | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Name | Campaign Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Type | Type: 1-Image , 2-Video,3-Text,4-Settings , 5-Survey | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
TextMessage | Campaign Message Content | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AlternateTextMessage | Campaign Message Alternate Content | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
TargetUrl | Target Url | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AlternateTargetUrl | Alternate Target Url | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
MediaUrl | Media Url | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
AlternateMediaUrl | Alternate Media Url | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
AlternateCustomParams | Alternate Custom Parameters | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
ReportAdmins | Send Report | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
FastListId | FL Id | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
ReportExpireDate | Report ExpireDate | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryExpireDate | Campaign Expiration Date | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryDate | Campaign Delivery Date | Status |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SpeedLimitation | Campaign Speed | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
DailyLimit | Daily Limit | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
AbCustomization | Enable Ab Customization | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
CustomParams | Custom Parameters | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
Application | Customer Application ( Name : Application Name Type : Application Type - I (IOS) -A (Android)) | Status |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://ws.euromsg.com/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:CreatePushCampaign>
<!--Optional:-->
<cam:ServiceTicket>?</cam:ServiceTicket>
<!--Optional:-->
<cam:PushCampaign>
<!--Optional:-->
<cam:CampaignID>?</cam:CampaignID>
<!--Optional:-->
<cam:Name>?</cam:Name>
<cam:Type>?</cam:Type>
<!--Optional:-->
<cam:TextMessage>?</cam:TextMessage>
<!--Optional:-->
<cam:AlternateTextMessage>?</cam:AlternateTextMessage>
<!--Optional:-->
<cam:TargetUrl>?</cam:TargetUrl>
<!--Optional:-->
<cam:AlternateTargetUrl>?</cam:AlternateTargetUrl>
<!--Optional:-->
<cam:MediaUrl>?</cam:MediaUrl>
<!--Optional:-->
<cam:AlternateMediaUrl>?</cam:AlternateMediaUrl>
<!--Optional:-->
<cam:AlternateCustomParams>?</cam:AlternateCustomParams>
<!--Optional:-->
<cam:ReportAdmins>?</cam:ReportAdmins>
<!--Optional:-->
<cam:DeliveryDate>?</cam:DeliveryDate>
<!--Optional:-->
<cam:DeliveryExpireDate>?</cam:DeliveryExpireDate>
<!--Optional:-->
<cam:ReportExpireDate>?</cam:ReportExpireDate>
<!--Optional:-->
<cam:FastListId>?</cam:FastListId>
<cam:SpeedLimitation>?</cam:SpeedLimitation>
<cam:DailyLimit>?</cam:DailyLimit>
<!--Optional:-->
<cam:AbCustomization>?</cam:AbCustomization>
<!--Optional:-->
<cam:CustomParams>?</cam:CustomParams>
<!--Optional:-->
<cam:Application>
<!--Optional:-->
<cam:Name>?</cam:Name>
<!--Optional:-->
<cam:Type>?</cam:Type>
</cam:Application>
</cam:PushCampaign>
</cam:CreatePushCampaign>
</soapenv:Body>
</soapenv:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreatePushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CreatePushCampaignResult>
<Code>00</Code>
<Message/>
<DetailedMessage/>
</CreatePushCampaignResult>
<PushCampaign>
<CampaignID>6236B1DB5263450FB5DC7DA5E2791060</CampaignID>
<Name>test123</Name>
<Type>1</Type>
<TextMessage>test</TextMessage>
<AlternateTextMessage>test2</AlternateTextMessage>
<TargetUrl>?</TargetUrl>
<AlternateTargetUrl>?</AlternateTargetUrl>
<MediaUrl>?</MediaUrl>
<AlternateMediaUrl>?</AlternateMediaUrl>
<AlternateCustomParams>?</AlternateCustomParams>
<ReportAdmins>cem.basaranoglu@euromsg.com</ReportAdmins>
<DeliveryDate>2019-03-15 12:53</DeliveryDate>
<DeliveryExpireDate>2019-03-15 12:53</DeliveryExpireDate>
<ReportExpireDate>2019-03-15 12:53</ReportExpireDate>
<FastListId>1</FastListId>
<SpeedLimitation>1</SpeedLimitation>
<DailyLimit>1</DailyLimit>
<AbCustomization>?</AbCustomization>
<CustomParams>?</CustomParams>
<Application>
<Name>GittiGidiyorIOS</Name>
<Type>I</Type>
</Application>
</PushCampaign>
</CreatePushCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
|
the parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| sendemailcampaign |
---|
| sendemailcampaign |
---|
|
Back to Top ^
<SendEmailCampaign>
|
---|
Sends an Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | New Campaign ID | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryDateTime | Campaign Sending Time | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DemograficFilters | Demographic criteria selected in campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
GroupList | Interest lists recipient source | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MarketingPDFTo | Email address to send campaign reports to | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MarketingPDFLanguage | Language selection for PDF reports | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AdminReportTo | Email address to send administrative campaign reports to | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SubjectOptimization | Subject Optimization Parameter | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
If Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CampaignType |
---|
| parameter is SingleShot, then a campaign is prepared for one time only send. If this parameter is sent as Template, an operation campaign is created. If it is sent as Automatic, a scheduled campaign will be created. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| sendpushcampaign |
---|
| sendpushcampaign |
---|
|
Back to Top ^
<SendPushCampaign>
|
---|
Sends a Push Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | New Campaign ID | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryDateTime | Campaign Sending Time | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DemograficFilters | Demographic criteria selected in campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
GroupList | Interest lists recipient source | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MarketingPDFTo | Email address to send campaign reports to | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MarketingPDFLanguage | Language selection for PDF reports | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AdminReportTo | Email address to send administrative campaign reports to | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<SendPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<SendPushCampaignResult />
</SendPushCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| TestEmailCampaign |
---|
| TestEmailCampaign |
---|
|
Back to Top ^
<TestEmailCampaign>
|
---|
Tests an Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to be updated | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ListGroup | ListGroup Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ListName | ListName Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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
Anchor |
---|
| updateemailcampaign |
---|
| updateemailcampaign |
---|
|
Back to Top ^
<UpdateEmailCampaign>
|
---|
Updates the draft of an Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to be updated | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Name | Campaign Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignType | Campaign Type: SingleShot , Template or Automatic | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
FromName | Campaign Sender's Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
FromAddress | Campaign Sender's email address | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ReplyAddress | Reply Email Address | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Subject | Campaign Subject Line | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ReadFlag | Keep Read Report for the Campaign, if false the Read Report will not be kept | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ClickThroughFlag | Keep Click Report for the Campaign, if false Click Report will not be kept | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ShareThisFlag | Place "Share" links in the email | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
UniqueEmailFlag | If the identifier of your account is something other than EMAIL, this function makes them unique at the time of sending | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
HtmlMessage | Campaign HTML content | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
PreHeaderText | Preview Text | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ExpireDate | Campaign Expiration Date | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryDate | Campaign Delivery Date | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | HtmlMessage |
---|
| parameter must always have HTML, Head and Body Tags.
|
Note |
---|
If Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CampaignType |
---|
| parameter is SingleShot, then a campaign is prepared for one time only send. If this parameter is sent as Template, an operation campaign is created. If it is sent as Automatic, a scheduled campaign will be created. |
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromName |
---|
| and Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromAddress |
---|
| parameters are pre-defined in your account. You can access these information from settings>sending path.
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| cancelemailcampaign |
---|
| cancelemailcampaign |
---|
|
Back to Top ^
<CancelEmailCampaign>
|
---|
Cancels an Email Campaign for which sending is not yet complete. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to cancel | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ForceCancelIfCampStarted | If this parameter is sent as true, Campaign sending will be canceled even if it has already started. | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
If Status |
---|
subtle | true |
---|
colour | Red |
---|
title | ForceCancelIfCampStarted |
---|
| parameter is sent as false, the campaign with a future scheduled date of sending but not yet sent is canceled. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| queryemailcampaign |
---|
| queryemailcampaign |
---|
|
Back to Top ^
<QueryEmailCampaign>
|
---|
Lists the parameters of an existing Email Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | Campaign ID | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| SelectCampaignsSummaryStatsByMemberId |
---|
| SelectCampaignsSummaryStatsByMemberId |
---|
|
Back to Top ^
<QueryMemberCampaigns>
|
---|
Select campaign summary stats by member id |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MemberID | The ID of the Member | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignIds | Campaign ID(s) | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<QueryMemberCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<MemberId>string</MemberId>
<CampaignIds>
<string>string</string>
<string>string</string>
</CampaignIds>
</QueryMemberCampaigns>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
SelectCanceledEmailCampaigns
Anchor |
---|
| selectcanceledemailcampaign |
---|
| selectcanceledemailcampaign |
---|
|
Back to Top ^
<CancelEmailCampaign>
|
---|
Lists Cancelled Email Campaigns in a selected date range. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SinceDayAgo | Determine how many days in retrospect the query will run | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
SelectOngoingEmailCampaigns
Anchor |
---|
| selectongoingemailcampaign |
---|
| selectongoingemailcampaign |
---|
|
Back to Top ^
<SelectOngoingEmailCampaigns>
|
---|
Lists the Ongoing Email Campaigns in a selected date range. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SinceDayAgo | Determine how many days in retrospect the query will run | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
SelectTestedEmailCampaigns
Anchor |
---|
| selecttestedemailcampaign |
---|
| selecttestedemailcampaign |
---|
|
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 | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SinceDayAgo | Determine how many days in retrospect the query will run | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
CreateSmsCampaign
Anchor |
---|
| createsmscampaign |
---|
| createsmscampaign |
---|
|
Back to Top ^
<CreateSmsCampaign>
|
---|
Creates an SMS Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Name | Campaign Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignType | Campaign Type: SingleShot or Template or Automatic | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Originator | SMS Campaign Sender's Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SmsMessage | Message Text | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AlternateSmsMessage | Alternative Message Text | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
UniqueSmsFlag | If this parameter is true, the repeated GSM numbers in the selected audience are de-duplicated at the time of sending. | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
You can not use a variable in the alternative message body. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| SendSmsCampaign |
---|
| SendSmsCampaign |
---|
|
Back to Top ^
<SendSmsCampaign>
|
---|
Sends an Sms Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryStartDateTime | Campaign is start date | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryEndDateTime | Campaign is finish date | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
GroupName | GroupName | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ListName | ListName | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MarketingPDFLanguage | Language selection for PDF reports | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AdminReportTo | Email address to send administrative campaign reports to | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| TestSmsCampaign |
---|
| TestSmsCampaign |
---|
|
Back to Top ^
<TestSmsCampaign>
|
---|
Test an Sms Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
GroupName | GroupName | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ListName | ListName | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
Anchor |
---|
| QuerySmsCampaign |
---|
| QuerySmsCampaign |
---|
|
Back to Top ^
<QuerySmsCampaign>
|
---|
Lists the parameters of an existing Sms Campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://ws.euromsg.com/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:SelectCampaignsSummaryStatsByMemberId>
<!--Optional:-->
<cam:ServiceTicket></cam:ServiceTicket>
<!--Optional:-->
<cam:MemberId></cam:MemberId>
<!--Optional:-->
<cam:CampaignIds>
<!--Zero or more repetitions:-->
<cam:string></cam:string>
</cam:CampaignIds>
</cam:SelectCampaignsSummaryStatsByMemberId>
</soapenv:Body>
</soapenv:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SelectCampaignsSummaryStatsByMemberIdResponse xmlns="http://ws.euromsg.com/campaign">
<SelectCampaignsSummaryStatsByMemberIdResult>
<Code>00</Code>
<Message/>
<DetailedMessage/>
</SelectCampaignsSummaryStatsByMemberIdResult>
<CampaignList>
<CampaignSummary>
<Id></Id>
<Name></Name>
<Subject></Subject>
<DeliveryDate></DeliveryDate>
<ReadTime/>
<DeliveryStatus/>
<ClickStatus></ClickStatus>
</CampaignSummary>
</CampaignList>
</SelectCampaignsSummaryStatsByMemberIdResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to be updated | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ListGroup | ListGroup Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ListName | ListName Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<AppendListToCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</AppendListToCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<AppendListToCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<AppendListToCampaignResult />
</AppendListToCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
<LockCampaign>
|
---|
Locks a ready-to-go campaign |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to be updated | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<LockCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</LockCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<LockCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<LockCampaignResult />
</LockCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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. |
Anchor |
---|
| selectcreatedemail |
---|
| selectcreatedemail |
---|
|
SelectCreatedEmailCampaigns
Back to Top ^
<SelectCreatedEmailCampaigns>
|
---|
Select new email campaigns within specific days. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SinceDayAgo | Determine how many days in retrospect the query will run | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<SelectCreatedEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectCreatedEmailCampaigns>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
Anchor |
---|
| selectscheduledcamps |
---|
| selectscheduledcamps |
---|
|
SelectScheduledEmailCampaigns
Back to Top ^
<SelectScheduledEmailCampaigns>
|
---|
Select scheduled email campaigns and their status within specific days. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SinceDayAgo | Determine how many days in retrospect the query will run | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<SelectScheduledEmailCampaigns xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<SinceDayAgo>int</SinceDayAgo>
</SelectScheduledEmailCampaigns>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
Anchor |
---|
| #sendextended |
---|
| #sendextended |
---|
|
SendEmailCampaignWithExtendedOptions
Back to Top ^
<SendEmailCampaignWithExtendedOptions>
|
---|
Sends an Email Campaign with external options |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | New Campaign ID | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DeliveryDateTime | Campaign Sending Time | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
DemograficFilters | Demographic criteria selected in campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
GroupList | Interest lists recipient source | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MarketingPDFTo | Email address to send campaign reports to | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
MarketingPDFLanguage | Language selection for PDF reports | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AdminReportTo | Email address to send administrative campaign reports to | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SubjectOptimization | Subject Optimization Parameter | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ExtendedOptions | Defines a key value pair to send an email campaign with external parameters. | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
If Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CampaignType |
---|
| parameter is SingleShot, then a campaign is prepared for one time only send. If this parameter is sent as Template, an operation campaign is created. If it is sent as Automatic, a scheduled campaign will be created. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<SendEmailCampaignWithExtendedOptionsResponse xmlns="http://ws.euromsg.com/campaign">
<SendEmailCampaignWithExtendedOptionsResult />
</SendEmailCampaignWithExtendedOptionsResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to cancel | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StartEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StartEmailCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StartEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StartEmailCampaignResult />
</StartEmailCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to cancel | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StopEmailCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StopEmailCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StopEmailCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StopEmailCampaignResult />
</StopEmailCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | The ID of the Campaign to cancel | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<UnlockCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</UnlockCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<UnlockCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<UnlockCampaignResult />
</UnlockCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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. |
Anchor |
---|
| updatesmscamp |
---|
| updatesmscamp |
---|
|
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 | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Name | Campaign Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignType | Campaign Type: SingleShot or Template or Automatic | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Originator | SMS Campaign Sender's Name | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
SmsMessage | Message Text | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
AlternateSmsMessage | Alternative Message Text | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
UniqueSmsFlag | If this parameter is true, the repeated GSM numbers in the selected audience are de-duplicated at the time of sending. | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
You can not use a variable in the alternative message body. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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. |
Anchor |
---|
| cancelsmscampaign |
---|
| cancelsmscampaign |
---|
|
Back to Top ^
<CancelSmsCampaign>
|
---|
Cancels SMS campaigns. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ForceCancelIfCampStarted | Forces to cancel | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
You can not use a variable in the alternative message body. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<CancelSmsCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelSmsCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<CancelSmsCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelSmsCampaignResult />
</CancelSmsCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 |
Anchor |
---|
| cancelpushcampaign |
---|
| cancelpushcampaign |
---|
|
Back to Top ^
<CancelPushCampaign>
|
---|
Cancels push campaigns. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ForceCancelIfCampStarted | Forces to cancel | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
note |
You can not use a variable in the alternative message body. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<CancelPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelPushCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<CancelPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelPushCampaignResult />
</CancelPushCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 |
Anchor |
---|
| stoppushcampaign |
---|
| stoppushcampaign |
---|
|
Back to Top ^
<StopPushCampaign>
|
---|
Stops a push which is in send status. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
You can not use a variable in the alternative message body Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
. |
note
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StopPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StopPushCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StopPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StopPushCampaignResult />
</StopPushCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 |
Anchor |
---|
| startpushcampaign |
---|
| startpushcampaign |
---|
|
StartPushCampaign
Back to Top ^
<StartPushCampaign>
|
---|
Restarts a previously stopped push campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
note |
You can not use a variable in the alternative message body. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StartPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StartPushCampaign>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StartPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StartPushCampaignResult />
</StartPushCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 |
Anchor |
---|
| cancelwebpushcampaign |
---|
| cancelwebpushcampaign |
---|
|
CancelWebPushCampaign
Back to Top ^
<CancelWebPushCampaign>
|
---|
Cancels web push campaigns. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
ForceCancelIfCampStarted | Forces to cancel | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
note |
You can not use a variable in the alternative message body. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<CancelWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
<ForceCancelIfCampStarted>boolean</ForceCancelIfCampStarted>
</CancelWebPushCampaign>
</soap:Body>
</soap:Envelope>
|
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<CancelWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<CancelWebPushCampaignResult />
</CancelWebPushCampaignResponse>
</soap:Body>
</soap:Envelope>
|
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 |
Anchor |
---|
| stopwebpushcampaign |
---|
| stopwebpushcampaign |
---|
|
StopWebPushCampaign
Back to Top ^
<StopWebPushCampaign>
|
---|
Stops a web push which is in send status. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new SMS Web Push Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
You can not use a variable in the alternative message body Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
. |
Note |
---|
If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StopWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StopWebPushCampaign>
</soap:Body>
</soap:Envelope>
|
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?><soap>
<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>
<StopWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StopWebPushCampaignResult />
</StopWebPushCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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 |
Anchor |
---|
| startwebpushcampaign |
---|
| startwebpushcampaign |
---|
|
Back to Top ^
<StartWebPushCampaign>
|
---|
Restarts a previously stopped Web Push campaign. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
CampaignID | ID for the new Web Push Campaign | Status |
---|
| |
---|
colour | Green |
---|
title | MAndatory |
---|
|
|
Note |
---|
You can not use a variable in the alternative message body Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CampID |
---|
| parameter must be 32 bytes, GUID and uppercase. |
Note |
---|
. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StartWebPushCampaign xmlns="http://ws.euromsg.com/campaign">
<ServiceTicket>string</ServiceTicket>
<CampaignId>string</CampaignId>
</StartWebPushCampaign>
</soap:Body>
</soap:Envelope>
|
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<StartWebPushCampaignResponse xmlns="http://ws.euromsg.com/campaign">
<StartWebPushCampaignResult />
</StartWebPushCampaignResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
the parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
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
...