SimplQ / simplQ-frontend

Modern and fully web based free queue management open source software.
https://simplq.me
GNU General Public License v3.0
176 stars 135 forks source link

Twilio Integration for client side SMS notification #643

Open daltonfury42 opened 3 years ago

daltonfury42 commented 3 years ago

Feature: Let clients supply Twilio credentials to enable them to send SMS from their Twilio account.

Step 1:

In the queue settings, add two text boxes to enter their Account SID and Auth Token and a "Save Credentials" button.

Once the user clicks on save credentials, make a network call

PUT /me/sms
{
  "integration": "twilio"
  "accountSid": "<sid>",
  "authToken": "<token>"
}

Saving the credentials is a one time activity, on success or when the user navigates to settings again for the same or a different queue, in place of the above form, a "Clear Credentials" button should be displayed.

Clicking on the clear credentials button will make a DELETE /me/sms?integration=twilio backend call to delete the credentials.

Step 2:

If credentials are saved at backend, a "Enable SMS" toggle will be activated, which the user can use to enable and pause notifications.

This should trigger a patch call to the backend:

PATCH /queue/<queue-id>
{
  "enableSms": true/false
}

Step 3:

  1. Add links and short documentation to help users create twilio credentials.
  2. Add link to "Contact us if you want our team to set up SMS for for a fee".
Burhan-Rashid commented 3 years ago

@daltonfury42 i want to work on this feature. Pls let me know if u have any designs available for the same.

daltonfury42 commented 3 years ago

@maaverik What is your thoughts on this one? This would allow the queue manager to set up and pay for SMS on his own, just that he will have to trust us with the credentials for twilio.

@Burhan-Rashid sorry for the late replay. You can take it up if the proposal gets accepted and if you are still interested.

maaverik commented 3 years ago

It's a good idea. I just feel that we should also have an explicit disclaimer saying that we are saving the credentials, but not using it for anything else and users always have the option to delete it.

daltonfury42 commented 3 years ago

Why should we have the disclaimer? 🤔

I feel having it might make someone overly cautious and then decide not to go ahead.

maaverik commented 3 years ago

In my view, if someone is going to add credentials, they're already pretty technically knowledgeable, so they would expect to know that at least we've thought about securing credentials, ours being an open-source project and all.

daltonfury42 commented 3 years ago

Okay, makes sense.

aswath-s-tw commented 2 years ago

@maaverik @daltonfury42 I would like to take this up. Is it taken ? And one more question, is this eligible for hacktoberfest 2022 ?

maaverik commented 2 years ago

Hi @aswath-s-tw, this project is not being actively maintained anymore. Thanks anyway for offering to help!