Support for sending of SMS notification to known mobile number

[SandGrainOne]

Description

This epic builds on the changes in epic #148 and will be adding mechanisms to support SMS notifications.

Will support sending an SMS from Altinn to a known mobile number.
Issues out of scope:

• Settings for ORG and validation of from name/setting from name, maks length: 11 characters #333

Notifications microservice

Workflow: Order placement for SMS notification

New endpoint for taking an order request an ensuring that the order is stored correctly for processing.

Tasks

Preview Give feedback

1. Investigate if Link Mobility have a phone number that we can use in tests. #338
   kind/analysis +1
   
2. Core logic for placing an sms notification order #336
   kind/user-story +1
   
3. API logic for placing a SMS notifications order #328
   kind/user-story +1
   
4. Repository logic for placing a SMS notifications order #337
   kind/user-story +1
   
5. Automated test for workflow: Order placement for SMS notification #339
   kind/chore +1
   
6. Document workflow: Order placement for SMS notification #340
   kind/documentation +1
   

Workflow: Processing past due orders

Job that can pick up orders that have a requested send time that require processing. Splitting an order into notifications.

Tasks

Preview Give feedback

1. Repository logic for placing a sms notification #341
   kind/user-story +1
   
2. Service logic for placing a sms notification #342
   kind/user-story +1
   
3. Update OrderProcessingService to handle SMS notification-channel #343
   kind/user-story +1
   
4. Document workflow: Processing past due orders #398
   kind/documentation +1
   

Acceptance criteria

• Sms notification table is populated when sms orders are processed.

Workflow: Processing new SMS

Job that can pick up SMS notifications from the database and produce SMS requests to Kafka Topic

Tasks

Preview Give feedback

1. Add necessary repository logic to start sending of new SMS notifications. #353
   kind/user-story +1
   
2. New core service called SmsNotificationsService handling Business logic for SMS #351
   kind/user-story +1
   
3. New trigger endpoint to start processing SMS notifications #350
   kind/user-story +1
   
4. Document workflow: Processing new SMS #399
   kind/documentation +1

Acceptance criteria

• New notifications picked up for sending are marked as "Sending" in database.
• A notification that is processed should result in an sms being sent from Link Mobility

Workflow: Recording send status and results

Logic that can read from Kafka and pick up the status and/result of an SMS sending in order to handle the result and persisting it to the database

Tasks

Preview Give feedback

1. Implement consumer for reading a status-message from Kafka #360
   +0
   
2. Implement support for LinkMobility status codes #361
   +0
   

Workflow: Get order by ID

Expand endpoint to include SMS related details like texts and phone number

Tasks

Preview Give feedback

1. Extend API logic for getting order by id #331
   kind/user-story +1
   
2. Modify documentation to reflect changes for get order by id #364
   kind/documentation +1
   
3. Update automated tests for getting order by id #332
   kind/user-story +1

Workflow: Get order with status

Expand endpoint to include status for SMS orders.

Tasks

Preview Give feedback

1. Changes needed for the orders status API (/orders/{id}/status) #356
   +0
   
2. Repository changes needed for getting order with status (API: /orders/{id}/status) #358
   +0
   
3. Documentation update for the "Get order with status" workflow for the SMS notification feature #373
   kind/documentation +1
   
4. K6 automated test for "Get order with status" workflow for the SMS notification #359
   +0
5. Clean up versioned function in database #427
   kind/chore +1
   

Workflow: Get SMS notification summary

Introduce endpoint for reporting status for sms notitifcations related to a single orderorders.

Tasks

Preview Give feedback

1. Implement API logic for sms notification summary #417
   kind/user-story +1
   
2. Implement core logic for sms notification summary #415
   kind/user-story +1
   
3. Implement repository logic for sms notification summary #414
   kind/user-story +1
   
4. Documentation for sms notification summary altinn-studio-docs#1399
   +0
5. Add TC05_GetSmsNotificationSummary(data, id); to regressoin + use case #428
   +0

Notifications SMS microservice

Project setup & CI/CD

Tasks

Preview Give feedback

1. Create a new dotnet solution with projects #335
   +0
   

Workflow: Send SMS @tba76

Triggered by new messages on a Kafka Topic. Send SMS

Tasks

Preview Give feedback

1. Set up access to SMS service at Link Mobility #362
   +0
   
2. Create new service for send sms #368
   +0
   
3. Implement consumer for reading sms-message objects from Kafka #366
   +0
   
4. Implement a client to send sms messages (Link Mobility) #367
   +0
   
5. Documentation: architecture

Workflow: Report back the result of sending SMS

Report back the result of to the central application through a Kafka topic.

Tasks

Preview Give feedback

1. Create a kafka client to write messages to a kafka topic #369
   +0
   
2. Update SMS Service logic to report the result of sending an SMS #374
   +0
   

Workflow: Handle the callback calls with the delivery report from SMS provider

A part of the API is a callback from the SMS provider with a delivery report. This must be handled and reported back to the central application for storage.

Tasks

Preview Give feedback

1. Make an endpoint for getting delivery report with basic auth with IP filter #377
   +0
   
2. For delivery reports, need to analyse on how to use the XML API for the Link Mobility more efficiently #376
   +0
   
3. Delivery report update need to be sent back to Kafka message queue #378
   +0
   
4. Handle environment connections between Altinn and LinkMobility #426
   kind/analysis +1

[acn-sbuad]

All related issues closed a while ago. Closing epic