An inbound SMS received in reply to a message Kademi sent, linked back to the SmsItem that was sent out. These are created when the SMS provider reports replies, so one sent message can collect several replies over time and they are read back newest first. As well as the reply text and the sender's number the record keeps the provider's view of the original message, and any extra provider fields such as customstring and username are stored in the extraFields name and value set.

Group: Database Entities

Implements: Serializable, Relational


Properties

PropertyReturnsDescription
extraFieldsNvSetAdditional name and value pairs reported by the SMS provider alongside the reply, such as customstring and username. Null when the provider sent nothing extra.
fromPhoneStringThe phone number the reply came from, as reported by the SMS provider. This is the recipient's number, so it will not always match the number the original message was sent to.
idlongThe database-assigned unique identifier for this reply.
messageStringThe text of the reply, truncated to 1000 characters.
originalMessageStringThe text of the message that was replied to, as the SMS provider reported it. Kept alongside the reply so the conversation reads correctly even if the sent record changes.
originalMessageIdStringThe SMS provider's identifier for the message that was replied to. Use this to match a reply up with the provider's own reporting.
originalSenderIdStringThe sender id the original message was sent from, ie the from number or alphanumeric sender name shown on the recipient's handset.
receivedDateDateWhen Kademi recorded the reply. This is the time the reply was processed, not the time the handset sent it. Replies are listed newest first by this value.
smsItemSmsItemThe sent message this is a reply to. Always set, so a reply is always attributable to an outbound SMS.

Methods

getId() · getSmsItem() · getReceivedDate() · getFromPhone() · getMessage() · getOriginalMessage() · getOriginalMessageId() · getOriginalSenderId() · getExtraFields() · rowId()

getId()

Returns: long

The database-assigned unique identifier for this reply.

getSmsItem()

Returns: SmsItem

The sent message this is a reply to. Always set, so a reply is always attributable to an outbound SMS.

getReceivedDate()

Returns: Date

When Kademi recorded the reply. This is the time the reply was processed, not the time the handset sent it. Replies are listed newest first by this value.

getFromPhone()

Returns: String

The phone number the reply came from, as reported by the SMS provider. This is the recipient's number, so it will not always match the number the original message was sent to.

getMessage()

Returns: String

The text of the reply, truncated to 1000 characters.

getOriginalMessage()

Returns: String

The text of the message that was replied to, as the SMS provider reported it. Kept alongside the reply so the conversation reads correctly even if the sent record changes.

getOriginalMessageId()

Returns: String

The SMS provider's identifier for the message that was replied to. Use this to match a reply up with the provider's own reporting.

getOriginalSenderId()

Returns: String

The sender id the original message was sent from, ie the from number or alphanumeric sender name shown on the recipient's handset.

getExtraFields()

Returns: NvSet

Additional name and value pairs reported by the SMS provider alongside the reply, such as customstring and username. Null when the provider sent nothing extra.

rowId()

Returns: Long

The database identifier for this reply, as the generic row id used across Kademi entities. Same value as the id.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.