MGP options

Overview

Messages are represented by MGP options within EMG. The option key is a numerical value which also has a text representation in many contexts, for example in the connector log files.

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.

Not all options applies to messages and many options are for internal use only.

Option keys in numerical order

ValueOptionDescription
1 IDEMG message id
2SOURCEADDRSource address
3SOURCEADDRTONSource address TON (Type Of Number)
4SOURCEADDRNPISource address NPI (Number Plan Indicator)
5SOURCESUBADDRESS 
6SOURCEPORT 
8DESTADDRDestination address
9DESTADDRTONDestination address TON (Type Of Number)
10DESTADDRNPIDestination address NPI (Number Plan Indicator)
11DESTSUBADDRESS 
12DESTPORT 
14UDHUser Data Header
15UDHLENLength of User Data Header
16MESSAGEMessage body
17MESSAGELENLength of message body
18VP 
19DLRIndicates whether a delivery report (DLR) has been requested.
0 – DLR not requested
1 – DLR requested
2 is added to this value if intermediate delivery reports are also requested.
20DELTIME 
21SCTS 
22USERNAMEUsername for the user that submitted the message to EMG.
23PASSWORD 
24NEWPASSWORD 
25MSGTYPE1 – Normal message
5 – Delivery report (DLR)
26MSGSUBTYPE 
27MSGCLASS 
28CHARCODE0 – Default
1 – GSM-7 / IA5
2 – 8-bit binary
3 – Latin-1
4 – UCS2
32 – UTF-8
29AUTHCODE 
30USER 
31REPLYPATH 
32PRIORITY 
33TARIFFCLASS 
34REMOTEIPIP address of client
35SYSTEMTYPE 
36SMSCOP 
38ROUTEA “hard” route for the message.
39ROUTEDLRThe route for subsequent delivery reports for the message.
40RETCODE 
41SERVICETYPE 
42MESSAGEMODE 
43PROTOCOLID 
46USERRESPONSECODE 
52MESSAGESTATE 
54LONGMESSAGE 
55LONGMODE 
57CANCELMODE 
58INTERFACEVERSION 
59CONNECTORReceiving connector
60OUTCONNECTORSending connector
61STATUSMessage status
1 – Delivered
2 – In process
3 – Failed
4 – Deleted
5 – Expired
6 – Rejected
7 – Canceled
8 – Queued
9 – Orphaned
10 – Relayed
11 – Unknown
62SOURCENETWORKTYPE 
64SMSCIDMessage id from remote end.
65OPSENTEXPIRES 
66DLREXPIRES 
68TCPSOURCEPORT 
69MAPPING 
70DLRADDRESS 
71DLRPID 
72DOMAIN 
73CONCATSMSREF 
74CONCATSMSSEQ 
75CONCATSMSMAX 
76REQUIREPREFIX 
77AUTHTON 
78AUTHNPI 
79BILLINGID 
80SINGLESHOT 
81DLRID 
82CONNECTORNAME 
83STATE 
84PROTOCOL 
85INSTANCES 
86QUEUESIZE 
87TYPE 
88QSTATS1 
89QSTATS5 
90QSTATS15 
91INSTANCE 
93STARTSECSTime when message received by EMG in seconds since epoch.
94STARTMSECSMilliseconds part of time when message received by EMG.
95ENDSECSTime when message sent by EMG in seconds since epoch.
96ENDMSECSMilliseconds part of time when message sent by EMG.
97NOTE 
98CLIENTCONFIG 
99COMPANY 
100NAME 
101PBNAME 
102PBTYPE 
103REASON 
104PBID 
105ISADMIN 
106UDHI 
107REPLACEPID 
108LRADDR 
109LRPID 
110HPLMNADDR 
111SUBJECT 
113DCS 
115HEADER 
116KEYWORD 
117REMOVEPREFIX 
118QPRIORITYEMG queue priority (1-5). A lower value means a higher priority.
119XUSERNAMEUsername for receiving user, used for MO routing to specific client.
120MAXINSTANCES 
121AVGINSTANCES1 
123MODE 
124DBSQL 
125DBNAME 
126DBDATA 
127CREDITS 
128SOURCEADDRTYPE 
129DESTADDRTYPE 
130REQUIREPREFIX_SOURCEADDR 
131REMOVEPREFIX_SOURCEADDR 
132PDUSEQ 
133PDUSEQMAX 
134ORIGSOURCEADDR 
135ORIGDESTADDR 
136SERVICEDESCRIPTION 
137SENDERTS 
138IMSI 
139VLR 
140ORIGID 
141SERVICEID 
142ACLENTRYWHOID 
143ACLENTRYWHEREID 
144PLUGINARG 
145MMSDESTADDR 
146MSISDN 
147XPRIORITY 
148TCPSOURCEIP 
149SENDERADDRESS 
150ORIGIN 
151SUBMITTS 
152DONETS 
153MESSAGEID 
154INREPLYTO 
155REFERENCES 
156QUOTEDREPLY 
157QUOTEDREPLY_SEPARATOR 
158SERVICETYPEIN 
159SOURCEFULLNAME 
160CONTENTTYPE 
161CONTENTLOCATION 
162DESTFULLNAME 
163MESSAGEIDIN 
164ARCORMOD 
165ARCORFUNC 
166ARCORUNIT 
167SCAADDR 
168SCAADDRTON 
169SCAADDRNPI 
170REASONTEXT 
171ITSSESSIONINFO 
172LASTDLRSECS 
173LASTDLRMSECS 
174SMTP_RET 
175INSTANCES_INUSE 
176DESTNETWORK 
177TARIFFNAME 
178SMPPOPTIONSMPP custom options in the interval 0x1400 to 0x10000. The format of the value, as used by emgsend and plugins, is: “key:value”.The key is “0x1400” etc, and the value is hex encoded.
179BUFFEREDSTATUS 
180WAPAPPLICATION 
181XSER_EXTRA 
182MMS_RELAY_SERVER_ID 
183DLR_IN 
184DLR_OUT 
185OPERATOR 
186MESSAGE_ERROR 
187NETWORK_ERROR 
188AUROUTE 
189AUROUTELIST 
190PROXY 
191CHARGE 
192CHARGE_COST 
193CHARGE_PRICE_ID 
194CHARGE_COST_PRICE_ID 
195SMPP_PDU_HEADER 
196SMPP_PDU_BODY 
197MORE_MESSAGES 
198SMPP_DLR_TEXT 
199CUSTOM_OPTION 
200LICENSEDATA 
201CHARGE_RESELLER 
202CHARGE_RESELLER_PRICE_ID 
203SMPP_USSD_SERVICE_OP 
204MAXQUEUESIZE 
205MAXQUEUESIZE_SOFT 
206MCC 
207MNC 
208MSC 
209UCP_LRQ 
210ORIGINAL_UDH 
211ORIGINAL_DCS 
212MESSAGE_NOT_PERSISTED 
213ROUTESAT 
214GROUPNew in EMG 7.2. Used by connector groups.
215DLR_MCCNew in EMG 7.2.
216DLR_MNCNew in EMG 7.2.
217PART_IDUsed by MERGE_IN.
218REMOTEIP_OUTNew in EMG 7.2. Used by DLR_TO_SAME_IP.
219HTTP_HEADERSThe values for this option, settable from plugins. are added to the HTTP headers for outgoing traffic.
Introduced in EMG 7.2.5.
220REMOTEPORTAutomatically set on incoming messages in the same way as REMOTEIP (38).
Introduced in EMG 7.2.5.

Additional notes

User Data Header (UDH)

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).