Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

POST 

Service URLreport.asmx

 

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

Report Web Service Methods

 

MethodDescription
GetCampaignReportQueries the campaigns and its basic details between 2 dates. Date format must be dd.mm.yyyy
GetCampaignReportWithCampIDQueries a campaign and its basic details.
GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpQueries 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.
GetEmailCampaignLinksQueries links of a campaign.
GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpQueries and builds a delivery status file with specified demografic variables for a campaign and then ftp the file built to remote site.
GetEmailUnsubscribeReportBetweenTwoDatesViaFtpQueries 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.
GetFilteredMembersQueries subscribers by filters.
GetIncomingSmsMessagesReports incoming SMS messages.
GetListContentQueries members in a list.
GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpQueries and builds a delivery status file with specified demografic variables for an SMS campaign and then ftp the file built to remote site.
GetSmsCampaignReportQueries the SMS campaigns and their basic details between 2 dates. Date format must be dd.mm.yyyy
GetSmsCampaignReportWithCampIDQueries the sms campaigns and their basic details with camp_id.
GetSmsOptoutReportBetweenTwoDatesQuery and build a sms optout report between two dates.
GetUnsubscribeReportBetweenTwoDatesQuery and build a unsubscribe report between two dates.
QueryBulkFileProgressQuery the status of a conversation.
QueryDataWarehouseUploadProgressQuery the status of a datawarehouse upload.
QueryOngoingEmailStatusReports delivery status of an ongoing e-mail.
QueryOngoingSmsStatusReports delivery status of an ongoing e-sms.

 

 

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

 


GetEmailUnsubscribeReportBetweenTwoDatesViaFtp 

Back to Top ^

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

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampaignIDCampaign ID to get the Report for

OPTIONAL

MapColumns of the Report File

MANDATORY

ZipPasswordPassword of the Zip File that contains the Report File

OPTIONAL

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

MANDATORY

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

MANDATORY

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

MANDATORY

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

MANDATORY

ChangeDirThe folder path to send the Report to

MANDATORY

SecureConnection Type

MANDATORY

KeyAccount reference information

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

If the request was successful, the CODE parameter will return 00 as a response.

If CAMP_ID parameter is left blank, the service returns the report for all members who have unsibscribed between two dates. If CAMP_ID parameter is filled, the system returns the report only for members who have unsubscribed from a particular campaign, between two dates.

Secure parameter can have a TRUE or FALSE value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as TRUE.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

 


Back to Top ^

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

Parameters

 

ParameterValue
ServiceTicketServiceTicket obtained through Login
CampaignIDCampaign ID to list the links for
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>
        <GetEmailCampaignLinks
            xmlns="http://ws.euromsg.com/report">
            <ServiceTicket>string</ServiceTicket>
            <CampaignID>string</CampaignID>
        </GetEmailCampaignLinks>
    </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>
        <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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
9998Not a valid campaign id!The entered CampaignID value does not match any registered Campaigs in the account.

 


GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp 

Back to Top ^

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

Parameters

 

ParameterDeğer 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampaignIDCampaign ID to create the report for

MANDATORY

BeginDateReport start date

MANDATORY

EndDateReport end date

MANDATORY

MapOrder of the Report columns

MANDATORY

ZipPasswordPassword of the Zip File that contains the Report File

OPTIONAL

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

MANDATORY

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

MANDATORY

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

MANDATORY

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

MANDATORY

ChangeDirThe folder path to send the Report to

MANDATORY

SecureConnection Type

MANDATORY

KeyAccount reference information

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

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
9998Not a valid campaign id!The entered CampaignID value does not match any registered Campaigns in the account

 


GetUnsubscribeReportBetweenTwoDates 

Back to Top ^

<GetUnsubscribeReportBetweenTwoDates>

Lists the members who have unsubscribed between two dates.

Parameters

 

ParameterValue
ServiceTicketServiceTicket obtained through Login
BeginDateReport start date
EndDateReport end date
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>
    <GetUnsubscribeReportBetweenTwoDates xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetUnsubscribeReportBetweenTwoDates>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

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

 

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

 


GetFilteredMembers 

Back to Top ^

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

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

FiltersString that contains the filters to apply

MANDATORY

EmKeyOperatorValueContains the details of the filter to apply

MANDATORY

KeyDemographic or permission information to apply the filtering to

MANDATORY

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

MANDATORY

ValueThe key parameter value to be used for filtering

MANDATORY

MapColumns of the report to create

MANDATORY

ZipPasswordZip password for the report to create

OPTIONAL

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

MANDATORY

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

MANDATORY

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

MANDATORY

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

MANDATORY

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

MANDATORY

ChangeDirThe folder path to send the report to

MANDATORY

SecureConnection type

MANDATORY

KeyAccount reference information

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

If the request was successful, the CODE parameter will return 00 as a response.

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

Secure parameter can have a TRUE or FALSE value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as TRUE.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

 


GetCampaignReport 

Back to Top ^

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

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

BeginDateReport start date. dd.mm.yyyy

MANDATORY

EndDateReport end date. dd.mm.yyyy

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>
        <GetCampaignReport xmlns="http://ws.euromsg.com/report">
            <ServiceTicket>string</ServiceTicket>
            <BeginDate>string</BeginDate>
            <EndDate>string</EndDate>
        </GetCampaignReport>
    </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>
        <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>

If the request was successful, the CODE parameter will return 00 as a response.

 

Error Parameters

 

CodeError MessageAçıklama
9998No session. Please try re-logon.No active sessions found. Try login again.

 


QueryBulkFileProgress 

Back to Top ^

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

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

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>
    <QueryBulkFileProgress xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <ConversationID>string</ConversationID>
    </QueryBulkFileProgress>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

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 TOTALROWCOUNTINCONVERSATION and PROCESSEDROWCOUNTINCONVERSATION parameter values are returned as "0". These values reflect the true statuses after the report request is processed.

Error Parameters

 

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

 


QueryOngoingSmsStatus 

Back to Top ^

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

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampIDCampaign ID

MANDATORY

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

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>
    <QueryOngoingSmsStatus xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <CampID>string</CampID>
      <TransacitonID>string</TransacitonID>
    </QueryOngoingSmsStatus>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

 


GetCampaignReportWithCampID 

Back to Top ^

 

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

Parametreler

 

ParametreDeğer 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampIDCampaign ID

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>
        <GetCampaignReportWithCampID xmlns="http://ws.euromsg.com/report">
            <ServiceTicket>string</ServiceTicket>
            <CampID>string</CampID>
        </GetCampaignReportWithCampID>
    </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>
        <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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Not a valid campaign id!Invalid Campaign ID.

 


GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp 

Back to Top ^

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

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampaignIDRapor alınacak kampanya ID’si

OPTIONAL

MapRapor dosyasında yer alacak kolonlar

MANDATORY

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

OPTIONAL

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

MANDATORY

BeginDateRapor başlangıç tarihi

MANDATORY

EndDateRapor bitiş tarihi

MANDATORY

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

MANDATORY

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

MANDATORY

PasswordRaporun bırakılacağı ftp/sftp parolası

MANDATORY

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

MANDATORY

SecureBağlantının tipi

MANDATORY

KeyHesabın referans bilgisi

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

If the request was successful, the CODE parameter will return 00 as a response.

If CAMP_ID parameter is left blank, the service returns the report for all members who have unsibscribed between two dates. If CAMP_ID parameter is filled, the system returns the report only for members who have unsubscribed from a particular campaign, between two dates.

Secure parameter can have a TRUE or FALSE value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as TRUE.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

 


QueryOngoingEmailStatus 

Back to Top ^

<QueryOngoingEmailStatus>
Email işlem kampanyası kapsamında gönderilen bir e-postanın ulaşım durumunu sorgular

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampIDCampaign ID

MANDATORY

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

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>
    <QueryOngoingEmailStatus xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <CampID>string</CampID>
      <TransacitonID>string</TransacitonID>
    </QueryOngoingEmailStatus>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Online Campaign does not exist!Gönderilen CampID parametresinin hesapta kayıtlı bir işlem kampanyasını ifade etmediğini gösterir.

 


GetListContent 

Back to Top ^

<GetListContent>
Belirtilen listenin içeriğindeki üyeleri listeler

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

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

MANDATORY

ListNameİçeriği sorgulanacak liste ismi

MANDATORY

ListInsertionBeginDateListeye kayda göre başlangıç tarihi

MANDATORY

ListInsertionFinishDateListeye kayda göre bitiş tarihi

MANDATORY

MapRapor dosyasında yer alacak kolonlar

MANDATORY

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

OPTIONAL

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

MANDATORY

BeginDateRapor başlangıç tarihi

MANDATORY

EndDateRapor bitiş tarihi

MANDATORY

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

MANDATORY

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

MANDATORY

PasswordRaporun bırakılacağı ftp/sftp parolası

MANDATORY

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

MANDATORY

SecureConnection Type

MANDATORY

KeyHesabın referans bilgisi

MANDATORY

If the request was successful, the CODE parameter will return 00 as a response.

Secure parameter can have a TRUE or FALSE value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as TRUE.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

 


GetSmsCampaignReport 

Back to Top ^

<GetSmsCampaignReport>
Belirtilen tarihler arasında ki sms kampanyalarının özelliklerini listeler.

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

BeginDateReport start date. dd.mm.yyyy

MANDATORY

EndDateReport end date. dd.mm.yyyy

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>
    <GetSmsCampaignReport xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetSmsCampaignReport>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

Hata Parametreleri

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

 


GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp 

Back to Top ^

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

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampaignIDRapor alınacak kampanya ID’si

OPTIONAL

MapRapor dosyasında yer alacak kolonlar

MANDATORY

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

OPTIONAL

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

MANDATORY

BeginDateRapor başlangıç tarihi

MANDATORY

EndDateRapor bitiş tarihi

MANDATORY

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

MANDATORY

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

MANDATORY

PasswordRaporun bırakılacağı ftp/sftp parolası

MANDATORY

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

MANDATORY

SecureBağlantının tipi

MANDATORY

KeyHesabın referans bilgisi

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

If the request was successful, the CODE parameter will return 00 as a response.

If CAMP_ID parameter is left blank, the service returns the report for all members who have unsibscribed between two dates. If CAMP_ID parameter is filled, the system returns the report only for members who have unsubscribed from a particular campaign, between two dates.

Secure parameter can have a TRUE or FALSE value depending on the connetion type. If the connection type is SFTP or secure FTP, then this flag must be sent as TRUE.

Error Parameter

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

 


GetSmsCampaignReportWithCampID 

Back to Top ^

<GetSmsCampaignReportWithCampID>
Bir sms kampanyasının kampanyanın özet bilgi ve özelliklerini listeler.

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

CampIDCampaign ID

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>
    <GetSmsCampaignReportWithCampID xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <SmsCampID>string</SmsCampID>
    </GetSmsCampaignReportWithCampID>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Not a valid campaign id!Invalid Campaign ID.

 


GetIncomingSmsMessages 

Back to Top ^

<GetIncomingSmsMessages>
Hesabınızda tanımlı olan kısa numaraya gönderilen smsleri listeler.

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

BeginTimeReport start date

MANDATORY

EndTimeReport end date

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>
    <GetIncomingSmsMessages xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </GetIncomingSmsMessages>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.Login metodu çalıştırılmamış. Aktif oturum yok.
99Not a valid date!Invalid date format.

 


GetSmsOptoutReportBetweenTwoDates 

Back to Top ^

<GetSmsOptoutReportBetweenTwoDates>
İki tarih aralığında sms kanalı üzerinden üyelikten ayrılan kullanıcıları listeler

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

BeginDateReport start date

MANDATORY

EndDateReport end date

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>
    <GetSmsOptoutReportBetweenTwoDates xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetSmsOptoutReportBetweenTwoDates>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

Date format is YYYY-MM-DD HH:MM:SS. The date range is limited to a maximum of 24 hours.

Error Parameters

 

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

 


QueryDataWarehouseUploadProgress 

Back to Top ^

<QueryDataWarehouseUploadProgres
Bir data warehouse yüklemesinin durumunu sorgulamanızı sağlar

Parameters

 

ParameterValue 
ServiceTicketServiceTicket obtained through Login

MANDATORY

FileNameYüklemesi sorgulamak istenilen dosya ismi

OPTIONAL

BeginTimeReport start date

OPTIONAL

EndTimeReport end date

OPTIONAL

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>
    <QueryDataWarehouseUploadProgress xmlns="http://ws.euromsg.com/report">
      <ServiceTicket>string</ServiceTicket>
      <FileName>string</FileName>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </QueryDataWarehouseUploadProgress>
  </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>
    <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>

If the request was successful, the CODE parameter will return 00 as a response.

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.

Date format is YYYY-MM-DD HH:MM:SS.

Error Parameters

 

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99Not a valid date!Invalid date format

 


 

  • No labels