Implement support for voice SMS messages

Author: Peter Kubov

pymess/backend/__init__.py

@@ -25,8 +25,8 @@ class BaseController:
     def __init__(self):
         self._loaded_backends = {}
 
-    def get_backend(self, recipient):
-        backend_name = self.router.get_backend_name(recipient) or get_default_sender_backend_name(self.backend_type_name)
+    def get_backend(self, recipient, **kwargs):
+        backend_name = self.router.get_backend_name(recipient, **kwargs) or get_default_sender_backend_name(self.backend_type_name)
         if backend_name not in self._loaded_backends:
             self._loaded_backends[backend_name] = get_backend(self.backend_type_name, backend_name)
         return self._loaded_backends[backend_name]
@@ -71,7 +71,7 @@ def send(self, recipient, content, related_objects=None, tag=None, template=None
         :param message_backend: message backend instance
         :param kwargs: extra attributes that will be stored to the message
         """
-        backend = message_backend or self.get_backend(recipient)
+        backend = message_backend or self.get_backend(recipient, **kwargs)
         message = self.create_message(recipient=recipient, content=content, related_objects=related_objects, tag=tag,
                                       template=template, **kwargs)
         if send_immediately or not self.is_turned_on_batch_sending():
@@ -119,7 +119,7 @@ def create_message(self, recipient, content, related_objects, tag, template,
     def _get_backend_messages_map(self, messages):
         backends_messages_map = defaultdict(list)
         for message in messages:
-            backend = self.get_backend(recipient=message.recipient)
+            backend = self.get_backend(recipient=message.recipient, is_voice_message=getattr(message, 'is_voice_message', False))
             backends_messages_map[backend].append(message)
         return backends_messages_map
 

pymess/backend/routers.py

@@ -1,6 +1,6 @@
 class BaseRouter:
 
-    def get_backend_name(self, recipient):
+    def get_backend_name(self, recipient, **kwargs):
         """
         Method should return name of the backend specified in PYMESS_*_BACKEND_ROUTER setting option
         """
@@ -9,5 +9,5 @@ def get_backend_name(self, recipient):
 
 class DefaultBackendRouter(BaseRouter):
 
-    def get_backend_name(self, recipient):
+    def get_backend_name(self, recipient, **kwargs):
         return None

pymess/backend/sms/__init__.py

@@ -55,6 +55,7 @@ def create_message(self, recipient, content, related_objects, tag, template,
         :param kwargs: extra attributes that will be saved with the message
         """
         try:
+            is_voice_message = template.is_voice_message if template else False
             return super().create_message(
                 recipient=recipient,
                 content=content,
@@ -65,7 +66,8 @@ def create_message(self, recipient, content, related_objects, tag, template,
                 priority=priority,
                 extra_data=kwargs,
                 sender=template.sender_name if template else None,
-                **self.get_backend(recipient).get_extra_message_kwargs()
+                is_voice_message=is_voice_message,
+                **self.get_backend(recipient, is_voice_message=is_voice_message).get_extra_message_kwargs()
             )
         except PersistenceException as ex:
             raise self.SMSSendingError(str(ex))

pymess/backend/sms/sms_operator.py

@@ -20,6 +20,8 @@ class RequestType(str, Enum):
 
     SMS = 'SMS'
     DELIVERY_REQUEST = 'DELIVERY_REQUEST'
+    VOICE_MESSAGE = 'VOICE_MESSAGE'
+    VOICE_MESSAGE_DELIVERY_REQUEST = 'VOICE_MESSAGE_DELIVERY_REQUEST'
 
 
 class SmsOperatorState(IntegerChoicesEnum):
@@ -55,9 +57,12 @@ class SMSOperatorSendingError(Exception):
         pass
 
     TEMPLATES = {
-        'base': 'pymess/sms/sms_operator/base.xml',
+        'base_sms': 'pymess/sms/sms_operator/base_sms.xml',
+        'base_voice': 'pymess/sms/sms_operator/base_voice.xml',
         RequestType.SMS: 'pymess/sms/sms_operator/sms.xml',
-        RequestType.DELIVERY_REQUEST: 'pymess/sms/sms_operator/delivery_request.xml',
+        RequestType.DELIVERY_REQUEST: 'pymess/sms/sms_operator/sms_delivery_request.xml',
+        RequestType.VOICE_MESSAGE: 'pymess/sms/sms_operator/voice.xml',
+        RequestType.VOICE_MESSAGE_DELIVERY_REQUEST: 'pymess/sms/sms_operator/voice_delivery_request.xml',
     }
 
     SMS_OPERATOR_STATES_MAPPING = {
@@ -78,11 +83,19 @@ class SMSOperatorSendingError(Exception):
     }
 
     config = {
-        'URL': 'https://www.sms-operator.cz/webservices/webservice.aspx',
+        'SMS_URL': 'https://www.sms-operator.cz/webservices/webservice.aspx',
+        'VOICE_URL': 'https://www.sms-operator.cz/webservices/voice.ashx',
         'UNIQ_PREFIX': '',
         'TIMEOUT': 5,  # 5s
     }
 
+    URLS = {
+        RequestType.SMS: 'SMS_URL',
+        RequestType.DELIVERY_REQUEST: 'SMS_URL',
+        RequestType.VOICE_MESSAGE: 'VOICE_URL',
+        RequestType.VOICE_MESSAGE_DELIVERY_REQUEST: 'VOICE_URL',
+    }
+
     def _get_extra_sender_data(self):
         return {
             'prefix': self.config['UNIQ_PREFIX'],
@@ -95,14 +108,22 @@ def _serialize_messages(self, messages, request_type):
         :param request_type: type of the request to the SMS operator
         :return: serialized XML message that will be sent to the SMS operator service
         """
+        # Determine the base template and type based on request type
+        if request_type in [RequestType.VOICE_MESSAGE, RequestType.VOICE_MESSAGE_DELIVERY_REQUEST]:
+            base_template = self.TEMPLATES['base_voice']
+            type_value = 'Voice' if request_type == RequestType.VOICE_MESSAGE else 'Voice-Status'
+        else:
+            base_template = self.TEMPLATES['base_sms']
+            type_value = 'SMS' if request_type == RequestType.SMS else 'SMS-Status'
+        
         return render_to_string(
-            self.TEMPLATES['base'], {
+            base_template, {
                 'username': self.config['USERNAME'],
                 'password': self.config['PASSWORD'],
                 'prefix': str(self.config['UNIQ_PREFIX']) + '-',
                 'template_type': self.TEMPLATES[request_type],
                 'messages': messages,
-                'type': 'SMS' if request_type == RequestType.SMS else 'SMS-Status',
+                'type': type_value,
             }
         )
 
@@ -115,9 +136,12 @@ def _send_requests(self, messages, request_type, is_sending=False, **change_sms_
         :param change_sms_kwargs: extra kwargs that will be stored to the message object
         """
         requests_xml = self._serialize_messages(messages, request_type)
+        url_key = self.URLS[request_type]
+        url = self.config[url_key]
+        
         try:
             resp = generate_session(slug='pymess - SMS operator', related_objects=list(messages)).post(
-                self.config['URL'],
+                url,
                 data=requests_xml,
                 headers={'Content-Type': 'text/xml'},
                 timeout=self.config['TIMEOUT']
@@ -189,9 +213,10 @@ def _update_sms_states_from_response(self, messages, parsed_response, is_sending
 
     def publish_message(self, message):
         try:
+            request_type = RequestType.VOICE_MESSAGE if getattr(message, 'is_voice_message', False) else RequestType.SMS
             self._send_requests(
                 [message],
-                request_type=RequestType.SMS.value,
+                request_type=request_type,
                 is_sending=True,
                 sent_at=timezone.now()
             )
@@ -210,7 +235,25 @@ def publish_message(self, message):
             # about exception).
 
     def publish_messages(self, messages):
-        self._send_requests(messages, request_type=RequestType.SMS, is_sending=True, sent_at=timezone.now())
+        sent_at = timezone.now()
+        voice_messages = [message for message in messages if getattr(message, 'is_voice_message', False)]
+        sms_messages = [message for message in messages if not getattr(message, 'is_voice_message', False)]
+
+        if voice_messages:
+            self._send_requests(
+                voice_messages,
+                request_type=RequestType.VOICE_MESSAGE,
+                is_sending=True,
+                sent_at=sent_at
+            )
+
+        if sms_messages:
+            self._send_requests(
+                sms_messages,
+                request_type=RequestType.SMS,
+                is_sending=True,
+                sent_at=sent_at
+            )
 
     def _parse_response_codes(self, xml):
         """
@@ -222,8 +265,23 @@ def _parse_response_codes(self, xml):
 
         soup = BeautifulSoup(xml, 'html.parser')
 
-        return {int(item.smsid.string.lstrip(self.config['UNIQ_PREFIX'] + '-')): SmsOperatorState(int(item.status.string))
-                for item in soup.find_all('dataitem')}
+        result = {}
+        for item in soup.find_all('dataitem'):
+            # Try to get the ID from either smsid or msgid tags (for voice messages)
+            id_tag = item.smsid if item.smsid else item.msgid
+            if id_tag:
+                message_id = int(id_tag.string.lstrip(self.config['UNIQ_PREFIX'] + '-'))
+                status = SmsOperatorState(int(item.status.string))
+                result[message_id] = status
+        
+        return result
 
     def update_sms_states(self, messages):
-        self._send_requests(messages, request_type=RequestType.DELIVERY_REQUEST)
+        voice_messages = [message for message in messages if getattr(message, 'is_voice_message', False)]
+        sms_messages = [message for message in messages if not getattr(message, 'is_voice_message', False)]
+
+        if voice_messages:
+            self._send_requests(voice_messages, request_type=RequestType.VOICE_MESSAGE_DELIVERY_REQUEST)
+
+        if sms_messages:
+            self._send_requests(sms_messages, request_type=RequestType.DELIVERY_REQUEST)