https://github.com/cmdotcom/talk-sdk-dotnet

SDK for use with the CM VoiceAPI
https://github.com/cmdotcom/talk-sdk-dotnet

dotnet dtmf netstandard nuget otp sdk talk

Last synced: 3 months ago
JSON representation

SDK for use with the CM VoiceAPI

• Host: GitHub
• URL: https://github.com/cmdotcom/talk-sdk-dotnet
• Owner: cmdotcom
• License: mit
• Created: 2018-06-25T07:01:57.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T10:48:46.000Z (7 months ago)
• Last Synced: 2024-10-07T10:42:55.279Z (4 months ago)
• Topics: dotnet, dtmf, netstandard, nuget, otp, sdk, talk
• Language: C#
• Homepage: https://docs.cmtelecom.com/voice-api-apps/v2.0
• Size: 76.2 KB
• Stars: 3
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build](https://img.shields.io/appveyor/ci/cmdotcom/voiceapisdk/master.svg "Build Status")](https://ci.appveyor.com/project/cmdotcom/voiceapisdk/branch/master)

[![Test](https://img.shields.io/appveyor/tests/cmdotcom/voiceapisdk/master.svg "Test Status")](https://ci.appveyor.com/project/cmdotcom/voiceapisdk/branch/master/tests)

[![NuGetV](https://img.shields.io/nuget/v/CM.Voice.VoiceApi.Sdk.svg "Nuget Version")](https://www.nuget.org/packages/CM.Voice.VoiceApi.Sdk)

[![NuGetDownloads](https://img.shields.io/nuget/dt/CM.Voice.VoiceApi.Sdk.svg "Nuget downloads")](https://www.nuget.org/packages/CM.Voice.VoiceApi.Sdk)

# VoiceApiSdk

SDK for use with the CM VoiceAPI

## API Documentation

https://docs.cmtelecom.com/voice-api-apps/v2.0

# Usage

## Instantiate a client

```cs

var httpClient = new HttpClient();

var voiceApiClient = new VoiceApiClient(httpClient, myApiKey);

```

`httpClient` is requested as a parameter, such that you can use a single instance throughout your application, as is highly recommended.

Ideally you would have it injected by Dependency Injection.

`myApiKey` is your unique api key (or product token) which authorizes you on the CM platform. Always keep this key secret!

## Send an instruction

Before we can send an instruction, we need to create one.

```cs

var instruction = new NotificationInstruction

{

    Caller = "+1234567890",

    Callee = "+9876543210",

    Prompt = "This is a test call."

};

```

This is an example Notification instruction, which will simply call the `Callee` while showing the `Caller`. 

When picked up, it will read the prompt using the default voice (en-GB, Female, nr. 1) and hang up.

The other instructions are the `OtpInstruction` (for sending a One Time Password) and the `RequestDtmfInstruction` (for calling and requesting numerical input from the callee).

More information on the various fields and their uses can be found in the docs (https://docs.cmtelecom.com/voice-api-apps/v2.0), as well as the list of possible voices.

To send the instruction, simply call `SendAsync()`  on the client and the call should take place shortly after.

```cs

var result = await voiceApiClient.SendAsync(instruction).ConfigureAwait(false);

```

Finally, the result will have a `HttpStatusCode`, `Content` (as string), a boolean indicating `Success` and a call `DeserializeEvent()` to Deserialize the result into a `CallQueuedEvent`