freesmartphone.org Framework DBus Interface Specification
org.freesmartphone.GSM.SMS
Description
The SMS interface is used to send and signal incoming short messages (SMS) directly, i.e. as opposed to using the SIM interface which always buffers short messages on the SIM after receiving and before sending.
Namespace
org.freesmartphone.GSM.SMS
Methods
Signals
Errors
None
Methods
Description: Calculates the number of GSM Short Messages necessary to deliver a given text.
Parameters
s: contentsThe contents of the message.
Returns
u: messagesThe number of SMS to be sent, if this message were to be delivered.
Description: Sends a text message via the GSM Short Message Service (SMS)
Text messages can be of unlimited length. They might get fragmented by the underlying transport layers though.
Parameters
s: recipient_numberThe number of the recipient.
s: contentsThe contents of the message.
b: want_reportIf true, status reports (message receipts) will be sent by the SMSC, delivered via the IncomingMessageReceipt signal.
Returns
i: transaction_indexThe given transaction index for this message. This is the message-reference number of this message.
s: timestampThe timestamp this message was received by the SMSC.
Description: Sends a message via the GSM Short Message Service (SMS)
This maps to the GSM 07.05 command +CMGS=..., see 3GPP TS 07.05 Chapter 3.5.1 (text mode) and 4.3 (pdu mode).
Parameters
s: recipient_numberThe number of the recipient.
s: contentsThe contents of the message.
a{sv}: propertiesAdditional properties of the message. Valid properties are:
- (string:alphabet) = Encoding of the short message, must be one of "gsm_default", "usc2" or "binary"
- (bool:reject-duplicates) = If true the SMSC shall reject messages with the same message-reference as this one (default false)
- (bool:reply-path) = If true requests a reply path, see 3GPP TS 03.40 Annex D for more information.
- (bool:status-report-request) = If true the SMSC will send us reports about the status of our message. These can be received via the IncomingMessageReceipt signal.
- (int:message-reference) = Message reference number with which the message can be identified.
- (int:pid) = Numerical representation of the protocol identifier
- (int:message-class) = Numerical representation of the message class
- (a(int):data) = If alphabet is "binary" the userdata is stored in this field
- Properties for concatenated short messages (CSM):
- (int:csm_id) = Id of the csm (messages belonging to the same csm must have the same id),
- (int:csm_num) = Total number of messages in this csm,
- (int:csm_seq) = Number defining the order of the messages in the csm.
- Properties for port addressing (similar to UDP ports):
- (int:src_port) = Source port this short message comes from,
- (int:dst_port) = Destination port this short message should be routed to,
- (int:port_size) = Either 8 for 8-bit or 16 for 16-bit port addressing.
- Properties for message indication:
(int:message-indication-type) = Type of messages that are waiting, (int:message-indication-count) = Number of messages that are waiting. Returns
i: transaction_indexThe given transaction index for this message. This is the message-reference number of this message.
s: timestampThe timestamp this message was received by the SMSC.
Description: Acknowledges the receipt of a message via the GSM Short Message Service (SMS). Every message that has been delivered with the IncomingMessage signal needs to be either acked or nacked.
This maps to the GSM 07.05 command +CNMA=..., see 3GPP TS 07.05 Chapter 3.4.4 (text mode) and 4.6 (pdu mode).
Parameters
s: contentsOptional text to send along with the acknowledgement. Will usually be empty.
a{sv}: propertiesAdditional properties of the message. Valid properties are:
- (string:alphabet) = Encoding of the short message, must be one of "gsm_default", "usc2" or "binary"
- (int:pid) = Numerical representation of the protocol identifier
- (int:message-class) = Numerical representation of the message class
- (a(int):data) = If alphabet is "binary" the userdata is stored in this field
- Properties for concatenated short messages (CSM):
- (int:csm_id) = Id of the csm (messages belonging to the same csm must have the same id),
- (int:csm_num) = Total number of messages in this csm,
- (int:csm_seq) = Number defining the order of the messages in the csm.
- Properties for port addressing (similar to UDP ports):
- (int:src_port) = Source port this short message comes from,
- (int:dst_port) = Destination port this short message should be routed to,
- (int:port_size) = Either 8 for 8-bit or 16 for 16-bit port addressing.
- Properties for message indication:
- (int:message-indication-type) = Type of messages that are waiting,
- (int:message-indication-count) = Number of messages that are waiting.
Description: Reports that an error has occured during the receipt of a message via the GSM Short Message Service (SMS). Every message that has been delivered with the IncomingMessage signal needs to be either acked or nacked.
This maps to the GSM 07.05 command +CNMA=..., see 3GPP TS 07.05 Chapter 3.4.4 (text mode) and 4.6 (pdu mode).
Parameters
s: contentsOptional text to send along with the negative acknowledgement. Will usually be empty.
a{sv}: propertiesAdditional properties of the message. Valid properties are:
- (int:fcs) = Integer representation of the failure cause. If unset it will be 0xff (unspecified error).
- (string:alphabet) = Encoding of the short message, must be one of "gsm_default", "usc2" or "binary"
- (int:pid) = Numerical representation of the protocol identifier
- (int:message-class) = Numerical representation of the message class
- (a(int):data) = If alphabet is "binary" the userdata is stored in this field
- Properties for concatenated short messages (CSM):
- (int:csm_id) = Id of the csm (messages belonging to the same csm must have the same id),
- (int:csm_num) = Total number of messages in this csm,
- (int:csm_seq) = Number defining the order of the messages in the csm.
- Properties for port addressing (similar to UDP ports):
- (int:src_port) = Source port this short message comes from,
- (int:dst_port) = Destination port this short message should be routed to,
- (int:port_size) = Either 8 for 8-bit or 16 for 16-bit port addressing.
- Properties for message indication:
- (int:message-indication-type) = Type of messages that are waiting,
- (int:message-indication-count) = Number of messages that are waiting.
Signals
Description: Sent, when a message has been received. The receipt of a message needs to be either acked or nacked with the AckMessage or NackMessage methods.
Parameters
s: sender_numberThe number of the sender.
s: contentsThe contents of the message.
a{sv}: propertiesAdditional properties of the message. Valid properties are:
- (string:type) = Type of the message, will be "sms-deliver"
- (string:alphabet) = Encoding of the short message, must be one of "gsm_default", "usc2" or "binary"
- (bool:more-messages-to-send) = If true indicates that the SMSC will send more messages.
- (bool:reply-path) = If true indicates that a reply path has been set, see 3GPP TS 03.40 Annex D for more information.
- (bool:status-report-indicator) = If true the sender of this message has requested status reports.
- (int:pid) = Numerical representation of the protocol identifier
- (int:message-class) = Numerical representation of the message class
- (a(int):data) = If alphabet is "binary" the userdata is stored in this field
- (string:timestamp) = A timestamp indicating when the SMSC received the message.
- Properties for concatenated short messages (CSM):
- (int:csm_id) = Id of the csm (messages belonging to the same csm must have the same id),
- (int:csm_num) = Total number of messages in this csm,
- (int:csm_seq) = Number defining the order of the messages in the csm.
- Properties for port addressing (similar to UDP ports):
- (int:src_port) = Source port this short message comes from,
- (int:dst_port) = Destination port this short message should be routed to,
- (int:port_size) = Either 8 for 8-bit or 16 for 16-bit port addressing.
- Properties for message indication:
- (int:message-indication-type) = Type of messages that are waiting,
- (int:message-indication-count) = Number of messages that are waiting.
IncomingMessageReceipt ( ssa{sv} )
Description: Sent when a status report for a message has been received. Status reports for messages can be requested by setting the property "status-report-request" to True when sending messages through SendMessage
Parameters
s: sender_numberThe number of the sender.
s: contentsOptional contents of the receipt. Will usually be empty.
a{sv}: propertiesAdditional properties of the message. Valid properties are:
- (string:type) = Type of the message, will be "sms-status-report"
- (string:alphabet) = Encoding of the short message, must be one of "gsm_default", "usc2" or "binary" if present.
- (bool:more-messages-to-send) = If true indicates that the SMSC will send more messages.
- (bool:status-report-qualifier) = Indicates what triggered this status report, will be one of "sms-submit" or "sms-command".
- (int:pid) = Numerical representation of the protocol identifier
- (int:message-class) = Numerical representation of the message class
- (a(int):data) = If alphabet is "binary" the userdata is stored in this field
- (int:message-reference) = Message reference number of the message the status report is about.
- (string:timestamp) = A timestamp indicating when the SMSC received the original message.
- (string:discharge-time) = A timestamp indicating when the current status change has taken place.
- (int:status) = Integer representation of the status.
- (string:status-message) = A string conveying the meaning of the status.
- Properties for concatenated short messages (CSM):
- (int:csm_id) = Id of the csm (messages belonging to the same csm must have the same id),
- (int:csm_num) = Total number of messages in this csm,
- (int:csm_seq) = Number defining the order of the messages in the csm.
- Properties for port addressing (similar to UDP ports):
- (int:src_port) = Source port this short message comes from,
- (int:dst_port) = Destination port this short message should be routed to,
- (int:port_size) = Either 8 for 8-bit or 16 for 16-bit port addressing.
- Properties for message indication:
- (int:message-indication-type) = Type of messages that are waiting,
- (int:message-indication-count) = Number of messages that are waiting.
| Specified 2008-2009 by the Freesmartphone.org team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org