POST
Service URL | report.asmx |
---|
General Information
Report Web Service provides several methods for getting reports for your Email, SMS and Push campaign reports.
Report Web Service Methods
The following table lists supported methods in Report Web Service and provides a brief description of each method. Click on the method name for detailed information:
Method | Description |
---|---|
Queries the campaigns and its basic details between 2 dates. | |
Queries a campaign and its basic details. | |
Queries and builds an email campaign delivery status report file with specified demographic variables and date range. | |
Queries links of a campaign. | |
Queries and builds a campaign member link report file with specified demographic variables and date range. | |
Queries and builds an unsubscribe report file with specified demographic variables and date range. | |
Queries subscribers by filters. | |
Reports incoming SMS messages. | |
Queries members in a list. | |
Queries and builds a delivery status file with specified demographic variables for an SMS campaign. | |
Queries SMS campaigns and its basic details between 2 dates. Date format must be dd.mm.yyyy | |
Queries SMS campaigns and its basic details with CAMP_ID. | |
Queries and builds an SMS opt-out report between two dates. | |
Queries and builds an unsubscribe report between two dates. | |
Queries the status of a conversation. | |
Queries the status of a Data Warehouse upload. | |
Reports delivery status of an ongoing (triggered) Email. | |
Reports delivery status of an ongoing (triggered) SMS. | |
QuerySendingPushMessageToMembers | Queries push messages sent to members. |
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
<GetEmailUnsubscribeReportBetweenTwoDatesViaFtp> |
---|
Creates the report of the members who unsubscribed between two dates. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampaignID | Campaign ID to get the Report for | OPTIONAL |
Map | Columns of the Report File | MANDATORY |
ZipPassword | Password of the Zip File that contains the Report File | OPTIONAL |
NotificationEmail | The address to send notification email about the status of the Report request | MANDATORY |
ServerIP | IP address of the FTP/SFTP server to send the Report to | MANDATORY |
Username | The Username for the FTP/SFTP server to send the Report to | MANDATORY |
Password | The password for the FTP/SFTP server to send the Report to | MANDATORY |
ChangeDir | The folder path to send the Report to | MANDATORY |
Secure | Connection Type | MANDATORY |
Key | Account reference information | MANDATORY |
<?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>
<?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
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetEmailCampaignLinks
<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 |
<?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>
<?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
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
<GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp> |
---|
Returns the list of users who clicked on a campaign link between two dates. |
Parameters
Parameter | Değer | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampaignID | Campaign ID to create the report for | MANDATORY |
BeginDate | Report start date | MANDATORY |
EndDate | Report end date | MANDATORY |
Map | Order of the Report columns | MANDATORY |
ZipPassword | Password of the Zip File that contains the Report File | OPTIONAL |
NotificationEmail | The address to send notification email about the status of the report request | MANDATORY |
ServerIP | IP address of the FTP/SFTP server to send the Report to | MANDATORY |
Username | The Username for the FTP/SFTP server to send the Report to | MANDATORY |
Password | The password for the FTP/SFTP server to send the Report to | MANDATORY |
ChangeDir | The folder path to send the Report to | MANDATORY |
Secure | Connection Type | MANDATORY |
Key | Account reference information | MANDATORY |
<?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>
<?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
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
<GetUnsubscribeReportBetweenTwoDates> |
---|
Lists the members who have unsubscribed between two dates. |
Parameters
Parameter | Value |
---|---|
ServiceTicket | ServiceTicket obtained through Login |
BeginDate | Report start date. Date format must be dd.mm.yyyy |
EndDate | Report end date. Date format must be dd.mm.yyyy |
<?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>
<?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
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
<GetFilteredMembers> |
---|
Allows you to create member inquiries based on specific filters. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
Filters | String that contains the filters to apply | MANDATORY |
EmKeyOperatorValue | Contains the details of the filter to apply | MANDATORY |
Key | Demographic or permission information to apply the filtering to | MANDATORY |
Operator | Comparison operator to apply in the scope of the filter(=, <>, <, > etc) | MANDATORY |
Value | The key parameter value to be used for filtering | MANDATORY |
Map | Columns of the report to create | MANDATORY |
ZipPassword | Zip password for the report to create | OPTIONAL |
NotificationEmail | The address to send the notification email depending on the status of the report request | MANDATORY |
FtpDetails | The string that contains the FTP/SFTP field info to send the created report to | MANDATORY |
ServerIP | IP address of the FTP/SFTP server to send the report to | MANDATORY |
Username | The username of the FTP/SFTP server to send the report to | MANDATORY |
Password | The password for the FTP/SFTP server to send the report to | MANDATORY |
ChangeDir | The folder path to send the report to | MANDATORY |
Secure | Connection type | MANDATORY |
Key | Account reference information | MANDATORY |
<?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>
<?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
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetCampaignReport
<GetCampaignReport> |
---|
Lists the campaign reports between two specified dates. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
BeginDate | Report start date. Date format must be dd.mm.yyyy | MANDATORY |
EndDate | Report end date. Date format must be dd.mm.yyyy | MANDATORY |
<?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>
<?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
Code | Error Message | Açıklama |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
QueryBulkFileProgress
<QueryBulkFileProgress> |
---|
Allows you to inquire the status of an upload or report request. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
ConversationID | 32 Byte ID returned by the system as a result of the upload or report request | MANDATORY |
<?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>
<?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
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
<QueryOngoingSmsStatus> |
---|
Queries the delivery status of a triggered SMS message. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampID | Campaign ID | MANDATORY |
TransactionID | 32 Byte ID returned by the system as a result of the upload or report request | MANDATORY |
<?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>
<?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
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetCampaignReportWithCampID
<GetCampaignReportWithCampID> |
---|
Lists summary information and features of an Email Campaign. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampID | Campaign ID | MANDATORY |
<?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>
<?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
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> |
---|
Shows the Campaign's delivery status based on the Campaign ID. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampaignID | Campaign ID to take report for | MANDATORY |
Map | Columns of the report file | MANDATORY |
ZipPassword | The password of the Zip file that contains the report file | OPTIONAL |
NotificationEmail | The address to send notification email about the status of the report request | MANDATORY |
BeginDate | Report start date | MANDATORY |
EndDate | Report end date | MANDATORY |
ServerIP | IP address of the FTP/SFTP server to send the report to | MANDATORY |
Username | Username for the FTP/SFTP server to send the report to | MANDATORY |
Password | Password for the ftp/sftp server to send the report to | MANDATORY |
ChangeDir | The folder path to send the report to | MANDATORY |
Secure | Connection Type | MANDATORY |
Key | Account Reference Information | MANDATORY |
<?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>
<?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
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
QueryOngoingEmailStatus
<QueryOngoingEmailStatus> |
---|
Queries the delivery status a triggered email message. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampID | Campaign ID | MANDATORY |
TransactionID | 32 Byte ID returned by the system as a result of the upload or report request | MANDATORY |
<?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>
<?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
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Online Campaign does not exist! | The sent CampID parameter does not correspond to any registered campaign in the account. |
GetListContent
<GetListContent> |
---|
Lists the members found in a specified list. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
GroupName | Group that the list to inquire belongs to | MANDATORY |
ListName | Name of the List to create inquiry | MANDATORY |
ListInsertionBeginDate | Start date based on saving on the list | MANDATORY |
ListInsertionFinishDate | End date based on saving on the list | MANDATORY |
Map | Columns of the report file | MANDATORY |
ZipPassword | The password of the Zip file that contains the report file | OPTIONAL |
NotificationEmail | The address to send notification email about the status of the report request | MANDATORY |
BeginDate | Report start date | MANDATORY |
EndDate | Report end date | MANDATORY |
ServerIP | IP address of the FTP/SFTP server to send the report to | MANDATORY |
Username | Username for the FTP/SFTP server to send the report to | MANDATORY |
Password | Password for the ftp/sftp server to send the report to | MANDATORY |
ChangeDir | The folder path to send the report to | MANDATORY |
Secure | Connection Type | MANDATORY |
Key | Account reference information | 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
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetSmsCampaignReport
<GetSmsCampaignReport> |
---|
Lists the features of the SMS campaigns between specified dates. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
BeginDate | Report start date. Date format must be dd.mm.yyyy | MANDATORY |
EndDate | Report end date. Date format must be dd.mm.yyyy | MANDATORY |
<?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>
<?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.
Error Parameters
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
<GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp> |
---|
Shows the campaign SMS delivery status report based on the specified SMS Campaign ID. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampaignID | Campaign ID to take report for | OPTIONAL |
Map | Columns of the report file | MANDATORY |
ZipPassword | The password of the Zip file that contains the report file | OPTIONAL |
NotificationEmail | The address to send notification email about the status of the report request | MANDATORY |
BeginDate | Report start date | MANDATORY |
EndDate | Report end date | MANDATORY |
ServerIP | IP address of the FTP/SFTP server to send the report to | MANDATORY |
Username | Username for the FTP/SFTP server to send the report to | MANDATORY |
Password | Password for the ftp/sftp server to send the report to | MANDATORY |
ChangeDir | The folder path to send the report to | MANDATORY |
Secure | Connection Type | MANDATORY |
Key | FTP Key ID | OPTIONAL |
<?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>
<?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
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetSmsCampaignReportWithCampID
<GetSmsCampaignReportWithCampID> |
---|
Lists summary information and features of an SMS Campaign. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
CampID | Campaign ID | MANDATORY |
<?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>
<?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
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
<GetIncomingSmsMessages> |
---|
Lists the SMS messages sent to the short number defined in your account. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
BeginTime | Report start date. Date format must be dd.mm.yyyy | MANDATORY |
EndTime | Report end date. Date format must be dd.mm.yyyy | MANDATORY |
<?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>
<?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
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
<GetSmsOptoutReportBetweenTwoDates> |
---|
Lists the members who have unsubscribed from the SMS channel between two dates. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
BeginDate | Report start date. Date format must be dd.mm.yyyy | MANDATORY |
EndDate | Report end date. Date format must be dd.mm.yyyy | MANDATORY |
<?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>
<?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> <KeyId>string</KeyId> <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
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
<QueryDataWarehouseUploadProgres |
---|
Allows you to inquire about the status of a data warehouse upload. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
FileName | Name of the file to inquire about upload status | OPTIONAL |
BeginTime | Report start date. Date format must be dd.mm.yyyy | OPTIONAL |
EndTime | Report end date. Date format must be dd.mm.yyyy | OPTIONAL |
<?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>
<?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.
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 |
QuerySendingPushMessageToMembers
<QuerySendingPushMessageToMembers> |
---|
Query of sending push message to members. |
Parameters
Parameter | Value | |
---|---|---|
ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
beginDate | Report start date. Date format must be dd.mm.yyyy | MANDATORY |
endDate | Report end date. Date format must be dd.mm.yyyy | MANDATORY |
key | EMAIL, MEMBER_ID or a field name of your defined in RMC account management panel. | MANDATORY |
value | The value of the field name specified in the Key field. | MANDATORY |
pageSize | Sets the page size of the report. | MANDATORY |
pageCount | Sets the page count of thre report. | MANDATORY |
<?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> <QuerySendingPushMessageToMembers xmlns="http://ws.euromsg.com/report"> <ServiceTicket>string</ServiceTicket> <key>string</key> <value>string</value> <beginDate>string</beginDate> <endDate>string</endDate> <pageSize>int</pageSize> <pageCount>int</pageCount> </QuerySendingPushMessageToMembers> </soap:Body> </soap:Envelope>
<?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> <QuerySendingPushMessageToMembersResponse xmlns="http://ws.euromsg.com/report"> <QuerySendingPushMessageToMembersResult> <UnreadMessageCount>int</UnreadMessageCount> <ReadMessageCount>int</ReadMessageCount> <pushReportList> <EmPushMessage> <PushId>string</PushId> <Type>Image or Video or Text or Settings or Survey</Type> <Text>string</Text> <TargetUrl>string</TargetUrl> <MediaUrl>string</MediaUrl> <MemberId>string</MemberId> <SentTime>dateTime</SentTime> <PacketStatus>string</PacketStatus> <MessageStatusCode>string</MessageStatusCode> <MessageStatus>string</MessageStatus> <CampId>string</CampId> <CampName>string</CampName> <ContentType>string</ContentType> <IsABCustomization>boolean</IsABCustomization> <TextMessageA>string</TextMessageA> <TextMessageB>string</TextMessageB> <EmpushToken>string</EmpushToken> <Params>string</Params> <AlternateMessage>string</AlternateMessage> <SystemVariables xsi:nil="true" /> <PromoTableId>string</PromoTableId> <CustomerId>string</CustomerId> </EmPushMessage> <EmPushMessage> <PushId>string</PushId> <Type>Image or Video or Text or Settings or Survey</Type> <Text>string</Text> <TargetUrl>string</TargetUrl> <MediaUrl>string</MediaUrl> <MemberId>string</MemberId> <SentTime>dateTime</SentTime> <PacketStatus>string</PacketStatus> <MessageStatusCode>string</MessageStatusCode> <MessageStatus>string</MessageStatus> <CampId>string</CampId> <CampName>string</CampName> <ContentType>string</ContentType> <IsABCustomization>boolean</IsABCustomization> <TextMessageA>string</TextMessageA> <TextMessageB>string</TextMessageB> <EmpushToken>string</EmpushToken> <Params>string</Params> <AlternateMessage>string</AlternateMessage> <SystemVariables xsi:nil="true" /> <PromoTableId>string</PromoTableId> <CustomerId>string</CustomerId> </EmPushMessage> </pushReportList> </QuerySendingPushMessageToMembersResult> </QuerySendingPushMessageToMembersResponse> </soap:Body> </soap:Envelope>
If the request was successful, the CODE parameter will return 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. |
Parent Topic: SOAP Web Service