XML MO Metadata

Modified on Mon, 06 Mar 2017 15:05 by Torbjørn Marø — Categorized as: Gateway, XML API

The METADATA element is a key-value collection of extra data that is useful in many cases. The key-value sets are identified as DATA elements. The following key-value sets are currently being sent:

Key Format Description
TIMESTAMP DateTime: YYYY-MM-DD hh:mm:ss The time when the message was received from the operator by the gateway, given in CET time
REFERENCE String A uniquely identifying reference for the MO, use this to identify wether or not you have handeled this MO already and are receiving it because the gateway are retrying it because it was not able to verify that you have received it earlier

Example MO request containing METADATA

Content-Type: application/xml
PSW-Message-Type: MO
PSW-Message-version: 3
PSW-Message-Reference: 12345678-1337-1234-1234-123456789ABC
  
<?xml version="1.0"?>
<MSGLST>
  <MSG>
    <ID>1</ID>
    <TEXT>Some text</TEXT>
    <SND>4712345678</SND>
    <RCV>26112</RCV>
    <METADATA>
      <DATA KEY="TIMESTAMP" VALUE="2013-03-07 13:37:00"></DATA>
      <DATA KEY="REFERENCE" VALUE="12345678-1337-1234-1234-123456789ABC"></DATA>
    </METADATA>
  </MSG>
</MSGLST>

Additional HTTP Headers

Please note the extra HTTP Headers in the exampe above. They are present to allow you to verify what information is available in the request. PSW-Message-version 3 or above will contain a METADATA element.

Note

The XML MO metadata collection is only available for the XMLHTTP2 protocol and is not activated by default. You will need to contact support to activate it. It is however recommended that you do so, especially if the MOs are triggering charged messages.