EMG 3.1.5 - User's Guide

C. MGP options

The following options can be used with messages. The option name is given followed by its numeric value. The numeric value is used in log files etc.

Some options only applies to certain protocols. These options are simply ignored by protocols which do not support them.

All numeric key values that are not used are reserved for future use.

User-Data Header (UDH) options can be supplied in two ways. Some can be supplied by setting the corresponding MGP options, DESTPORT for example. It is also possible to include the UDH in the actual message data and set the User-Data Header Indicator (UDHI).

C.1 Option keys in numeric order


Key value	Option
1	ID
2	SOURCEADDR
3	SOURCEADDRTON
4	SOURCEADDRNPI
6	SOURCEPORT
8	DESTADDR
9	DESTADDRTON
10	DESTADDRNPI
12	DESTPORT
14	UDH
15	MSGTYPE
16	MESSAGE
17	MESSAGELEN
18	VP
19	DLR
20	DELTIME
21	SCTS
27	MSGCLASS
28	CHARCODE
30	USER
31	REPLYPATH
32	PRIORITY
34	REMOTEIP
38	ROUTE
43	PROTOCOLID
59	CONNECTOR
60	OUTCONNECTOR
61	STATUS
64	SMSCID
73	CONCATSMSREF
74	CONCATSMSSEQ
75	CONCATSMSMAX
79	BILLINGID
81	DLRID
93	STARTSECS
94	STARTMSECS
95	ENDSECS
96	EMDMSECS
97	NOTE
106	UDHI
107	REPLACEPID
108	LRADDR
109	LRPID
110	HPLMNADDR
111	SUBJECT
112	OTOA
113	DCS
118	QPRIORITY
119	XUSERNAME

C.2 Options reference

C.2.1 BlLLINGID (79)

Billing ID

Only used with UCP 4.0

C.2.2 CHARCODE (28)

Character code of message

Coded into the DCS (Data Coding Scheme).

Values:


0	Default (GSM)
1	IA5
2	8-bit (binary)
3	ISO 8859-1 (Latin-1)
4	UCS2

C.2.3 CONCATSMSMAX (75)

GSM concatenated messages, number of messages

Encoded into UDH.

C.2.4 CONCATSMSREF (73)

GSM concatenated messages, reference number

Encoded into UDH.

C.2.5 CONCATSMSSEQ (74)

GSM concatenated messages, sequence number

Encoded into UDH.

C.2.6 CONNECTOR (59)

Connector on which message was received

C.2.7 DCS (113)

Data Coding Scheme

Defined in GSM 3.38.

C.2.8 DELTIME (20)

Delivery time

C.2.9 DESTADDR (8)

Destination or recipient address

C.2.10 DESTADDRNPI (10)

Destination address, number plan indicator (GSM 3.40)

Values:


0	Unknown (default)
1	ISDN
3	Data numbering plan (X.121)
4	Telex
5	Private
6	ERMES
15	Reserved for extension

C.2.11 DESTADDRTON (9)

Destination or recipient address, type of number (GSM 3.40)

Values:


0	Unknown (default)
1	International number
2	National number
3	Network specific number
4	Subscriber number
5	Alphanumeric
6	Abbreviated number
7	Reserved for extension

C.2.12 DESTPORT (12)

Destination port

Encoded into the UDH. Used to send binary messages like ringtones, WAP push etc.

C.2.13 DLR (19)

Delivery Receipt

C.2.14 DLRID (81)

Message id of original message

C.2.15 ENDMSECS (96)

Timestamp when message finished by EMG (millisecs)

This option only holds the milliseconds part of the time

Values: 0-999

C.2.16 ENDSECS (95)

Timestamp when message finished by EMG (seconds)

The milliseconds of this value is stored in ENDMSECS.

The value of the option is the time in seconds since 1 January 1970 (UTC).

C.2.17 HPLMNADDR (110)

Applies to: UCP

Introduced in EMG 1.0h.

C.2.18 ID (1)

Message id

This is the unique message id assigned by EMG.

C.2.19 LRADDR (108)

Last Resort Address

Introduced in EMG1.0h.

C.2.20 LRPID (109)

Last Resort Protocol Identifier

Introduced in EMG1.0h.

C.2.21 MESSAGE (16)

Message data

C.2.22 MESSAGELEN (17)

Length of message (in characters or bytes)

C.2.23 MSGCLASS (27)

Message class as defined by (GSM 3.40)

Values:

0 Flash SMS (message displayed immediately)
1 Store message (memory or SIM) (default)
2 Store message to SIM
3 TE (Terminal Equipment) specific

C.2.24 MSGTYPE (15)

Message type

Specifies the type of message.

Values:


SMS	1
DLR	5
Email	6
MMS	7

Default value: 1

C.2.25 NOTE (97)

Note

A user-specified text attached to the message. Can, for example, be used to hold extra information on the message.

C.2.26 OTOA (112)

Syntax: OTOA=<string>

Applies to: UCP

Introduced in EMG 1.0h

C.2.27 OUTCONNECTOR (60)

Name of connector on which message was sent out

C.2.28 PRIORITY (32)

Priority of message

There are differences in how priority options are implemented in the different SMSCs. However, in GSM 3.40 there are only priority or non-priority messages.

Values:
0 No priority (default)
1 Priority

Protocol-specific mappings
CIMD2 MGP
1-4 1
5-9,none 0

MGP CIMD2
0,none No value
1 1

SMPP MGP
0,none 0
1-3 1

MGP SMPP
0,none none
1 2

UCP MGP
0,1,none 0
2-3 1

MGP UCP
0 none
1 2

C.2.29 PROTOCOLID (43)

Protocol identifier (GSM 3.40)

C.2.30 QPRIORITY (118)

Specifies the queue priority in EMG. A message with a lower value is always processed before a message with a higher value when message queues are processed in EMG.

Values:


1	Highest priority
2
3	Normal
4
5	Lowest priority

Default value: 3

C.2.31 REMOTEIP (34)

IP of the client that sent the message

C.2.32 REPLACEPID (107)

Replace PID (or RPID)

Applies to: UCP

Introduced in EMG 1.0h

C.2.33 REPLYPATH (31)

Reply path

C.2.34 ROUTE (38)

Message-specific route

The option value must be a valid connector name. The specified connector will be used instead of any routes specified in the routing table or on the incoming connector.

C.2.35 SCTS (21)

Service Center TimeStamp

C.2.36 SMSCID (64)

Message id assigned by the remote SMSC

The exact format and value of this option is protocol and SMSC dependent.

C.2.37 SOURCEADDR (2)

Source or sender address

C.2.38 SOURCEADDRNPI (4)

Source address number plan indicator

For possible values, see DESTADDRNPI

C.2.39 SOURCEADDRTON (3)

Source address type of number

For possible values, see DESTADDRTON

C.2.40 SOURCEPORT (6)

Source port

Encoded into the UDH.

C.2.41 STARTMSECS (94)

Timestamp when message received by EMG (millis)

This option only holds the milliseconds part of the time

Values: 0-999

C.2.42 STARTSECS (93)

Timestamp when message received by EMG (seconds)

The milliseconds of this value is stored in STARTMSECS.

The value of the option is the time in seconds since 1 January 1970 (UTC).

C.2.43 STATUS (61)

Message status

Values:


1	Delivered
2	In process
3	Failed
4	Deleted
5	Expired
6	Rejected
7	Canceled
8	Queued
9	Orphaned
10	Relayed
11	Unknown

C.2.44 SUBJECT (111)

Default subject.

Applies to: SMTP

Introduced in EMG 2.0.

C.2.45 UDH (14)

User Data Header

The User Data Header

C.2.46 UDHI (106)

User Data Header Indicator

Indicates that the message includes a UDH in the message data.

Introduced in EMG 1.0f.

C.2.47 USER (30)

Username for client that sent the message

C.2.48 VP (18)

Validity Period

C.2.49 XUSERNAME (119)

MGP username

Used to route messages not only to a specific connector but to a specific user.

Applies to: MGP