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. Click on the method name for detailed 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<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<GetPostPushResult xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<serviceTicket>string</serviceTicket>
<pushIds>
<string>string</string>
<string>string</string>
</pushIds>
</GetPostPushResult>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<GetPostPushResultResponse xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<GetPostPushResultResult>
<PostPushList>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string<<Email>string</EmpushToken>Email>
<AppAlias>string</<Key_Id>string</Key_Id>
<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>
<Email>string</Email>
<Key_Id>string</Key_Id>
<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>
</soapsoap12:Body>
</soapsoap12: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<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<GetPostPushResultByCreationDate xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<serviceTicket>string</serviceTicket>
<request>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
<Page>int</Page>
</request>
</GetPostPushResultByCreationDate>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<GetPostPushResultByCreationDateResponse xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<GetPostPushResultByCreationDateResult>
<PostPushList>
<PostPushModel>
<PushId>guid</PushId>
<Email>string</Email>
<Key_Id>string</Key_Id>
<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<<Email>string</EmpushToken>Email>
<AppAlias>string</AppAlias><Key_Id>string</Key_Id>
<PushType>string<<EmpushToken>string</PushType>EmpushToken>
<TextMessage>string<<AppAlias>string</TextMessage>AppAlias>
<TargetUrl>string<<PushType>string</TargetUrl>PushType>
<MediaUrl>string<<TextMessage>string</MediaUrl>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>
</soapsoap12:Body>
</soapsoap12: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<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<GetPostPushResultByLastUpdate xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<serviceTicket>string</serviceTicket>
<request>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
<Page>int</Page>
</request>
</GetPostPushResultByLastUpdate>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<GetPostPushResultByLastUpdateResponse xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<GetPostPushResultByLastUpdateResult>
<PostPushList>
<PostPushModel>
<PushId>guid</PushId>
<EmpushToken>string<<Email>string</EmpushToken>Email>
<AppAlias>string</AppAlias><Key_Id>string</Key_Id>
<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>
<Email>string</Email>
<Key_Id>string</Key_Id>
<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>
</soapsoap12:Body>
</soapsoap12: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<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<PostTransactionalPush xmlns="http://apiws.relateddigitaleuromsg.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>
<SoundFile>string</SoundFile>
<SystemVariables>
<anyType />
<anyType />
</SystemVariables>
<PromoTableId>string</PromoTableId>
<CustomerId>string</CustomerId>
</message><IsMutableContent>boolean</IsMutableContent>
<CustomParams>
</PostTransactionalPush><string>string</string>
</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><string>string</string>
</CustomParams>
<AlternateCustomParams>
<PostTransactionalPushResponse xmlns="http://api.relateddigital.com/postpush"> <string>string</string>
<PostTransactionalPushResult> <PushList>
<EmPushMessageResultItem>
<PushId>string</PushId><string>string</string>
</EmPushMessageResultItem>AlternateCustomParams>
<EmPushMessageResultItem>
<PushId>string</PushId><SoundFile>string</SoundFile>
<<Title>string</EmPushMessageResultItem>Title>
</PushList>
message>
</PostTransactionalPushResult>
PostTransactionalPush>
</PostTransactionalPushResponse>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red | 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 Anchor |
---|
transtoken | transtoken | 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://api.relateddigital.com/postpush">
<ServiceTicket>string</ServiceTicket>
<ApplicationAlias>string</ApplicationAlias>
<ClassificationName>string</ClassificationName>
<AuthToken>string</AuthToken>
<message>RESPONSE EXAMPLE | linenumbers | true |
---|
|
<?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>
<PostTransactionalPushResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalPushResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalPushResult>
</PostTransactionalPushResponse>
</soap12:Body>
</soap12: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"?>
<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>
<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>
<PushId>string<<CampId>string</PushId>CampId>
<CampName>string</CampName>
<Type>Image or Video or Text or Settings or Survey<<ContentType>string</Type>ContentType>
<Text>string<<IsABCustomization>boolean</Text>IsABCustomization>
<TargetUrl>string<<TextMessageA>string</TargetUrl>TextMessageA>
<MediaUrl>string<<TextMessageB>string</MediaUrl>TextMessageB>
<MemberId>string<<EmpushToken>string</MemberId>EmpushToken>
<SentTime>dateTime</SentTime>
<Params>string</Params>
<PacketStatus>string</PacketStatus> <AlternateMessage>string</AlternateMessage>
<MessageStatusCode>string</MessageStatusCode> <SystemVariables>
<MessageStatus>string</MessageStatus> <anyType />
<CampId>string</CampId> <anyType <CampName>string</CampName>>
<ContentType>string<</ContentType>SystemVariables>
<IsABCustomization>boolean<<PromoTableId>string</IsABCustomization>PromoTableId>
<TextMessageA>string<<CustomerId>string</TextMessageA>CustomerId>
<TextMessageB>string<<IsMutableContent>boolean</TextMessageB>IsMutableContent>
<CustomParams>
<EmpushToken>string</EmpushToken> <Params>string<<string>string</Params>string>
<AlternateMessage>string<<string>string</AlternateMessage>string>
<SoundFile>string<</SoundFile>CustomParams>
<AlternateCustomParams>
<SystemVariables> <anyType <string>string</>string>
<anyType <string>string</>string>
</SystemVariables>AlternateCustomParams>
<PromoTableId>string<<SoundFile>string</PromoTableId>SoundFile>
<CustomerId>string<<Title>string</CustomerId>Title>
</message>
</PostTransactionalPushWithToken>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<PostTransactionalPushWithTokenResponse xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<PostTransactionalPushWithTokenResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalPushWithTokenResult>
</PostTransactionalPushWithTokenResponse>
</soapsoap12:Body>
</soapsoap12: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. |
PostTransactionalPushWithLastUsedKnownTokenOnly
Anchor |
---|
| transtokenlast |
---|
| transtokenlast |
---|
|
Back to Top ^
<PostTransactionalPushWithLastUsedKnownTokenOnly> |
---|
Sends transactional push notifications by Last Used Known Token. |
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 |
---|
|
|
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<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>
<PostTransactionalPushWithLastUsedKnownTokenOnly xmlns="http://ws.euromsg.com/postpush">
<ServiceTicket>string<//schemas.xmlsoap.org/soap/envelope/">
<soap:Body>ServiceTicket>
<ApplicationAlias>string</ApplicationAlias>
<ClassificationName>string</ClassificationName>
<MemberKey>string</MemberKey>
<MemberValue>string</MemberValue>
<message>
<PostTransactionalPushWithLastUsedKnownTokenOnly xmlns="http://api.relateddigital.com/postpush"><PushId>string</PushId>
<Type>Image or Video or Text or Settings or Survey</Type>
<Text>string</Text>
<ServiceTicket>string<<TargetUrl>string</ServiceTicket>TargetUrl>
<ApplicationAlias>string<<MediaUrl>string</ApplicationAlias>MediaUrl>
<ClassificationName>string<<MemberId>string</ClassificationName>MemberId>
<MemberKey>string<<SentTime>dateTime</MemberKey>SentTime>
<MemberValue>string<<PacketStatus>string</MemberValue>PacketStatus>
<message><MessageStatusCode>string</MessageStatusCode>
<PushId>string<<MessageStatus>string</PushId>MessageStatus>
<Type>Image<CampId>string</CampId>
or Video or Text or Settings or Survey<<CampName>string</Type>CampName>
<Text>string<<ContentType>string</Text>ContentType>
<TargetUrl>string<<IsABCustomization>boolean</TargetUrl>IsABCustomization>
<MediaUrl>string<<TextMessageA>string</MediaUrl>TextMessageA>
<MemberId>string<<TextMessageB>string</MemberId>TextMessageB>
<SentTime>dateTime<<EmpushToken>string</SentTime>EmpushToken>
<PacketStatus>string<<Params>string</PacketStatus>Params>
<MessageStatusCode>string</MessageStatusCode><AlternateMessage>string</AlternateMessage>
<SystemVariables>
<MessageStatus>string</MessageStatus> <anyType />
<CampId>string</CampId> <anyType <CampName>string</CampName>>
<ContentType>string<</ContentType>SystemVariables>
<IsABCustomization>boolean<<PromoTableId>string</IsABCustomization>PromoTableId>
<TextMessageA>string<<CustomerId>string</TextMessageA>CustomerId>
<TextMessageB>string<<IsMutableContent>boolean</TextMessageB>IsMutableContent>
<CustomParams>
<EmpushToken>string</EmpushToken> <Params>string<<string>string</Params>string>
<AlternateMessage>string<<string>string</AlternateMessage>string>
<SoundFile>string<</SoundFile>CustomParams>
<AlternateCustomParams>
<SystemVariables> <anyType <string>string</>string>
<anyType <string>string</>string>
</SystemVariables>AlternateCustomParams>
<PromoTableId>string<<SoundFile>string</PromoTableId>SoundFile>
<CustomerId>string<<Title>string</CustomerId>Title>
</message>
</PostTransactionalPushWithLastUsedKnownTokenOnly>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<PostTransactionalPushWithLastUsedKnownTokenOnlyResponse xmlns="http://apiws.relateddigitaleuromsg.com/postpush">
<PostTransactionalPushWithLastUsedKnownTokenOnlyResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalPushWithLastUsedKnownTokenOnlyResult>
</PostTransactionalPushWithLastUsedKnownTokenOnlyResponse>
</soapsoap12:Body>
</soapsoap12: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. |
PostTransactionalWebPush
Anchor |
---|
| PostTransactionalWebPush |
---|
| PostTransactionalWebPush |
---|
|
Back to Top ^
<PostTransactionalPush> |
---|
Sends transactional web 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 | Web 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<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<PostTransactionalWebPush xmlns="http://ws.euromsg.com/postpush">
<ServiceTicket>string</ServiceTicket>
<ApplicationAlias>string</ApplicationAlias>
<ClassificationName>string</ClassificationName>
<MemberKey>string</MemberKey>
<MemberValue>string</MemberValue>
<message>
<Title>string</Title>
<Message>string</Message>
<MediaUrl>string</MediaUrl>
<TargetUrl>string</TargetUrl>
<Type>Image or Video or Text or Settings or Survey</Type>
</message>
</PostTransactionalWebPush>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<PostTransactionalWebPushResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalWebPushResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalWebPushResult>
</PostTransactionalWebPushResponse>
</soapsoap12:Body>
</soapsoap12: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. |
PostTransactionalWebPushWithToken
Anchor |
---|
| PostTransactionalWebPushWithToken |
---|
| PostTransactionalWebPushWithToken |
---|
|
Back to Top ^
<PostTransactionalPushWithToken> |
---|
Sends transactional web 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 | Web 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<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<PostTransactionalWebPushWithToken xmlns="http://ws.euromsg.com/postpush">
<ServiceTicket>26A34DE9FC1DE99856C464D590DEF8C8E930FD910BD87F7BA80E8C4E8113786FA11AAFC01F40149AA04DFA259384A7D730F89550D3A8D8763FD84B29FC45253DE4638C003B8A90081CEDFABF7752C2C8249C8F6A250E94499898940267A9FF1EB23294C03E26FE02C3F84F7436D1D4F5AEEBF782BFD8A9662D748F097F90FDBA9DD003537197E6E1BFED20603F3F13C3< <ServiceTicket>string</ServiceTicket>
<ApplicationAlias>NewEuromsgWebPushTest<<ApplicationAlias>string</ApplicationAlias>
<ClassificationName>test_clsf<<ClassificationName>string</ClassificationName>
<AuthToken>c0NLG6xbeqs:APA91bFq9JRzP7mi8L77aRZUUa3MtwkUVQLEhI6NUc3gRFtlV_e8rK8DHje-NqAgDCl_eEViWUwuVlTFB9HCkfVCQST_L8IAbSaqQJHzeoMHG-eyVaf64VXMEvg3U-Sb9kemxxNPtSK-<<AuthToken>string</AuthToken>
<message>
<Title>Test1 soap<<Title>string</Title>
<Message>Text Message<<Message>string</Message>
<MediaUrl>https://www.euromsg.com/tr/abc.jpg</<MediaUrl>string</MediaUrl>
<TargetUrl>https://www.euromsg.com/tr/abc.jpg</<TargetUrl>string</TargetUrl>
<Type>Image<<Type>Image or Video or Text or Settings or Survey</Type>
</message>
</PostTransactionalWebPushWithToken>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap<soap12:Body>
<PostTransactionalWebPushResponse<PostTransactionalWebPushWithTokenResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalWebPushResult><PostTransactionalWebPushWithTokenResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalWebPushResult>PostTransactionalWebPushWithTokenResult>
</PostTransactionalWebPushResponse>PostTransactionalWebPushWithTokenResponse>
</soapsoap12:Body>
</soapsoap12: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. |
Parent Topic: SOAP Web Service