Status | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
---|---|
GetPostPushResultByCreationDate | |
GetPostPushResultByLastUpdate | |
PostTransactionalPush | |
PostTransactionalPushWithToken |
Warning | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
To interact with any Web Services, developers must first use the Login method to create a
|
CreateSendList
GetPostPushResult
Anchor | ||||
---|---|---|---|---|
|
<GetPostPushResult> |
---|
Parameters
Parameter | Value | |||||||
---|---|---|---|---|---|---|---|---|
ServiceTicket | ServiceTicket obtained through Login |
| ||||||
pushIds |
|
Status | ||||
---|---|---|---|---|
|
Code Block | language | |||||
---|---|---|---|---|---|---|
Code Block | ||||||
| ||||||
<?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 <CreateSendList xmlns="http://ws.euromsg.com/sendlistpostpush"> <serviceTicket>string</serviceTicket> <ServiceTicket>string</ServiceTicket> <pushIds> <string>string</string> <ListGroup>string</ListGroup> <string>string</string> <ListName>string</ListName> </pushIds> </CreateSendList>GetPostPushResult> </soap:Body> </soap:Envelope> |
language | xml |
---|---|
title | REQUEST EXAMPLE |
linenumbers | true |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/" 2001/XMLSchema-instance" xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsdsoap="http://wwwschemas.w3xmlsoap.org/soap/2001envelope/XMLSchema"> <soap:Body> <GetPostPushResultResponse <CreateSendListResponse xmlns="http://ws.euromsg.com/sendlistpostpush"> <GetPostPushResultResult> <CreateSendListResult> <PostPushList> <PostPushModel> <Code>00</Code> <PushId>guid</PushId> <Message /> <EmpushToken>string</EmpushToken> <DetailedMessage <AppAlias>string</>AppAlias> <PushType>string</PushType> <CreatedListID>1686794</CreatedListID> <TextMessage>string</TextMessage> </CreateSendListResult> <<TargetUrl>string</CreateSendListResponse>TargetUrl> </soap:Body> </soap:Envelope> | ||||||
Tip |
Status | ||||||
---|---|---|---|---|---|---|
|
Error Parameters
Parameters
ServiceTicket
obtained through Login
Status | ||||
---|---|---|---|---|
|
Group name of the List to add
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
DemograficData
fieldStatus | ||||
---|---|---|---|---|
|
ArrayOfEmKeyValue
string defines the fields for the memberStatus | ||||
---|---|---|---|---|
|
true
, the existing member is updated.Status | ||||
---|---|---|---|---|
|
Note |
---|
Fields like First Name and Last Name are set through the Related Marketing Cloud platform. |
Static Fields
<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 |
Error Parameters
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetPostPushResultByCreationDate
Anchor | ||||
---|---|---|---|---|
|
<GetPostPushResultByCreationDate> |
---|
Parameters
Parameter | Value | |||||||
---|---|---|---|---|---|---|---|---|
ServiceTicket | ServiceTicket obtained through Login |
| ||||||
BeginDate |
| |||||||
EndDate |
| |||||||
Page |
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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> <AddBulk xmlns=<GetPostPushResultByCreationDate xmlns="http://ws.euromsg.com/sendlistpostpush"> <serviceTicket>string</serviceTicket> <ServiceTicket>string</ServiceTicket> <request> <ListGroup>string<<BeginDate>string</ListGroup>BeginDate> <ListName>string</ListName><EndDate>string</EndDate> <Key>string</Key><Page>int</Page> </request> </GetPostPushResultByCreationDate> <DemograficData> <ArrayOfEmKeyValue> </soap:Body> </soap:Envelope> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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> <EmKeyValue> <PostPushList> <PostPushModel> <Key>string<<PushId>guid</Key>PushId> <EmpushToken>string</EmpushToken> <Value>string<<AppAlias>string</Value>AppAlias> <PushType>string</PushType> </EmKeyValue> <TextMessage>string</TextMessage> <TargetUrl>string</TargetUrl> <EmKeyValue> <MediaUrl>string</MediaUrl> <Status>string</Status> <Key>string</Key> <Created>dateTime</Created> <Value>string<<TakenForSent>dateTime</Value>TakenForSent> <DsLastChange>dateTime</DsLastChange> </EmKeyValue> <OpenTime>dateTime</OpenTime> </ArrayOfEmKeyValue>PostPushModel> <PostPushModel> <ArrayOfEmKeyValue> <PushId>guid</PushId> <EmpushToken>string</EmpushToken> <EmKeyValue> <AppAlias>string</AppAlias> <Key>string<<PushType>string</Key>PushType> <TextMessage>string</TextMessage> <Value>string<<TargetUrl>string</Value>TargetUrl> <MediaUrl>string</MediaUrl> </EmKeyValue> <Status>string</Status> <Created>dateTime</Created> <EmKeyValue> <TakenForSent>dateTime</TakenForSent> <Key>string<<DsLastChange>dateTime</Key>DsLastChange> <OpenTime>dateTime</OpenTime> <Value>string<</Value>PostPushModel> </EmKeyValue> </PostPushList> </ArrayOfEmKeyValue>GetPostPushResultByCreationDateResult> </DemograficData> <ForceInsert>boolean</ForceInsert> </GetPostPushResultByCreationDateResponse> </AddBulk> </soap:Body> </soap:Envelope> | ||||||
Code Block | ||||||
|
Tip | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
If the request was successful, the |
Error Parameters
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetPostPushResultByLastUpdate
Anchor | ||||
---|---|---|---|---|
|
<GetPostPushResultByLastUpdate> |
---|
Parameters
Parameter | Value | |||||||
---|---|---|---|---|---|---|---|---|
ServiceTicket | ServiceTicket obtained through Login |
| ||||||
BeginDate |
| |||||||
EndDate |
| |||||||
Page |
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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> |
Error Parameters
<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
|
Error Parameters
Parameters
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
PostTransactionalPush
Anchor |
---|
|
<PostTransactionalPush> |
---|
Parameters
Parameter | Value | |||||||
---|---|---|---|---|---|---|---|---|
ServiceTicket | ServiceTicket obtained through Login |
|
language | xml |
---|---|
title | REQUEST EXAMPLE |
linenumbers | true |
ApplicationAlias |
|
Status | ||||
---|---|---|---|---|
|
Reference Key Name. Member adding and updating shall be done based on this field
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
The file to upload
Status | ||||
---|---|---|---|---|
|
File Type - Must be in zip
or csv
format
Status | ||||
---|---|---|---|---|
|
A notification email will sent to this email address when the upload is completed
Status | ||||
---|---|---|---|---|
|
ClassificationName | ||
MemberKey | ||
MemberValue | ||
message |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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> |
language | xml |
---|---|
title | RESPONSE EXAMPLE |
linenumbers | true |
<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> |
Status | ||||||
---|---|---|---|---|---|---|
|
Error Parameters
zip
or csv
formatShows the number of members in the send list.
Parameters
ServiceTicket
obtained through Login
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Code Block | ||||||
| ||||||
<?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> <QuerySendListMemberCount </EmPushMessageResultItem> xmlns="http://ws.euromsg.com/sendlist"> <EmPushMessageResultItem> <ServiceTicket>string</ServiceTicket> <PushId>string</PushId> <ListID>int</ListID> </EmPushMessageResultItem> </PushList> </QuerySendListMemberCount>PostTransactionalPushResult> </PostTransactionalPushResponse> </soap:Body> </soap:Envelope> | ||||||
Code Block | ||||||
|
Tip | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
If the request was successful, the |
Error Parameters
Code | Error Message | Description |
---|---|---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
PostTransactionalPushWithToken
Anchor | ||||
---|---|---|---|---|
|
<PostTransactionalPushWithToken> |
---|
Parameters
Parameter | Value | |||||||
---|---|---|---|---|---|---|---|---|
ServiceTicket | ServiceTicket obtained through Login |
| ||||||
ApplicationAlias |
| |||||||
ClassificationName |
| |||||||
AuthToken |
| |||||||
message |
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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> |
Error Parameters
Allows you to delete the members listed in a file in your RMC account.
Parameters
ServiceTicket
obtained through Login
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname ;COLUMN2=KeyID
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
zip
or csv
formatStatus | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
If the member is not included in any lists, and the value is true
, the user is deleted from the system completely
Status | ||||
---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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>
<RemoveBulkFile xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<Key>string</Key>
<Map>string</Map>
<File>base64Binary</File>
<FileType>string</FileType>
<NotificationEmail>string</NotificationEmail>
<DeleteIfInNoList>boolean</DeleteIfInNoList>
</RemoveBulkFile>
</soap:Body>
</soap:Envelope> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveBulkFileResponse xmlns="http://ws.euromsg.com/sendlist">
<RemoveBulkFileResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
<CreatedListID>0</CreatedListID>
</RemoveBulkFileResult>
</RemoveBulkFileResponse >
</soap:Body>
</soap:Envelope> |
Status | ||||||
---|---|---|---|---|---|---|
|
Error Parameters
Parameters
ServiceTicket
obtained through Login
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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>
<RemoveSendList xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</RemoveSendList>
</soap:Body>
</soap:Envelope> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveSendListResponse
xmlns="http://ws.euromsg.com/sendlist">
<RemoveSendListResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>0</CreatedListID>
</RemoveSendListResult>
</RemoveSendListResponse>
</soap:Body>
</soap:Envelope> |
Error Parameters
Query Send Lists of customer.
Parameters
ServiceTicket
obtained through Login
Status | ||||
---|---|---|---|---|
|
language | xml |
---|---|
title | REQUEST EXAMPLE |
linenumbers | true |
<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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<?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
|
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