Transactional SMS Web Service

POST 


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.


To interact with any Web Services, developers must first use the Login method to create a SERVICE TICKET. Developers can send requests to other Web Service and methods using this SERVICE TICKET.



SendPersonalSms 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

OriginatorSMS Sender's Name

MANDATORY

NumberMessagePairGSM Number and Text Message

MANDATORY

KeyGSM Number

MANDATORY

ValueMessage Text

MANDATORY

BeginTimeTime to start sending the message

MANDATORY

EndTimeTime to end sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <SendPersonalSms xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SendPersonalSmsResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>
If the request was successful, the <CODE> parameter will return 00 as a response. In addition to that, MEMBERID field will also be returned as a response.

Error Parameters

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



SendBulkSms 

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

OriginatorSMS Sender's Name

MANDATORY

MessageSMS Text Message

MANDATORY

GsmNumbers

GSM Numbers to send SMS to

Maximum 5 gsm no should be added.

MANDATORY

BeginTimeTime to start sending the message

MANDATORY

EndTimeTime to end sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <SendBulkSms xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SendBulkSmsResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, regarding the sent SMS messages PACKET ID value is returned.

Format for GSM numbers is 532.1234567.

Error Parameters

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



SendPersonalSmsWithTypeAndKeyID 

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

OriginatorSMS Sender's Name

MANDATORY

NumberMessagePairGSM Number and Text Message

MANDATORY

KeyGSM Number

MANDATORY

ValueMessage Text

MANDATORY

KeyIDsKEY_ID information of the GSM numbers to send SMS messages to

MANDATORY

PostTypeType of the SMS message to send

MANDATORY

BeginTimeTime to start sending the message

MANDATORY

EndTimeTime to end sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <SendPersonalSmsWithTypeAndKeyID xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SendPersonalSmsWithTypeAndKeyIDResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response.

 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.

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

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



SendBulkSmsWithTypeAndKeyID 

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

OriginatorSMS Sender's Name

MANDATORY

MessageGSM Number and Text Message

MANDATORY

GsmNumbersGSM Numbers to send SMS to

MANDATORY

KeyIDsKEY_ID information of the GSM numbers to send SMS messages to

MANDATORY

PostTypeType of the SMS message to send

MANDATORY

BeginTimeTime to start sending the message

MANDATORY

EndTimeTime to end sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <SendBulkSmsWithTypeAndKeyID xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SendBulkSmsWithTypeAndKeyIDResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response.

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.

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

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

SingleShotSms 

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

OriginatorSMS Sender's Name

MANDATORY

NumberMessagePairGSM Number and Text Message

MANDATORY

KeyGSM Number

MANDATORY

ValueText Message

MANDATORY

BeginTimeTime to start sending the message

MANDATORY

EndTimeTime to end sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <SingleShotSms xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SingleShotSmsResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response.

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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login
PacketIdPacketID value returned from the Service after sending the SMS
REQUEST EXAMPLE
<?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>
    <ReportSmsWithPacketId xmlns="http://ws.euromsg.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <PacketId>string</PacketId>
    </ReportSmsWithPacketId>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <ReportSmsWithPacketIdResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.



GetSmsBulkResult 

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

BeginDateTime to start sending the message

MANDATORY

EndDateTime to end sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <GetSmsBulkResult xmlns="http://ws.euromsg.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </GetSmsBulkResult>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <GetSmsBulkResultResponse xmlns="http://ws.euromsg.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>
          <Details>
            <Success>int</Success>
            <Error>int</Error>
            <Waiting>int</Waiting>
            <Timeout>int</Timeout>
            <Unfinished>int</Unfinished>
          </Details>
        </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>
          <Details>
            <Success>int</Success>
            <Error>int</Error>
            <Waiting>int</Waiting>
            <Timeout>int</Timeout>
            <Unfinished>int</Unfinished>
          </Details>
        </EmSmsBulkDeliveryResult>
      </BulkReport>
    </GetSmsBulkResultResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.



ReportSingleShotSms 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

PacketIdPacketID value returned from the Service after sending the SMS

MANDATORY

REQUEST EXAMPLE
<?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>
    <ReportSingleShotSms xmlns="http://ws.euromsg.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <PacketId>string</PacketId>
    </ReportSingleShotSms>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <ReportSingleShotSmsResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>
If the request was successful, the <CODE> parameter will return 00 as a response.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

SingleShotSmsWithTypeAndKeyID 

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

OriginatorSMS Sender's Name

MANDATORY

GsmNumberGSM Number

MANDATORY

MessageMessage Text

MANDATORY

KeyIDsKEY_ID information of the GSM numbers to send SMS messages to

MANDATORY

PostTypeType of the SMS message to send

MANDATORY

BeginTimeTime to start sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <SingleShotSmsWithTypeAndKeyID xmlns="http://ws.euromsg.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <GsmNumber>string</GsmNumber>
      <Message>string</Message>
      <KeyID>string</KeyID>
      <PostType>string</PostType>
      <BeginTime>string</BeginTime>
    </SingleShotSmsWithTypeAndKeyID>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SingleShotSmsWithTypeAndKeyIDResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response.

 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.

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

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




SendPersonalSmsToAMember 

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

OriginatorSMS Sender's Name

MANDATORY

MessageText message

MANDATORY

KeyAccount reference information

MANDATORY

ValueThe value of the field name specified in the Key field

MANDATORY

BeginTimeTime to start sending the message

MANDATORY

EndTimeTime to end sending the message

MANDATORY

REQUEST EXAMPLE
<?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>
    <SendPersonalSmsToAMember xmlns="http://ws.euromsg.com/postsms">
      <ServiceTicket>string</ServiceTicket>
      <Originator>string</Originator>
      <Key>string</Key>
      <Value>string</Value>
      <Message>string</Message>
      <BeginTime>string</BeginTime>
      <EndTime>string</EndTime>
    </SendPersonalSmsToAMember>
  </soap12:Body>
</soap12:Envelope>
RESPONSE EXAMPLE
<?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>
    <SendPersonalSmsToAMemberResponse xmlns="http://ws.euromsg.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>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

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



Parent Topic: SOAP Web Service


Copyright 2020 Related Digital