Voice Elements SMS

We understand how important SMS communication is in our industry. We have two implementations to choose from to allow you complete control of how you can use SMS in your organization.

- SMS using your VoiceElements Client – continue reading
- SMS via REST API – click here to navigate to this article

SMS Using Your VoiceElements Client

SMS From Within Your VoiceElements Application

Sending and receiving SMS from within VoiceElements is a snap. It requires version 8.6.3 of the VoiceElements Client which is available on NUGET:

https://www.nuget.org/packages/InventiveLabs.VoiceElementsClient/

Set Encryption Keys

Before you can use SMS, you must set the encryption keys. These keys are unique to your account and you can get the keys for your SMS enabled number(s) from our portal:

https://customer.voiceelements.com/

Setting the keys in code is done at startup:

`1`	`s_telephonyServer.SmsMyPrivateKeyXml = myCustomerKeyPairXml;`

`2`	`s_telephonyServer.SmsBorderElementsPublicKeyXml = myBorderKeyPairXml;`

You should also subscribe to the SMS events to receive SMS messages and delivery reports:

`1`	`s_telephonyServer.SmsMessage += TelephonyServer_SmsMessage;`

`2`	`s_telephonyServer.SmsDeliveryReport += TelephonyServer_SmsDeliveryReport;`

Outgoing SMS

After these are set, you can easily send an SMS message as in this example:

1public static void SendSms(string number, string smsText)
2{
3    try
4    {
5        Guid messageGuid;
6        string[] headers;
7        string[] sdp;
8 
9        var sipStatusCode = s_telephonyServer.SmsSendMessage(smsText, number, fromNumber, null, out messageGuid, out headers, out sdp);
10        Log.Write("SMS Result: {0}", sipStatusCode);
11    }
12    catch (Exception ex)
13    {
14        Log.WriteException(ex, "SendSms()");
15    }
16}

Incoming SMS

And then handle incoming SMS messages upon arrival:

1private static void TelephonyServer_SmsMessage(object sender, SmsMessageEventArgs e)
2{
3    Log.Write($"Received SMS (From: {e.SmsFrom}, To: {e.SmsTo}): {e.SmsMessage}");
4}

Delivery Reports

The system will also give you delivery reports for sent SMS messages:

1private static void TelephonyServer_SmsDeliveryReport(object sender, SmsDeliveryReportEventArgs e)
2{
3    if (string.IsNullOrWhiteSpace(e.DeliveryDescription) && e.DeliveryState.ToLower() == "waiting")
4    {
5        Log.Write($"Received SMS Delivery Report (From: {e.SmsFrom}, To: {e.SmsTo}): Message delivery is pending...");
6    }
7    else
8    {
9        Log.Write($"Received SMS Delivery Report (From: {e.SmsFrom}, To: {e.SmsTo}): {e.DeliveryDescription}");
10    }
11}

Handling Undeliverable Messages

You can also request that any undelivered SMS messages be sent to you. These would be messages that may have arrived while your application was offline.

1try
2{
3    string[] headers;
4    string[] sdp;
5   
6    var result = s_telephonyServer.SmsRequestUndeliveredMessages(out headers, out sdp);
7    Log.Write($"Requesting undelivered SMS messages.  Result: {result}");
8}
9catch { }

Interested in SMS Via REST API?

If you would like to know more about our REST API, please see our article SMS via REST API and SMS REST API Reference Guide.

Please contact us if you have any questions!

We invite you to schedule a free consultation with our Tech Team to explore your project goals and how we can help you get quickly into production.

Was this article helpful to you? No Yes 18