userMessageSync
| Namespace: | (default namespace) |
| XML Schema: | ns0.xsd |
Message Synchronization Object Used to synchronize a message from server to device and vice versa.
XML
Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| operation (int) | 1/1 | The sync operation for this message 0 .. update 1 .. insert 2 .. delete |
| messageId (int) | 1/1 | The message id of the message The message id will be zero for new messages from the device otherwise the message id must be greater than zero. |
| deviceMessageId (int) | 1/1 | The device message id of the message The device message id will be zero for new messages from the server otherwise the device message id must be greater than zero. |
| address (string) | 0/1 | The address of the message in international format (+4367612345678), for short codes (6567) or plain text for alphanumeric sender addresses. |
| message (string) | 0/1 | The message body |
| incoming (boolean) | 0/1 | The message direction (incoming or outgoing) state |
| read (boolean) | 0/1 | The message read state |
| locked (boolean) | 0/1 | The message locked state If a message is locked, it will be not cleaned automatically. |
| origin (int) | 0/1 | The origin of the message 0 .. sim 1 .. mysms 2 .. a2a |
| status (int) | 0/1 | The status of the message 0 .. none 1 .. pending 2 .. complete 3 .. failed |
| dateSent (dateTime) | 0/1 | The date when the message was sent |
| dateStatus (dateTime) | 0/1 |
Optional date for the specific status.
completed .. the date when the message was received by the recipient sending .. the date when the message will be sent |
JSON
| property | type | description |
|---|---|---|
| operation | operation (int) | The sync operation for this message 0 .. update 1 .. insert 2 .. delete |
| messageId | messageId (int) | The message id of the message The message id will be zero for new messages from the device otherwise the message id must be greater than zero. |
| deviceMessageId | deviceMessageId (int) | The device message id of the message The device message id will be zero for new messages from the server otherwise the device message id must be greater than zero. |
| address | address (string) | The address of the message in international format (+4367612345678), for short codes (6567) or plain text for alphanumeric sender addresses. |
| message | message (string) | The message body |
| incoming | incoming (boolean) | The message direction (incoming or outgoing) state |
| read | read (boolean) | The message read state |
| locked | locked (boolean) | The message locked state If a message is locked, it will be not cleaned automatically. |
| origin | origin (int) | The origin of the message 0 .. sim 1 .. mysms 2 .. a2a |
| status | status (int) | The status of the message 0 .. none 1 .. pending 2 .. complete 3 .. failed |
| dateSent | dateSent (dateTime) | The date when the message was sent |
| dateStatus | dateStatus (dateTime) |
Optional date for the specific status.
completed .. the date when the message was received by the recipient sending .. the date when the message will be sent |