Campaign Web Service

POST

Service URL	campaign.asmx

Campaign web servisini kullanarak, yeni bir email veya sms kampanyası yaratma, hesapta bulunan kampanyaları sorgulama, kampanya durdurma, test emaili gönderme gibi işlemleri yapabilirsiniz.

Campaign web servisine ait aşağıda ki metodlar bulunmaktadır.

Method	Description
AppendListToCampaign	Appends a list to a specific campaign.
CancelEmailCampaign	Cancels an email that is in send status.
CreateEmailCampaign	Creates an email campaign. If the campaign already exists, it updates it.
CreateSmsCampaign	Creates an SMS campaign. If the campaign already exists, it updates it.
LockCampaign	Locks a ready-to-go campaign.
QueryEmailCampaign	Queries an email campaign.
QuerySmsCampaign	Queries an SMS campaign.
SelectCanceledEmailCampaigns	Selects cancelled email campaigns and their status within specific days.
SelectCreatedEmailCampaigns	Selects new email campaigns within specific days.
SelectOngoingEmailCampaigns	Selects ready-to-go ongoing email campaigns within specific days.
SelectScheduledEmailCampaigns	Selects scheduled email campaigns and their status within specific days.
SelectTestedEmailCampaigns	Selects ready-to-go email campaigns within specific days.
SendEmailCampaign	Sets an email campaign to prod.
SendEmailCampaignWithExtendedOptions	Sets an email campaign to prod.
SendSmsCampaign	Sets an SMS campaign to prod.
StartEmailCampaign	Restarts a previously stopped email.
StopEmailCampaign	Stops an email in send status.
TestEmailCampaign	Sets an email campaign for test.
TestSmsCampaign	Sets an SMS campaign for test.
UnlockCampaign	Unlocks a ready-to-go campaign.
UpdateEmailCampaign	Updates an email campaign. If the campaign does not exist, it creates it.
UpdateSmsCampaign	Updates an SMS campaign. If the campaign does not exist, it creates it.

To interact with any Web Services, developers must first use the Login method to create a SERVICE TICKET. Developers can send requests to other Web Service and methods using this SERVICE TICKET.

CreateEmailCampaign

Back to Top ^

`<CreateEmailCampaign>`
This method is used to Create an Email Campaign.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
CampaignID	New Campaign ID	MANDATORY
Name	Campaign Name	MANDATORY
CampaignType	Campaign Type: `SingleShot` , `Template` or `Automatic`	MANDATORY
FromName	Campaign Sender's Name	MANDATORY
FromAddress	Campaign Sender's email address	MANDATORY
ReplyAddress	Reply Email Address	MANDATORY
Subject	Campaign Subject Line	MANDATORY
ReadFlag	Keep Read Report for the Campaign, if `false` the Read Report will not be kept	MANDATORY
ClickThroughFlag	Keep Click Report for the Campaign, if `false` Click Report will not be kept	MANDATORY
ShareThisFlag	Place "Share" links in the email	MANDATORY
UniqueEmailFlag	If the identifier of your account is something other than EMAIL, this function makes them unique at the time of sending	MANDATORY
HtmlMessage	Campaign HTML content	MANDATORY
PreHeaderText	Preview Text	MANDATORY
ExpireDate	Campaign Expiration Date	MANDATORY
DeliveryDate	Campaign Delivery Date	MANDATORY

CAMPID parametresi mutlaka 32byte, GUID ve uppercase olmalıdır.

HTMLMESSAGE parameter must always have HTML, Head and Body Tags.

If 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.

FROMNAME and FROMADDRESS parameters are pre-defined in your account. You can access these information from settings>sending path.

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, CODE the parameter will return 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.

SendEmailCampaign

Back to Top ^

`<SendEmailCampaign>`
This method is used to Send an Email Campaign.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
CampaignID	New Campaign ID	MANDATORY
DeliveryDateTime		MANDATORY
DemograficFilters		MANDATORY
GroupList		MANDATORY
MarketingPDFTo		MANDATORY
MarketingPDFLanguage		MANDATORY
AdminReportTo		MANDATORY
SubjectOptimization		MANDATORY

CAMPID parametresi mutlaka 32byte, GUID ve uppercase olmalıdır.

HTMLMESSAGE parameter must always have HTML, Head and Body Tags.

If 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.

FROMNAME and FROMADDRESS parameters are pre-defined in your account. You can access these information from settings>sending path.

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, <CODE> the parameter will return 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.

UpdateEmailCampaign

Back to Top ^

`<UpdateEmailCampaign>`
This method is used to Update an Email Campaign draft.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
CampaignID	The ID of the Campaign to be updated	MANDATORY
Name	Campaign Name	MANDATORY
CampaignType	Campaign Type: `SingleShot` , `Template` or `Automatic`	MANDATORY
FromName	Campaign Sender's Name	MANDATORY
FromAddress	Campaign Sender's email address	MANDATORY
ReplyAddress	Reply Email Address	MANDATORY
Subject	Campaign Subject Line	MANDATORY
ReadFlag	Keep Read Report for the Campaign, if `false` the Read Report will not be kept	MANDATORY
ClickThroughFlag	Keep Click Report for the Campaign, if `false` Click Report will not be kept	MANDATORY
ShareThisFlag	Place "Share" links in the email	MANDATORY
UniqueEmailFlag	If the identifier of your account is something other than EMAIL, this function makes them unique at the time of sending	MANDATORY
HtmlMessage	Campaign HTML content	MANDATORY
PreHeaderText	Preview Text	MANDATORY
ExpireDate	Campaign Expiration Date	MANDATORY
DeliveryDate	Campaign Delivery Date	MANDATORY

CAMPID parametresi mutlaka 32byte, GUID ve uppercase olmalıdır.

HTMLMESSAGE parameter must always have HTML, Head and Body Tags.

If 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.

FROMNAME and FROMADDRESS parameters are pre-defined in your account. You can access these information from settings>sending path.

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, <CODE> the parameter will return 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

Back to Top ^

`<CancelEmailCampaign>`
This method is used to Cancel an Email Campaign for which sending is not yet complete.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
CampaignID	The ID of the Campaign to cancel	MANDATORY
ForceCancelIfCampStarted	If this parameter is sent as `true,` Campaign sending will be canceled even if it has already started.	MANDATORY

If FORCECANCELIFCAMPSTARTED parameter is sent as false, the campaign with a future scheduled date of sending but not yet sent is canceled.

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, <CODE> the parameter will return 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

Back to Top ^

`<QueryEmailCampaign>`
This method is used to list the parameters of an existing Email Campaign.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
CampaignID		MANDATORY

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, <CODE> the parameter will return 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.

SelectCanceledEmailCampaigns

Back to Top ^

`<CancelEmailCampaign>`
This method is used to list Cancelled Email Campaigns in a given date range.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
SinceDayAgo	How many days in retrospect the query will run	MANDATORY

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, <CODE> the parameter will return 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

Back to Top ^

`<SelectOngoingEmailCampaigns>`
This method is used to list the Ongoing Email Campaigns in a given date range.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
SinceDayAgo	How many days in retrospect the query will run	MANDATORY

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

 <?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>

If the request was successful, <CODE> the parameter will return 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

Back to Top ^

`<SelectTestedEmailCampaigns>`
This method is used to list the Campaigns for which Test sending was done, in a given date range.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
SinceDayAgo	How many days in retrospect the query will run	MANDATORY

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, <CODE> the parameter will return 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

Back to Top ^

`<CreateSmsCampaign>`
This method is used to Create an SMS Campaign.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
CampaignID	ID for the new SMS Campaign	MANDATORY
Name	Campaign Name	MANDATORY
CampaignType	Campaign Type: `SingleShot` or `Template` or `Automatic`	MANDATORY
Originator	SMS Campaign Sender's Name	MANDATORY
SmsMessage	Message Text	MANDATORY
AlternateSmsMessage	Alternative Message Text	MANDATORY
UniqueSmsFlag	If this parameter is `true,` the repeated GSM numbers in the selected audience are de-duplicated at the time of sending.	MANDATORY

CAMPID parametresi mutlaka 32byte, GUID ve uppercase olmalıdır.

You can not use a variable in the alternative message body.

If in the message text, SMS text exceeds 160 characters excluding variables, alternative message text will be sent.

REQUEST EXAMPLE

<?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>

RESPONSE EXAMPLE

<?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>

If the request was successful, <CODE> the parameter will return 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.