文档首页/ 消息&短信 MSGSMS/ SDK参考/ .NET SDK使用指导
更新时间:2024-10-10 GMT+08:00
分享

.NET SDK使用指导

MSGSMS提供.NET语言的应用侧SDK供开发者使用。本文介绍.NET SDK的安装和配置,及使用.NET SDK调用API参考的示例,您可以参考本章节进行快速集成开发。

开发前准备

  • 注册华为账号并开通华为云,完成企业实名认证
  • 已具备.NET开发环境 ,华为云.NET SDK适用于以下版本:
    • .NET and .NET Core 2.0及以上版本。
    • .NET Framework 4.6.2及以上版本。
  • 已获取华为云账号对应的Access Key(AK)和Secret Access Key(SK)。

    请在华为云控制台“我的凭证 > 访问密钥”页面上创建和查看您的AK/SK。具体请参见访问密钥

安装SDK

使用.NET CLI工具安装SDK。

dotnet add package HuaweiCloud.SDK.Core
dotnet add package HuaweiCloud.SDK.Msgsms

代码示例

以调用创建短信应用接口为例,以下代码示例向您展示使用.NET SDK的主要步骤:

  1. 创建认证。
  2. 创建MsgsmsClient实例并初始化。
  3. 实例化请求对象。
  4. 调用创建短信应用接口。
    using System;
    using System.Collections.Generic;
    using HuaweiCloud.SDK.Core;
    using HuaweiCloud.SDK.Core.Auth;
    using HuaweiCloud.SDK.Msgsms;
    using HuaweiCloud.SDK.Msgsms.V2;
    using HuaweiCloud.SDK.Msgsms.V2.Model;
    
    namespace CreateAppSolution
    {
        class Program
        {
            static void Main(string[] args)
            {
                // 认证用的ak和sk直接写到代码中有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
                // 本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。
                string ak = Environment.GetEnvironmentVariable("CLOUD_SDK_AK");
                string sk = Environment.GetEnvironmentVariable("CLOUD_SDK_SK");
    
                var config = HttpConfig.GetDefaultConfig();
                config.IgnoreSslVerification = true;
                // 创建认证
                var auth = new BasicCredentials(ak, sk);
    
                // 创建MsgsmsClient实例并初始化
                var client = MsgsmsClient.NewBuilder()
                        .WithCredential(auth)
                        .WithRegion(MsgsmsRegion.ValueOf("cn-north-4"))
                        .WithHttpConfig(config)
                        .Build();
    
                // 实例化请求对象
                var req = new CreateAppRequest
                {
                };
                req.Body = new SmsAppAddReq()
                {
                };
    
                try
                {
                    // 调用创建短信应用接口
                    var resp = client.CreateApp(req);
                    var respStatusCode = resp.HttpStatusCode;
                    Console.WriteLine(respStatusCode);
                }
                catch (RequestTimeoutException requestTimeoutException)
                {
                    Console.WriteLine(requestTimeoutException.ErrorMessage);
                }
                catch (ServiceResponseException clientRequestException)
                {
                    Console.WriteLine(clientRequestException.HttpStatusCode);
                    Console.WriteLine(clientRequestException.RequestId);
                    Console.WriteLine(clientRequestException.ErrorCode);
                    Console.WriteLine(clientRequestException.ErrorMsg);
                }
                catch (ConnectionException connectionException)
                {
                    Console.WriteLine(connectionException.ErrorMessage);
                }
            }
        }
    }
    

    参数

    说明

    ak

    您的华为云账号访问密钥ID(Access Key ID)。

    sk

    您的华为云账号秘密访问密钥(Secret Access Key)。

    MsgsmsRegion.ValueOf("cn-north-4")

    请替换为您要访问的MSGSMS平台所在区域,当前MSGSMS支持访问的区域,在SDK代码MsgsmsRegion.cs中已经定义。

    您可以在MSGSMS控制台页面左上角查看当前服务所在区域名称。

    项目源码及更多详细的使用指导请参考华为云.Net软件开发工具包(.Net SDK)

    推荐您使用API在线调试工具API Explorer ,API Explorer支持快速调试和检索,调试API的同时,可以根据您的参数实时生成各种开发语言的SDK示例代码,方便您直接根据示例代码使用SDK。

相关文档