def submit_sm(self,
vumi_message_id,
destination_addr,
source_addr='',
esm_class=0,
protocol_id=0,
priority_flag=0,
schedule_delivery_time='',
validity_period='',
replace_if_present=0,
data_coding=0,
sm_default_msg_id=0,
sm_length=0,
short_message='',
optional_parameters=None,
**configured_parameters):
"""
Put a `submit_sm` command on the wire.
:param str source_addr:
Address of SME which originated this message.
If unknown leave blank.
:param str destination_addr:
Destination address of this short message.
For mobile terminated messages, this is the directory number
of the recipient MS.
:param str service_type:
The service_type parameter can be used to indicate the SMS
Application service associated with the message.
If unknown leave blank.
:param int source_addr_ton:
Type of Number for source address.
:param int source_addr_npi:
Numbering Plan Indicator for source address.
:param int dest_addr_ton:
Type of Number for destination.
:param int dest_addr_npi:
Numbering Plan Indicator for destination.
:param int esm_class:
Indicates Message Mode & Message Type.
:param int protocol_id:
Protocol Identifier. Network specific field.
:param int priority_flag:
Designates the priority level of the message.
:param str schedule_delivery_time:
The short message is to be scheduled by the SMSC for delivery.
Leave blank for immediate delivery.
:param str validity_period:
The validity period of this message.
Leave blank for SMSC default.
:param int registered_delivery:
Indicator to signify if an SMSC delivery receipt or an SME
acknowledgement is required.
:param int replace_if_present:
Flag indicating if submitted message should replace an
existing message.
:param int data_coding:
Defines the encoding scheme of the short message user data.
:param int sm_default_msg_id:
Indicates the short message to send from a list of pre- defined
('canned') short messages stored on the SMSC.
Leave blank if not using an SMSC canned message.
:param int sm_length:
Length in octets of the short_message user data.
This is automatically calculated and set during PDU encoding,
no need to specify.
:param int short_message:
Up to 254 octets of short message user data.
The exact physical limit for short_message size may vary
according to the underlying network.
Applications which need to send messages longer than 254
octets should use the message_payload parameter. In this
case the sm_length field should be set to zero.
:param dict optional_parameters:
keys and values to be embedded in the PDU as tag-length-values.
Refer to the SMPP specification and your SMSCs instructions
on what valid and suitable keys and values are.
:returns: list of 1 sequence number (int) for consistency with other
submit_sm calls.
:rtype: list
"""
configured_param_values = {
'service_type': self.config.service_type,
'source_addr_ton': self.config.source_addr_ton,
'source_addr_npi': self.config.source_addr_npi,
'dest_addr_ton': self.config.dest_addr_ton,
'dest_addr_npi': self.config.dest_addr_npi,
'registered_delivery': self.config.registered_delivery,
}
configured_param_values.update(configured_parameters)
sequence_number = yield self.sequence_generator.next()
pdu = SubmitSM(sequence_number=sequence_number,
source_addr=source_addr,
destination_addr=destination_addr,
esm_class=esm_class,
protocol_id=protocol_id,
priority_flag=priority_flag,
schedule_delivery_time=schedule_delivery_time,
validity_period=validity_period,
replace_if_present=replace_if_present,
data_coding=data_coding,
sm_default_msg_id=sm_default_msg_id,
sm_length=sm_length,
short_message=short_message,
**configured_param_values)
if optional_parameters:
for key, value in optional_parameters.items():
pdu.add_optional_parameter(key, value)
yield self.vumi_transport.message_stash.set_sequence_number_message_id(
sequence_number, vumi_message_id)
self.send_pdu(pdu)
returnValue([sequence_number])
def submit_sm(self,
vumi_message_id,
destination_addr,
source_addr='',
esm_class=0,
protocol_id=0,
priority_flag=0,
schedule_delivery_time='',
validity_period='',
replace_if_present=0,
data_coding=0,
sm_default_msg_id=0,
sm_length=0,
short_message='',
optional_parameters=None,
**configured_parameters
):
"""
Put a `submit_sm` command on the wire.
:param str source_addr:
Address of SME which originated this message.
If unknown leave blank.
:param str destination_addr:
Destination address of this short message.
For mobile terminated messages, this is the directory number
of the recipient MS.
:param str service_type:
The service_type parameter can be used to indicate the SMS
Application service associated with the message.
If unknown leave blank.
:param int source_addr_ton:
Type of Number for source address.
:param int source_addr_npi:
Numbering Plan Indicator for source address.
:param int dest_addr_ton:
Type of Number for destination.
:param int dest_addr_npi:
Numbering Plan Indicator for destination.
:param int esm_class:
Indicates Message Mode & Message Type.
:param int protocol_id:
Protocol Identifier. Network specific field.
:param int priority_flag:
Designates the priority level of the message.
:param str schedule_delivery_time:
The short message is to be scheduled by the SMSC for delivery.
Leave blank for immediate delivery.
:param str validity_period:
The validity period of this message.
Leave blank for SMSC default.
:param int registered_delivery:
Indicator to signify if an SMSC delivery receipt or an SME
acknowledgement is required.
:param int replace_if_present:
Flag indicating if submitted message should replace an
existing message.
:param int data_coding:
Defines the encoding scheme of the short message user data.
:param int sm_default_msg_id:
Indicates the short message to send from a list of pre- defined
('canned') short messages stored on the SMSC.
Leave blank if not using an SMSC canned message.
:param int sm_length:
Length in octets of the short_message user data.
This is automatically calculated and set during PDU encoding,
no need to specify.
:param int short_message:
Up to 254 octets of short message user data.
The exact physical limit for short_message size may vary
according to the underlying network.
Applications which need to send messages longer than 254
octets should use the message_payload parameter. In this
case the sm_length field should be set to zero.
:param dict optional_parameters:
keys and values to be embedded in the PDU as tag-length-values.
Refer to the SMPP specification and your SMSCs instructions
on what valid and suitable keys and values are.
:returns: list of 1 sequence number (int) for consistency with other
submit_sm calls.
:rtype: list
"""
configured_param_values = {
'service_type': self.config.service_type,
'source_addr_ton': self.config.source_addr_ton,
'source_addr_npi': self.config.source_addr_npi,
'dest_addr_ton': self.config.dest_addr_ton,
'dest_addr_npi': self.config.dest_addr_npi,
'registered_delivery': self.config.registered_delivery,
}
configured_param_values.update(configured_parameters)
sequence_number = yield self.sequence_generator.next()
pdu = SubmitSM(
sequence_number=sequence_number,
source_addr=source_addr,
destination_addr=destination_addr,
esm_class=esm_class,
protocol_id=protocol_id,
priority_flag=priority_flag,
schedule_delivery_time=schedule_delivery_time,
validity_period=validity_period,
replace_if_present=replace_if_present,
data_coding=data_coding,
sm_default_msg_id=sm_default_msg_id,
sm_length=sm_length,
short_message=short_message,
**configured_param_values)
if optional_parameters:
for key, value in optional_parameters.items():
pdu.add_optional_parameter(key, value)
yield self.send_submit_sm(vumi_message_id, pdu)
returnValue([sequence_number])
