Anchor |
---|
topslws | topslws | Service URL | postpush.asmx |
---|
Post Push Web Service Methods
The following table lists supported methods in Post Push Web Service and provides a brief description of each method. For more detail on each method, click the method name.
Method | Description |
---|
GetPostPushResult | Reports the current statuses of sent transactional push notifications. |
GetPostPushResultByCreationDate | Reports the current statuses of sent transactional push notifications by creation date. |
GetPostPushResultByLastUpdate | Reports the current statuses of sent transactional push notifications by last update. |
PostTransactionalPush | Sends the transactional push notification to members by member key. |
PostTransactionalPushWithToken | Sends the transactional push notification to members by token ıd. |
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 Anchor |
---|
getpush | getpush | 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
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"?>
<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>
<GetPostPushResult xmlns="http://ws.euromsg.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://ws.euromsg.com/postpush">
<GetPostPushResultResult>
<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>
<Status>string<<TargetUrl>string</Status>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://ws.euromsg.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://ws.euromsg.com/postpush">
<GetPostPushResultByCreationDateResult>
<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>
</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://ws.euromsg.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://ws.euromsg.com/postpush">
<GetPostPushResultByLastUpdateResult>
<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</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 the transactional push notification to members by member keynotifications 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, MEMBERKEY_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://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> <IsMutableContent>boolean</IsMutableContent>
</PostTransactionalPush><CustomParams>
</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>
<string>string</string>
</CustomParams>
<PostTransactionalPushResponse xmlns="http://ws.euromsg.com/postpush"> <AlternateCustomParams>
<PostTransactionalPushResult> <string>string</string>
<PushList> <string>string</string>
<EmPushMessageResultItem> </AlternateCustomParams>
<PushId>string<<SoundFile>string</PushId>SoundFile>
<<Title>string</EmPushMessageResultItem>Title>
<EmPushMessageResultItem>
<PushId>string</PushId></message>
</EmPushMessageResultItem>PostTransactionalPush>
</PushList>
</PostTransactionalPushResult>
</PostTransactionalPushResponse>
</soap</soap12: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. |
PostTransactionalPushWithToken Anchor |
---|
transtoken | transtoken | Back to Top ^
<PostTransactionalPushWithToken> |
---|
Sends the transactional push notification to members 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> Code Block |
---|
language | xml |
---|
title | 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>
|
<ClassificationName>string</ClassificationName><AuthToken>string</AuthToken><message> </EmPushMessageResultItem>
|
<PushId>string</PushId> <EmPushMessageResultItem>
|
<Type>Image or Video or Text or Settings or Survey</Type> <PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
|
<Text>string</Text> </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>
<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>
<IsMutableContent>boolean</IsMutableContent>
<CustomParams>
<string>string</string>
<string>string</string>
</CustomParams>
<AlternateCustomParams>
<string>string</string>
<string>string</string>
</AlternateCustomParams>
<SoundFile>string</SoundFile>
<Title>string</Title>
</message>
</PostTransactionalPushWithToken>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | 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>
<PostTransactionalPushWithTokenResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalPushWithTokenResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalPushWithTokenResult>
</PostTransactionalPushWithTokenResponse>
</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. |
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"?>
<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</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>
<IsMutableContent>boolean</IsMutableContent>
<CustomParams>
<string>string</string>
<string>string</string>
</CustomParams>
<AlternateCustomParams>
<string>string</string>
<string>string</string>
</AlternateCustomParams>
<SoundFile>string</SoundFile>
<Title>string</Title>
</message>
</PostTransactionalPushWithLastUsedKnownTokenOnly>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | 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>
<PostTransactionalPushWithLastUsedKnownTokenOnlyResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalPushWithLastUsedKnownTokenOnlyResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalPushWithLastUsedKnownTokenOnlyResult>
</PostTransactionalPushWithLastUsedKnownTokenOnlyResponse>
</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. |
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"?>
<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>
<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>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | 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>
<PostTransactionalWebPushResponse xmlns="http://ws.euromsg.com/postpush">
<PostTransactionalWebPushResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</PostTransactionalWebPushResult>
</PostTransactionalWebPushResponse>
</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. |
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 |
<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>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>
<PostTransactionalWebPushWithToken xmlns="http://ws.euromsg.com/postpush">
|
<TextMessageB>string</TextMessageB>
<EmpushToken>string</EmpushToken><ServiceTicket>string</ServiceTicket>
<ApplicationAlias>string</ApplicationAlias>
|
<Params>string</Params> <ClassificationName>string</ClassificationName>
|
<AlternateMessage>string<AlternateMessage><SystemVariables><anyType/> <Message>string</Message>
|
<anyType><SystemVariables><PromoTableId>string</PromoTableId><Type>Image or Video or Text or Settings or |
<CustomerId>string<CustomerId>PostTransactionalPushWithToken>PostTransactionalWebPushWithToken>
</ |
soapsoap
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: |
soapschemasxmlsoap//<soap<PostTransactionalPushWithTokenResponse<PostTransactionalWebPushWithTokenResponse xmlns="http://ws.euromsg.com/postpush">
|
<PostTransactionalPushWithTokenResult><PostTransactionalWebPushWithTokenResult>
<PushList>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
<EmPushMessageResultItem>
<PushId>string</PushId>
</EmPushMessageResultItem>
</PushList>
</ |
PostTransactionalPushWithTokenResult>PostTransactionalWebPushWithTokenResult>
</ |
PostTransactionalPushWithTokenResponse>PostTransactionalWebPushWithTokenResponse>
</ |
soapsoap
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