OneMessage.io 1.0.3

.NET 7.0 .NET Framework 4.8 
dotnet add package OneMessage.io --version 1.0.3
NuGet\Install-Package OneMessage.io -Version 1.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="OneMessage.io" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add OneMessage.io --version 1.0.3
#r "nuget: OneMessage.io, 1.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install OneMessage.io as a Cake Addin
#addin nuget:?package=OneMessage.io&version=1.0.3

// Install OneMessage.io as a Cake Tool
#tool nuget:?package=OneMessage.io&version=1.0.3

OneMessage.io - the C# library for the one_msg_waba_sdk

1MSG.IO is the perfect WhatsApp management tool for your business. With us you get full access to the official Whatsapp API/webhooks.

Every API request must contain an Authorize HTTP header with a token. This is your channel token, which can be found in your channel project on your profile page. Please do not give the token to anyone or post it publicly.

The authorization token must be added to each request in the GET parameter 'token' and always passed to query string (?token={your_token}). Parameters in GET queries pass query string. Parameters in POST requests — through the JSON-encoded request body.

All 'send' methods (except /sendTemplate) will only work when the dialog session with the user is open. Some of our solutions simplify and avoid such limitations, but we urge you to pay more attention to this detail

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.39.0
  • SDK version: 1.0.3
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks supported

.NET 7.0 .NET Framework 4.8

Dependencies

Installation

Please refer to the latest nuget installation description at the top of a page NuGet link

Usage

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using OneMessage.io.Api;
using OneMessage.io.Client;
using OneMessage.io.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.1msg.io/YOUR_INSTANCE_NUMBER";
            // Configure API key authorization: token
            config.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new ChannelApi(config);

            try
            {
                // GetMe
                GetMe result = apiInstance.GetMe();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ChannelApi.GetMe: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

All URIs are relative to https://api.1msg.io/YOUR_INSTANCE_NUMBER

Class Method HTTP request Description
ChannelApi GetCommerce GET /commerce Get Commerce Settings
ChannelApi GetExtendedStatistics GET /extendedStatistics Get Extended Channel statistics
ChannelApi GetMe GET /me Get Profile Info
ChannelApi GetSettings GET /settings Get Settings
ChannelApi GetStatistics GET /statistics Get Channel statistics
ChannelApi GetStatus GET /status Get Status
ChannelApi OutputIP GET /outputIP Get channel server IP
ChannelApi SetMe POST /me Change user info
ChannelApi SetSettings POST /settings Set settings
MediaApi UploadMedia POST /uploadMedia Upload media & get mediaId
MessagingApi MessagesList GET /messages Get messages list
MessagingApi ReadMessage POST /readMessage Mark message as read
MessagingApi SendContact POST /sendContact Send a Contact
MessagingApi SendFile POST /sendFile Send a File
MessagingApi SendList POST /sendList Send List Message
MessagingApi SendLocation POST /sendLocation Send a Location
MessagingApi SendMessage POST /sendMessage Send a Message
ProductsCatalogsApi SendProduct POST /sendProduct Send a Product
ProductsCatalogsApi SetCommerce POST /commerce Set Commerce Settings
TemplatesApi AddTemplate POST /addTemplate Create template
TemplatesApi RemoveTemplate POST /removeTemplate Remove template
TemplatesApi SendTemplate POST /sendTemplate Send Template Message
TemplatesApi TemplatesList GET /templates Get templates list
WebhooksApi AckHookInfo GET /hookInfo Check ACKs
WebhooksApi SetWebhook POST /webhook Set webhook

<a id="documentation-for-models"></a>

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

token

  • Type: API key
  • API key parameter name: token
  • Location: URL query string
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Framework net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.3 244 10/17/2023
1.0.1 83 10/17/2023
1.0.0 81 10/16/2023

Updated README