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
| Value | Option | Description |
|---|---|---|
| 1 | ID | EMG message id |
| 2 | SOURCEADDR | Source address |
| 3 | SOURCEADDRTON | Source address TON (Type Of Number) |
| 4 | SOURCEADDRNPI | Source address NPI (Number Plan Indicator) |
| 5 | SOURCESUBADDRESS | |
| 6 | SOURCEPORT | |
| 8 | DESTADDR | Destination address |
| 9 | DESTADDRTON | Destination address TON (Type Of Number) |
| 10 | DESTADDRNPI | Destination address NPI (Number Plan Indicator) |
| 11 | DESTSUBADDRESS | |
| 12 | DESTPORT | |
| 14 | UDH | User Data Header |
| 15 | UDHLEN | Length of User Data Header |
| 16 | MESSAGE | Message body |
| 17 | MESSAGELEN | Length of message body |
| 18 | VP | |
| 19 | DLR | Indicates 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. |
| 20 | DELTIME | |
| 21 | SCTS | |
| 22 | USERNAME | Username for the user that submitted the message to EMG. |
| 23 | PASSWORD | |
| 24 | NEWPASSWORD | |
| 25 | MSGTYPE | 1 – Normal message 5 – Delivery report (DLR) |
| 26 | MSGSUBTYPE | |
| 27 | MSGCLASS | |
| 28 | CHARCODE | 0 – Default 1 – GSM-7 / IA5 2 – 8-bit binary 3 – Latin-1 4 – UCS2 32 – UTF-8 |
| 29 | AUTHCODE | |
| 30 | USER | |
| 31 | REPLYPATH | |
| 32 | PRIORITY | |
| 33 | TARIFFCLASS | |
| 34 | REMOTEIP | IP address of client |
| 35 | SYSTEMTYPE | |
| 36 | SMSCOP | |
| 38 | ROUTE | A “hard” route for the message. |
| 39 | ROUTEDLR | The route for subsequent delivery reports for the message. |
| 40 | RETCODE | |
| 41 | SERVICETYPE | |
| 42 | MESSAGEMODE | |
| 43 | PROTOCOLID | |
| 46 | USERRESPONSECODE | |
| 52 | MESSAGESTATE | |
| 54 | LONGMESSAGE | |
| 55 | LONGMODE | |
| 57 | CANCELMODE | |
| 58 | INTERFACEVERSION | |
| 59 | CONNECTOR | Receiving connector |
| 60 | OUTCONNECTOR | Sending connector |
| 61 | STATUS | Message status 1 – Delivered 2 – In process 3 – Failed 4 – Deleted 5 – Expired 6 – Rejected 7 – Canceled 8 – Queued 9 – Orphaned 10 – Relayed 11 – Unknown |
| 62 | SOURCENETWORKTYPE | |
| 64 | SMSCID | Message id from remote end. |
| 65 | OPSENTEXPIRES | |
| 66 | DLREXPIRES | |
| 68 | TCPSOURCEPORT | |
| 69 | MAPPING | |
| 70 | DLRADDRESS | |
| 71 | DLRPID | |
| 72 | DOMAIN | |
| 73 | CONCATSMSREF | |
| 74 | CONCATSMSSEQ | |
| 75 | CONCATSMSMAX | |
| 76 | REQUIREPREFIX | |
| 77 | AUTHTON | |
| 78 | AUTHNPI | |
| 79 | BILLINGID | |
| 80 | SINGLESHOT | |
| 81 | DLRID | |
| 82 | CONNECTORNAME | |
| 83 | STATE | |
| 84 | PROTOCOL | |
| 85 | INSTANCES | |
| 86 | QUEUESIZE | |
| 87 | TYPE | |
| 88 | QSTATS1 | |
| 89 | QSTATS5 | |
| 90 | QSTATS15 | |
| 91 | INSTANCE | |
| 93 | STARTSECS | Time when message received by EMG in seconds since epoch. |
| 94 | STARTMSECS | Milliseconds part of time when message received by EMG. |
| 95 | ENDSECS | Time when message sent by EMG in seconds since epoch. |
| 96 | ENDMSECS | Milliseconds part of time when message sent by EMG. |
| 97 | NOTE | |
| 98 | CLIENTCONFIG | |
| 99 | COMPANY | |
| 100 | NAME | |
| 101 | PBNAME | |
| 102 | PBTYPE | |
| 103 | REASON | |
| 104 | PBID | |
| 105 | ISADMIN | |
| 106 | UDHI | |
| 107 | REPLACEPID | |
| 108 | LRADDR | |
| 109 | LRPID | |
| 110 | HPLMNADDR | |
| 111 | SUBJECT | |
| 113 | DCS | |
| 115 | HEADER | |
| 116 | KEYWORD | |
| 117 | REMOVEPREFIX | |
| 118 | QPRIORITY | EMG queue priority (1-5). A lower value means a higher priority. |
| 119 | XUSERNAME | Username for receiving user, used for MO routing to specific client. |
| 120 | MAXINSTANCES | |
| 121 | AVGINSTANCES1 | |
| 123 | MODE | |
| 124 | DBSQL | |
| 125 | DBNAME | |
| 126 | DBDATA | |
| 127 | CREDITS | |
| 128 | SOURCEADDRTYPE | |
| 129 | DESTADDRTYPE | |
| 130 | REQUIREPREFIX_SOURCEADDR | |
| 131 | REMOVEPREFIX_SOURCEADDR | |
| 132 | PDUSEQ | |
| 133 | PDUSEQMAX | |
| 134 | ORIGSOURCEADDR | |
| 135 | ORIGDESTADDR | |
| 136 | SERVICEDESCRIPTION | |
| 137 | SENDERTS | |
| 138 | IMSI | |
| 139 | VLR | |
| 140 | ORIGID | |
| 141 | SERVICEID | |
| 142 | ACLENTRYWHOID | |
| 143 | ACLENTRYWHEREID | |
| 144 | PLUGINARG | |
| 145 | MMSDESTADDR | |
| 146 | MSISDN | |
| 147 | XPRIORITY | |
| 148 | TCPSOURCEIP | |
| 149 | SENDERADDRESS | |
| 150 | ORIGIN | |
| 151 | SUBMITTS | |
| 152 | DONETS | |
| 153 | MESSAGEID | |
| 154 | INREPLYTO | |
| 155 | REFERENCES | |
| 156 | QUOTEDREPLY | |
| 157 | QUOTEDREPLY_SEPARATOR | |
| 158 | SERVICETYPEIN | |
| 159 | SOURCEFULLNAME | |
| 160 | CONTENTTYPE | |
| 161 | CONTENTLOCATION | |
| 162 | DESTFULLNAME | |
| 163 | MESSAGEIDIN | |
| 164 | ARCORMOD | |
| 165 | ARCORFUNC | |
| 166 | ARCORUNIT | |
| 167 | SCAADDR | |
| 168 | SCAADDRTON | |
| 169 | SCAADDRNPI | |
| 170 | REASONTEXT | |
| 171 | ITSSESSIONINFO | |
| 172 | LASTDLRSECS | |
| 173 | LASTDLRMSECS | |
| 174 | SMTP_RET | |
| 175 | INSTANCES_INUSE | |
| 176 | DESTNETWORK | |
| 177 | TARIFFNAME | |
| 178 | SMPPOPTION | SMPP 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. |
| 179 | BUFFEREDSTATUS | |
| 180 | WAPAPPLICATION | |
| 181 | XSER_EXTRA | |
| 182 | MMS_RELAY_SERVER_ID | |
| 183 | DLR_IN | |
| 184 | DLR_OUT | |
| 185 | OPERATOR | |
| 186 | MESSAGE_ERROR | |
| 187 | NETWORK_ERROR | |
| 188 | AUROUTE | |
| 189 | AUROUTELIST | |
| 190 | PROXY | |
| 191 | CHARGE | |
| 192 | CHARGE_COST | |
| 193 | CHARGE_PRICE_ID | |
| 194 | CHARGE_COST_PRICE_ID | |
| 195 | SMPP_PDU_HEADER | |
| 196 | SMPP_PDU_BODY | |
| 197 | MORE_MESSAGES | |
| 198 | SMPP_DLR_TEXT | |
| 199 | CUSTOM_OPTION | |
| 200 | LICENSEDATA | |
| 201 | CHARGE_RESELLER | |
| 202 | CHARGE_RESELLER_PRICE_ID | |
| 203 | SMPP_USSD_SERVICE_OP | |
| 204 | MAXQUEUESIZE | |
| 205 | MAXQUEUESIZE_SOFT | |
| 206 | MCC | |
| 207 | MNC | |
| 208 | MSC | |
| 209 | UCP_LRQ | |
| 210 | ORIGINAL_UDH | |
| 211 | ORIGINAL_DCS | |
| 212 | MESSAGE_NOT_PERSISTED | |
| 213 | ROUTESAT | |
| 214 | GROUP | New in EMG 7.2. Used by connector groups. |
| 215 | DLR_MCC | New in EMG 7.2. |
| 216 | DLR_MNC | New in EMG 7.2. |
| 217 | PART_ID | Used by MERGE_IN. |
| 218 | REMOTEIP_OUT | New in EMG 7.2. Used by DLR_TO_SAME_IP. |
| 219 | HTTP_HEADERS | The values for this option, settable from plugins. are added to the HTTP headers for outgoing traffic. Introduced in EMG 7.2.5. |
| 220 | REMOTEPORT | Automatically 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).