/messagedb/load
<base-url>/messagedb/load.[xml|json]
Example: https://127.0.0.1:7000/messagedb/load.json
Use this URL to load a single message or multiple messages from the server.
The following arguments are available:
| Property | Type | Description |
| TypeID | String | Only load messages of this type. (e.g: SMS, EMAIL, FILE, etc.). Leave empty to load messages of any type. |
| Filter | String | Only load messages that match the given filter. The filter should be a T-SQL expression. |
| Order | String | Load messages in the given order. The order should be a T-SQL expression. |
| Top | Integer | Specify the maximum number of messages to load. |
| IgnoreAttachments | Boolean | Specify this as true or 1 to load without any attachments. |
| ReadUncommitted | Boolean | Specify this as true or 1 to load from the message database without locking the database. This boosts performance but may return uncommitted data. |
| FromArchive | Boolean | Specify this as true or 1 to load from the archive database instead of the message database. |
Post body
In this example we are loading the last 3 messages that were received.
{
"Filter": "StatusID = 'RECEIVED'"
, "Order": "ID DESC"
, "Top": 3
, "ReadUncommitted": true
, "IgnoreAttachments": true
}<load>
<Filter>StatusID='RECEIVED'</Filter>
<Order>ID DESC</Order>
<Top>3</Top>
<ReadUncommitted>true</ReadUncommitted>
<IgnoreAttachments>true</IgnoreAttachments>
</load>
Response body
{
"message":[
{
"ID":95585,
"TypeID":"SMS",
"DirectionID":"IN",
"StatusID":"RECEIVED",
"StatusDetailsID":0,
"TriggerStatusID":"NOMATCH",
"TriggerDetailsID":0,
"AckStatusID":"",
"ChannelID":"HTTP_SMS1",
"BillingID":"",
"ScheduledTime":"\/Date(1630589624000)\/",
"SentTime":"\/Date(-2209161600000)\/",
"ReceivedTime":"\/Date(1630589664000)\/",
"LastUpdate":"\/Date(1630589664000)\/",
"Priority":0,
"BatchID":0,
"ConversationID":0,
"Hash":"",
"Creator":"",
"Archive":false,
"CustomField1":0,
"CustomField2":"",
"Trace":"[1630589664 09/02/2021 03:34:24 PM]: Message processed (no scripts executed; none of the trigger conditions matched)\r\n[1630589664 09/02/2021 03:34:24 PM]: Copy of message id: [95584]\r\n[1630589664 09/02/2021 03:34:24 PM]: New message created in database",
"Retries":0,
"ToAddressTon":0,
"ToAddressNpi":0,
"FromAddressTon":0,
"FromAddressNpi":0,
"RequestDeliveryReport":false,
"IsDeliveryReport":false,
"DataCoding":0,
"BodyFormat":0,
"HasUdh":false,
"TotalParts":1,
"PartNumber":1,
"GsmSmscAddressTon":0,
"GsmSmscAddressNpi":0,
"SmppSequenceNumber":null,
"ToAddress":"+31612345678",
"SmppStatusCode":null,
"Reference":"",
"ValidityPeriod":0,
"FromAddress":"+31651900915",
"Body":"Receiving a couple of messages",
"DeliveryStatus":"",
"SmppClient":null,
"LanguageSingleShift":0,
"LanguageLockingShift":0,
"SmppPriority":null,
"GsmSmscAddress":null,
"SmppServiceType":null,
"MultipartReference":null,
"SmppTlvs":null
},
{
"ID":95584,
"TypeID":"SMS",
"DirectionID":"IN",
"StatusID":"RECEIVED",
"StatusDetailsID":0,
"TriggerStatusID":"NOMATCH",
"TriggerDetailsID":0,
"AckStatusID":"",
"ChannelID":"HTTP_SMS1",
"BillingID":"",
"ScheduledTime":"\/Date(1630589624000)\/",
"SentTime":"\/Date(-2209161600000)\/",
"ReceivedTime":"\/Date(1630589664000)\/",
"LastUpdate":"\/Date(1630589664000)\/",
"Priority":0,
"BatchID":0,
"ConversationID":0,
"Hash":"",
"Creator":"",
"Archive":false,
"CustomField1":0,
"CustomField2":"",
"Trace":"[1630589664 09/02/2021 03:34:24 PM]: Message processed (no scripts executed; none of the trigger conditions matched)\r\n[1630589664 09/02/2021 03:34:24 PM]: Copy of message id: [95583]\r\n[1630589664 09/02/2021 03:34:24 PM]: New message created in database",
"Retries":0,
"ToAddressTon":0,
"ToAddressNpi":0,
"FromAddressTon":0,
"FromAddressNpi":0,
"RequestDeliveryReport":false,
"IsDeliveryReport":false,
"DataCoding":0,
"BodyFormat":0,
"HasUdh":false,
"TotalParts":1,
"PartNumber":1,
"GsmSmscAddressTon":0,
"GsmSmscAddressNpi":0,
"SmppSequenceNumber":null,
"ToAddress":"+31612345678",
"SmppStatusCode":null,
"Reference":"",
"ValidityPeriod":0,
"FromAddress":"+31651900915",
"Body":"Receiving a couple of messages",
"DeliveryStatus":"",
"SmppClient":null,
"LanguageSingleShift":0,
"LanguageLockingShift":0,
"SmppPriority":null,
"GsmSmscAddress":null,
"SmppServiceType":null,
"MultipartReference":null,
"SmppTlvs":null
},
{
"ID":95583,
"TypeID":"SMS",
"DirectionID":"IN",
"StatusID":"RECEIVED",
"StatusDetailsID":0,
"TriggerStatusID":"NOMATCH",
"TriggerDetailsID":0,
"AckStatusID":"",
"ChannelID":"HTTP_SMS1",
"BillingID":"",
"ScheduledTime":"\/Date(1630589624000)\/",
"SentTime":"\/Date(-2209161600000)\/",
"ReceivedTime":"\/Date(1630589664000)\/",
"LastUpdate":"\/Date(1630589664000)\/",
"Priority":0,
"BatchID":0,
"ConversationID":0,
"Hash":"",
"Creator":"",
"Archive":false,
"CustomField1":0,
"CustomField2":"",
"Trace":"[1630589664 09/02/2021 03:34:24 PM]: Message processed (no scripts executed; none of the trigger conditions matched)\r\n[1630589664 09/02/2021 03:34:24 PM]: Copy of message id: [95582]\r\n[1630589664 09/02/2021 03:34:24 PM]: New message created in database",
"Retries":0,
"ToAddressTon":0,
"ToAddressNpi":0,
"FromAddressTon":0,
"FromAddressNpi":0,
"RequestDeliveryReport":false,
"IsDeliveryReport":false,
"DataCoding":0,
"BodyFormat":0,
"HasUdh":false,
"TotalParts":1,
"PartNumber":1,
"GsmSmscAddressTon":0,
"GsmSmscAddressNpi":0,
"SmppSequenceNumber":null,
"ToAddress":"+31612345678",
"SmppStatusCode":null,
"Reference":"",
"ValidityPeriod":0,
"FromAddress":"+31651900915",
"Body":"Receiving a couple of messages",
"DeliveryStatus":"",
"SmppClient":null,
"LanguageSingleShift":0,
"LanguageLockingShift":0,
"SmppPriority":null,
"GsmSmscAddress":null,
"SmppServiceType":null,
"MultipartReference":null,
"SmppTlvs":null
}
]
}<messages>
<message>
<ID>95585</ID>
<TypeID><![CDATA[SMS]]></TypeID>
<DirectionID><![CDATA[IN]]></DirectionID>
<StatusID><![CDATA[RECEIVED]]></StatusID>
<StatusDetailsID>0</StatusDetailsID>
<TriggerStatusID><![CDATA[NOMATCH]]></TriggerStatusID>
<TriggerDetailsID>0</TriggerDetailsID>
<AckStatusID><![CDATA[]]></AckStatusID>
<ChannelID><![CDATA[HTTP_SMS1]]></ChannelID>
<BillingID><![CDATA[]]></BillingID>
<ScheduledTime>9/2/2021 3:33:44 PM</ScheduledTime>
<SentTime>12/30/1899 1:00:00 AM</SentTime>
<ReceivedTime>9/2/2021 3:34:24 PM</ReceivedTime>
<LastUpdate>9/2/2021 3:34:24 PM</LastUpdate>
<Priority>0</Priority>
<BatchID>0</BatchID>
<ConversationID>0</ConversationID>
<Hash><![CDATA[]]></Hash>
<Creator><![CDATA[]]></Creator>
<Archive>False</Archive>
<CustomField1>0</CustomField1>
<CustomField2><![CDATA[]]></CustomField2>
<Trace><![CDATA[[1630589664 09/02/2021 03:34:24 PM]: Message processed (no scripts executed; none of the trigger conditions matched)
[1630589664 09/02/2021 03:34:24 PM]: Copy of message id: [95584]
[1630589664 09/02/2021 03:34:24 PM]: New message created in database]]></Trace>
<Retries>0</Retries>
<ToAddressTon>0</ToAddressTon>
<ToAddressNpi>0</ToAddressNpi>
<FromAddressTon>0</FromAddressTon>
<FromAddressNpi>0</FromAddressNpi>
<RequestDeliveryReport>False</RequestDeliveryReport>
<IsDeliveryReport>False</IsDeliveryReport>
<DataCoding>0</DataCoding>
<BodyFormat>0</BodyFormat>
<HasUdh>False</HasUdh>
<TotalParts>1</TotalParts>
<PartNumber>1</PartNumber>
<GsmSmscAddressTon>0</GsmSmscAddressTon>
<GsmSmscAddressNpi>0</GsmSmscAddressNpi>
<SmppSequenceNumber></SmppSequenceNumber>
<ToAddress><![CDATA[+31612345678]]></ToAddress>
<SmppStatusCode></SmppStatusCode>
<Reference><![CDATA[]]></Reference>
<ValidityPeriod>0</ValidityPeriod>
<FromAddress><![CDATA[+31651900915]]></FromAddress>
<Body><![CDATA[Receiving a couple of messages]]></Body>
<DeliveryStatus><![CDATA[]]></DeliveryStatus>
<SmppClient></SmppClient>
<LanguageSingleShift>0</LanguageSingleShift>
<LanguageLockingShift>0</LanguageLockingShift>
<SmppPriority></SmppPriority>
<GsmSmscAddress></GsmSmscAddress>
<SmppServiceType></SmppServiceType>
<MultipartReference></MultipartReference>
<SmppTlvs></SmppTlvs>
</message>
<message>
<ID>95584</ID>
<TypeID><![CDATA[SMS]]></TypeID>
<DirectionID><![CDATA[IN]]></DirectionID>
<StatusID><![CDATA[RECEIVED]]></StatusID>
<StatusDetailsID>0</StatusDetailsID>
<TriggerStatusID><![CDATA[NOMATCH]]></TriggerStatusID>
<TriggerDetailsID>0</TriggerDetailsID>
<AckStatusID><![CDATA[]]></AckStatusID>
<ChannelID><![CDATA[HTTP_SMS1]]></ChannelID>
<BillingID><![CDATA[]]></BillingID>
<ScheduledTime>9/2/2021 3:33:44 PM</ScheduledTime>
<SentTime>12/30/1899 1:00:00 AM</SentTime>
<ReceivedTime>9/2/2021 3:34:24 PM</ReceivedTime>
<LastUpdate>9/2/2021 3:34:24 PM</LastUpdate>
<Priority>0</Priority>
<BatchID>0</BatchID>
<ConversationID>0</ConversationID>
<Hash><![CDATA[]]></Hash>
<Creator><![CDATA[]]></Creator>
<Archive>False</Archive>
<CustomField1>0</CustomField1>
<CustomField2><![CDATA[]]></CustomField2>
<Trace><![CDATA[[1630589664 09/02/2021 03:34:24 PM]: Message processed (no scripts executed; none of the trigger conditions matched)
[1630589664 09/02/2021 03:34:24 PM]: Copy of message id: [95583]
[1630589664 09/02/2021 03:34:24 PM]: New message created in database]]></Trace>
<Retries>0</Retries>
<ToAddressTon>0</ToAddressTon>
<ToAddressNpi>0</ToAddressNpi>
<FromAddressTon>0</FromAddressTon>
<FromAddressNpi>0</FromAddressNpi>
<RequestDeliveryReport>False</RequestDeliveryReport>
<IsDeliveryReport>False</IsDeliveryReport>
<DataCoding>0</DataCoding>
<BodyFormat>0</BodyFormat>
<HasUdh>False</HasUdh>
<TotalParts>1</TotalParts>
<PartNumber>1</PartNumber>
<GsmSmscAddressTon>0</GsmSmscAddressTon>
<GsmSmscAddressNpi>0</GsmSmscAddressNpi>
<SmppSequenceNumber></SmppSequenceNumber>
<ToAddress><![CDATA[+31612345678]]></ToAddress>
<SmppStatusCode></SmppStatusCode>
<Reference><![CDATA[]]></Reference>
<ValidityPeriod>0</ValidityPeriod>
<FromAddress><![CDATA[+31651900915]]></FromAddress>
<Body><![CDATA[Receiving a couple of messages]]></Body>
<DeliveryStatus><![CDATA[]]></DeliveryStatus>
<SmppClient></SmppClient>
<LanguageSingleShift>0</LanguageSingleShift>
<LanguageLockingShift>0</LanguageLockingShift>
<SmppPriority></SmppPriority>
<GsmSmscAddress></GsmSmscAddress>
<SmppServiceType></SmppServiceType>
<MultipartReference></MultipartReference>
<SmppTlvs></SmppTlvs>
</message>
<message>
<ID>95583</ID>
<TypeID><![CDATA[SMS]]></TypeID>
<DirectionID><![CDATA[IN]]></DirectionID>
<StatusID><![CDATA[RECEIVED]]></StatusID>
<StatusDetailsID>0</StatusDetailsID>
<TriggerStatusID><![CDATA[NOMATCH]]></TriggerStatusID>
<TriggerDetailsID>0</TriggerDetailsID>
<AckStatusID><![CDATA[]]></AckStatusID>
<ChannelID><![CDATA[HTTP_SMS1]]></ChannelID>
<BillingID><![CDATA[]]></BillingID>
<ScheduledTime>9/2/2021 3:33:44 PM</ScheduledTime>
<SentTime>12/30/1899 1:00:00 AM</SentTime>
<ReceivedTime>9/2/2021 3:34:24 PM</ReceivedTime>
<LastUpdate>9/2/2021 3:34:24 PM</LastUpdate>
<Priority>0</Priority>
<BatchID>0</BatchID>
<ConversationID>0</ConversationID>
<Hash><![CDATA[]]></Hash>
<Creator><![CDATA[]]></Creator>
<Archive>False</Archive>
<CustomField1>0</CustomField1>
<CustomField2><![CDATA[]]></CustomField2>
<Trace><![CDATA[[1630589664 09/02/2021 03:34:24 PM]: Message processed (no scripts executed; none of the trigger conditions matched)
[1630589664 09/02/2021 03:34:24 PM]: Copy of message id: [95582]
[1630589664 09/02/2021 03:34:24 PM]: New message created in database]]></Trace>
<Retries>0</Retries>
<ToAddressTon>0</ToAddressTon>
<ToAddressNpi>0</ToAddressNpi>
<FromAddressTon>0</FromAddressTon>
<FromAddressNpi>0</FromAddressNpi>
<RequestDeliveryReport>False</RequestDeliveryReport>
<IsDeliveryReport>False</IsDeliveryReport>
<DataCoding>0</DataCoding>
<BodyFormat>0</BodyFormat>
<HasUdh>False</HasUdh>
<TotalParts>1</TotalParts>
<PartNumber>1</PartNumber>
<GsmSmscAddressTon>0</GsmSmscAddressTon>
<GsmSmscAddressNpi>0</GsmSmscAddressNpi>
<SmppSequenceNumber></SmppSequenceNumber>
<ToAddress><![CDATA[+31612345678]]></ToAddress>
<SmppStatusCode></SmppStatusCode>
<Reference><![CDATA[]]></Reference>
<ValidityPeriod>0</ValidityPeriod>
<FromAddress><![CDATA[+31651900915]]></FromAddress>
<Body><![CDATA[Receiving a couple of messages]]></Body>
<DeliveryStatus><![CDATA[]]></DeliveryStatus>
<SmppClient></SmppClient>
<LanguageSingleShift>0</LanguageSingleShift>
<LanguageLockingShift>0</LanguageLockingShift>
<SmppPriority></SmppPriority>
<GsmSmscAddress></GsmSmscAddress>
<SmppServiceType></SmppServiceType>
<MultipartReference></MultipartReference>
<SmppTlvs></SmppTlvs>
</message>
</messages>