Sending SMThe send request element is formatted as follows:
Element
Type
Default Value
Max
length
Description
correlationId
string
100
Correlation ID to keep track of SOAP
requests and responses (WS-I
recommendation). The server echoes
whatever value is provided.
originatingAddress
string
If omitted, this value
is set by IPX (it is
however highly
recommended that
this value always is
set by the Content
Provider)
16
The originating address for the
outgoing SM. Type of originating
address is defined by the
orginatorTON parameter.
Short number max length is 16.
Alpha numeric sender is limited to
GSM default Alphabet with max length
11 characters.
MSISDN sender max length is 16
originatorTON
integer
1
The originating address. type of
number (TON):
0 . Short number
1 . Alpha numeric (max length 11)
2 . MSISDN
Behaviour may vary with Operator
integrations.
destinationAddress
string
40
The MSISDN that the SM should be
sent to, starting with country code.
Example: 46762050312.
For some markets (where the
Consumer MSISDN must be
obfuscated) this value can also be an
alphanumeric alias, prefixed with.#..
Sending SM to multiple recipients is
supported by providing a distribution
list of semi-colon separated MSISDNs
(e.g. 46762050312;46762050313).
Note that no white-spaces are
allowed, the recipients must be unique
within a list and the distribution list is
limited to 1000 entries.
userData
string
Empty message.
280
The message content,
userDataHeader
string
No user data header.
280
User Data Header together with the
User Data can contain up to 140 (i.e.
280 when hex-encoded) octets. This
parameter is always hex-encoded.
DCS
integer
17
3
Data coding scheme. See [5] for more
information.
Behaviour may vary with Operator
integrations.
PID
integer
Use .1 until supported.
relativeValidityTime
integer
172800 (48 hours)
10
Relative validity time in seconds
(relative to the time for the submission
to IPX).
Behaviour may vary with Operator
integrations.
deliveryTime
string
Immediately.
25
The message can be delivered with
delayed delivery time.
Format: yyyy-MM-dd HH:mm:ss Z,
example: 2000-01-01 01:01:01 .0000.
Behaviour may vary with Operator
integrations.
statusReportFlags
integer
0
1
Deliver report request:
0 . No delivery report
1 . Delivery report requested
accountName
string
#NULL#
50
This field allows IPX to route
messages in a flexible manner, which
may or may not be content provider
specific.
For normal usage, #NULL# should be
supplied.
Note: Usage of this field must be
provisioned by IPX.
tariffClass
string
40
Tariff class for the message,
representing the price of a premium
message. Valid market tariff classes
are provided by IPX.
For non-premium messages, the
market.s zero tariff class must be
supplied, e.g. SGD0, EUR0 or
corresponding
VAT
double
-1
5
Set to -1 for normal usage (apply for
most Content Providers).
Specifies the requested (non-default)
VAT.
Note that the VAT finally used is
returned in the submit response.
Behaviour may vary with Operator
integrations.
IPX support should be contacted
before usage.
referenceId
string
150
Referenced order of the premium
message, normally a message ID
from an MO message
contentCategory
string
#NULL#
40
The content category. Set to #NULL#
if not used or not supported by the
market.
Market specific information. Contact
IPX support for further information.
contentMetaData
string
#NULL#
1000
The content meta data. Set to
#NULL# if not used or not supported
by the market.
Market specific information. Contact
IPX support for further information.
Username
string
64
The Content Provider.s username
provided by IPX.
Password
string
64
The Content Provider.s password
provided by IPX.
Receiving SM
Parameter
Type
Max
length
Description
DestinationAddress
string
11
The short number the SM was sent to.
Example: 72160.
OriginatorAddress
string
40
The Consumer.s MSISDN, starting
with the country code (sender of the
SM). Example: 46762050312.
For some markets (where the
Consumer MSISDN must be
obfuscated) this value can also be an
alphanumeric alias, prefixed with .#..
Message
string
280
The message text,
MessageId
string
22
A unique ID for the message. This
message ID should be used as
reference ID when sending premium
MT message.
TimeStamp
string
20
Time of arrival of the SM at the
Operator.s SMSC.
The time zone of the timestamp is
CET or CEST (with summer time as
defined for the EU).
Format: yyyy-MM-dd HH:mm:ss.
Operator
string
100
The name of the Consumer.s Mobile
Operator (a list of available operators
is provided by IPX) or the account
name used when sending the
message.
UserDataHeader
string
280
User Data can contain up to 140 (i.e.
280 when hex-encoded) octets. This
parameter is always hex-encoded.
See [6] for more information.
Behaviour may vary with Operator
integrations. IPX always forwards the
received data unchanged or empty if
not available.
Note: Access to this parameter must
be provisioned by IPX support.
MessageAlphabet
int
2
Indicates the message alphabet used
in the SM:
0 . Default (GSM)
1 . 8 bit (binary)
2 . UCS2
The Message Alphabet is part of the
Data coding scheme as described in
[5].
Note: Access to this parameter must
be provisioned by IPX support.
Related Responce Codes
Code
Text
0
Success
1
Invalid login or un-authorized API
usage
2
Consumer is blocked by IPX
3
Operation is not provisioned by
IPX
4
The consumer is unknown to IPX
5
Consumer has blocked
service in IPX
6
The originating address is not
supported
7
Alpha originating address not
supported by account
8
MSISDN originating address not
supported by account
9
GSM extended not supported by
account
10
Unicode not supported by
account
11
Status report not supported by
account
12
Required capability not
13
Could not route message
14
The content provider max
throttling rate is exceeded
15
The account max throttling rate is
exceeded
50
Partial success: (<1>;<2>;
)
99
Internal server error
100
Invalid destination address
101
Invalid tariff class (price)
102
Invalid referenced (linked) ID
103
Invalid account name
104
Invalid content category
105
Invalid content meta data
106
Invalid originating address
107
Invalid alphanumeric originating
address
108
Invalid validity time
109
Invalid delivery time
110
Invalid message content/user
data
111
Invalid message length
112
Invalid user data header
113
Invalid data coding scheme
114
Invalid protocol ID
115
Invalid status report flags
116
Invalid TON
117
Invalid VAT
200
Operator integration error
201
Communication problems
202
Read timeout
209
Integration error
Reason codes
Reason code
Text
0
Not applicable
1000
The consumer is not
recognized as a subscriber
(from operator)
1001
The subscriber is blocked
(from operator)
1002
The subscriber has insufficient
funds for the requested
transaction (from operator)
1003
The mobile subscribers
message queue is full (from
operator)
1004
Invalid content meta data
1006
Charging error
1007
The subscriber has blocked
this service (from operator)
1008
The subscriber is not
registered (from operator)
Tuesday, December 30, 2008
Reason,Responce codes and variables
Labels:
rails,
ruby on rails,
sms,
sms on rails,
text messaging
Subscribe to:
Post Comments (Atom)

0 comments:
Post a Comment