Page Comparison

Status

colour	Green
title	post

AnchortopslwstopslwsService URLpostpush.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

GetPostPushResultByCreationDateGetPostPushResultByLastUpdatePostTransactionalPushPostTransactionalPushWithToken WarningTo interact with any Web Services, developers must first use the Login method to create a StatussubtletruecolourRedtitle Service Ticket. Developers can send requests to other Web Service and methods using this StatussubtletruecolourRedtitle Service Ticket. CreateSendList Anchorgetpushgetpush

Back to Top ^

<CreateSendList>Creates an empty Send List.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status

colour	Green
title	mandatory

pushIdsGroup Name of the List

Status

colour	Green
title	mandatory

ListNameName of the list

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://

Status

colour	Green
title	post

Anchor

	topslws
	topslws

Service URL	LIVE: https://api.relateddigital.com/live/postpush.asmx ECOMM: https://api.relateddigital.com/ecomm/postpush.asmx MAX: https://api.relateddigital.com/max/postpush.asmx LIVEB: https://api.relateddigital.com/liveb/postpush.asmx

General Information

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:

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 transactional push notifications by Member Key.
PostTransactionalPushWithToken	Sends transactional push notifications by Token ID.
PostTransactionalPushWithLastUsedKnownTokenOnly	Sends transactional push notifications by Last Used Known Token.
PostTransactionalWebPush	Sends transactional web push notifications by Member Key.
Transactional Push Web Service With Token	Sends transactional web push notifications by Token ID.

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"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     xmlns:soapxmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
    <soap<soap12: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>
   </soapsoap12:Body>
</soapsoap12:Envelope>

If the request was successful, the

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
    xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
   2001/XMLSchema-instance" xmlns:xsixsd="http://www.w3.org/2001/XMLSchema-instance"     xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
    <soap<soap12:Body>
       <GetPostPushResultResponse <CreateSendListResponse xmlns="http://ws.euromsg.com/sendlistpostpush">
      <GetPostPushResultResult>
     <CreateSendListResult>   <PostPushList>
          <PostPushModel>
  <Code>00</Code>          <PushId>guid</PushId>
      <Message />     <Email>string</Email>
           <DetailedMessage /><Key_Id>string</Key_Id>
            <EmpushToken>string</EmpushToken>
           <CreatedListID>1686794</CreatedListID> <AppAlias>string</AppAlias>
            <PushType>string</PushType>
            </CreateSendListResult><TextMessage>string</TextMessage>
            </CreateSendListResponse><TargetUrl>string</TargetUrl>
            </soap:Body>
</soap:Envelope>

Tip

Status

subtle	true
colour	Red
title	Code

parameter will return StatussubtletruecolourRedtitle00 as a response. In addition to that, the ID of the created list StatussubtletruecolourRedtitleCreatedListID is returned.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.AddBulk Anchoraddbulkaddbulk

Back to Top ^

Bulk adds to a Send List.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroup

Group name of the List to add

Status

colour	Green
title	mandatory

ListNameName of the List

Status

colour	Green
title	mandatory

KeyReference Key Name. Member adding and updating will be done based on this field. Reference Key value must be specified in the DemograficData field

Status

colour	Green
title	mandatory

DemograficDataArrayOfEmKeyValue string defines the fields for the member

Status

colour	Green
title	mandatory

ForceInsertIf the member exists in the system and the value is true , the existing member is updated.

Status

colour	Green
title	mandatory

Note
Fields like First Name and Last Name are set through the Related Marketing Cloud platform.

Static Fields

Field NameDescriptionEMAILEmail addressSTATUSMember Status. A: Active, P: PassiveEMAIL_PERMITEmail opt-in. Y: Yes, N: NoGSM_PERMITSMS opt-in. Y: Yes, N: NoFAX_PERMITFAX opt-in. Y: Yes, N: NoCALL_PERMITCall Center opt-in. Y: Yes, N: NoPRINT_PERMITPrint opt-in. Y: Yes, N: NoREFERRALReferral AddressREFERRAL_DOMAINReferral Domain 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> <AddBulk xmlns="http://ws.euromsg.com/sendlist"> <ServiceTicket>string</ServiceTicket> <ListGroup>string</ListGroup> <ListName>string</ListName>

<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>
  </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.

GetPostPushResultByCreationDate
Anchor
creation
creation

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"?>
<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>
    <GetPostPushResultByCreationDate xmlns="http://ws.euromsg.com/postpush">
      <serviceTicket>string</serviceTicket>
      <request>
           <Key>string</Key><BeginDate>string</BeginDate>
        <EndDate>string</EndDate>
   <DemograficData>     <Page>int</Page>
      </request>
    <ArrayOfEmKeyValue></GetPostPushResultByCreationDate>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope              <EmKeyValue>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>
    <GetPostPushResultByCreationDateResponse xmlns="http://ws.euromsg.com/postpush">
      <GetPostPushResultByCreationDateResult>
        <PostPushList>
   <Key>string</Key>       <PostPushModel>
            <PushId>guid</PushId>
    <Value>string</Value>        <Email>string</Email>
            </EmKeyValue><Key_Id>string</Key_Id>
            <EmpushToken>string</EmpushToken>
       <EmKeyValue>     <AppAlias>string</AppAlias>
            <PushType>string</PushType>
      <Key>string</Key>      <TextMessage>string</TextMessage>
            <TargetUrl>string</TargetUrl>
     <Value>string</Value>       <MediaUrl>string</MediaUrl>
             <<Status>string</EmKeyValue>Status>
            <Created>dateTime</Created>
   </ArrayOfEmKeyValue>         <TakenForSent>dateTime</TakenForSent>
       <ArrayOfEmKeyValue>     <DsLastChange>dateTime</DsLastChange>
            <OpenTime>dateTime</OpenTime>
  <EmKeyValue>        </PostPushModel>
          <PostPushModel>
     <Key>string</Key>       <PushId>guid</PushId>
            <Email>string</Email>
    <Value>string</Value>        <Key_Id>string</Key_Id>
            <<EmpushToken>string</EmKeyValue>EmpushToken>
            <AppAlias>string</AppAlias>
       <EmKeyValue>     <PushType>string</PushType>
            <TextMessage>string</TextMessage>
      <Key>string</Key>      <TargetUrl>string</TargetUrl>
            <MediaUrl>string</MediaUrl>
     <Value>string</Value>       <Status>string</Status>
             </EmKeyValue><Created>dateTime</Created>
            <TakenForSent>dateTime</TakenForSent>
            <<DsLastChange>dateTime</ArrayOfEmKeyValue>DsLastChange>
            <<OpenTime>dateTime</DemograficData>OpenTime>
          </PostPushModel>
   <ForceInsert>boolean</ForceInsert>     </PostPushList>
      </AddBulk>GetPostPushResultByCreationDateResult>
    </GetPostPushResultByCreationDateResponse>
  </soapsoap12:Body>
</soapsoap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
        <AddBulkResponse
            xmlns="http://ws.euromsg.com/sendlist">
            <AddBulkResult>

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
Anchor
update
update

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"?>
<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>
    <GetPostPushResultByLastUpdate xmlns="http://ws.euromsg.com/postpush">
      <serviceTicket>string</serviceTicket>

<request>
        <BeginDate>string</BeginDate>

<Message

 <EndDate>string</

>

EndDate>
        <Page>int</Page>

<DetailedMessage

</

>

request>
    </GetPostPushResultByLastUpdate>

</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>
    <GetPostPushResultByLastUpdateResponse xmlns="http://ws.euromsg.com/postpush">
      <GetPostPushResultByLastUpdateResult>
        <PostPushList>

        <PostPushModel>

<Key>test1@sampledomain.com<

<PushId>guid</

Key>

PushId>
            <Email>string</Email>

     <Key_Id>string</Key_Id>
            <EmpushToken>string</EmpushToken>

<Message

/>

         <AppAlias>string</AppAlias>

<DetailedMessage

/>

<PushType>string</PushType>
            <TextMessage>string</TextMessage>

<

<TargetUrl>string</

BulkDetailedResult>

TargetUrl>
            <MediaUrl>string</MediaUrl>

         <Status>string</Status>

<Key>test2@sampledomain.com</Key>

 <Created>dateTime</Created>
            <TakenForSent>dateTime</TakenForSent>

<Code>00<

<DsLastChange>dateTime</

Code>

DsLastChange>
            <OpenTime>dateTime</OpenTime>

<Message

</

>

PostPushModel>
          <PostPushModel>

<DetailedMessage

 <PushId>guid</

>

PushId>
            <Email>string</Email>

</BulkDetailedResult>

         <Key_Id>string</Key_Id>

</DetailsResult>

<

<EmpushToken>string</

AddBulkResponse>

EmpushToken>

</soap:Body> </soap:Envelope> TipIf the request was successful, the StatussubtletruecolourRedtitleCode parameter will return StatussubtletruecolourRedtitle00 as a response.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.99No such list!The specified List cannot be found.99Member is new. No update!If ForceInsert is false and the user does not exist in the system, this error is given. The member is not added. To add the new member in the system the value of the ForceInsertparameter must be true.AddBulkFile Anchoraddbulkfileaddbulkfile

Back to Top ^

Allows you to add all the members listed in a file to your RMC account in bulk.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroupGroup name of the List to add

Status

colour	Green
title	mandatory

ListNameName of the List

       <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>
  </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.

PostTransactionalPush
Anchor
posttrans
posttrans

Back to Top ^

<PostTransactionalPush>
Sends transactional push notifications by Member Key.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

KeyReference Key Name. Member adding and updating shall be done based on this field

ApplicationAlias

Application alias defined on RMC account

Status

colour	Green
title	mandatory

MapMaps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname; COLUMN2=KeyID

ClassificationName

Campaign classification name.

Status

colour

Green

title
Yellow

mandatory

optıonal

FileThe file to upload

MemberKey

EMAIL, KEY_ID or a field name of your defined in RMC account management panel

Status

colour	Green
title	mandatory

FileTypeFile Type - Must be in zip or csv format

MemberValue

The value of the field name specified in the Key field

Status

colour	Green
title	mandatory

NotificationEmailA notification email will sent to this email address when the upload is completed

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:

soap

soap12="http://

schemas

www.

xmlsoap

w3.org/2003/05/soap

/

-envelope

/

">

<soap

<soap12:Body>

<AddBulkFile

<PostTransactionalPush xmlns="http://ws.euromsg.com/

sendlist

postpush">


      <ServiceTicket>string</ServiceTicket>
      <ApplicationAlias>string</ApplicationAlias>

<ListGroup>string<

 <ClassificationName>string</

ListGroup>

ClassificationName>
      <MemberKey>string</MemberKey>

<ListName>string<

<MemberValue>string</

ListName>

MemberValue>
      <message>

<Key>string</Key>

   <PushId>string</PushId>
        <Type>Image

<Map>string</Map>

or Video or Text or Settings or Survey</Type>

<File>base64Binary<

 <Text>string</

File>

Text>
        <TargetUrl>string</TargetUrl>

<FileType>string</FileType>

     <MediaUrl>string</MediaUrl>

<NotificationEmail>string<

 <MemberId>string</

NotificationEmail>

MemberId>

</AddBulkFile>

<SentTime>dateTime</SentTime>

<

<PacketStatus>string</

soap:Body> </soap:Envelope> Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?> <soap:Envelope

PacketStatus>

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

<MessageStatusCode>string</MessageStatusCode>

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<MessageStatus>string</MessageStatus>

<soap:Body>

    <CampId>string</CampId>

<AddBulkFileResponse

    <CampName>string</CampName>

xmlns="http://ws.euromsg.com/sendlist">

<ContentType>string</ContentType>
        <IsABCustomization>boolean</IsABCustomization>

     <TextMessageA>string</TextMessageA>
        <TextMessageB>string</TextMessageB>

<Code>00<

<EmpushToken>string</

Code>

EmpushToken>
        <Params>string</Params>

<Message

/>

<AlternateMessage>string</AlternateMessage>
        <SystemVariables>
          <anyType />

<DetailedMessage

<anyType />
        </SystemVariables>

<ConversationID>EEFF123AE537442BBF9AD3231F812684<

<PromoTableId>string</

ConversationID>

PromoTableId>
        <CustomerId>string</CustomerId>

<IsMutableContent>boolean</IsMutableContent>
        <CustomParams>

<

<string>string</

AddBulkFileResult>

string>

</AddBulkFileResponse>

<string>string</string>
        </

soap:Body> </soap:Envelope> TipIf the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return StatussubtletruecolourRedtitle00 as a response. In addition to that, the ID of the created list StatussubtletruecolourRedtitleCreatedListID is returned.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.99Not a valid file type. It must be ZIP or CSV or TXT.Invalid file type. It must be in zip or csv formatQuerySendListMemberCount Anchorquerymemcountquerymemcount

Back to Top ^

Shows the number of members in the send list.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListIDList ID

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>
        <QuerySendListMemberCountCustomParams>
        <AlternateCustomParams>
          <string>string</string>
          <string>string</string>
        </AlternateCustomParams>
        <SoundFile>string</SoundFile>
        <Title>string</Title>
      </message>
    </PostTransactionalPush>
  </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>
    <PostTransactionalPushResponse xmlns="http://ws.euromsg.com/postpush">
      <PostTransactionalPushResult>
        <PushList>
          <EmPushMessageResultItem>
            <PushId>string</PushId>
          </EmPushMessageResultItem>
    xmlns="http://ws.euromsg.com/sendlist">      <EmPushMessageResultItem>
            <ServiceTicket>string<<PushId>string</ServiceTicket>PushId>
          </EmPushMessageResultItem>
   <ListID>int</ListID>     </PushList>
      </QuerySendListMemberCount>PostTransactionalPushResult>
    </PostTransactionalPushResponse>
  </soapsoap12:Body>
</soapsoap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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

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 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"

>

<soap:Body>

xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>

<QuerySendListMemberCountResponse

<PostTransactionalPushWithToken xmlns="http://ws.euromsg.com/

sendlist

postpush">
      <ServiceTicket>string</ServiceTicket>

 <ApplicationAlias>string</ApplicationAlias>
      <ClassificationName>string</ClassificationName>

<Code>00<

<AuthToken>string</

Code>

AuthToken>
      <message>

<Message

<PushId>string</

>

PushId>
        <Type>Image or Video or Text or Settings or

<DetailedMessage

Survey</

>

Type>
        <Text>string</Text>

 <TargetUrl>string</TargetUrl>
        <MediaUrl>string</MediaUrl>
        <MemberId>string</MemberId>

</QuerySendListMemberCountResult>

<SentTime>dateTime</SentTime>
        <PacketStatus>string</PacketStatus>

<MemberCount>0<

<MessageStatusCode>string</

MemberCount>

MessageStatusCode>

</QuerySendListMemberCountResponse>

<MessageStatus>string</MessageStatus>

</soap:Body> </soap:Envelope> TipIf the request was successful, the StatussubtletruecolourRedtitleCode parameter will return StatussubtletruecolourRedtitle00 as a response.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.RemoveBulkFile Anchorremovebulkfileremovebulkfile

Back to Top ^

Allows you to delete the members listed in a file in your RMC account.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroupGroup name of the List

Status

colour	Green
title	mandatory

ListNameName of the list

Status

colour	Green
title	mandatory

KeyReference Key Name

Status

colour	Green
title	mandatory

Map

Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname ;COLUMN2=KeyID

Status

colour	Green
title	mandatory

FileFile to upload

Status

colour	Green
title	mandatory

FileTypeFile Type - Must be in zip or csv format

Status

colour	Green
title	mandatory

NotificationEmailA notification email will sent to this email address when the upload is completed

Status

colour	Green
title	mandatory

DeleteIfInNoList

If the member is not included in any lists, and the value is true, the user is deleted from the system completely

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>
        <RemoveBulkFile xmlns="http://ws.euromsg.com/sendlist">
  <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>

<ServiceTicket>string</ServiceTicket>

        <IsMutableContent>boolean</IsMutableContent>

<ListGroup>string</ListGroup>

    <CustomParams>

<ListName>string</ListName>

  <string>string</string>

<Key>string<

<string>string</

Key>

string>
        </CustomParams>

<Map>string</Map>

    <AlternateCustomParams>

<File>base64Binary</File>

  <string>string</string>

<FileType>string<

<string>string</

FileType>

string>
        </AlternateCustomParams>

<NotificationEmail>string</NotificationEmail>

     <SoundFile>string</SoundFile>

<DeleteIfInNoList>boolean<

 <Title>string</

DeleteIfInNoList>

Title>
      </message>
    </

RemoveBulkFile>

PostTransactionalPushWithLastUsedKnownTokenOnly>
  </

soap

soap12:Body>
</

soap

soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?>

<soap

<soap12:Envelope

xmlns:

soap

xsi="http://

schemas

www.

xmlsoap

w3.org/

soap/envelope/" xmlns:xsi

2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema

-instance

xmlns:

xsd

soap12="http://www.w3.org/

2001/XMLSchema

2003/05/soap-envelope">

<soap

<soap12:Body>

<RemoveBulkFileResponse

<PostTransactionalPushWithLastUsedKnownTokenOnlyResponse xmlns="http://ws.euromsg.com/

sendlist

postpush">
      <PostTransactionalPushWithLastUsedKnownTokenOnlyResult>

   <PushList>
          <EmPushMessageResultItem>

<PushId>string</PushId>
          </EmPushMessageResultItem>

<DetailedMessage

/>

    <EmPushMessageResultItem>

<ConversationID>EEFF123AE537442BBF9AD3231F812684<

<PushId>string</

ConversationID>

PushId>
          </EmPushMessageResultItem>

</PushList>
      </

RemoveBulkFileResult>

PostTransactionalPushWithLastUsedKnownTokenOnlyResult>

</

RemoveBulkFileResponse

PostTransactionalPushWithLastUsedKnownTokenOnlyResponse>

>

</

soap

soap12:Body>
</

soap

soap12:Envelope>

Tip
If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status

title
subtle	true
colour	Red

00 as a response. In addition to that, the ID of the created list

Code

parameter will return

Status

title

subtle	true
colour	Red

CreatedListID is returned

00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

RemoveSendList

PostTransactionalWebPush
Anchor

removesendlist

PostTransactionalWebPush

removesendlist

PostTransactionalWebPush

Back to Top ^

Deletes a Send List.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

<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

ListGroup

MemberValue

Group Name

The value of the

List

field name specified in the Key field

Status

colour	Green
title	mandatory

ListNameName of the List

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:

xsi

xsd="http://www.w3.org/2001/XMLSchema

-instance"

" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <PostTransactionalWebPush xmlns

:xsd

="http://

www

ws.

w3.org/2001/XMLSchema"

euromsg.com/postpush">
      <ServiceTicket>string</ServiceTicket>
      <ApplicationAlias>string</ApplicationAlias>
      <ClassificationName>string</ClassificationName>
      <MemberKey>string</MemberKey>

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<MemberValue>string</MemberValue>

<soap:Body>

 <message>

<RemoveSendList

xmlns="http://ws.euromsg.com/sendlist">

<Title>string</Title>
        <Message>string</Message>

<ServiceTicket>string</ServiceTicket>

    <MediaUrl>string</MediaUrl>

<ListGroup>string<

<TargetUrl>string</

ListGroup>

TargetUrl>
        <Type>Image or Video

<ListName>string</ListName>

or Text or Settings or Survey</Type>
      </

RemoveSendList>

message>
    </PostTransactionalWebPush>
  </

soap

soap12:Body>
</

soap

soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?xml version="1.0" encoding="utf-8"?>

<soap

<soap12:Envelope

 xmlns:

soap

xsi="http://

schemas

www.

xmlsoap

w3.org/

soap/envelope/

2001/XMLSchema-instance"

xmlns:

xsi

xsd="http://www.w3.org/2001/XMLSchema

-instance

xmlns:

xsd

soap12="http://www.w3.org/

2001/XMLSchema

2003/05/soap-envelope">

<soap

<soap12:Body>

<RemoveSendListResponse

<PostTransactionalWebPushResponse xmlns="http://ws.euromsg.com/

sendlist

postpush">
      <PostTransactionalWebPushResult>

   <PushList>
          <EmPushMessageResultItem>

       <PushId>string</PushId>

<Message

</

>

EmPushMessageResultItem>
          <EmPushMessageResultItem>

<DetailedMessage

/>

   <PushId>string</PushId>
          </EmPushMessageResultItem>

      </PushList>
      </

RemoveSendListResult>

PostTransactionalWebPushResult>

</

RemoveSendListResponse>

PostTransactionalWebPushResponse>

</

soap

soap12:Body>
</

soap

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

. Aside from that, the returned StatussubtletruecolourRedtitle99 values indicates errors.

Error Parameters

CodeError MessageDescription9998No session. Please try re-logon.No active sessions found. Try login again.QuerySendList Anchorquerysendquerysend

Back to Top ^

Query Send Lists of customer.

Parameters

ParameterValueServiceTicketServiceTicket obtained through Login

.

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:Envelope xmlns:xsi="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://wwwws.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QuerySendLists xmlns="http://ws.euromsg.com/sendlist">euromsg.com/postpush">
      <ServiceTicket>string</ServiceTicket>
      <ApplicationAlias>string</ApplicationAlias>
      <ClassificationName>string</ClassificationName>
      <AuthToken>string</AuthToken>
      <message>
        <Title>string</Title>
        <Message>string</Message>
        <MediaUrl>string</MediaUrl>
        <TargetUrl>string</TargetUrl>
        <Type>Image or Video or Text or Settings or Survey</Type>
      <ServiceTicket>string<</ServiceTicket>message>
    </QuerySendLists>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/soap2003/envelope/">
  <soap:Body>
    <QuerySendListsResponse xmlns="http://ws.euromsg.com/sendlist">
      <QuerySendListsResult>
        <SendLists>
   05/soap-envelope">
  <soap12:Body>
    <PostTransactionalWebPushWithTokenResponse  <EmSendListResponse>xmlns="http://ws.euromsg.com/postpush">
      <PostTransactionalWebPushWithTokenResult>
      <ListId>string</ListId>  <PushList>
          <ListName>string</ListName><EmPushMessageResultItem>
            <GroupName>string<<PushId>string</GroupName>PushId>
          </EmSendListResponse>EmPushMessageResultItem>
          <EmSendListResponse><EmPushMessageResultItem>
            <ListId>string</ListId>
       <PushId>string</PushId>
    <ListName>string</ListName>             <GroupName>string</GroupName>
          </EmSendListResponse>EmPushMessageResultItem>
        </SendLists>PushList>
      </QuerySendListsResult>PostTransactionalWebPushWithTokenResult>
    </QuerySendListsResponse>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

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Post Push Web Service Methods

Parameters

General Information

Transactional Push Web Service Methods

GetPostPushResult Anchorgetpushgetpush

Parameters

Error Parameters

Parameters

Static Fields

Error Parameters

GetPostPushResultByCreationDate Anchorcreationcreation

Parameters

Error Parameters

GetPostPushResultByLastUpdate Anchorupdateupdate

Parameters

Error Parameters

Parameters

Error Parameters

PostTransactionalPush Anchorposttransposttrans

Parameters

Error Parameters

Parameters

Error Parameters

PostTransactionalPushWithToken Anchortranstokentranstoken

Parameters

Error Parameters

Parameters

Error Parameters

Parameters

Error Parameters

PostTransactionalWebPush Anchor

PostTransactionalWebPush

PostTransactionalWebPush

Parameters

Parameters

Error Parameters

Parameters

Error Parameters

PostTransactionalWebPushWithToken AnchorPostTransactionalWebPushWithTokenPostTransactionalWebPushWithToken

Parameters

Error Parameters

GetPostPushResult
Anchor
getpush
getpush

GetPostPushResultByCreationDate
Anchor
creation
creation

GetPostPushResultByLastUpdate
Anchor
update
update

PostTransactionalPush
Anchor
posttrans
posttrans

PostTransactionalPushWithToken
Anchor
transtoken
transtoken

PostTransactionalWebPush
Anchor

PostTransactionalWebPushWithToken
Anchor
PostTransactionalWebPushWithToken
PostTransactionalWebPushWithToken