text-sdk-dotnet

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

text-sdk-dotnet

★ 13 Open GitHub ↗

.NET Standard SDK to send messages with CM.com

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![.NET build & tests](https://github.com/cmdotcom/text-sdk-dotnet/actions/workflows/main.yml/badge.svg)](https://github.com/cmdotcom/text-sdk-dotnet/actions/workflows/main.yml)
[![NuGetV](https://img.shields.io/nuget/v/CM.Text.svg "NuGet Version")](https://www.nuget.org/packages/CM.Text)
[![NuGetDownloads](https://img.shields.io/nuget/dt/CM.Text.svg "NuGet downloads")](https://www.nuget.org/packages/CM.Text)

# CM Text SDK
A software development kit to provide ways to interact with CM.com's Text service. API's used:
- [Messaging](https://developers.cm.com/messaging/docs)

# Usage

## Instantiate the client
Using your unique `ApiKey` (or product token) which authorizes you on the CM platform. 
Always keep this key secret!

The product token can be found in the [Channels](https://www.cm.com/app/channels) application on the platform, under the `Gateway` section.

```cs
var client = new TextClient(new Guid(ConfigurationManager.AppSettings["ApiKey"]));
```

## Send a message
By calling `SendMessageAsync` and providing message text, sender name, recipient phone number(s) and a reference (optional).

```cs
var result = await client.SendMessageAsync("Message_Text", "Sender_Name", new List<string> { "Recipient_PhoneNumber" }, "Your_Reference").ConfigureAwait(false);
```

## Get the result
`SendMessageAsync` returns an object of type `TextClientResult`, example:

```cs
{
  "statusMessage": "Created 1 message(s)",
  "statusCode": 201,
  "details": [
    {
      "reference": "Example_Reference",
      "status": "Accepted",
      "to": "Example_PhoneNumber",
      "parts": 1,
      "details": null
    },
    {
      "reference": "Example_Reference2",
      "status": "Rejected",
      "to": "Example_PhoneNumber2",
      "parts": 0,
      "details": "A body without content was found"
    }
  ]
}
```

## Sending a rich message
By using the `MessageBuilder` it is possible to create images with media for channels such as WhatsApp and RCS
```cs
var apiKey = new Guid(ConfigurationManager.AppSettings["ApiKey"]);
var client = new TextClient(apiKey);
var builder = new MessageBuilder("Message Text", "Sender_name", "Recipient_PhoneNumber");
builder
    .WithAllowedChannels(Channel.WhatsApp)
    .WithRichMessage(
        new MediaMessage(
            "cm.com",
            "https://avatars3.githubusercontent.com/u/8234794?s=200&v=4",
            "image/png"
        )
    );
var message = builder.Build();
var result = await client.SendMessageAsync(message);
```

## Status codes
For all possible status codes, please reference the `TextClientStatusCode` enum.

## Sending a WhatsApp template message
By using the `MessageBuilder` it is possible to create template messages. Please note that this is WhatsApp only and your template needs to be approved before sending.
For more info please check our documentation: https://www.cm.com/en-en/app/docs/api/business-messaging-api/1.0/index#whatsapp-template-message
```cs
var apiKey = new Guid(ConfigurationManager.AppSettings["ApiKey"]);
var client = new TextClient(apiKey);
var builder = new MessageBuilder("Message Text", "Sender_name", "Recipient_PhoneNumber");
builder
 .WithAllowedChannels(Channel.WhatsApp)
 .WithTemplate(new TemplateMessage() {
  Content = new TemplateMessageContent() {
   Whatsapp = new WhatsappTemplate() {
    Name = "template-name",
     Namespace = "the-namespace-of-template",
     Language = new Language() {
      Code = "en",
       Policy = "deterministic"
     },
     Components = new TemplateComponents[] {
      new TemplateComponents() {
       Type = "body",
        ComponentParameters = new ComponentParameters[] {
         new ComponentParameters() {
          Type = "text",
           Text = "firstname"
         }
        }
      },
     }
   }
  }
 });

var message = builder.Build();
var result = await client.SendMessageAsync(message);
```
## Sending an Apple Pay Request
It is now possible to send an apple pay request only possible in Apple Business Chat

```cs
var apiKey = new Guid(ConfigurationManager.AppSettings["ApiKey"]);
var client = new TextClient(apiKey);
 var builder = new MessageBuilder("Message Text", "Sender_name", "Recipient_PhoneNumber");
     builder.WithAllowedChannels(Channel.WhatsApp).WithInteractive(new CM.Text.BusinessMessaging.Model.MultiChannel.WhatsAppInteractiveMessage()
            {
                whatsAppInteractiveContent = new CM.Text.BusinessMessaging.Model.MultiChannel.WhatsAppInteractiveContent()
                {
                    Type = "list",
                    Header = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveHeader()
                    {
                        Type = "text",
                        Text = "List message example"
                    },
                    Body = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveBody()
                    {
                        Text = "checkout our list message demo"
                    },
                    Action = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveAction()
                    {
                        Button = "button text",
                        Sections = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveSection[]
                         {
                             new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveSection()
                             {
                                 Title = "Select an option",
                                 Rows = new CM.Text.BusinessMessaging.Model.MultiChannel.Rows[]
                                 {
                                     new CM.Text.BusinessMessaging.Model.MultiChannel.Rows()
                                     {
                                         Id = "unique Id",
                                         Title = "unique title1",
                                         Description = "description text"
                                     },
                                     new CM.Text.BusinessMessaging.Model.MultiChannel.Rows()
                                     {
                                         Id = "unique Id2",
                                         Title = "unique title2",
                                         Description = "description text"
                                     },
                                 }
                             }
                         }
                    },
                    Footer = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveFooter()
                    {
                        Text = "footer text"
                    }
                }
        });
            
var message = builder.Build();
var result = await client.SendMessageAsync(message);
```

Only with Reply buttons you can send media like image,video or document 
see following example.

```cs
var apiKey = new Guid(ConfigurationManager.AppSettings["ApiKey"]);
var client = new TextClient(apiKey);
 var builder = new MessageBuilder("Message Text", "Sender_name", "Recipient_PhoneNumber");
    builder.WithAllowedChannels(Channel.WhatsApp).WithInteractive(new CM.Text.BusinessMessaging.Model.MultiChannel.WhatsAppInteractiveMessage()
            {
                whatsAppInteractiveContent = new CM.Text.BusinessMessaging.Model.MultiChannel.WhatsAppInteractiveContent()
                {
                    Type = "button",
                    Header = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveHeader()
                    {
                        Type = "image",                    
                        Media = new CM.Text.BusinessMessaging.Model.MultiChannel.MediaContent()
                         {
                                MediaUri = "https://www.cm.com/cdn/web/blog/content/logo-cmcom.png"
                          }
                        
                    },
                    Body = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveBody()
                    {
                        Text = "checkout our reply message demo"
                    },
                    Action = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveAction()
                    {
                        Buttons = new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveButton[]
                        {
                            new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveButton()
                            {
                               Type = "reply",
                                Reply = new CM.Text.BusinessMessaging.Model.MultiChannel.ReplyMessage()
                                {
                                    Id = "unique-postback-id1",
                                    Title = "First Button"
                                }
                            },
                               new CM.Text.BusinessMessaging.Model.MultiChannel.InteractiveButton()
                            {
                              Type = "reply",
                                Reply = new CM.Text.BusinessMessaging.Model.MultiChannel.ReplyMessage()
                                {
                                    Id = "unique-postback-id2",
                                    Title = "Second Button "
                                }
                            }
                        }
                    }
                }
            });
            
var message = builder.Build();
var result = await client.SendMessageAsync(message);
```

## Using the OTP API
Send a simple OTP code
```cs
    var client = new TextClient(new Guid(ConfigurationManager.AppSettings["ApiKey"]));
    var otpBuilder = new OtpRequestBuilder("Sender_name", "Recipient_PhoneNumber");
    otpBuilder.WithMessage("Your otp code is {code}.");
    var result = await textClient.SendOtpAsync(otpBuilder.Build());
```

Verify the response code
```cs
    var verifyResult = client.VerifyOtp("OTP-ID", "code");
    bool isValid = verifyResult.Verified;
```

For more advanced scenarios see also https://developers.cm.com/identity/docs/one-time-password-create

text-sdk-dotnet

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README