C# SDK

最近更新时间:2019-09-23 16:11:16

SDK 功能简介

语音消息 SDK 支持以下操作:

说明:

  • 发送语音验证码
    只需提供验证码数字,如需自定义内容,可以 发送语音通知。例如,当 msg=“5678” 时,您收到的语音通知为您的语音验证码是五六七八。
  • 发送语音通知
    数字默认按照个十百千万进行播报,可通过在数字前添加英文逗号(,)改变播报方式。例如,当 msg=您的语音验证码是5678。 时,您收到的语音通知为您的语音验证码是五千六百七十八。,当 msg=您的语音验证码是5,6,7,8。时,您收到的语音通知为您的语音验证码是五六七八。

SDK 使用指南

相关资料

各个接口及其参数的详情介绍请参见 API 指南SDK 文档错误码

前提条件

在使用 SDK 前,您需要准备以下信息:

  • 获取 SDK AppID 和 App Key
    语音消息应用 SDK AppIDApp Key 可在 语音消息控制台 的应用信息里获取。如您尚未添加应用,请登录语音消息控制台 创建应用
  • 申请模板并确认审核通过
    语音正文内容模板需申请和审核,模板可在 语音消息控制台 的【应用管理】>【语音模板】页面申请,详细申请操作请参见 配置语音模板

配置 SDK

  • nuget:
    要使用 qcloudsms_csharp 功能,只需要在 .nuspec 文件中添加如下依赖:

    <dependencies>
    <dependency id="qcloud.qcloudsms_csharp" version="0.1.5" />
    </dependencies>

    或参考 nuget 官方网站 进行安装。

  • 命令行

    • Package Manager
      Install-Package qcloud.qcloudsms_csharp -Version 0.1.5
    • .NET CLI
      dotnet add package qcloud.qcloudsms_csharp --version 0.1.5
    • Paket CLI
      paket add qcloud.qcloudsms_csharp --version 0.1.5

示例代码

说明:

所有示例代码仅作参考,无法直接编译和运行,需根据实际情况进行修改。

  • 准备必要参数
    // 语音消息应用 SDK AppID
    int appid = 122333333;
    // 语音消息应用 App Key
    string appkey = "9ff91d87c2cd7cd0ea762f141975d1df37481d48700d70ac37470aefc60f9bad";
    // 需要发送语音消息的手机号码
    string[] phoneNumbers = {"21212313123", "12345678902", "12345678903"};
    // 语音模板 ID,需要在语音消息控制台中申请
    int templateId = 7839; // NOTE: 这里的模板 ID`7839`只是示例,真实的模板 ID 需要在语音消息控制台中申请

  • 发送语音验证码
    using qcloudsms_csharp;
    using qcloudsms_csharp.json;
    using qcloudsms_csharp.httpclient;
    using System;
    try
    {
      SmsVoiceVerifyCodeSender vvcsender = new SmsVoiceVerifyCodeSender(appid, appkey);
      var result = vvcsender.send("86", phoneNumbers[0], "09876", 2, "");
      Console.WriteLine(result);
    }
    catch (JSONException e)
    {
      Console.WriteLine(e);
    }
    catch (HTTPException e)
    {
      Console.WriteLine(e);
    }
    catch (Exception e)
    {
      Console.WriteLine(e);
    }

  • 指定模板发送语音通知
    using qcloudsms_csharp;
    using qcloudsms_csharp.json;
    using qcloudsms_csharp.httpclient;
    using System;
    try
    {
      int templateId = 45221;
      string[] parameters = { "5678" };
      TtsVoiceSender tvsender = new TtsVoiceSender(appid, appkey);
      TtsVoiceSenderResult result = tvsender.send("86", phoneNumbers[0],
          templateId, parameters, 2, "");
      Console.WriteLine(result);
    }
    catch (JSONException e)
    {
      Console.WriteLine(e);
    }
    catch (HTTPException e)
    {
      Console.WriteLine(e);
    }
    catch (Exception e)
    {
      Console.WriteLine(e);
    }