Status


colour	Green
title	post

Anchor

	toprws
	toprws

Service URL	report.asmx

You can use Report web service to analyze some reports on specific campaigns.

Report Web Service Methods

Method	Description
GetCampaignReport	Queries the campaigns and its basic details between 2 dates. Date format must be dd.mm.yyyy
GetCampaignReportWithCampID	Queries a campaign and its basic details.
GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp	Queries and builds a delivery status file with specified demografic variables and date period for a campaign and then ftp the file built to remote site.
GetEmailCampaignLinks	Queries links of a campaign.
GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp	Queries and builds a delivery status file with specified demografic variables for a campaign and then ftp the file built to remote site.
GetEmailUnsubscribeReportBetweenTwoDatesViaFtp	Queries and builds an unsubscribe report file with specified demografic variables and date period for a campaign and then ftp the file built to remote site.
GetFilteredMembers	Queries subscribers by filters.
GetIncomingSmsMessages	Reports incoming SMS messages.
GetListContent	Queries members in a list.
GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp	Queries and builds a delivery status file with specified demografic variables for an SMS campaign and then ftp the file built to remote site.
GetSmsCampaignReport	Queries the SMS campaigns and their basic details between 2 dates. Date format must be dd.mm.yyyy
GetSmsCampaignReportWithCampID	Queries the sms campaigns and their basic details with camp_id.
GetSmsOptoutReportBetweenTwoDates	Query and build a sms optout report between two dates.
GetUnsubscribeReportBetweenTwoDates	Query and build a unsubscribe report between two dates.
QueryBulkFileProgress	Query the status of a conversation.
QueryDataWarehouseUploadProgress	Query the status of a datawarehouse upload.
QueryOngoingEmailStatus	Reports delivery status of an ongoing e-mail.
QueryOngoingSmsStatus	Reports delivery status of an ongoing e-sms.

Warning

To interact with any Web Services, developers must first use the Login method to create a

Status


subtle	true
colour	Red
title	Service Ticket

. Developers can send requests to other Web Service and methods using this

Status


subtle	true
colour	Red
title	Service Ticket

GetEmailUnsubscribeReportBetweenTwoDatesViaFtp
Anchor
getemailuns
getemailuns

Back to Top ^

<GetEmailUnsubscribeReportBetweenTwoDatesViaFtp>
Creates the report of the members who unsubscribed between two dates.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampaignID

Campaign ID to get the Report for

Status

colour	Yellow
title	optional

Map

Columns of the Report File

Status

colour	Green
title	mandatory

ZipPassword

Password of the Zip File that contains the Report File

Status

colour	Yellow
title	optional

NotificationEmail

The address to send notification email about the status of the Report request

Status

colour	Green
title	mandatory

ServerIP

IP address of the FTP/SFTP server to send the Report to

Status

colour	Green
title	mandatory

Username

The Username for the FTP/SFTP server to send the Report to

Status

colour	Green
title	mandatory

Password

The password for the FTP/SFTP server to send the Report to

Status

colour	Green
title	mandatory

ChangeDir

The folder path to send the Report to

Status

colour	Green
title	mandatory

Secure

Connection Type

Status

colour	Green
title	mandatory

Key

Account reference information

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>
    <GetEmailUnsubscribeReportBetweenTwoDatesViaFtp xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <CampaignID>string</CampaignID>
      <Map>string</Map>
      <ZipPassword>string</ZipPassword>
      <NotificationEmail>string</NotificationEmail>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
      <FtpDetails>
        <ServerIP>string</ServerIP>
        <Port>int</Port>
        <Username>string</Username>
        <Password>string</Password>
        <ChangeDir>string</ChangeDir>
        <Secure>boolean</Secure>
        <Key>string</Key>
      </FtpDetails>
    </GetEmailUnsubscribeReportBetweenTwoDatesViaFtp>
  </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>
    <GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResponse xmlns="http://ws.euromsg.com/report">
      <GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResult>
    </GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResponse>
  </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.

Warning

If

Status


subtle	true
colour	Red
title	CAMP_ID

parameter is left blank, the service returns the report for all members who have unsibscribed between two dates. If

Status


subtle	true
colour	Red
title	CAMP_ID

parameter is filled, the system returns the report only for members who have unsubscribed from a particular campaign, between two dates.

Warning

Secure parameter can have a

Status

subtle	true
colour	Red
title	true

or

Status

subtle	true
colour	Red
title	false

value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as

Status

subtle	true
colour	Red
title	true

.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

GetEmailCampaignLinks
Anchor
getemaillinks
getemaillinks

Back to Top ^

<GetEmailCampaignLinks>
Lists the features of the links included in a campaign.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`
CampaignID	Campaign ID to list the links for

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>
        <GetEmailCampaignLinks
            xmlns="http://ws.euromsg.com/report">
            <ServiceTicket>string</ServiceTicket>
            <CampaignID>string</CampaignID>
        </GetEmailCampaignLinks>
    </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>
        <GetEmailCampaignLinksResponse
            xmlns="http://ws.euromsg.com/report">
            <GetEmailCampaignLinksResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
                <ConversationID>string</ConversationID>
                <ConversationStatus>string</ConversationStatus>
                <TotalRowCountInConversation>int</TotalRowCountInConversation>
                <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
            </GetEmailCampaignLinksResult>
            <Links>
                <CampaignLink>
                    <LinkID>string</LinkID>
                    <LinkName>string</LinkName>
                    <Link>string</Link>
                    <LinkType>string</LinkType>
                    <TotalClickCount>int</TotalClickCount>
                    <UniqueClickCount>int</UniqueClickCount>
                </CampaignLink>
                <CampaignLink>
                    <LinkID>string</LinkID>
                    <LinkName>string</LinkName>
                    <Link>string</Link>
                    <LinkType>string</LinkType>
                    <TotalClickCount>int</TotalClickCount>
                    <UniqueClickCount>int</UniqueClickCount>
                </CampaignLink>
            </Links>
        </GetEmailCampaignLinksResponse>
    </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.
9998	Not a valid campaign id!	The entered CampaignID value does not match any registered Campaigs in the account.

GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp
Anchor
getemaillinkreport
getemaillinkreport

Back to Top ^

`<GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp>`
Returns the list of users who clicked on a campaign link between two dates.

Parameters

Parameter Değer

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampaignID

Campaign ID to create the report for

Status

colour	Green
title	mandatory

BeginDate

Report start date

Status

colour	Green
title	mandatory

EndDate

Report end date

Status

colour	Green
title	mandatory

Map

Order of the Report columns

Status

colour	Green
title	mandatory

ZipPassword

Password of the Zip File that contains the Report File

Status


colour	Yellow
title	optional

NotificationEmail

The address to send notification email about the status of the report request

Status

colour	Green
title	mandatory

ServerIP

IP address of the FTP/SFTP server to send the Report to

Status

colour	Green
title	mandatory

Username

The Username for the FTP/SFTP server to send the Report to

Status

colour	Green
title	mandatory

Password

The password for the FTP/SFTP server to send the Report to

Status

colour	Green
title	mandatory

ChangeDir

The folder path to send the Report to

Status

colour	Green
title	mandatory

Secure

Connection Type

Status

colour	Green
title	mandatory

Key

Account reference information

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>
    <GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <CampaignID>string</CampaignID>
      <Map>string</Map>
      <ZipPassword>string</ZipPassword>
      <NotificationEmail>string</NotificationEmail>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
      <FtpDetails>
        <ServerIP>string</ServerIP>
        <Port>int</Port>
        <Username>string</Username>
        <Password>string</Password>
        <ChangeDir>string</ChangeDir>
        <Secure>boolean</Secure>
        <Key>string</Key>
      </FtpDetails>
    </GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp>
  </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>
    <GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResponse xmlns="http://ws.euromsg.com/report">
      <GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResult>
    </GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResponse>
  </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.
9998	Not a valid campaign id!	The entered CampaignID value does not match any registered Campaigns in the account

GetUnsubscribeReportBetweenTwoDates
Anchor
getunsnonftp
getunsnonftp

Back to Top ^

`<GetUnsubscribeReportBetweenTwoDates>`
Lists the members who have unsubscribed between two dates.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`
BeginDate	Report start date
EndDate	Report end date

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>
    <GetUnsubscribeReportBetweenTwoDates xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetUnsubscribeReportBetweenTwoDates>
  </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>
    <GetUnsubscribeReportBetweenTwoDatesResponse xmlns="http://ws.euromsg.com/report">
      <GetUnsubscribeReportBetweenTwoDatesResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetUnsubscribeReportBetweenTwoDatesResult>
      <Unsubscribers>
        <EmUnsubscriberDetails>
          <KeyId>string</KeyId>
          <Email>string</Email>
          <UnsubscribeTime>string</UnsubscribeTime>
          <Reason>string</Reason>
          <GsmNo>string</GsmNo>
          <EmailPermit>string</EmailPermit>
          <GsmPermit>string</GsmPermit>
        </EmUnsubscriberDetails>
        <EmUnsubscriberDetails>
          <KeyId>string</KeyId>
          <Email>string</Email>
          <UnsubscribeTime>string</UnsubscribeTime>
          <Reason>string</Reason>
          <GsmNo>string</GsmNo>
          <EmailPermit>string</EmailPermit>
          <GsmPermit>string</GsmPermit>
        </EmUnsubscriberDetails>
      </Unsubscribers>
    </GetUnsubscribeReportBetweenTwoDatesResponse>
  </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.

Warning
Date format is yyyy-MM-dd hh:mm:ss. The date range is limited to a maximum of 24 hours since the data size may grow considerably.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid date!	Entered date range exceeds 24 hours or the date format is wrong.

GetFilteredMembers
Anchor
getfilteredmem
getfilteredmem

Back to Top ^

<GetFilteredMembers>
Allows you to create member inquiries based on specific filters.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Filters

String that contains the filters to apply

Status

colour	Green
title	mandatory

EmKeyOperatorValue

Contains the details of the filter to apply

Status

colour	Green
title	mandatory

Key

Demographic or permission information to apply the filtering to

Status

colour	Green
title	mandatory

Operator

Comparison operator to apply in the scope of the filter(=, <>, <, > etc)

Status

colour	Green
title	mandatory

Value

The key parameter value to be used for filtering

Status

colour	Green
title	mandatory

Map

Columns of the report to create

Status

colour	Green
title	mandatory

ZipPassword

Zip password for the report to create

Status


colour	Yellow
title	optional

NotificationEmail

The address to send the notification email depending on the status of the report request

Status

colour	Green
title	mandatory

FtpDetails

The string that contains the FTP/SFTP field info to send the created report to

Status

colour	Green
title	mandatory

ServerIP

IP address of the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Username

The username of the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Password

The password for the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

ChangeDir

The folder path to send the report to

Status

colour	Green
title	mandatory

Secure

Connection type

Status

colour	Green
title	mandatory

Key

Account reference information

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>
    <GetFilteredMembers xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <Filters>
        <EmKeyOperatorValue>
          <Key>string</Key>
          <Operator>string</Operator>
          <Value>string</Value>
        </EmKeyOperatorValue>
        <EmKeyOperatorValue>
          <Key>string</Key>
          <Operator>string</Operator>
          <Value>string</Value>
        </EmKeyOperatorValue>
      </Filters>
      <Map>string</Map>
      <ZipPassword>string</ZipPassword>
      <NotificationEmail>string</NotificationEmail>
      <FtpDetails>
        <ServerIP>string</ServerIP>
        <Port>int</Port>
        <Username>string</Username>
        <Password>string</Password>
        <ChangeDir>string</ChangeDir>
        <Secure>boolean</Secure>
        <Key>string</Key>
      </FtpDetails>
    </GetFilteredMembers>
  </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>
    <GetFilteredMembersResponse xmlns="http://ws.euromsg.com/report">
      <GetFilteredMembersResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetFilteredMembersResult>
    </GetFilteredMembersResponse>
  </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.

Warning
If there are no users created based on the specified filter, then the report is created including the "header" line only.

Warning

Secure parameter can have a

Status

subtle	true
colour	Red
title	true

or

Status

subtle	true
colour	Red
title	false

value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as

Status

subtle	true
colour	Red
title	true

.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

GetCampaignReport
Anchor
getcampreport
getcampreport

Back to Top ^

<GetCampaignReport>
Lists the campaign reports between two specified dates.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

BeginDate

Report start date. dd.mm.yyyy

Status

colour	Green
title	mandatory

EndDate

Report end date. dd.mm.yyyy

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>
        <GetCampaignReport xmlns="http://ws.euromsg.com/report">
            <ServiceTicket>string</ServiceTicket>
            <BeginDate>string</BeginDate>
            <EndDate>string</EndDate>
        </GetCampaignReport>
    </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>
        <GetCampaignReportResponse
            xmlns="http://ws.euromsg.com/report">
            <GetCampaignReportResult>
                <Code>00</Code>
                <Message />
                <DetailedMessage />
                <ConversationID>string</ConversationID>
                <ConversationStatus>string</ConversationStatus>
                <TotalRowCountInConversation>int</TotalRowCountInConversation>
                <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
            </GetCampaignReportResult>
            <Campaigns>
                <EmCampaignReportResult>
                    <Name>string</Name>
                    <Subject>string</Subject>
                    <CustomerTitle>string</CustomerTitle>
                    <CreationDate>string</CreationDate>
                    <DeliveryStart>string</DeliveryStart>
                    <DeliveryFinish>string</DeliveryFinish>
                    <CampaignID>string</CampaignID>
                    <TotalSent>string</TotalSent>
                    <TotalRead>string</TotalRead>
                    <HardBounce>string</HardBounce>
                    <SoftBounce>string</SoftBounce>
                    <Other>string</Other>
                    <UniqueRead>string</UniqueRead>
                    <UniqueClick>string</UniqueClick>
                    <TotalClick>string</TotalClick>
                    <ReadRatio>string</ReadRatio>
                    <ClickRatio>string</ClickRatio>
                    <HotmailJunkCount>string</HotmailJunkCount>
                    <YahooJunkCount>string</YahooJunkCount>
                    <Lists>string</Lists>
                    <Status>string</Status>
                    <Classification>
                        <string>string</string>
                        <string>string</string>
                    </Classification>
                </EmCampaignReportResult>
                <EmCampaignReportResult>
                    <Name>string</Name>
                    <Subject>string</Subject>
                    <CustomerTitle>string</CustomerTitle>
                    <CreationDate>string</CreationDate>
                    <DeliveryStart>string</DeliveryStart>
                    <DeliveryFinish>string</DeliveryFinish>
                    <CampaignID>string</CampaignID>
                    <TotalSent>string</TotalSent>
                    <TotalRead>string</TotalRead>
                    <HardBounce>string</HardBounce>
                    <SoftBounce>string</SoftBounce>
                    <Other>string</Other>
                    <UniqueRead>string</UniqueRead>
                    <UniqueClick>string</UniqueClick>
                    <TotalClick>string</TotalClick>
                    <ReadRatio>string</ReadRatio>
                    <ClickRatio>string</ClickRatio>
                    <HotmailJunkCount>string</HotmailJunkCount>
                    <YahooJunkCount>string</YahooJunkCount>
                    <Lists>string</Lists>
                    <Status>string</Status>
                    <Classification>
                        <string>string</string>
                        <string>string</string>
                    </Classification>
                </EmCampaignReportResult>
            </Campaigns>
        </GetCampaignReportResponse>
    </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	Açıklama
9998	No session. Please try re-logon.	No active sessions found. Try login again.

QueryBulkFileProgress
Anchor
querybulkprog
querybulkprog

Back to Top ^

<QueryBulkFileProgress>
Allows you to inquire the status of an upload or report request.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ConversationID

32 Byte ID returned by the system as a result of the upload or report request

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>
    <QueryBulkFileProgress xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <ConversationID>string</ConversationID>
    </QueryBulkFileProgress>
  </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>
    <QueryBulkFileProgressResponse xmlns="http://ws.euromsg.com/report">
      <QueryBulkFileProgressResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </QueryBulkFileProgressResult>
    </QueryBulkFileProgressResponse>
  </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.

Warning

Report requests are processed between midnight 00:00 and 06:00. Requests sent during the day do not get processed in the database until midnight. Therefore, when you run queries for report requests, the

Status


subtle	true
colour	Red
title	TotalRowCountInConversation

and

Status


subtle	true
colour	Red
title	ProcessedRowCountInConversation

parameter values are returned as "0". These values reflect the true statuses after the report request is processed.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid conversation ID!	Conversation ID sent to the service is incorrect.

QueryOngoingSmsStatus
Anchor
queryongsmsstat
queryongsmsstat

Back to Top ^

`<QueryOngoingSmsStatus>`

Sms işlem kampanyası kapsamında gönderilen bir sms’in ulaşım durumunu sorgular

Queries the delivery status of an SMS sent in the scope of an SMS Campaign.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampID

Campaign ID

Status

colour	Green
title	mandatory

TransactionID

32 Byte ID returned by the system as a result of the upload or report request

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>
    <QueryOngoingSmsStatus xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <CampID>string</CampID>
      <TransacitonID>string</TransacitonID>
    </QueryOngoingSmsStatus>
  </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>
    <QueryOngoingSmsStatusResponse xmlns="http://ws.euromsg.com/report">
      <QueryOngoingSmsStatusResult>
        <Code>string</Code>
        <Message>string</Message>
        <DetailedMessage>string</DetailedMessage>
      </QueryOngoingSmsStatusResult>
      <DeliveryResult>
        <GsmNumber>string</GsmNumber>
        <DeliveryResult>string</DeliveryResult>
        <DeliveryDetail>string</DeliveryDetail>
        <DeliveryTime>string</DeliveryTime>
        <DeliveredMessage>string</DeliveredMessage>
        <PostType>string</PostType>
        <KeyID>string</KeyID>
        <SendDate>string</SendDate>
      </DeliveryResult>
    </QueryOngoingSmsStatusResponse>
  </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.

GetCampaignReportWithCampID GetCampaignReportWithCampID
Anchor
getcampreportwid
getcampreportwid

Back to Top ^

<GetCampaignReportWithCampID>
Bir e-posta kampanyasının kampanyanın özet bilgi ve özelliklerini listeler.

Parametreler

Lists summary information and features of an Email Campaign.

Parameters

ParametreParameter DeğerValue

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampID

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>
        <GetCampaignReportWithCampID xmlns="http://ws.euromsg.com/report">
            <ServiceTicket>string</ServiceTicket>
            <CampID>string</CampID>
        </GetCampaignReportWithCampID>
    </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>
        <GetCampaignReportWithCampIDResponse
            xmlns="http://ws.euromsg.com/report">
            <GetCampaignReportWithCampIDResult>
                <Code>99</Code>
                <Message>Not a valid campaign id!</Message>
                <DetailedMessage />
                <ConversationID>string</ConversationID>
                <ConversationStatus>string</ConversationStatus>
                <TotalRowCountInConversation>int</TotalRowCountInConversation>
                <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
            </GetCampaignReportWithCampIDResult>
            <Campaign>
                <Name>string</Name>
                <Subject>string</Subject>
                <CustomerTitle>string</CustomerTitle>
                <CreationDate>string</CreationDate>
                <DeliveryStart>string</DeliveryStart>
                <DeliveryFinish>string</DeliveryFinish>
                <CampaignID>string</CampaignID>
                <TotalSent>string</TotalSent>
                <TotalRead>string</TotalRead>
                <HardBounce>string</HardBounce>
                <SoftBounce>string</SoftBounce>
                <Other>string</Other>
                <UniqueRead>string</UniqueRead>
                <UniqueClick>string</UniqueClick>
                <TotalClick>string</TotalClick>
                <ReadRatio>string</ReadRatio>
                <ClickRatio>string</ClickRatio>
                <HotmailJunkCount>string</HotmailJunkCount>
                <YahooJunkCount>string</YahooJunkCount>
                <Lists>string</Lists>
                <Status>string</Status>
                <Classification>
                    <string>string</string>
                    <string>string</string>
                </Classification>
            </Campaign>
        </GetCampaignReportWithCampIDResponse>
    </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	Not a valid campaign id!	Invalid Campaign ID.

GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
Anchor
gettoolongname
gettoolongname

Back to Top ^

<GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp>

Belirtilen kampanya ID’sine göre, kampanyaya ait ulaşım durumu raporunu gösterir

Shows the Campaign's deliverability status based on Campaign ID.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampaignID

Rapor alınacak kampanya ID’si

Campaign ID to take report for

Status


colour	Yellow
title	optional

Map

Rapor dosyasında yer alacak kolonlar

Columns of the report file

Status

colour	Green
title	mandatory

ZipPassword

Rapor dosyasının bulunduğu zip’in şifresi

The password of the Zip file that contains the report file

Status


colour	Yellow
title	optional

NotificationEmail

Rapor isteğinin durumu hakkında gönderilecek bildirim e-postasının gönderileceği adres

The address to send notification email about the status of the report request

Status

colour	Green
title	mandatory

BeginDate

Rapor başlangıç tarihi

Report start date

Status

colour	Green
title	mandatory

EndDate

Rapor bitiş tarihi

Report end date

Status

colour	Green
title	mandatory

ServerIP

Raporun bırakılacağı ftp/sftp sunucu IP’si

IP address of the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Username

Raporun bırakılacağı ftp/sftp kullanıcı adı

Username for the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Password

Raporun bırakılacağı

Password for the ftp/sftp

parolası

server to send the report to

Status

colour	Green
title	mandatory

ChangeDir

Raporun bırakılacağı klasör yolu

The folder path to send the report to

Status

colour	Green
title	mandatory

Secure

Bağlantının tipi

Connection Type

Status

colour	Green
title	mandatory

Key

Hesabın referans bilgisi

Account Reference Information

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>
        <GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
            xmlns="http://ws.euromsg.com/report">
            <ServiceTicket>string</ServiceTicket>
            <CampaignID>string</CampaignID>
            <Map>string</Map>
            <ZipPassword>string</ZipPassword>
            <NotificationEmail>string</NotificationEmail>
            <BeginDate>string</BeginDate>
            <EndDate>string</EndDate>
            <FtpDetails>
                <ServerIP>string</ServerIP>
                <Port>int</Port>
                <Username>string</Username>
                <Password>string</Password>
                <ChangeDir>string</ChangeDir>
                <Secure>boolean</Secure>
                <Key>string</Key>
            </FtpDetails>
        </GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp>
    </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>
        <GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse
            xmlns="http://ws.euromsg.com/report">
            <GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
                <Code>00</Code>
                <Message/>
                <DetailedMessage/>
                <ConversationID>AB85E41E5DC24DA58C90B0D08F87F24B</ConversationID>
                <ConversationStatus>F</ConversationStatus>
                <TotalRowCountInConversation>0</TotalRowCountInConversation>
                <ProcessedRowCountInConversation>0</ProcessedRowCountInConversation>
            </GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
        </GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse>
    </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.

Warning

If

Status


subtle	true
colour	Red
title	CAMP_ID

parameter is left blank, the service returns the report for all members who have unsibscribed between two dates. If

Status


subtle	true
colour	Red
title	CAMP_ID

parameter is filled, the system returns the report only for members who have unsubscribed from a particular campaign, between two dates.

Warning

Secure parameter can have a

Status

subtle	true
colour	Red
title	true

or

Status

subtle	true
colour	Red
title	false

value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as

Status

subtle	true
colour	Red
title	true

.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

QueryOngoingEmailStatus
Anchor
ongoingemailstat
ongoingemailstat

Back to Top ^

<QueryOngoingEmailStatus>
Email işlem kampanyası kapsamında gönderilen bir e-postanın ulaşım durumunu sorgularQueries the delivery status of an Email sent in the scope of an Email Campaign.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampID

Campaign ID

Status

colour	Green
title	mandatory

TransactionID

32 Byte ID returned by the system as a result of the upload or report request

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>
    <QueryOngoingEmailStatus xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <CampID>string</CampID>
      <TransacitonID>string</TransacitonID>
    </QueryOngoingEmailStatus>
  </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>
    <QueryOngoingEmailStatusResponse xmlns="http://ws.euromsg.com/report">
      <QueryOngoingEmailStatusResult>
        <CampID>string</CampID>
        <TransacitonID>string</TransacitonID>
        <RelayStatus>string</RelayStatus>
        <DeliveryStatus>string</DeliveryStatus>
        <ReadTime>string</ReadTime>
        <UndeliveryReason>string</UndeliveryReason>
        <MarkedSpam>boolean</MarkedSpam>
      </QueryOngoingEmailStatusResult>
    </QueryOngoingEmailStatusResponse>
  </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	Online Campaign does not exist!	Gönderilen `CampID` parametresinin hesapta kayıtlı bir işlem kampanyasını ifade etmediğini gösterirThe sent `CampID` parameter does not correspond to any registered campaign in the account.

GetListContent
Anchor
getlistcontent
getlistcontent

Back to Top ^

<GetListContent>
Belirtilen listenin içeriğindeki üyeleri listeler Lists the members found in a specified list.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

GroupName

İçeriği sorgulanacak listenin bağlı olduğu grup

Group that the list to inquire belongs to

Status

colour	Green
title	mandatory

ListName

İçeriği sorgulanacak liste ismi

Name of the List to create inquiry

Status

colour	Green
title	mandatory

ListInsertionBeginDate

Listeye kayda göre başlangıç tarihi

Start date based on saving on the list

Status

colour	Green
title	mandatory

ListInsertionFinishDate

Listeye kayda göre bitiş tarihi

End date based on saving on the list

Status

colour	Green
title	mandatory

Map

Rapor dosyasında yer alacak kolonlar

Columns of the report file

Status

colour	Green
title	mandatory

ZipPassword

Rapor dosyasının bulunduğu zip’in şifresi

The password of the Zip file that contains the report file

Status


colour	Yellow
title	optional

NotificationEmail

Rapor isteğinin durumu hakkında gönderilecek bildirim e-postasının gönderileceği adres

The address to send notification email about the status of the report request

Status

colour	Green
title	mandatory

BeginDate

Rapor başlangıç tarihi

Report start date

Status

colour	Green
title	mandatory

EndDate

Rapor bitiş tarihi

Report end date

Status

colour	Green
title	mandatory

ServerIP

Raporun bırakılacağı ftp/sftp sunucu IP’si

IP address of the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Username

Raporun bırakılacağı ftp/sftp kullanıcı adı

Username for the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Password

Raporun bırakılacağı

Password for the ftp/sftp

parolası

server to send the report to

Status

colour	Green
title	mandatory

ChangeDir

Raporun bırakılacağı klasör yolu

The folder path to send the report to

Status

colour	Green
title	mandatory

Secure

Connection Type

Status

colour	Green
title	mandatory

Key

Hesabın referans bilgisi

Account reference information

Status

colour	Green
title	mandatory

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.

Warning

Secure parameter can have a

Status

subtle	true
colour	Red
title	true

or

Status

subtle	true
colour	Red
title	false

value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as

Status

subtle	true
colour	Red
title	true

.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

GetSmsCampaignReport
Anchor
getsmsreport
getsmsreport

Back to Top ^

<GetSmsCampaignReport>
Belirtilen tarihler arasında ki sms kampanyalarının özelliklerini listeler Lists the features of the SMS campaigns between specified dates.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

BeginDate

Report start date. dd.mm.yyyy

Status

colour	Green
title	mandatory

EndDate

Report end date. dd.mm.yyyy

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>
    <GetSmsCampaignReport xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetSmsCampaignReport>
  </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>
    <GetSmsCampaignReportResponse xmlns="http://ws.euromsg.com/report">
      <GetSmsCampaignReportResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetSmsCampaignReportResult>
      <Campaigns>
        <EmSmsCampaignReportResult>
          <CampaignID>string</CampaignID>
          <Name>string</Name>
          <Originator>string</Originator>
          <CreationDate>string</CreationDate>
          <DeliveryStart>string</DeliveryStart>
          <Status>string</Status>
          <GsmColumn>string</GsmColumn>
          <SmsMessage>string</SmsMessage>
          <UniqueSms>string</UniqueSms>
          <TotalSmsCount>string</TotalSmsCount>
          <DuplicateSmsCount>string</DuplicateSmsCount>
          <PreparedSmsCount>string</PreparedSmsCount>
          <TotalSent>string</TotalSent>
          <Read>string</Read>
          <Waiting>string</Waiting>
          <Fail>string</Fail>
          <Timeout>string</Timeout>
          <Lists>string</Lists>
        </EmSmsCampaignReportResult>
      </Campaigns>
    </GetSmsCampaignReportResponse>
  </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

Hata Parametreleri

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
Anchor
smsdeliverytwodates
smsdeliverytwodates

Back to Top ^

<GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp>

Belirtilen sms kampanya ID’sine göre, kampanyaya ait smslerin ulaşım durumu raporunu gösterir

Shows the campaign SMS delivery status report based on the specified SMS Campaign ID.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampaignID

Rapor alınacak kampanya ID’si

Campaign ID to take report for

Status


colour	Yellow
title	optional

Map

Rapor dosyasında yer alacak kolonlar

Columns of the report file

Status

colour	Green
title	mandatory

ZipPassword

Rapor dosyasının bulunduğu zip’in şifresi

The password of the Zip file that contains the report file

Status


colour	Yellow
title	optional

NotificationEmail

Rapor isteğinin durumu hakkında gönderilecek bildirim e-postasının gönderileceği adres

The address to send notification email about the status of the report request

Status

colour	Green
title	mandatory

BeginDate

Rapor başlangıç tarihi

Report start date

Status

colour	Green
title	mandatory

EndDate

Rapor bitiş tarihi

Report end date

Status

colour	Green
title	mandatory

ServerIP

Raporun bırakılacağı ftp/sftp sunucu IP’si

IP address of the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Username

Raporun bırakılacağı ftp/sftp kullanıcı adı

Username for the FTP/SFTP server to send the report to

Status

colour	Green
title	mandatory

Password

Raporun bırakılacağı

Password for the ftp/sftp

parolası

server to send the report to

Status

colour	Green
title	mandatory

ChangeDir

Raporun bırakılacağı klasör yolu

The folder path to send the report to

Status

colour	Green
title	mandatory

Secure

Bağlantının tipi

Connection Type

Status

colour	Green
title	mandatory

Key

Hesabın referans bilgisi

Account reference information

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>
    <GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <CampaignID>string</CampaignID>
      <Map>string</Map>
      <ZipPassword>string</ZipPassword>
      <NotificationEmail>string</NotificationEmail>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
      <FtpDetails>
        <ServerIP>string</ServerIP>
        <Port>int</Port>
        <Username>string</Username>
        <Password>string</Password>
        <ChangeDir>string</ChangeDir>
        <Secure>boolean</Secure>
        <Key>string</Key>
      </FtpDetails>
    </GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp>
  </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?>
<?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>
    <GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse xmlns="http://ws.euromsg.com/report">
      <GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
    </GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse>
  </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.

Warning

If

Status


subtle	true
colour	Red
title	CAMP_ID

parameter is left blank, the service returns the report for all members who have unsibscribed between two dates. If

Status


subtle	true
colour	Red
title	CAMP_ID

parameter is filled, the system returns the report only for members who have unsubscribed from a particular campaign, between two dates.

Warning

Secure parameter can have a

Status

subtle	true
colour	Red
title	true

or

Status

subtle	true
colour	Red
title	false

value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as

Status

subtle	true
colour	Red
title	true

.

Error Parameter

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

GetSmsCampaignReportWithCampID
Anchor
smsreportwid
smsreportwid

Back to Top ^

<GetSmsCampaignReportWithCampID>
Bir sms kampanyasının kampanyanın özet bilgi ve özelliklerini listelerLists summary information and features of an SMS Campaign.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

CampID

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>
    <GetSmsCampaignReportWithCampID xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <SmsCampID>string</SmsCampID>
    </GetSmsCampaignReportWithCampID>
  </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>
    <GetSmsCampaignReportWithCampIDResponse xmlns="http://ws.euromsg.com/report">
      <GetSmsCampaignReportWithCampIDResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetSmsCampaignReportWithCampIDResult>
      <SmsCampaign>
        <CampaignID>string</CampaignID>
        <Name>string</Name>
        <Originator>string</Originator>
        <CreationDate>string</CreationDate>
        <DeliveryStart>string</DeliveryStart>
        <Status>string</Status>
        <GsmColumn>string</GsmColumn>
        <SmsMessage>string</SmsMessage>
        <UniqueSms>string</UniqueSms>
        <TotalSmsCount>string</TotalSmsCount>
        <DuplicateSmsCount>string</DuplicateSmsCount>
        <PreparedSmsCount>string</PreparedSmsCount>
        <TotalSent>string</TotalSent>
        <Read>string</Read>
        <Waiting>string</Waiting>
        <Fail>string</Fail>
        <Timeout>string</Timeout>
        <Lists>string</Lists>
      </SmsCampaign>
    </GetSmsCampaignReportWithCampIDResponse>
  </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	Not a valid campaign id!	Invalid Campaign ID.

GetIncomingSmsMessages
Anchor
incomingsms
incomingsms

Back to Top ^

<GetIncomingSmsMessages>
Hesabınızda tanımlı olan kısa numaraya gönderilen smsleri listelerLists the SMS messages sent to the short number defined in your account.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

BeginTime

Report start date

Status

colour	Green
title	mandatory

EndTime

Report end date

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>
    <GetIncomingSmsMessages xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </GetIncomingSmsMessages>
  </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>
    <GetIncomingSmsMessagesResponse xmlns="http://ws.euromsg.com/report">
      <GetIncomingSmsMessagesResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetIncomingSmsMessagesResult>
      <SmsMessages>
        <EmSmsIncomingMessage>
          <GsmNumber>string</GsmNumber>
          <Message>string</Message>
          <OperatorMessageID>string</OperatorMessageID>
          <SendDate>string</SendDate>
          <Operator>string</Operator>
        </EmSmsIncomingMessage>
        <EmSmsIncomingMessage>
          <GsmNumber>string</GsmNumber>
          <Message>string</Message>
          <OperatorMessageID>string</OperatorMessageID>
          <SendDate>string</SendDate>
          <Operator>string</Operator>
        </EmSmsIncomingMessage>
      </SmsMessages>
    </GetIncomingSmsMessagesResponse>
  </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.	`Login` metodu çalıştırılmamış. Aktif oturum yok.
99	Not a valid date!	Invalid date format.

GetSmsOptoutReportBetweenTwoDates
Anchor
optouttwodates
optouttwodates

Back to Top ^

`<GetSmsOptoutReportBetweenTwoDates>`
İki tarih aralığında sms kanalı üzerinden üyelikten ayrılan kullanıcıları listeler Lists the members who have unsubscribed from the SMS channel between two dates.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

BeginDate

Report start date

Status

colour	Green
title	mandatory

EndDate

Report end date

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>
    <GetSmsOptoutReportBetweenTwoDates xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetSmsOptoutReportBetweenTwoDates>
  </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>
    <GetSmsOptoutReportBetweenTwoDatesResponse xmlns="http://ws.euromsg.com/report">
      <GetSmsOptoutReportBetweenTwoDatesResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </GetSmsOptoutReportBetweenTwoDatesResult>
      <Unsubscribers>
        <EmSmsOptoutList>
          <SourceNumber>string</SourceNumber>
          <PhoneNumber>string</PhoneNumber>
          <Message>string</Message>
          <Operator>string</Operator>
          <RecordDate>string</RecordDate>
          <MessageType>string</MessageType>
          <EffectedMembers>
            <EmSmsOptoutEffectedMembers xsi:nil="true" />
            <EmSmsOptoutEffectedMembers xsi:nil="true" />
          </EffectedMembers>
        </EmSmsOptoutList>
        <EmSmsOptoutList>
          <SourceNumber>string</SourceNumber>
          <PhoneNumber>string</PhoneNumber>
          <Message>string</Message>
          <Operator>string</Operator>
          <RecordDate>string</RecordDate>
          <MessageType>string</MessageType>
          <EffectedMembers>
            <EmSmsOptoutEffectedMembers xsi:nil="true" />
            <EmSmsOptoutEffectedMembers xsi:nil="true" />
          </EffectedMembers>
        </EmSmsOptoutList>
      </Unsubscribers>
    </GetSmsOptoutReportBetweenTwoDatesResponse>
  </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.

Warning

Date format is

Status


subtle	true
colour	Red
title	yyyy-MM-dd hh:mm:ss

. The date range is limited to a maximum of 24 hours.

Error Parameters

Code	Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid date!	Entered date interval exceeds 24 hours or the date format is wrong.

QueryDataWarehouseUploadProgress
Anchor
datawarehouse
datawarehouse

Back to Top ^

<QueryDataWarehouseUploadProgres
Bir data warehouse yüklemesinin durumunu sorgulamanızı sağlar Allows you to inquire about the status of a data warehouse upload.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

FileName

Yüklemesi sorgulamak istenilen dosya ismi

Name of the file to inquire about upload status

Status


colour	Yellow
title	optional

BeginTime

Report start date

Status


colour	Yellow
title	optional

EndTime

Report end date

Status


colour	Yellow
title	optional

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>
    <QueryDataWarehouseUploadProgress xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <FileName>string</FileName>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </QueryDataWarehouseUploadProgress>
  </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>
    <QueryDataWarehouseUploadProgressResponse xmlns="http://ws.euromsg.com/report">
      <QueryDataWarehouseUploadProgressResult>
        <ConversationID>string</ConversationID>
        <ConversationStatus>string</ConversationStatus>
        <TotalRowCountInConversation>int</TotalRowCountInConversation>
        <ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
      </QueryDataWarehouseUploadProgressResult>
      <DWTables>
        <EmDWTableReport>
          <DWTableID>string</DWTableID>
          <FileName>string</FileName>
          <ZipFileName>string</ZipFileName>
          <Status>string</Status>
          <ErrorMessage>string</ErrorMessage>
          <TotalRowCount>int</TotalRowCount>
          <InvalidEmailCount>int</InvalidEmailCount>
          <InvalidGsmCount>int</InvalidGsmCount>
          <BlackListedEmailCount>int</BlackListedEmailCount>
          <BlackListedGsmCount>int</BlackListedGsmCount>
          <NewMemberCount>int</NewMemberCount>
          <ProcessStartTime>string</ProcessStartTime>
          <ProcessEndTime>string</ProcessEndTime>
          <IsBase>boolean</IsBase>
          <FileVersion>string</FileVersion>
        </EmDWTableReport>
      </DWTables>
    </QueryDataWarehouseUploadProgressResponse>
  </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.

Warning
If only the date range is sent, the system returns all of the upload statuses performed between the given dates. If only the name of the file is sent, the system returns only the upload statuses for the specified file. If both the date range and file name are sent at the same time, the system returns the upload status of the given file name within the specified date range.

Warning

Date format is

Status

subtle	true
colour	Red
title	yyyy-MM-dd hh:mm:ss

.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid date!	Invalid date format

Page Comparison

Versions Compared

Old Version 21

New Version 22

Key

Report Web Service Methods

GetEmailUnsubscribeReportBetweenTwoDatesViaFtp Anchorgetemailunsgetemailuns

Parameters

Error Parameters

GetEmailCampaignLinks Anchorgetemaillinksgetemaillinks

Parameters

Error Parameters

GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp Anchorgetemaillinkreportgetemaillinkreport

Parameters

Error Parameters

GetUnsubscribeReportBetweenTwoDates Anchorgetunsnonftpgetunsnonftp

Parameters

Error Parameters

GetFilteredMembers Anchorgetfilteredmemgetfilteredmem

Parameters

Error Parameters

GetCampaignReport Anchorgetcampreportgetcampreport

Parameters

Error Parameters

QueryBulkFileProgress Anchorquerybulkprogquerybulkprog

Parameters

Error Parameters

QueryOngoingSmsStatus Anchorqueryongsmsstatqueryongsmsstat

Parameters

Error Parameters

GetCampaignReportWithCampID GetCampaignReportWithCampID Anchorgetcampreportwidgetcampreportwid

Parameters

Error Parameters

GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp Anchorgettoolongnamegettoolongname

Parameters

Error Parameters

QueryOngoingEmailStatus Anchorongoingemailstatongoingemailstat

Parameters

Error Parameters

GetListContent Anchorgetlistcontentgetlistcontent

Parameters

Error Parameters

GetSmsCampaignReport Anchorgetsmsreportgetsmsreport

Parameters

Error Parameters

GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp Anchorsmsdeliverytwodatessmsdeliverytwodates

Parameters

Error Parameter

GetSmsCampaignReportWithCampID Anchorsmsreportwidsmsreportwid

Parameters

Error Parameters

GetIncomingSmsMessages Anchorincomingsmsincomingsms

Parameters

Error Parameters

GetSmsOptoutReportBetweenTwoDates Anchoroptouttwodatesoptouttwodates

Parameters

Error Parameters

QueryDataWarehouseUploadProgress Anchordatawarehousedatawarehouse

Parameters

Error Parameters

GetEmailUnsubscribeReportBetweenTwoDatesViaFtp
Anchor
getemailuns
getemailuns

GetEmailCampaignLinks
Anchor
getemaillinks
getemaillinks

GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp
Anchor
getemaillinkreport
getemaillinkreport

GetUnsubscribeReportBetweenTwoDates
Anchor
getunsnonftp
getunsnonftp

GetFilteredMembers
Anchor
getfilteredmem
getfilteredmem

GetCampaignReport
Anchor
getcampreport
getcampreport

QueryBulkFileProgress
Anchor
querybulkprog
querybulkprog

QueryOngoingSmsStatus
Anchor
queryongsmsstat
queryongsmsstat

GetCampaignReportWithCampID GetCampaignReportWithCampID
Anchor
getcampreportwid
getcampreportwid

GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
Anchor
gettoolongname
gettoolongname

QueryOngoingEmailStatus
Anchor
ongoingemailstat
ongoingemailstat

GetListContent
Anchor
getlistcontent
getlistcontent

GetSmsCampaignReport
Anchor
getsmsreport
getsmsreport

GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
Anchor
smsdeliverytwodates
smsdeliverytwodates

GetSmsCampaignReportWithCampID
Anchor
smsreportwid
smsreportwid

GetIncomingSmsMessages
Anchor
incomingsms
incomingsms

GetSmsOptoutReportBetweenTwoDates
Anchor
optouttwodates
optouttwodates

QueryDataWarehouseUploadProgress
Anchor
datawarehouse
datawarehouse