Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Data type

Description

message

SendParameters

See SendParameters for more information.

Returns

This method returns an object of the type SendResult.

lookup

This method lookup which operator a specific number will be delivered to.

...

Parameter

Data type

Description

message

LookupParameters

See LookupParameters for more information.

Returns

This method returns an object of the type LookupResult. Successful results with supplied operator will use return code 200 (OK).

...

Parameter

Data type

Description

message

RefundParameters

See RefundParameters for more information.

 


Objects in the WebService

...

Name

Data type

Description

username

String

This is the username which is used for authentication. This is provided by Support.

serviceId

Integer

This is the serviceId which is used for authentication. This is provided by Support.

password

String

This is the password which is used for authentication. This is provided by Support.

source

String

This is the source number from where the message should be sent. The format is depending on the specified sourceTON.

sourceTON

Integer

This is the source type of number. See TON for more information.

destination

String

This is the destination number. The format is depending on the specified destinationTON.

destinationTON

Integer

This is the destination type of number. See TON for more information.

dcs

Integer

This is the Data Coding Scheme that should be used when sending the SMS. See DCS for more information.

userDataHeader

String

This value may be specified when sending concatenated SMS, WAP-push, etc. The format is hex encoded 8-bit bytes. More information about valid UDH for long SMS etc may be given by support upon request.

userData

String

This is the message itself. The DCS specifies the format on this value.

GSM default alphabet encoded messages has a maximum length of 1377 bytes. Note that Extended GSM characters need 2 bytes for one character. 1 GSM7 message is 160 non-extended characters. 153 non-extended characters for GSM7 if the message is concatenated.

Binary messages should be hex encoded as 8-bit bytes and the maximum length is 140 bytes (280 bytes when hex encoded).

UCS2 encoded messages has a maximum length of 567 characters.

Note that messages will be split into several SMS if the text doesn’t fit in one SMS. 1 UCS2 encoded message is 70 characters or 63 characters if the message is concatenated.

useDeliveryReport

Boolean

True indicates that a delivery report should be sent back when the message has come to a final state. It’s recommended to set this value to true.

validityTime

Long

This specifies how long the message is supposed to live. The value should be specified in milliseconds. -1 indicates default validity time should apply. Recommended time is between 15 minutes (900000) and 48 hours (172800000).

tariffClass

String

Used for Premium SMS otherwise empty or null. Format: <currency in ISO 4217><cent of currency>

Example: SEK350 equals 3.50 SEK

vat

Float

Used for Premium SMS.

25 equals 25%

-1 equals not used or default.

customerParameters

List of

CustomParameter

Optional, parameters may be specified if requested by support.

 

List of available constants.

Anchor
SendResult
SendResult
SendResult

Name

Data type

Description

messageId

String

This is the unique messageId that will appear in the delivery report and should be referred to when sending questions to support.

resultCode

Integer

The result code. See Result Codes for more information.

resultDescription

String

This is the textual description for the result code.

...

Name

Data type

Description

operator

String

This is the resolved operator which the system will use when sending messages to the specified MSISDN. Format is for example: se.telia, no.telenor, dk.tdc

resultCode

Integer

The result code. See Result Codes for more information.

resultDescription

String

This is the textual description for the result code.

...

Name

Data type

Description

username

String

This is the username which is used for authentication. This is provided by Support.

serviceId

Integer

This is the serviceId which is used for authentication. This is provided by Support.

password

String

This is the password which is used for authentication. This is provided by Support.

destination

String

This is the MSIDN that should be resolved. Mobile number on international format starting with +.

messageId

String

This is the ID of the original charge message.

customerParameters

List of

CustomParameter

Optional, parameters may be specified if requested by support.

 

List of available constants.

 

Anchor
RefundResult
RefundResult
RefundResult

Name

Data type

Description

resultCode

Integer

The result code. See Result Codes for more information.

resultDescription

String

This is the textual description for the result code.

...