Web Service - Methods - SendPremiumSMS

SendPremiumSMS

This method is used to send a single premium text message to a single mobile handset.

The recipient must have previously sent in a message to the short code/keyword service. This inbound message will have generated the rbid (Reverse Billing Identifier) which is then used to send the premium message.

A premium message is sent to an rbid, not to a mobile phone number.

Please note that when sending a premium message it is not possible to stipulate your own Originator (or Sender ID field as it is also known). The RBID field has embedded within it the Originator, which is automatically set to the Short Code number of the premium service.

With the validity parameter you can set the length of time that the message will be attempted for delivery, before it expires and delivery will no longer be attempted.

You can choose to automatically receive delivery status changes for each recipient of the message, if required. Giving a web page in the statusNotificationUrl parameter will ensure that as each recipient’s message is delivered (or fails), the status will be returned to your nominated web page.

Alternatively, if you wish to retrieve delivery status information using the Web Service, then use the method GetPremiumSMSStatus.

You can choose which character set your message body is sent with. The standard character set is GSM 03.38. If you are sending messages that contain double-byte characters from languages such as Cyrillic, Hindi and Chinese, then you should select the Unicode character set.

The maximum number of characters in a single text message is 160 when using GSM 03.38, and 70 when using Unicode.

The message body has a maximum length determined by the value of the EXTENDED SMS setting, set in the ADMIN PANEL area of your online account. The default setting is 3, enabling you to send a message with a maximum length of 459 characters (3 x 153 characters) with the GSM 03.38 character set, and 198 characters (3 x 66 characters) with the Unicode character set.

Please note that each 153 or 66 character message part is charged for separately.

You can choose to receive any return code data from this method as either a CSV string or XML through your setting of the returnCSVString parameter.

If a CSV string is requested, the first line will contain the Transaction code contained within the '#' characters.

» returnCSVString» Boolean
» externalLogin» String
» password» String
» clientBillingReference» String
» clientMessageReference» String
» rbid» String
» body» String
» validity» Long
» characterSetID» Int
» statusNotificationUrl» String

On successful completion of this method, the destination number and an integer code (representing the number’s status) are returned.

Return Data

XML:

<SendPremiumSMSResponse> 
    <Transaction> 
        <IP>123.123.123.123</IP> 
        <Code>1</Code> 
        <Description>Transaction  OK</Description> 
    </Transaction> 
</SendPremiumSMSResponse>
        

CSV:

#1# 1

Footer Bottom