Skip to content

Commit

Permalink
fix: compilation error / readme (#89)
Browse files Browse the repository at this point in the history 
* Fix compilation error, fix readme layout

* Simplify cast
  • Loading branch information
@Tr00d
Tr00d committed May 22, 2023
1 parent f1082a6 commit a1a54cf
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 54 deletions.
11 changes: 6 additions & 5 deletions DotNetCliCodeSnippets/Messages/WhatsApp/SendWhatsAppMtm.cs
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Vonage;
using Vonage.Messages.WhatsApp;
Expand Down Expand Up @@ -27,17 +28,17 @@ public async Task Execute()
WhatsApp = new MessageWhatsApp
{
Policy = "deterministic",
Locale = "en-GB"
Locale = "en-GB",
},
Template = new MessageTemplate
{
Name = "whatsapp:hsm:technology:nexmo:mytemplate",
Parameters = new List<string>
Parameters = new List<object>
{
"Vonage Verification"
"Vonage Verification",
"64873",
"10"
}
"10",
},
}
};

Expand Down
121 changes: 72 additions & 49 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,62 @@

<img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Vonage" />

The purpose of the code snippets project is to provide simple examples focused on one goal. For example, sending an SMS, handling an incoming SMS webhook or making a Text to Speech call.
The purpose of the code snippets project is to provide simple examples focused on one goal. For example, sending an SMS,
handling an incoming SMS webhook or making a Text to Speech call.

## Configure with Your Vonage Credentials

To use this sample you will first need a [Vonage account](https://dashboard.nexmo.com/sign-up). Once you have your own API credentials, Create a Vonage Client instance and pass in credentials in the constructor.
To use this sample you will first need a [Vonage account](https://dashboard.nexmo.com/sign-up). Once you have your own
API credentials, Create a Vonage Client instance and pass in credentials in the constructor.

Setting up environment variables

### Configuring Environment Variables

Open the sln file. For each project, right click and go to properties -> debug -> Environment Variables. Alternatively you can edit the environment variables in the Properties/launchSettings.json - there is a Properties/launchSettings.json.dist file present you can rename. This file has keys associated with each relevant property.
Open the sln file. For each project, right click and go to properties -> debug -> Environment Variables. Alternatively
you can edit the environment variables in the Properties/launchSettings.json - there is a
Properties/launchSettings.json.dist file present you can rename. This file has keys associated with each relevant
property.

### Environment Variable Reference

Key | Description
----|------------
`VONAGE_API_KEY` | Your API key
`VONAGE_API_SECRET` | Vonage API secret
`VONAGE_PRIVATE_KEY_PATH` | Path to a private key for your Vonage app
`VONAGE_APPLICATION_ID` | Your application ID
`VONAGE_API_SIGNATURE_SECRET` | Vonage SIGNATURE_SECRET from the Dashboard. This is different to the usual API_SECRET.
`CODE` | User Supplied Verification code (for checking verify requests)
`SMS_CALLBACK_URL` | Callback URL that you would like to receive SMS webhooks to
`DIGITS` | DTMF Digits to play into app
`API_KEY` | API key to apply an update to
`VOICE_CALLBACK_VALUE` | A SIP URI, telephone number or app ID (depending on `VOICE_CALLBACK_TYPE`)
`VOICE_CALLBACK_TYPE` | `sip`, `tel` or `app`
`VONAGE_NUMBER` | Vonage Number used for Caller ID or lvn you want to purchase/cancel/update
`VONAGE_NUMBER_FEATURES` | `VOICE` or `SMS` or `VOICE,SMS`
`TO_NUMBER` | Number to send an SMS to.
`TEXT` | Text to be played into call via text-to-speech
`VONAGE_REDACT_ID` | Vonage ID to use for redaction
`REQUEST_ID` | The ID of the request to search (returned when the request is started) - also request to operate on for verify
`INSIGHT_NUMBER` | The number to provide insight information for.
`VONAGE_BRAND_NAME` | The alphanumeric string that represents the name or number of the organisation sending the message.
`UUID` | The UUID of the call leg to modify.
`NUMBER_SEARCH_PATTERN` | Whether to look for `NUMBER_SEARCH_CRITERIA` at the beginning of the number (`0`), anywhere within the number (`1`) or at the end of the number (`2`)
`NUMBER_SEARCH_CRITERIA` | The number pattern you want to search for, e.g. `234`
`RECIPIENT_NUMBER` | Telephone number to verify, in E.164 format
`NCCO_URL` | The URL of the NCCO to transfer control to, eg `https://raw.githubusercontent.com/nexmo-community/ncco-examples/gh-pages/text-to-speech.json`
`VOICE_STATUS_URL` | The webhook URL that Vonage makes a request to when a call completes
`BRAND_NAME` | Included in the message to explain who is confirming the phone number
`VONAGE_NUMBER_TYPE` | `landline`, `mobile-lvn` or `landline-toll-free`
`COUNTRY_CODE`| The two-character country code for the number you want to purchase, e.g. `GB`
`RECORDING_URL` | This is the URL to the recording supplied in the record even webhook
`URL` | The URL of the audio file that will be played.
`FROM_NUMBER` | The phone number you are sending the message from.
`VONAGE_REDACT_TYPE` | Type of transaction to redact `Outbound` or `Inbound`
`VONAGE_REDACT_PRODUCT` | Product you are redacting for: `Sms`, `Voice`, `NumberInsight`, `Verify`, `VerifySdk`, `Messages`
`VONAGE_SECRET_ID` | The secret to revoke/retrieve
`NEW_SECRET` | The new secret to use with this API key
| Key | Description |
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| `VONAGE_API_KEY` | Your API key |
| `VONAGE_API_SECRET` | Vonage API secret |
| `VONAGE_PRIVATE_KEY_PATH` | Path to a private key for your Vonage app |
| `VONAGE_APPLICATION_ID` | Your application ID |
| `VONAGE_API_SIGNATURE_SECRET` | Vonage SIGNATURE_SECRET from the Dashboard. This is different to the usual API_SECRET. |
| `CODE` | User Supplied Verification code (for checking verify requests) |
| `SMS_CALLBACK_URL` | Callback URL that you would like to receive SMS webhooks to |
| `DIGITS` | DTMF Digits to play into app |
| `API_KEY` | API key to apply an update to |
| `VOICE_CALLBACK_VALUE` | A SIP URI, telephone number or app ID (depending on `VOICE_CALLBACK_TYPE`) |
| `VOICE_CALLBACK_TYPE` | `sip`, `tel` or `app` |
| `VONAGE_NUMBER` | Vonage Number used for Caller ID or lvn you want to purchase/cancel/update |
| `VONAGE_NUMBER_FEATURES` | `VOICE` or `SMS` or `VOICE,SMS` |
| `TO_NUMBER` | Number to send an SMS to. |
| `TEXT` | Text to be played into call via text-to-speech |
| `VONAGE_REDACT_ID` | Vonage ID to use for redaction |
| `REQUEST_ID` | The ID of the request to search (returned when the request is started) - also request to operate on for verify |
| `INSIGHT_NUMBER` | The number to provide insight information for. |
| `VONAGE_BRAND_NAME` | The alphanumeric string that represents the name or number of the organisation sending the message. |
| `UUID` | The UUID of the call leg to modify. |
| `NUMBER_SEARCH_PATTERN` | Whether to look for `NUMBER_SEARCH_CRITERIA` at the beginning of the number (`0`), anywhere within the number (`1`) or at the end of the number (`2`) |
| `NUMBER_SEARCH_CRITERIA` | The number pattern you want to search for, e.g. `234` |
| `RECIPIENT_NUMBER` | Telephone number to verify, in E.164 format |
| `NCCO_URL` | The URL of the NCCO to transfer control to, eg `https://raw.githubusercontent.com/nexmo-community/ncco-examples/gh-pages/text-to-speech.json` |
| `VOICE_STATUS_URL` | The webhook URL that Vonage makes a request to when a call completes |
| `BRAND_NAME` | Included in the message to explain who is confirming the phone number |
| `VONAGE_NUMBER_TYPE` | `landline`, `mobile-lvn` or `landline-toll-free` |
| `COUNTRY_CODE` | The two-character country code for the number you want to purchase, e.g. `GB` |
| `RECORDING_URL` | This is the URL to the recording supplied in the record even webhook |
| `URL` | The URL of the audio file that will be played. |
| `FROM_NUMBER` | The phone number you are sending the message from. |
| `VONAGE_REDACT_TYPE` | Type of transaction to redact `Outbound` or `Inbound` |
| `VONAGE_REDACT_PRODUCT` | Product you are redacting for: `Sms`, `Voice`, `NumberInsight`, `Verify`, `VerifySdk`, `Messages` |
| `VONAGE_SECRET_ID` | The secret to revoke/retrieve |
| `NEW_SECRET` | The new secret to use with this API key |

## Other option for setting Environment Variables

Expand All @@ -65,31 +70,40 @@ If you just want to set the environment variables via code you can do so by:
var VONAGE_API_KEY = Environment.GetEnvironmentVariable("VONAGE_API_KEY") ?? "CHANGE_ME";
```

As the environment variable has been removed from the launchSettings.json file it will return null when read into the environment - causing the app to default to the alternate string value.
As the environment variable has been removed from the launchSettings.json file it will return null when read into the
environment - causing the app to default to the alternate string value.

## Running the Code Snippets

### CLI Code Snippets

The non-webhook snippets are designed to be run from the cli - in order to run any given snippet you will need to pass in the argument -s or -snippet and set it equal to the partially qualified name of the snippet, e.g.
The non-webhook snippets are designed to be run from the cli - in order to run any given snippet you will need to pass
in the argument -s or -snippet and set it equal to the partially qualified name of the snippet, e.g.

```ps
dotnet run --project .\DotNetCliCodeSnippets\DotnetCliCodeSnippets.csproj --s=Messaging.SendSms
```

### Webhook snippets

The webhook code snippets are designed to be run in an MVC controller in IIS or IIS Express. Each controller defines its own snippet or set of snippets.
The webhook code snippets are designed to be run in an MVC controller in IIS or IIS Express. Each controller defines its
own snippet or set of snippets.

For example the inbound-sms snippet is located at

`/sms/webhooks/inbound-sms`

### Using Ngrok

In order to test the incoming webhook data from Vonage, the Vonage API needs an externally accessible URL to send that data to. A commonly used service for development and testing is ngrok. The service will provide you with an externally available web address that creates a secure tunnel to your local environment. The [Vonage API Developer Platform](https://developer.nexmo.com/concepts/guides/testing-with-ngrok) has a guide to getting started with testing with ngrok.
In order to test the incoming webhook data from Vonage, the Vonage API needs an externally accessible URL to send that
data to. A commonly used service for development and testing is ngrok. The service will provide you with an externally
available web address that creates a secure tunnel to your local environment.
The [Vonage API Developer Platform](https://developer.nexmo.com/concepts/guides/testing-with-ngrok) has a guide to
getting started with testing with ngrok.

Once you have your ngrok URL, you can enter your [Vonage Dashboard](https://dashboard.nexmo.com) and supply it as the `EVENT URL` for any Vonage service that sends event data via a webhook. A good test case is creating a Voice application and providing the ngrok URL in the following format as the event url:
Once you have your ngrok URL, you can enter your [Vonage Dashboard](https://dashboard.nexmo.com) and supply it as
the `EVENT URL` for any Vonage service that sends event data via a webhook. A good test case is creating a Voice
application and providing the ngrok URL in the following format as the event url:

The snippet webhook path above is then translated to:

Expand All @@ -103,7 +117,10 @@ For some of the examples, you will need to [buy a number](https://dashboard.nexm

## TLS Upgrade

Vonage permanently disabled support of legacy TLSv1 and TLSv1.1 protocols. Vulnerabilities within these TLS versions are serious and, left unaddressed, put organizations at risk of being breached. The only supported encryption protocol for HTTPS connections is now TLSv1.2. All API requests and all web requests to the Vonage Dashboard using legacy TLS protocols will be rejected.
Vonage permanently disabled support of legacy TLSv1 and TLSv1.1 protocols. Vulnerabilities within these TLS versions are
serious and, left unaddressed, put organizations at risk of being breached. The only supported encryption protocol for
HTTPS connections is now TLSv1.2. All API requests and all web requests to the Vonage Dashboard using legacy TLS
protocols will be rejected.

In case you are still using a legacy TLS protocol, make sure to force your app to TLSv1.2 by adding this line of code :

Expand All @@ -113,12 +130,18 @@ System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolTy

## Request an Example

Please [raise an issue](https://github.com/Nexmo/nexmo-dotnet/issues) to request an example that isn't present within the code snippets. Pull requests will be gratefully received.
Please [raise an issue](https://github.com/Nexmo/nexmo-dotnet/issues) to request an example that isn't present within
the code snippets. Pull requests will be gratefully received.

## Contributing

We ❤️ contributions from everyone! [Bug reports](https://github.com/Nexmo/nexmo-dotnet-code-snippets/issues), [bug fixes](https://github.com/Nexmo/nexmo-dotnet-code-snippets/pulls) and feedback on the application is always appreciated. Look at the [Contributor Guidelines](https://github.com/Nexmo/nexmo-dotnet-code-snippets/blob/master/CONTRIBUTING.md) for more information and please follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html).
We ❤️ contributions from
everyone! [Bug reports](https://github.com/Nexmo/nexmo-dotnet-code-snippets/issues), [bug fixes](https://github.com/Nexmo/nexmo-dotnet-code-snippets/pulls)
and feedback on the application is always appreciated. Look at
the [Contributor Guidelines](https://github.com/Nexmo/nexmo-dotnet-code-snippets/blob/master/CONTRIBUTING.md) for more
information and please follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html).

## License

This code is licensed under the [MIT](https://github.com/Nexmo/nexmo-dotnet-code-snippets/blob/master/LICENSE.md) license.
This code is licensed under the [MIT](https://github.com/Nexmo/nexmo-dotnet-code-snippets/blob/master/LICENSE.md)
license.

0 comments on commit a1a54cf

Please sign in to comment.