jleung
/
TwilioSMSReceiver
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update 'README.md'

This commit is contained in:
jleung 2022-01-04 22:48:11 +00:00
parent 4d18c20bbd
commit 665bb94aa2
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -12,9 +12,9 @@ The following message handlers will be implemented in a later release:
## Requirements ## Requirements
* A Public IP * A Public IP - or -
* A Reverse HTTP Proxy to direct traffic to if you don't want the code running without a reverse proxy. Kestrel is perfectly capable on serving HTTP requests without a reverse proxy in .NET 6.0 * A Reverse HTTP Proxy to direct traffic to if you don't want the code running without a reverse proxy. Kestrel is perfectly capable on serving HTTP requests without a reverse proxy in .NET 6.0
* A TLS Certificate * **Strongly Recommended** - TLS Certificate - this can be automated with your reverse proxy via certbot if you want a set it and forget it solution
* A [system](https://github.com/dotnet/core/blob/main/release-notes/6.0/supported-os.md) that is supported by .NET 6.0 * A [system](https://github.com/dotnet/core/blob/main/release-notes/6.0/supported-os.md) that is supported by .NET 6.0
## Code Implementation ## Code Implementation
@ -35,6 +35,16 @@ This endpoint takes a GET or POST request to add or remove Microsoft Teams webho
**Refer to ``/swagger/index.html`` endpoint in Development mode for the latest API updates** **Refer to ``/swagger/index.html`` endpoint in Development mode for the latest API updates**
## Twilio Configuration
### Webhook Configuration
1. Log into the Twilio account dashboard
2. On Phone Numbers -> Manage -> Active numbers, ensure a DID is there for this purpose. If not, purchase a DID from Twilio
3. In the DID, ensure the following is set on the Messaging section:
|Message Action|Handler Type|Web Endpoint|HTTP Verb|
|-|-|-|-|
| A MESSAGE COMES IN | Webhook | ``http://<Endpoint where the API is being hosted on>/api/SMSReceiver`` | POST |
| PRIMARY HANDLER FAILS | Webhook | ``http://<Endpoint where the API is being hosted on>/api/SMSReceiver`` | POST |
## Wishlist ## Wishlist
* MMS Message handling and storage - currently the code obtains all MMS media URL's sent from Twilio, but does not actively process them * MMS Message handling and storage - currently the code obtains all MMS media URL's sent from Twilio, but does not actively process them