support inbound messaging

Author: matthiez

README.md

@@ -2,6 +2,7 @@
 
 
 # Zammad Package for seven.io
+This package adds seven as a SMS provider for two-way messaging.
 
 Tested with Zammad v6.x.
 
@@ -14,7 +15,13 @@ Tested with Zammad v6.x.
 6. Go to **Manage->Channels->SMS->SMS Notification** and choose **seven**
 7. Type in your [API Key](https://help.seven.io/en/api-key-access), test and you are ready to go
 
-### Support
+## Usage
+
+Please refer to the official [documentation](https://admin-docs.zammad.org/en/6.1/channels/sms.html) over at Zammad.
+
+
+
+## Support
 
 Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/).
 

app/models/channel/driver/sms/seven.rb

@@ -1,6 +1,10 @@
 class Channel::Driver::Sms::Seven < Channel::Driver::Sms::Base
   NAME = 'sms/seven'.freeze
 
+  def fetchable?(_channel)
+    false
+  end
+
   def deliver(options, attr, _notification = false)
     Rails.logger.info "Sending SMS to recipient #{attr[:recipient]}"
 
@@ -9,14 +13,14 @@ def deliver(options, attr, _notification = false)
     Rails.logger.info "Backend sending seven SMS to #{attr[:recipient]}"
     begin
       url = 'https://gateway.seven.io/api/sms?' + URI.encode_www_form({
-                                                                          p: options[:api_key],
-                                                                          text: attr[:message],
-                                                                          to: attr[:recipient],
-                                                                          from: options[:from],
-                                                                          sendWith: 'zammad',
+                                                                        p: options[:api_key],
+                                                                        text: attr[:message],
+                                                                        to: attr[:recipient],
+                                                                        from: options[:from],
+                                                                        sendWith: 'zammad',
                                                                       })
 
-      if Setting.get('developer_mode') != true
+      if Setting.get('developer_mode') != false
         response = Faraday.get(url).body
         raise response if '100' != response
       end
@@ -28,14 +32,84 @@ def deliver(options, attr, _notification = false)
     end
   end
 
+  def process(_options, attr, channel)
+    from = attr['data']['sender']
+
+    Rails.logger.info "Receiving SMS from recipient #{from}"
+
+    if from.sub('+', '').scan(/^\d+$/).empty?
+      Rails.logger.info "Skipping inbound SMS because the sender is not a valid phone number: #{from}"
+      return [:json, {}]
+    end
+
+    # prevent already created articles
+    if Ticket::Article.exists?(message_id: attr['data']['id'])
+      return [:json, {}]
+    end
+
+    # find sender
+    user = user_by_mobile(from)
+    UserInfo.current_user_id = user.id
+
+    process_ticket(attr, channel, user)
+
+    [:json, {}]
+  end
+
+  def create_ticket(attr, channel, user)
+    title = cut_title(attr['data']['text'])
+    ticket = Ticket.new(
+      group_id:    channel.group_id,
+      title:       title,
+      state_id:    Ticket::State.find_by(default_create: true).id,
+      priority_id: Ticket::Priority.find_by(default_create: true).id,
+      customer_id: user.id,
+      preferences: {
+        channel_id: channel.id,
+        sms:        {
+          originator: attr['data']['sender'],
+          recipient:  attr['data']['system'],
+        }
+      }
+    )
+    ticket.save!
+    ticket
+  end
+
+  def create_article(attr, channel, ticket)
+    Ticket::Article.create!(
+      ticket_id:    ticket.id,
+      type:         article_type_sms,
+      sender:       Ticket::Article::Sender.find_by(name: 'Customer'),
+      body:         attr['data']['text'],
+      from:         attr['data']['sender'],
+      to:           attr['data']['system'],
+      message_id:   attr['data']['id'],
+      content_type: 'text/plain',
+      preferences:  {
+        channel_id: channel.id,
+        sms:        {
+          From:       attr['data']['sender'],
+          To:         attr['data']['system'],
+        },
+      }
+    )
+  end
+
   def self.definition
     {
-        name: 'seven',
-        adapter: 'sms/seven',
-        notification: [
-            {name: 'options::api_key', display: 'API Key', tag: 'input', type: 'text', limit: 64, null: false, placeholder: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'},
-            {name: 'options::from', display: 'From', tag: 'input', type: 'text', limit: 16, null: true, placeholder: '00491710000000'},
-        ]
+      name: 'seven',
+      adapter: 'sms/seven',
+      account:      [
+        { name: 'options::webhook_token', display: __('Webhook Token'), tag: 'input', type: 'text', limit: 200, null: false, default: Digest::MD5.hexdigest(SecureRandom.uuid), disabled: true, readonly: true },
+        {name: 'options::api_key', display: 'API Key', tag: 'input', type: 'text', limit: 64, null: false, placeholder: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'},
+        {name: 'options::from', display: 'From', tag: 'input', type: 'text', limit: 16, null: true, placeholder: '00491710000000'},
+        { name: 'group_id', display: __('Destination Group'), tag: 'tree_select', null: false, relation: 'Group', nulloption: true, filter: { active: true } },
+      ],
+      notification: [
+        {name: 'options::api_key', display: 'API Key', tag: 'input', type: 'text', limit: 64, null: false, placeholder: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'},
+        {name: 'options::from', display: 'From', tag: 'input', type: 'text', limit: 16, null: true, placeholder: '00491710000000'},
+      ]
     }
   end
-end
+end

seven-sms.szpm

@@ -1,12 +1,17 @@
 {
   "name": "seven SMS",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "vendor": "seven communications GmbH & Co. KG",
   "license": "MIT",
   "url": "https://www.seven.io/",
   "buildhost": "localhost",
-  "builddate": "2024-21-05 00:00:00 UTC",
+  "builddate": "2025-26-03 00:00:00 UTC",
   "change_log": [
+     {
+          "version": "2.1.0",
+          "date": "2025-26-03 00:00:00 UTC",
+          "log": "added inbound messaging"
+      },
     {
         "version": "2.0.0",
         "date": "2024-21-05 00:00:00 UTC",
@@ -34,7 +39,7 @@
       "location": "app/models/channel/driver/sms/seven.rb",
       "permission": 644,
       "encode": "base64",
-      "content": "Y2xhc3MgQ2hhbm5lbDo6RHJpdmVyOjpTbXM6OlNldmVuIDwgQ2hhbm5lbDo6RHJpdmVyOjpTbXM6OkJhc2UNCiAgTkFNRSA9ICdzbXMvc2V2ZW4nLmZyZWV6ZQ0KDQogIGRlZiBkZWxpdmVyKG9wdGlvbnMsIGF0dHIsIF9ub3RpZmljYXRpb24gPSBmYWxzZSkNCiAgICBSYWlscy5sb2dnZXIuaW5mbyAiU2VuZGluZyBTTVMgdG8gcmVjaXBpZW50ICN7YXR0cls6cmVjaXBpZW50XX0iDQoNCiAgICByZXR1cm4gdHJ1ZSBpZiBTZXR0aW5nLmdldCgnaW1wb3J0X21vZGUnKQ0KDQogICAgUmFpbHMubG9nZ2VyLmluZm8gIkJhY2tlbmQgc2VuZGluZyBzZXZlbiBTTVMgdG8gI3thdHRyWzpyZWNpcGllbnRdfSINCiAgICBiZWdpbg0KICAgICAgdXJsID0gJ2h0dHBzOi8vZ2F0ZXdheS5zZXZlbi5pby9hcGkvc21zPycgKyBVUkkuZW5jb2RlX3d3d19mb3JtKHsNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgcDogb3B0aW9uc1s6YXBpX2tleV0sDQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIHRleHQ6IGF0dHJbOm1lc3NhZ2VdLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB0bzogYXR0cls6cmVjaXBpZW50XSwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgZnJvbTogb3B0aW9uc1s6ZnJvbV0sDQogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIHNlbmRXaXRoOiAnemFtbWFkJywNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB9KQ0KDQogICAgICBpZiBTZXR0aW5nLmdldCgnZGV2ZWxvcGVyX21vZGUnKSAhPSB0cnVlDQogICAgICAgIHJlc3BvbnNlID0gRmFyYWRheS5nZXQodXJsKS5ib2R5DQogICAgICAgIHJhaXNlIHJlc3BvbnNlIGlmICcxMDAnICE9IHJlc3BvbnNlDQogICAgICBlbmQNCg0KICAgICAgdHJ1ZQ0KICAgIHJlc2N1ZSA9PiBlDQogICAgICBSYWlscy5sb2dnZXIuZGVidWcgInNldmVuIGVycm9yOiAje2UuaW5zcGVjdH0iDQogICAgICByYWlzZSBlDQogICAgZW5kDQogIGVuZA0KDQogIGRlZiBzZWxmLmRlZmluaXRpb24NCiAgICB7DQogICAgICAgIG5hbWU6ICdzZXZlbicsDQogICAgICAgIGFkYXB0ZXI6ICdzbXMvc2V2ZW4nLA0KICAgICAgICBub3RpZmljYXRpb246IFsNCiAgICAgICAgICAgIHtuYW1lOiAnb3B0aW9uczo6YXBpX2tleScsIGRpc3BsYXk6ICdBUEkgS2V5JywgdGFnOiAnaW5wdXQnLCB0eXBlOiAndGV4dCcsIGxpbWl0OiA2NCwgbnVsbDogZmFsc2UsIHBsYWNlaG9sZGVyOiAnWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWCd9LA0KICAgICAgICAgICAge25hbWU6ICdvcHRpb25zOjpmcm9tJywgZGlzcGxheTogJ0Zyb20nLCB0YWc6ICdpbnB1dCcsIHR5cGU6ICd0ZXh0JywgbGltaXQ6IDE2LCBudWxsOiB0cnVlLCBwbGFjZWhvbGRlcjogJzAwNDkxNzEwMDAwMDAwJ30sDQogICAgICAgIF0NCiAgICB9DQogIGVuZA0KZW5k"
+      "content": "Y2xhc3MgQ2hhbm5lbDo6RHJpdmVyOjpTbXM6OlNldmVuIDwgQ2hhbm5lbDo6RHJpdmVyOjpTbXM6OkJhc2UKICBOQU1FID0gJ3Ntcy9zZXZlbicuZnJlZXplCgogIGRlZiBmZXRjaGFibGU/KF9jaGFubmVsKQogICAgZmFsc2UKICBlbmQKCiAgZGVmIGRlbGl2ZXIob3B0aW9ucywgYXR0ciwgX25vdGlmaWNhdGlvbiA9IGZhbHNlKQogICAgUmFpbHMubG9nZ2VyLmluZm8gIlNlbmRpbmcgU01TIHRvIHJlY2lwaWVudCAje2F0dHJbOnJlY2lwaWVudF19IgoKICAgIHJldHVybiB0cnVlIGlmIFNldHRpbmcuZ2V0KCdpbXBvcnRfbW9kZScpCgogICAgUmFpbHMubG9nZ2VyLmluZm8gIkJhY2tlbmQgc2VuZGluZyBzZXZlbiBTTVMgdG8gI3thdHRyWzpyZWNpcGllbnRdfSIKICAgIGJlZ2luCiAgICAgIHVybCA9ICdodHRwczovL2dhdGV3YXkuc2V2ZW4uaW8vYXBpL3Ntcz8nICsgVVJJLmVuY29kZV93d3dfZm9ybSh7CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIHA6IG9wdGlvbnNbOmFwaV9rZXldLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB0ZXh0OiBhdHRyWzptZXNzYWdlXSwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgdG86IGF0dHJbOnJlY2lwaWVudF0sCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIGZyb206IG9wdGlvbnNbOmZyb21dLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBzZW5kV2l0aDogJ3phbW1hZCcsCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB9KQoKICAgICAgaWYgU2V0dGluZy5nZXQoJ2RldmVsb3Blcl9tb2RlJykgIT0gZmFsc2UKICAgICAgICByZXNwb25zZSA9IEZhcmFkYXkuZ2V0KHVybCkuYm9keQogICAgICAgIHJhaXNlIHJlc3BvbnNlIGlmICcxMDAnICE9IHJlc3BvbnNlCiAgICAgIGVuZAoKICAgICAgdHJ1ZQogICAgcmVzY3VlID0+IGUKICAgICAgUmFpbHMubG9nZ2VyLmRlYnVnICJzZXZlbiBlcnJvcjogI3tlLmluc3BlY3R9IgogICAgICByYWlzZSBlCiAgICBlbmQKICBlbmQKCiAgZGVmIHByb2Nlc3MoX29wdGlvbnMsIGF0dHIsIGNoYW5uZWwpCiAgICBmcm9tID0gYXR0clsnZGF0YSddWydzZW5kZXInXQoKICAgIFJhaWxzLmxvZ2dlci5pbmZvICJSZWNlaXZpbmcgU01TIGZyb20gcmVjaXBpZW50ICN7ZnJvbX0iCgogICAgaWYgZnJvbS5zdWIoJysnLCAnJykuc2NhbigvXlxkKyQvKS5lbXB0eT8KICAgICAgUmFpbHMubG9nZ2VyLmluZm8gIlNraXBwaW5nIGluYm91bmQgU01TIGJlY2F1c2UgdGhlIHNlbmRlciBpcyBub3QgYSB2YWxpZCBwaG9uZSBudW1iZXI6ICN7ZnJvbX0iCiAgICAgIHJldHVybiBbOmpzb24sIHt9XQogICAgZW5kCgogICAgIyBwcmV2ZW50IGFscmVhZHkgY3JlYXRlZCBhcnRpY2xlcwogICAgaWYgVGlja2V0OjpBcnRpY2xlLmV4aXN0cz8obWVzc2FnZV9pZDogYXR0clsnZGF0YSddWydpZCddKQogICAgICByZXR1cm4gWzpqc29uLCB7fV0KICAgIGVuZAoKICAgICMgZmluZCBzZW5kZXIKICAgIHVzZXIgPSB1c2VyX2J5X21vYmlsZShmcm9tKQogICAgVXNlckluZm8uY3VycmVudF91c2VyX2lkID0gdXNlci5pZAoKICAgIHByb2Nlc3NfdGlja2V0KGF0dHIsIGNoYW5uZWwsIHVzZXIpCgogICAgWzpqc29uLCB7fV0KICBlbmQKCiAgZGVmIGNyZWF0ZV90aWNrZXQoYXR0ciwgY2hhbm5lbCwgdXNlcikKICAgIHRpdGxlID0gY3V0X3RpdGxlKGF0dHJbJ2RhdGEnXVsndGV4dCddKQogICAgdGlja2V0ID0gVGlja2V0Lm5ldygKICAgICAgZ3JvdXBfaWQ6ICAgIGNoYW5uZWwuZ3JvdXBfaWQsCiAgICAgIHRpdGxlOiAgICAgICB0aXRsZSwKICAgICAgc3RhdGVfaWQ6ICAgIFRpY2tldDo6U3RhdGUuZmluZF9ieShkZWZhdWx0X2NyZWF0ZTogdHJ1ZSkuaWQsCiAgICAgIHByaW9yaXR5X2lkOiBUaWNrZXQ6OlByaW9yaXR5LmZpbmRfYnkoZGVmYXVsdF9jcmVhdGU6IHRydWUpLmlkLAogICAgICBjdXN0b21lcl9pZDogdXNlci5pZCwKICAgICAgcHJlZmVyZW5jZXM6IHsKICAgICAgICBjaGFubmVsX2lkOiBjaGFubmVsLmlkLAogICAgICAgIHNtczogICAgICAgIHsKICAgICAgICAgIG9yaWdpbmF0b3I6IGF0dHJbJ2RhdGEnXVsnc2VuZGVyJ10sCiAgICAgICAgICByZWNpcGllbnQ6ICBhdHRyWydkYXRhJ11bJ3N5c3RlbSddLAogICAgICAgIH0KICAgICAgfQogICAgKQogICAgdGlja2V0LnNhdmUhCiAgICB0aWNrZXQKICBlbmQKCiAgZGVmIGNyZWF0ZV9hcnRpY2xlKGF0dHIsIGNoYW5uZWwsIHRpY2tldCkKICAgIFRpY2tldDo6QXJ0aWNsZS5jcmVhdGUhKAogICAgICB0aWNrZXRfaWQ6ICAgIHRpY2tldC5pZCwKICAgICAgdHlwZTogICAgICAgICBhcnRpY2xlX3R5cGVfc21zLAogICAgICBzZW5kZXI6ICAgICAgIFRpY2tldDo6QXJ0aWNsZTo6U2VuZGVyLmZpbmRfYnkobmFtZTogJ0N1c3RvbWVyJyksCiAgICAgIGJvZHk6ICAgICAgICAgYXR0clsnZGF0YSddWyd0ZXh0J10sCiAgICAgIGZyb206ICAgICAgICAgYXR0clsnZGF0YSddWydzZW5kZXInXSwKICAgICAgdG86ICAgICAgICAgICBhdHRyWydkYXRhJ11bJ3N5c3RlbSddLAogICAgICBtZXNzYWdlX2lkOiAgIGF0dHJbJ2RhdGEnXVsnaWQnXSwKICAgICAgY29udGVudF90eXBlOiAndGV4dC9wbGFpbicsCiAgICAgIHByZWZlcmVuY2VzOiAgewogICAgICAgIGNoYW5uZWxfaWQ6IGNoYW5uZWwuaWQsCiAgICAgICAgc21zOiAgICAgICAgewogICAgICAgICAgRnJvbTogICAgICAgYXR0clsnZGF0YSddWydzZW5kZXInXSwKICAgICAgICAgIFRvOiAgICAgICAgIGF0dHJbJ2RhdGEnXVsnc3lzdGVtJ10sCiAgICAgICAgfSwKICAgICAgfQogICAgKQogIGVuZAoKICBkZWYgc2VsZi5kZWZpbml0aW9uCiAgICB7CiAgICAgIG5hbWU6ICdzZXZlbicsCiAgICAgIGFkYXB0ZXI6ICdzbXMvc2V2ZW4nLAogICAgICBhY2NvdW50OiAgICAgIFsKICAgICAgICB7IG5hbWU6ICdvcHRpb25zOjp3ZWJob29rX3Rva2VuJywgZGlzcGxheTogX18oJ1dlYmhvb2sgVG9rZW4nKSwgdGFnOiAnaW5wdXQnLCB0eXBlOiAndGV4dCcsIGxpbWl0OiAyMDAsIG51bGw6IGZhbHNlLCBkZWZhdWx0OiBEaWdlc3Q6Ok1ENS5oZXhkaWdlc3QoU2VjdXJlUmFuZG9tLnV1aWQpLCBkaXNhYmxlZDogdHJ1ZSwgcmVhZG9ubHk6IHRydWUgfSwKICAgICAgICB7bmFtZTogJ29wdGlvbnM6OmFwaV9rZXknLCBkaXNwbGF5OiAnQVBJIEtleScsIHRhZzogJ2lucHV0JywgdHlwZTogJ3RleHQnLCBsaW1pdDogNjQsIG51bGw6IGZhbHNlLCBwbGFjZWhvbGRlcjogJ1hYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgnfSwKICAgICAgICB7bmFtZTogJ29wdGlvbnM6OmZyb20nLCBkaXNwbGF5OiAnRnJvbScsIHRhZzogJ2lucHV0JywgdHlwZTogJ3RleHQnLCBsaW1pdDogMTYsIG51bGw6IHRydWUsIHBsYWNlaG9sZGVyOiAnMDA0OTE3MTAwMDAwMDAnfSwKICAgICAgICB7IG5hbWU6ICdncm91cF9pZCcsIGRpc3BsYXk6IF9fKCdEZXN0aW5hdGlvbiBHcm91cCcpLCB0YWc6ICd0cmVlX3NlbGVjdCcsIG51bGw6IGZhbHNlLCByZWxhdGlvbjogJ0dyb3VwJywgbnVsbG9wdGlvbjogdHJ1ZSwgZmlsdGVyOiB7IGFjdGl2ZTogdHJ1ZSB9IH0sCiAgICAgIF0sCiAgICAgIG5vdGlmaWNhdGlvbjogWwogICAgICAgIHtuYW1lOiAnb3B0aW9uczo6YXBpX2tleScsIGRpc3BsYXk6ICdBUEkgS2V5JywgdGFnOiAnaW5wdXQnLCB0eXBlOiAndGV4dCcsIGxpbWl0OiA2NCwgbnVsbDogZmFsc2UsIHBsYWNlaG9sZGVyOiAnWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWCd9LAogICAgICAgIHtuYW1lOiAnb3B0aW9uczo6ZnJvbScsIGRpc3BsYXk6ICdGcm9tJywgdGFnOiAnaW5wdXQnLCB0eXBlOiAndGV4dCcsIGxpbWl0OiAxNiwgbnVsbDogdHJ1ZSwgcGxhY2Vob2xkZXI6ICcwMDQ5MTcxMDAwMDAwMCd9LAogICAgICBdCiAgICB9CiAgZW5kCmVuZAo="
     }
   ]
 }