POST
| Service URL | LIVE: https://api.relateddigital.com/live/report.asmx ECOMM: https://api.relateddigital.com/ecomm/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 and builds campaign report between 2 dates. | |
Queries and builds campaign report between 2 dates based on Campaign ID. | |
Shows the Email Campaign's delivery status between two dates based on Campaign ID. | |
Queries links of a campaign. | |
Returns the list of users who clicked on a campaign link between two dates. | |
Queries and builds a report of members who unsubscribed from email between two dates. | |
Allows you to create member inquiries based on specific filters. | |
Reports incoming SMS messages. | |
Queries members in a list. | |
Queries and builds a delivery status report based on a given SMS Campaign ID. | |
Queries and builds SMS campaign reports between 2 dates. Date format must be dd.mm.yyyy | |
Queries and builds campaign report based on a given SMS Campaign ID. | |
Queries and builds an SMS opt-out report between two dates. | |
Queries and builds an unsubscribe report between two dates. | |
Allows you to inquire about the status of an upload or report request. | |
Queries the status of a Data Warehouse upload. | |
Queries and reports the delivery status of a triggered Email campaign. | |
Queries and reports the delivery status of a triggered SMS campaign. | |
| 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> |
|---|
| Queries and builds a report of members who unsubscribed from email 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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<IsPassive>boolean</IsPassive>
</FtpDetails>
</GetEmailUnsubscribeReportBetweenTwoDatesViaFtp>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResponse xmlns="http://ws.euromsg.com/report">
<GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResult>
<ConversationID>string</ConversationID>
<ConversationStatus>string</ConversationStatus>
<TotalRowCountInConversation>int</TotalRowCountInConversation>
<ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
</GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResult>
</GetEmailUnsubscribeReportBetweenTwoDatesViaFtpResponse>
</soap12:Body>
</soap12: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> |
|---|
| Queries links of a campaign. |
Parameters
| Parameter | Value |
|---|---|
| ServiceTicket | ServiceTicket obtained through Login |
| CampaignID | Campaign ID to list the links for |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetEmailCampaignLinks xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<CampaignID>string</CampaignID>
</GetEmailCampaignLinks>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetEmailCampaignLinksResponse xmlns="http://ws.euromsg.com/report">
<GetEmailCampaignLinksResult>
<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>
</soap12:Body>
</soap12: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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<IsPassive>boolean</IsPassive>
</FtpDetails>
</GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResponse xmlns="http://ws.euromsg.com/report">
<GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResult>
<ConversationID>string</ConversationID>
<ConversationStatus>string</ConversationStatus>
<TotalRowCountInConversation>int</TotalRowCountInConversation>
<ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
</GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResult>
</GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtpResponse>
</soap12:Body>
</soap12: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 yyyy-MM-dd hh:mm:ss |
| EndDate | Report end date. Date format must be yyyy-MM-dd hh:mm:ss |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetUnsubscribeReportBetweenTwoDates xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
</GetUnsubscribeReportBetweenTwoDates>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<Status>string</Status>
<ClientIP>string</ClientIP>
</EmUnsubscriberDetails>
<EmUnsubscriberDetails>
<KeyId>string</KeyId>
<Email>string</Email>
<UnsubscribeTime>string</UnsubscribeTime>
<Reason>string</Reason>
<GsmNo>string</GsmNo>
<EmailPermit>string</EmailPermit>
<GsmPermit>string</GsmPermit>
<Status>string</Status>
<ClientIP>string</ClientIP>
</EmUnsubscriberDetails>
</Unsubscribers>
</GetUnsubscribeReportBetweenTwoDatesResponse>
</soap12:Body>
</soap12: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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<IsPassive>boolean</IsPassive>
</FtpDetails>
</GetFilteredMembers>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetFilteredMembersResponse xmlns="http://ws.euromsg.com/report">
<GetFilteredMembersResult>
<ConversationID>string</ConversationID>
<ConversationStatus>string</ConversationStatus>
<TotalRowCountInConversation>int</TotalRowCountInConversation>
<ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
</GetFilteredMembersResult>
</GetFilteredMembersResponse>
</soap12:Body>
</soap12: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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCampaignReport xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
</GetCampaignReport>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCampaignReportResponse xmlns="http://ws.euromsg.com/report">
<GetCampaignReportResult>
<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>
<FromAddress>string</FromAddress>
</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>
<FromAddress>string</FromAddress>
</EmCampaignReportResult>
</Campaigns>
</GetCampaignReportResponse>
</soap12:Body>
</soap12: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 about 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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryBulkFileProgress xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<ConversationID>string</ConversationID>
</QueryBulkFileProgress>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryBulkFileProgressResponse xmlns="http://ws.euromsg.com/report">
<QueryBulkFileProgressResult>
<ConversationID>string</ConversationID>
<ConversationStatus>string</ConversationStatus>
<TotalRowCountInConversation>int</TotalRowCountInConversation>
<ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
</QueryBulkFileProgressResult>
</QueryBulkFileProgressResponse>
</soap12:Body>
</soap12: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 and reports the delivery status of a triggered SMS campaign. |
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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryOngoingSmsStatus xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<CampID>string</CampID>
<TransacitonID>string</TransacitonID>
</QueryOngoingSmsStatus>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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> |
|---|
Queries and builds campaign report between 2 dates based on Campaign ID. |
Parameters
| Parameter | Value | |
|---|---|---|
| ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
| CampID | Campaign ID | MANDATORY |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCampaignReportWithCampID xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<CampID>string</CampID>
</GetCampaignReportWithCampID>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCampaignReportWithCampIDResponse xmlns="http://ws.euromsg.com/report">
<GetCampaignReportWithCampIDResult>
<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>
<FromAddress>string</FromAddress>
</Campaign>
</GetCampaignReportWithCampIDResponse>
</soap12:Body>
</soap12: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 delivery status between two dates based on a given 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 |
Delivery Status
Values | Description |
HU-HB | Invalid domain or username. Errors like ip blocking. |
HJ | Marked as spam. |
SU | Mails that cannot be sent to the mail address in an instant. Errors like full of mail box or temporary dns error. |
HT | Disposable E-mails are named as HT by Euromessage. No delivery to those addresses. |
RE | Delivery is completed. No response from user. |
RD | Read by user. |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<IsPassive>boolean</IsPassive>
</FtpDetails>
</GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse xmlns="http://ws.euromsg.com/report">
<GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
<ConversationID>string</ConversationID>
<ConversationStatus>string</ConversationStatus>
<TotalRowCountInConversation>int</TotalRowCountInConversation>
<ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
</GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
</GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse>
</soap12:Body>
</soap12: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 campaign. |
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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryOngoingEmailStatus xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<CampID>string</CampID>
<TransacitonID>string</TransacitonID>
</QueryOngoingEmailStatus>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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 |
ÖRNEK REQUEST
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetListContent xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<GroupName>string</GroupName>
<ListName>string</ListName>
<ListInsertionBeginDate>string</ListInsertionBeginDate>
<ListInsertionFinishDate>string</ListInsertionFinishDate>
<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>
<IsPassive>boolean</IsPassive>
</FtpDetails>
<IsEncrypt>boolean</IsEncrypt>
</GetListContent>
</soap12:Body>
</soap12:Envelope>
ÖRNEK RESPONSE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetListContentResponse xmlns="http://ws.euromsg.com/report">
<GetListContentResult>
<ConversationID>string</ConversationID>
<ConversationStatus>string</ConversationStatus>
<TotalRowCountInConversation>int</TotalRowCountInConversation>
<ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
</GetListContentResult>
</GetListContentResponse>
</soap12:Body>
</soap12:Envelope>
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> |
|---|
Queries and builds SMS campaign reports between 2 dates. Date format must be dd.mm.yyyy. |
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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSmsCampaignReport xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
</GetSmsCampaignReport>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<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>
</soap12:Body>
</soap12: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> |
|---|
Queries and builds a delivery status report based on a given 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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<IsPassive>boolean</IsPassive>
</FtpDetails>
</GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse xmlns="http://ws.euromsg.com/report">
<GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
<ConversationID>string</ConversationID>
<ConversationStatus>string</ConversationStatus>
<TotalRowCountInConversation>int</TotalRowCountInConversation>
<ProcessedRowCountInConversation>int</ProcessedRowCountInConversation>
</GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResult>
</GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtpResponse>
</soap12:Body>
</soap12: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> |
|---|
Queries and builds campaign report based on a given SMS Campaign ID. |
Parameters
| Parameter | Value | |
|---|---|---|
| ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
| CampID | Campaign ID | MANDATORY |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSmsCampaignReportWithCampID xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<SmsCampID>string</SmsCampID>
</GetSmsCampaignReportWithCampID>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetIncomingSmsMessages xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<BeginTime>string</BeginTime>
<EndTime>string</EndTime>
</GetIncomingSmsMessages>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12: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> |
|---|
Queries and builds an SMS opt-out report 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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSmsOptoutReportBetweenTwoDates xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
</GetSmsOptoutReportBetweenTwoDates>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<KeyId>string</KeyId>
<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>
<KeyId>string</KeyId>
<EffectedMembers>
<EmSmsOptoutEffectedMembers xsi:nil="true" />
<EmSmsOptoutEffectedMembers xsi:nil="true" />
</EffectedMembers>
</EmSmsOptoutList>
</Unsubscribers>
</GetSmsOptoutReportBetweenTwoDatesResponse>
</soap12:Body>
</soap12: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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<QueryDataWarehouseUploadProgress xmlns="http://ws.euromsg.com/report">
<ServiceTicket>string</ServiceTicket>
<FileName>string</FileName>
<BeginTime>string</BeginTime>
<EndTime>string</EndTime>
</QueryDataWarehouseUploadProgress>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<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>
</soap12:Body>
</soap12: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
| 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> |
|---|
Queries Push messages sent to members. |
Parameters
| Parameter | Value | |
|---|---|---|
| ServiceTicket | ServiceTicket obtained through Login | MANDATORY |
| beginDate | Report start date. Date format must be yyyy-mm-dd hh:mm:ss (ex.;2018-10-25 00:00:00) | MANDATORY |
| endDate | Report end date. Date format must be yyyy-mm-dd hh:mm:ss (ex.;2018-10-25 00:00:00) | 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 |
REQUEST EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
</soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12: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>
<IsMutableContent>boolean</IsMutableContent>
<CustomParams xsi:nil="true" />
<AlternateCustomParams xsi:nil="true" />
<SoundFile>string</SoundFile>
<Title>string</Title>
</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>
<IsMutableContent>boolean</IsMutableContent>
<CustomParams xsi:nil="true" />
<AlternateCustomParams xsi:nil="true" />
<SoundFile>string</SoundFile>
<Title>string</Title>
</EmPushMessage>
</pushReportList>
</QuerySendingPushMessageToMembersResult>
</QuerySendingPushMessageToMembersResponse>
</soap12:Body>
</soap12: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