Page Comparison

Status


colour	Green
title	post

Anchor

	topsmsws
	topsmsws

Service URL	postsms.asmx

General Information

Transactional SMS's are SMS messages that are typically related to system or account related activity triggered by customer interactions with your brand. Common examples of these SMS messages are:

Password reminders / resets
System notifications
Order confirmation
Verification messages
Shipping confirmation

Transactional SMS Web Service Methods

The following table lists supported methods for Transactional SMS Web Service and provides a brief description of each method. Click on the method name for more information.

Method	Description
GetSmsBulkResult	Queries the status of bulk SMS messages between two dates.
ReportSingleShotSms	Enables Single Shot SMS Reporting by Packet ID.
ReportSmsWithPacketId	Enables SMS Reporting by Packet ID.
SendBulkSms	Allows you to send SMS message to multiple GSM numbers.
SendBulkSmsWithTypeAndKeyID	Allows you to send bulk SMS messages with Type and KeyID.
SendPersonalSms	Allows you to send a single SMS message.
SendPersonalSmsWithTypeAndKeyID	Allows you to send a single SMS message with Type and KeyID.
SingleShotSms	Allows you to send an OTP (One Time Password) SMS.
SingleShotSmsWithTypeAndKeyID	Enables Single Shot SMS Sending with PostType and KeyID.
SendPersonalSmsToAMember	Enables personal-sms sending to an existing member.

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

.

SendPersonalSms
Anchor
sendpersonalsms
sendpersonalsms

Back to Top ^

<SendPersonalSms>
Allows you to send a single SMS message.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Originator

SMS Sender's Name

Status

colour	Green
title	mandatory

NumberMessagePair

GSM Number and Text Message

Status

colour	Green
title	mandatory

Key

GSM Number

Status

colour	Green
title	mandatory

Value

Message Text

Status

colour	Green
title	mandatory

BeginTime

Time to start sending the message

Status

colour	Green
title	mandatory

EndTime

Time to end sending the message

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>
    <SendPersonalSms xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <NumberMessagePair>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
      </NumberMessagePair>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </SendPersonalSms>
  </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>
    <SendPersonalSmsResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <SendPersonalSmsResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </SendPersonalSmsResult>
    </SendPersonalSmsResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	<Code>

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that,

Status


subtle	true
colour	Red
title	MemberID

field will also be returned as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid orginator!	The SMS sender name is not defined in your account.

SendBulkSms
Anchor
sendbulksms
sendbulksms

Back to Top ^

<SendBulkSms>
Allows you to send SMS message to multiple GSM numbers.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Originator

SMS Sender's Name

Status

colour	Green
title	mandatory

Message

SMS Text Message

Status

colour	Green
title	mandatory

GsmNumbers

GSM Numbers to send SMS to

Note
Maximum 5 gsm no should be added.

Status

colour	Green
title	mandatory

BeginTime

Time to start sending the message

Status

colour	Green
title	mandatory

EndTime

Time to end sending the message

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>
    <SendBulkSms xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <Message>string</Message>
      <GsmNumbers>
        <string>string</string>
        <string>string</string>
      </GsmNumbers>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </SendBulkSms>
  </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>
    <SendBulkSmsResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <SendBulkSmsResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </SendBulkSmsResult>
    </SendBulkSmsResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that, regarding the sent SMS messages

Status


subtle	true
colour	Red
title	Packet ID

value is returned.

Warning

Format for GSM numbers is

Status

subtle	true
colour	Red
title	532.1234567

.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid orginator!	The SMS sender name is not defined in your account.

SendPersonalSmsWithTypeAndKeyID
Anchor
sendpersonalsmswtype
sendpersonalsmswtype

Back to Top ^

<SendPersonalSmsWithTypeAndKeyID>
Allows you to send a single SMS with Type and KeyID.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Originator

SMS Sender's Name

Status

colour	Green
title	mandatory

NumberMessagePair

GSM Number and Text Message

Status

colour	Green
title	mandatory

Key

GSM Number

Status

colour	Green
title	mandatory

Value

Message Text

Status

colour	Green
title	mandatory

KeyIDs

KEY_ID information of the GSM numbers to send SMS messages to

Status

colour	Green
title	mandatory

PostType

Type of the SMS message to send

Status

colour	Green
title	mandatory

BeginTime

Time to start sending the message

Status

colour	Green
title	mandatory

EndTime

Time to end sending the message

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>
    <SendPersonalSmsWithTypeAndKeyID xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <NumberMessagePair>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
      </NumberMessagePair>
      <KeyIDs>
        <string>string</string>
        <string>string</string>
      </KeyIDs>
      <PostTypes>
        <string>string</string>
        <string>string</string>
      </PostTypes>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </SendPersonalSmsWithTypeAndKeyID>
  </soap:Body>
</soap:Envelope><?xml version="1.0" encoding="utf-8"?>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<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>
    <SendPersonalSmsWithTypeAndKeyIDResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <SendPersonalSmsWithTypeAndKeyIDResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </SendPersonalSmsWithTypeAndKeyIDResult>
    </SendPersonalSmsWithTypeAndKeyIDResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Tip
PostType parameter is used to group the sent SMS messages when reporting. This is not a predefined parameter. For example for password reminder SMS messages, `Verification` value can be used as a PostType parameter.

Warning
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded. Please contact RMC Technical Client Support Team to obtain more information about sending transactional emails with promotional content.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid orginator!	The SMS sender name is not defined in your account.

SendBulkSmsWithTypeAndKeyID
Anchor
sendbulkwid
sendbulkwid

Back to Top ^

<SendBulkSmsWithTypeAndKeyID>
Allows you to send SMS messages to multiple GSM numbers.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Originator

SMS Sender's Name

Status

colour	Green
title	mandatory

Message

GSM Number and Text Message

Status

colour	Green
title	mandatory

GsmNumbers

GSM Numbers to send SMS to

Status

colour	Green
title	mandatory

KeyIDs

KEY_ID information of the GSM numbers to send SMS messages to

Status

colour	Green
title	mandatory

PostType

Type of the SMS message to send

Status

colour	Green
title	mandatory

BeginTime

Time to start sending the message

Status

colour	Green
title	mandatory

EndTime

Time to end sending the message

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>
    <SendBulkSmsWithTypeAndKeyID xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <Message>string</Message>
      <GsmNumbers>
        <string>string</string>
        <string>string</string>
      </GsmNumbers>
      <KeyIDs>
        <string>string</string>
        <string>string</string>
      </KeyIDs>
      <PostType>string</PostType>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </SendBulkSmsWithTypeAndKeyID>
  </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>
    <SendBulkSmsWithTypeAndKeyIDResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <SendBulkSmsWithTypeAndKeyIDResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </SendBulkSmsWithTypeAndKeyIDResult>
    </SendBulkSmsWithTypeAndKeyIDResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Tip
PostType parameter is used to group the sent SMS messages when reporting. This is not a predefined parameter. For example for password reminder SMS messages, `Verification` value can be used as a PostType parameter.

Warning
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded. Please contact RMC Technical Client Support Team to obtain more information about sending transactional emails with promotional content.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid orginator!	The SMS sender name is not defined in your account.

SingleShotSms
Anchor
singleshot
singleshot

Back to Top ^

<SingleShotSms>
Allows you to send an OTP (One Time Password) SMS.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Originator

SMS Sender's Name

Status

colour	Green
title	mandatory

NumberMessagePair

GSM Number and Text Message

Status

colour	Green
title	mandatory

Key

GSM Number

Status

colour	Green
title	mandatory

Value

Text Message

Status

colour	Green
title	mandatory

BeginTime

Time to start sending the message

Status

colour	Green
title	mandatory

EndTime

Time to end sending the message

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>
    <SingleShotSms xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <NumberMessagePair>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
      </NumberMessagePair>
      <BeginTime>string</BeginTime>
    </SingleShotSms>
  </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>
    <SingleShotSmsResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <SingleShotSmsResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </SingleShotSmsResult>
    </SingleShotSmsResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Tip
You must have an OTP user to be able to send Single Shot SMS. The messages sent by this service are not filtered by the advertisement filters applied by the GSM operators. And if the phone is in the coverage area, the messages are delivered within maximum 3 minutes.

ReportSmsWithPacketID
Anchor
reportsmsid
reportsmsid

Back to Top ^

<ReportSmsWithPacketId>
Queries the status of a specific SMS message sent.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`
PacketId	PacketID value returned from the Service after sending the SMS

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>
    <ReportSmsWithPacketId xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <PacketId>string</PacketId>
    </ReportSmsWithPacketId>
  </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>
    <ReportSmsWithPacketIdResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ReportSmsWithPacketIdResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </ReportSmsWithPacketIdResult>
    </ReportSmsWithPacketIdResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

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

GetSmsBulkResult
Anchor
bulkresult
bulkresult

Back to Top ^

<GetSmsBulkResult>
Queries the status of bulk SMS messages between two dates.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

BeginDate

Time to start sending the message

Status

colour	Green
title	mandatory

EndDate

Time to end sending the message

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>
    <GetSmsBulkResult xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetSmsBulkResult>
  </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>
    <GetSmsBulkResultResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <GetSmsBulkResultResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </GetSmsBulkResultResult>
      <BulkReport>
        <EmSmsBulkDeliveryResult>
          <PacketID>string</PacketID>
          <GsmNumber>string</GsmNumber>
          <DeliveryStatus>string</DeliveryStatus>
          <SendDate>string</SendDate>
          <DeliveryDate>string</DeliveryDate>
          <DeliveryDetail>string</DeliveryDetail>
          <KeyID>string</KeyID>
          <PostType>string</PostType>
        </EmSmsBulkDeliveryResult>
        <EmSmsBulkDeliveryResult>
          <PacketID>string</PacketID>
          <GsmNumber>string</GsmNumber>
          <DeliveryStatus>string</DeliveryStatus>
          <SendDate>string</SendDate>
          <DeliveryDate>string</DeliveryDate>
          <DeliveryDetail>string</DeliveryDetail>
          <KeyID>string</KeyID>
          <PostType>string</PostType>
        </EmSmsBulkDeliveryResult>
      </BulkReport>
    </GetSmsBulkResultResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

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

ReportSingleShotSms
Anchor
ReportSingleShotSms
ReportSingleShotSms

Back to Top ^

<ReportSingleShotSms>
Enables single-shot sms reporting by Packet ID

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

PacketId

PacketID value returned from the Service after sending the SMS

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>
    <ReportSingleShotSms xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <PacketId>string</PacketId>
    </ReportSingleShotSms>
  </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>
    <ReportSingleShotSmsResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ReportSingleShotSmsResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </ReportSingleShotSmsResult>
    </ReportSingleShotSmsResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	<Code>

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

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

SingleShotSmsWithTypeAndKeyID
Anchor
SingleShotSmsWithTypeAndKeyID
SingleShotSmsWithTypeAndKeyID

Back to Top ^

<SingleShotSmsWithTypeAndKeyID>
Allows you to send a single SMS with Type and KeyID.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Originator

SMS Sender's Name

Status

colour	Green
title	mandatory

GsmNumber

GSM Number

Status

colour	Green
title	mandatory

Message

Message Text

Status

colour	Green
title	mandatory

KeyIDs

KEY_ID information of the GSM numbers to send SMS messages to

Status

colour	Green
title	mandatory

PostType

Type of the SMS message to send

Status

colour	Green
title	mandatory

BeginTime

Time to start sending the message

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>
    <SingleShotSmsWithTypeAndKeyID xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <GsmNumber>string</GsmNumber>
      <Message>string</Message>
      <KeyID>string</KeyID>
      <PostType>string</PostType>
      <BeginTime>string</BeginTime>
    </SingleShotSmsWithTypeAndKeyID>
  </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>
    <SingleShotSmsWithTypeAndKeyIDResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <SingleShotSmsWithTypeAndKeyIDResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </SingleShotSmsWithTypeAndKeyIDResult>
    </SingleShotSmsWithTypeAndKeyIDResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Tip
PostType parameter is used to group the sent SMS messages when reporting. This is not a predefined parameter. For example for password reminder SMS messages, `Verification` value can be used as a PostType parameter.

Warning
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded. Please contact RMC Technical Client Support Team to obtain more information about sending transactional emails with promotional content.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid orginator!	The SMS sender name is not defined in your account.

SendPersonalSmsToAMember
Anchor
persmemb
persmemb

Back to Top ^

<SendPersonalSmsToAMember>
Enables personal-sms sending to an existing member.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Originator

SMS Sender's Name

Status

colour	Green
title	mandatory

Message

Text message

Status

colour	Green
title	mandatory

Key

Account reference information

Status

colour	Green
title	mandatory

Value

The value of the field name specified in the Key field

Status

colour	Green
title	mandatory

BeginTime

Time to start sending the message

Status

colour	Green
title	mandatory

EndTime

Time to end sending the message

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>
    <SendPersonalSmsToAMember xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <Key>string</Key>
      <Value>string</Value>
      <Message>string</Message>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </SendPersonalSmsToAMember>
  </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>
    <SendPersonalSmsToAMemberResponse xmlns="http://wsapi.euromsgrelateddigital.com/postsms">
      <SendPersonalSmsToAMemberResult>
        <PacketID>string</PacketID>
        <PacketStatus>string</PacketStatus>
        <DeliveryResults>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
          <EmSmsDeliveryResult>
            <GsmNumber>string</GsmNumber>
            <DeliveryResult>string</DeliveryResult>
            <DeliveryDetail>string</DeliveryDetail>
            <DeliveryTime>string</DeliveryTime>
            <DeliveredMessage>string</DeliveredMessage>
            <PostType>string</PostType>
            <KeyID>string</KeyID>
            <SendDate>string</SendDate>
          </EmSmsDeliveryResult>
        </DeliveryResults>
      </SendPersonalSmsToAMemberResult>
    </SendPersonalSmsToAMemberResponse>
  </soap:Body>
</soap:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid orginator!	The SMS sender name is not defined in your account.

Parent Topic: SOAP Web Service

Versions Compared

Old Version 42

New Version 43

Key

General Information

Transactional SMS Web Service Methods

SendPersonalSms
Anchor
sendpersonalsms
sendpersonalsms

Parameters

Error Parameters

SendBulkSms
Anchor
sendbulksms
sendbulksms

Parameters

Error Parameters

SendPersonalSmsWithTypeAndKeyID
Anchor
sendpersonalsmswtype
sendpersonalsmswtype

Parameters

Error Parameters

SendBulkSmsWithTypeAndKeyID
Anchor
sendbulkwid
sendbulkwid

Parameters

Error Parameters

SingleShotSms
Anchor
singleshot
singleshot

Parameters

ReportSmsWithPacketID
Anchor
reportsmsid
reportsmsid

Parameters

Error Parameters

GetSmsBulkResult
Anchor
bulkresult
bulkresult

Parameters

Error Parameters

ReportSingleShotSms
Anchor
ReportSingleShotSms
ReportSingleShotSms

Parameters

Error Parameters

SingleShotSmsWithTypeAndKeyID
Anchor
SingleShotSmsWithTypeAndKeyID
SingleShotSmsWithTypeAndKeyID

Parameters

Error Parameters

SendPersonalSmsToAMember
Anchor
persmemb
persmemb

Parameters

Error Parameters

Page Comparison

Versions Compared

Old Version 42

New Version 43

Key

General Information

Transactional SMS Web Service Methods

SendPersonalSms Anchorsendpersonalsmssendpersonalsms

Parameters

Error Parameters

SendBulkSms Anchorsendbulksmssendbulksms

Parameters

Error Parameters

SendPersonalSmsWithTypeAndKeyID Anchorsendpersonalsmswtypesendpersonalsmswtype

Parameters

Error Parameters

SendBulkSmsWithTypeAndKeyID Anchorsendbulkwidsendbulkwid

Parameters

Error Parameters

SingleShotSms Anchorsingleshotsingleshot

Parameters

ReportSmsWithPacketID Anchorreportsmsidreportsmsid

Parameters

Error Parameters

GetSmsBulkResult Anchorbulkresultbulkresult

Parameters

Error Parameters

ReportSingleShotSms AnchorReportSingleShotSmsReportSingleShotSms

Parameters

Error Parameters

SingleShotSmsWithTypeAndKeyID AnchorSingleShotSmsWithTypeAndKeyIDSingleShotSmsWithTypeAndKeyID

Parameters

Error Parameters

SendPersonalSmsToAMember Anchorpersmembpersmemb

Parameters

Error Parameters

SendPersonalSms
Anchor
sendpersonalsms
sendpersonalsms

SendBulkSms
Anchor
sendbulksms
sendbulksms

SendPersonalSmsWithTypeAndKeyID
Anchor
sendpersonalsmswtype
sendpersonalsmswtype

SendBulkSmsWithTypeAndKeyID
Anchor
sendbulkwid
sendbulkwid

SingleShotSms
Anchor
singleshot
singleshot

ReportSmsWithPacketID
Anchor
reportsmsid
reportsmsid

GetSmsBulkResult
Anchor
bulkresult
bulkresult

ReportSingleShotSms
Anchor
ReportSingleShotSms
ReportSingleShotSms

SingleShotSmsWithTypeAndKeyID
Anchor
SingleShotSmsWithTypeAndKeyID
SingleShotSmsWithTypeAndKeyID

SendPersonalSmsToAMember
Anchor
persmemb
persmemb