Transactional Push Notifications are Push messages that are typically related to system or account related activity triggered by customer interactions with your brand. Common examples of these Push Notifications are:
- Password reminders / resets
- System notifications
- Order confirmation
- Verification messages
- Shipping confirmation
Transactional Push Web Service Methods
The following table lists supported methods for Transactional Push Web Service and provides a brief description of each method. For more detail on each method, click Click on the method name .for more information:
Warning |
---|
To interact with any Web Services, developers must first use the Login method to create a Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . Developers can send requests to other Web Service and methods using this Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . |
GetPostPushResult
Back to Top ^
<GetPostPushResult> |
---|
Reports the current statuses of sent transactional push notifications. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
pushIds | Unique id for sent transactional push | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Note |
---|
Since the push ids are responsed by RMC, you may leave pushId section blank. |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostPushResult xmlns="http://ws.euromsg.com/postpush">
<serviceTicket>string</serviceTicket>
<pushIds>
<string>string</string>
<string>string</string>
</pushIds>
</GetPostPushResult>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostPushResultResponse xmlns="http://ws.euromsg.com/postpush">
<GetPostPushResultResult>
<PostPushList>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string</EmpushToken>
<AppAlias>string</AppAlias>
<PushType>string</PushType>
<TextMessage>string</TextMessage>
<TargetUrl>string</TargetUrl>
<MediaUrl>string</MediaUrl>
<Status>string</Status>
<Created>dateTime</Created>
<TakenForSent>dateTime</TakenForSent>
<DsLastChange>dateTime</DsLastChange>
<OpenTime>dateTime</OpenTime>
</PostPushModel>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string</EmpushToken>
<AppAlias>string</AppAlias>
<PushType>string</PushType>
<TextMessage>string</TextMessage>
<TargetUrl>string</TargetUrl>
<MediaUrl>string</MediaUrl>
<Status>string</Status>
<Created>dateTime</Created>
<TakenForSent>dateTime</TakenForSent>
<DsLastChange>dateTime</DsLastChange>
<OpenTime>dateTime</OpenTime>
</PostPushModel>
</PostPushList>
</GetPostPushResultResult>
</GetPostPushResultResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetPostPushResultByCreationDate
Back to Top ^
<GetPostPushResultByCreationDate> |
---|
Reports the current statuses of sent transactional push notifications by creation date. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BeginDate | Report start date. Date format should be yyyy-MM-dd HH:mm:ss | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
EndDate | Report end date. Date format should be yyyy-MM-dd HH:mm:ss | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Page | Page size of the report. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostPushResultByCreationDate xmlns="http://ws.euromsg.com/postpush">
<serviceTicket>string</serviceTicket>
<request>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
<Page>int</Page>
</request>
</GetPostPushResultByCreationDate>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostPushResultByCreationDateResponse xmlns="http://ws.euromsg.com/postpush">
<GetPostPushResultByCreationDateResult>
<PostPushList>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string</EmpushToken>
<AppAlias>string</AppAlias>
<PushType>string</PushType>
<TextMessage>string</TextMessage>
<TargetUrl>string</TargetUrl>
<MediaUrl>string</MediaUrl>
<Status>string</Status>
<Created>dateTime</Created>
<TakenForSent>dateTime</TakenForSent>
<DsLastChange>dateTime</DsLastChange>
<OpenTime>dateTime</OpenTime>
</PostPushModel>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string</EmpushToken>
<AppAlias>string</AppAlias>
<PushType>string</PushType>
<TextMessage>string</TextMessage>
<TargetUrl>string</TargetUrl>
<MediaUrl>string</MediaUrl>
<Status>string</Status>
<Created>dateTime</Created>
<TakenForSent>dateTime</TakenForSent>
<DsLastChange>dateTime</DsLastChange>
<OpenTime>dateTime</OpenTime>
</PostPushModel>
</PostPushList>
</GetPostPushResultByCreationDateResult>
</GetPostPushResultByCreationDateResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetPostPushResultByLastUpdate
Back to Top ^
<GetPostPushResultByLastUpdate> |
---|
Reports the current statuses of sent transactional push notifications by last update. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BeginDate | Report start date. Date format should be yyyy-MM-dd HH:mm:ss | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
EndDate | Report end date. Date format should be yyyy-MM-dd HH:mm:ss | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Page | Page size of the report. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostPushResultByLastUpdate xmlns="http://ws.euromsg.com/postpush">
<serviceTicket>string</serviceTicket>
<request>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
<Page>int</Page>
</request>
</GetPostPushResultByLastUpdate>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostPushResultByLastUpdateResponse xmlns="http://ws.euromsg.com/postpush">
<GetPostPushResultByLastUpdateResult>
<PostPushList>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string</EmpushToken>
<AppAlias>string</AppAlias>
<PushType>string</PushType>
<TextMessage>string</TextMessage>
<TargetUrl>string</TargetUrl>
<MediaUrl>string</MediaUrl>
<Status>string</Status>
<Created>dateTime</Created>
<TakenForSent>dateTime</TakenForSent>
<DsLastChange>dateTime</DsLastChange>
<OpenTime>dateTime</OpenTime>
</PostPushModel>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string</EmpushToken>
<AppAlias>string</AppAlias>
<PushType>string</PushType>
<TextMessage>string</TextMessage>
<TargetUrl>string</TargetUrl>
<MediaUrl>string</MediaUrl>
<Status>string</Status>
<Created>dateTime</Created>
<TakenForSent>dateTime</TakenForSent>
<DsLastChange>dateTime</DsLastChange>
<OpenTime>dateTime</OpenTime>
</PostPushModel>
</PostPushList>
</GetPostPushResultByLastUpdateResult>
</GetPostPushResultByLastUpdateResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
PostTransactionalPush
Back to Top ^
<PostTransactionalPush> |
---|
Sends transactional push notifications by Member Key. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ApplicationAlias | Application alias defined on RMC account | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ClassificationName | Campaign classification name. | Status |
---|
| |
---|
colour | Yellow |
---|
title | optıonal |
---|
|
|
MemberKey | EMAIL, MEMBER_ID or a field name of your defined in RMC account management panel | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
MemberValue | The value of the field name specified in the Key field | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
message | Push message details. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostTransactionalPush xmlns="http://ws.euromsg.com/postpush">
<ServiceTicket>string</ServiceTicket>
<ApplicationAlias>string</ApplicationAlias>
<ClassificationName>string</ClassificationName>
<MemberKey>string</MemberKey>
<MemberValue>string</MemberValue>
<message>
<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>
<anyType />
<anyType />
</SystemVariables>
<PromoTableId>string</PromoTableId>
<CustomerId>string</CustomerId>
</message>
</PostTransactionalPush>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostTransactionalPushResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalPushResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalPushResult>
</PostTransactionalPushResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
PostTransactionalPushWithToken
Back to Top ^
<PostTransactionalPushWithToken> |
---|
Sends transactional push notifications by Token ID. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ApplicationAlias | Application alias defined on RMC account | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ClassificationName | Campaign classification name. | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
AuthToken | Token id for authentication. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
message | Push message details. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostTransactionalPushWithToken xmlns="http://ws.euromsg.com/postpush">
<ServiceTicket>string</ServiceTicket>
<ApplicationAlias>string</ApplicationAlias>
<ClassificationName>string</ClassificationName>
<AuthToken>string</AuthToken>
<message>
<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>
<anyType />
<anyType />
</SystemVariables>
<PromoTableId>string</PromoTableId>
<CustomerId>string</CustomerId>
</message>
</PostTransactionalPushWithToken>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostTransactionalPushWithTokenResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalPushWithTokenResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalPushWithTokenResult>
</PostTransactionalPushWithTokenResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |