【API調用】騰訊雲短信

在之前介紹的火車票查詢工具中，利用郵件和短信將查詢結果推送給用戶。免費短信的條數只有5條，用完之后只能單獨使用郵件提醒。

最近發現騰訊雲的福利，簡單的介紹一下用法。

 

 

 

 

 

 

 

 

 

 

騰訊雲-》產品-》通信服務-》短信-》開通服務-》添加應用-》創建簽名和模板-》等待審核通過-》按照Demo測試

 

 

在整個流程中，最耗時的就是創建簽名和模板，對個人來說只能選擇app、公眾號或小程序的方式進行申請，多虧之前折騰過一點小程序，從而闖關成功。

接下來查看官方Demo https://github.com/qcloudsms/qcloudsms/tree/master/demo/csharp

整理后的測試Demo

調用代碼：

using QcloudSms;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleTest
{
    class SmsSDKDemo
    {
        /// <summary>
        /// appId
        /// </summary>
        private static int appId = 140xxxxx;
        /// <summary>
        /// appKey
        /// </summary>
        private static string appKey = "xxxxxxxxxxxxxxx";
        /// <summary>
        /// 接收手機號
        /// </summary>
        private static string phoneNumber = "xxxxxxxx";
        /// <summary>
        /// 短信模板ID
        /// </summary>
        private static int tmplateId = xxxxxxx;

        static void Main(string[] args)
        {
            try
            {
                SmsSingleSenderResult singleResult;
                SmsSingleSender singleSender = new SmsSingleSender(appId, appKey);

                singleResult = singleSender.Send(SmsType.普通短信, phoneNumber, "");
                Console.WriteLine(singleResult);

                List<string> templParams = new List<string>();
                templParams.Add("G2619");
                templParams.Add("二等座：23 無座：128");
                singleResult = singleSender.SendWithParam(phoneNumber, tmplateId, templParams);
                Console.WriteLine(singleResult);
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            Console.Read();
        }
    }
}

namespace QcloudSms
{
    #region 短信類型枚舉
    /// <summary>
    /// 短信類型枚舉
    /// </summary>
    public enum SmsType
    {
        普通短信 = 0,
        營銷短信 = 1
    }
    #endregion

    #region 單發
    /// <summary>
    /// 單發
    /// </summary>
    class SmsSingleSender
    {
        #region 變量
        /// <summary>
        /// appId
        /// </summary>
        private int appId;
        /// <summary>
        /// appkey
        /// </summary>
        private string appkey;
        /// <summary>
        /// url
        /// </summary>
        private string url = "https://yun.tim.qq.com/v5/tlssmssvr/sendsms";
        /// <summary>
        /// util
        /// </summary>
        private SmsSenderUtil util = new SmsSenderUtil();
        #endregion

        #region 構造
        /// <summary>
        /// 構造函數
        /// </summary>
        /// <param name="sdkappid"></param>
        /// <param name="appkey"></param>
        public SmsSingleSender(int sdkappid, string appkey)
        {
            this.appId = sdkappid;
            this.appkey = appkey;
        }
        #endregion

        #region 普通單發短信接口
        /// <summary>
        /// 普通單發短信接口，明確指定內容，如果有多個簽名，請在內容中以【】的方式添加到信息內容中，否則系統將使用默認簽名
        /// </summary>
        /// <param name="type">短信類型，0 為普通短信，1 營銷短信</param>
        /// <param name="phoneNumber">不帶國家碼的手機號</param>
        /// <param name="msg">信息內容，必須與申請的模板格式一致，否則將返回錯誤</param>
        /// <param name="extend">短信碼號擴展號，格式為純數字串，其他格式無效。默認沒有開通</param>
        /// <param name="ext">服務端原樣返回的參數，可填空</param>
        /// <returns>SmsSingleSenderResult</returns>
        public SmsSingleSenderResult Send(SmsType type, string phoneNumber, string msg, string extend = "", string ext = "")
        {
            long random = util.GetRandom();
            long curTime = util.GetCurTime();

            // 按照協議組織 post 請求包體
            JObject tel = new JObject();
            tel.Add("nationcode", SmsSenderUtil.nationCode);
            tel.Add("mobile", phoneNumber);
            JObject data = new JObject();
            data.Add("tel", tel);
            data.Add("msg", msg);
            data.Add("type", (int)type);
            data.Add("sig", util.StrToHash(string.Format("appkey={0}&random={1}&time={2}&mobile={3}", appkey, random, curTime, phoneNumber)));
            data.Add("time", curTime);
            data.Add("extend", extend);
            data.Add("ext", ext);

            string wholeUrl = url + "?sdkappid=" + appId + "&random=" + random;
            HttpWebRequest request = util.GetPostHttpConn(wholeUrl);
            byte[] requestData = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(data));
            request.ContentLength = requestData.Length;
            Stream requestStream = request.GetRequestStream();
            requestStream.Write(requestData, 0, requestData.Length);
            requestStream.Close();

            // 接收返回包
            HttpWebResponse response = (HttpWebResponse)request.GetResponse();
            Stream responseStream = response.GetResponseStream();
            StreamReader streamReader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            string responseStr = streamReader.ReadToEnd();
            streamReader.Close();
            responseStream.Close();
            SmsSingleSenderResult result;
            if (HttpStatusCode.OK == response.StatusCode)
            {
                result = util.ResponseStrToSingleSenderResult(responseStr);
            }
            else
            {
                result = new SmsSingleSenderResult();
                result.result = -1;
                result.errmsg = "http error " + response.StatusCode + " " + responseStr;
            }
            return result;
        }
        #endregion

        #region 指定模板單發
        /// <summary>
        /// 指定模板單發
        /// </summary>
        /// <param name="phoneNumber">不帶國家碼的手機號</param>
        /// <param name="templId">模板 id</param>
        /// <param name="templParams">模板參數列表，如模板 {1}...{2}...{3}，那么需要帶三個參數</param>
        /// <param name="sign">短信簽名，如果使用默認簽名，該字段可缺省</param>
        /// <param name="extend">擴展碼，可填空</param>
        /// <param name="ext">服務端原樣返回的參數，可填空</param>
        /// <returns>SmsSingleSenderResult</returns>
        public SmsSingleSenderResult SendWithParam(string phoneNumber, int templId, List<string> templParams, string sign = "", string extend = "", string ext = "")
        {
            long random = util.GetRandom();
            long curTime = util.GetCurTime();

            // 按照協議組織 post 請求包體
            JObject tel = new JObject();
            tel.Add("nationcode", SmsSenderUtil.nationCode);
            tel.Add("mobile", phoneNumber);
            JObject data = new JObject();
            data.Add("tel", tel);
            data.Add("sig", util.CalculateSigForTempl(appkey, random, curTime, phoneNumber));
            data.Add("tpl_id", templId);
            data.Add("params", util.SmsParamsToJSONArray(templParams));
            data.Add("sign", sign);
            data.Add("time", curTime);
            data.Add("extend", extend);
            data.Add("ext", ext);

            string wholeUrl = url + "?sdkappid=" + appId + "&random=" + random;
            HttpWebRequest request = util.GetPostHttpConn(wholeUrl);
            byte[] requestData = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(data));
            request.ContentLength = requestData.Length;
            Stream requestStream = request.GetRequestStream();
            requestStream.Write(requestData, 0, requestData.Length);
            requestStream.Close();

            // 接收返回包
            HttpWebResponse response = (HttpWebResponse)request.GetResponse();
            Stream responseStream = response.GetResponseStream();
            StreamReader streamReader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            string responseStr = streamReader.ReadToEnd();
            streamReader.Close();
            responseStream.Close();
            SmsSingleSenderResult result;
            if (HttpStatusCode.OK == response.StatusCode)
            {
                result = util.ResponseStrToSingleSenderResult(responseStr);
            }
            else
            {
                result = new SmsSingleSenderResult();
                result.result = -1;
                result.errmsg = "http error " + response.StatusCode + " " + responseStr;
            }
            return result;
        }
        #endregion
    }
    #endregion

    #region 單發結果
    /// <summary>
    /// 單發結果
    /// </summary>
    class SmsSingleSenderResult
    {
        /// <summary>
        /// 錯誤碼，0 表示成功（計費依據），非 0 表示失敗
        /// </summary>
        public int result { set; get; }
        /// <summary>
        /// 錯誤消息，result 非 0 時的具體錯誤信息
        /// </summary>
        public string errmsg { set; get; }
        /// <summary>
        /// 用戶的 session 內容，騰訊 server 回包中會原樣返回
        /// </summary>
        public string ext { set; get; }
        /// <summary>
        /// 本次發送標識 id，標識一次短信下發記錄
        /// </summary>
        public string sid { set; get; }
        /// <summary>
        /// 短信計費的條數
        /// </summary>
        public int fee { set; get; }
        /// <summary>
        /// ToString()
        /// </summary>
        /// <returns></returns>
        public override string ToString()
        {
            return string.Format("SmsSingleSenderResult\nresult {0}\nerrMsg {1}\next {2}\nsid {3}\nfee {4}", result, errmsg, ext, sid, fee);
        }
    }
    #endregion

    #region 群發
    /// <summary>
    /// 群發
    /// </summary>
    class SmsMultiSender
    {
        #region 變量
        /// <summary>
        /// appId
        /// </summary>
        private int appId;
        /// <summary>
        /// appkey
        /// </summary>
        private string appkey;
        /// <summary>
        /// url
        /// </summary>
        private string url = "https://yun.tim.qq.com/v5/tlssmssvr/sendmultisms2";
        /// <summary>
        /// util
        /// </summary>
        private SmsSenderUtil util = new SmsSenderUtil();
        #endregion

        #region 構造
        /// <summary>
        /// 構造
        /// </summary>
        /// <param name="sdkappid"></param>
        /// <param name="appkey"></param>
        public SmsMultiSender(int sdkappid, string appkey)
        {
            this.appId = sdkappid;
            this.appkey = appkey;
        }
        #endregion

        #region 普通群發短信接口
        /// <summary>
        /// 普通群發短信接口，明確指定內容，如果有多個簽名，請在內容中以【】的方式添加到信息內容中，否則系統將使用默認簽名
        ///【注意】 海外短信無群發功能
        /// </summary>
        /// <param name="type">短信類型，0 為普通短信，1 營銷短信</param>
        /// <param name="nationCode"></param>
        /// <param name="phoneNumbers">不帶國家碼的手機號列表</param>
        /// <param name="msg">信息內容，必須與申請的模板格式一致，否則將返回錯誤</param>
        /// <param name="extend">擴展碼，可填空</param>
        /// <param name="ext">服務端原樣返回的參數，可填空</param>
        /// <returns>SmsMultiSenderResult</returns>
        public SmsMultiSenderResult Send(SmsType type, List<string> phoneNumbers, string msg, string extend = "", string ext = "")
        {
            long random = util.GetRandom();
            long curTime = util.GetCurTime();

            // 按照協議組織 post 請求包體
            JObject data = new JObject();
            data.Add("tel", util.PhoneNumbersToJSONArray(SmsSenderUtil.nationCode, phoneNumbers));
            data.Add("type", (int)type);
            data.Add("msg", msg);
            data.Add("sig", util.CalculateSig(appkey, random, curTime, phoneNumbers));
            data.Add("time", curTime);
            data.Add("extend", extend);
            data.Add("ext", ext);

            string wholeUrl = url + "?sdkappid=" + appId + "&random=" + random;
            HttpWebRequest request = util.GetPostHttpConn(wholeUrl);
            byte[] requestData = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(data));
            request.ContentLength = requestData.Length;
            Stream requestStream = request.GetRequestStream();
            requestStream.Write(requestData, 0, requestData.Length);
            requestStream.Close();

            // 接收返回包
            HttpWebResponse response = (HttpWebResponse)request.GetResponse();
            Stream responseStream = response.GetResponseStream();
            StreamReader streamReader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            string responseStr = streamReader.ReadToEnd();
            streamReader.Close();
            responseStream.Close();
            SmsMultiSenderResult result;
            if (HttpStatusCode.OK == response.StatusCode)
            {
                result = util.ResponseStrToMultiSenderResult(responseStr);
            }
            else
            {
                result = new SmsMultiSenderResult();
                result.result = -1;
                result.errmsg = "http error " + response.StatusCode + " " + responseStr;
            }
            return result;
        }
        #endregion

        #region 指定模板群發
        /// <summary>
        /// 指定模板群發
        /// 【注意】海外短信無群發功能
        /// </summary>
        /// <param name="phoneNumbers">不帶國家碼的手機號列表</param>
        /// <param name="templId"> 模板 id</param>
        /// <param name="templParams">模板參數列表</param>
        /// <param name="sign"> 簽名，如果填空，系統會使用默認簽名</param>
        /// <param name="extend">擴展碼，可以填空</param>
        /// <param name="ext">服務端原樣返回的參數，可以填空</param>
        /// <returns> SmsMultiSenderResult</returns>
        public SmsMultiSenderResult SendWithParam(List<string> phoneNumbers, int templId, List<string> templParams, string sign = "", string extend = "", string ext = "")
        {
            long random = util.GetRandom();
            long curTime = util.GetCurTime();

            // 按照協議組織 post 請求包體
            JObject data = new JObject();
            data.Add("tel", util.PhoneNumbersToJSONArray(SmsSenderUtil.nationCode, phoneNumbers));
            data.Add("sig", util.CalculateSigForTempl(appkey, random, curTime, phoneNumbers));
            data.Add("tpl_id", templId);
            data.Add("params", util.SmsParamsToJSONArray(templParams));
            data.Add("sign", sign);
            data.Add("time", curTime);
            data.Add("extend", extend);
            data.Add("ext", ext);

            string wholeUrl = url + "?sdkappid=" + appId + "&random=" + random;
            HttpWebRequest request = util.GetPostHttpConn(wholeUrl);
            byte[] requestData = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(data));
            request.ContentLength = requestData.Length;
            Stream requestStream = request.GetRequestStream();
            requestStream.Write(requestData, 0, requestData.Length);
            requestStream.Close();

            // 接收返回包
            HttpWebResponse response = (HttpWebResponse)request.GetResponse();
            Stream responseStream = response.GetResponseStream();
            StreamReader streamReader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            string responseStr = streamReader.ReadToEnd();
            streamReader.Close();
            responseStream.Close();
            SmsMultiSenderResult result;
            if (HttpStatusCode.OK == response.StatusCode)
            {
                result = util.ResponseStrToMultiSenderResult(responseStr);
            }
            else
            {
                result = new SmsMultiSenderResult();
                result.result = -1;
                result.errmsg = "http error " + response.StatusCode + " " + responseStr;
            }
            return result;
        }
        #endregion
    }
    #endregion

    #region 群發結果
    /// <summary>
    /// 群發結果
    /// </summary>
    class SmsMultiSenderResult
    {
        public class Detail
        {
            /// <summary>
            /// 錯誤碼，0 表示成功（計費依據），非 0 表示失敗
            /// </summary>
            public int result { get; set; }
            /// <summary>
            /// 錯誤消息，result 非 0 時的具體錯誤信息
            /// </summary>
            public string errmsg { get; set; }
            /// <summary>
            /// 手機號碼
            /// </summary>
            public string mobile { get; set; }
            /// <summary>
            /// 國家碼
            /// </summary>
            public string nationcode { get; set; }
            /// <summary>
            /// 本次發送標識 id，標識一次短信下發記錄
            /// </summary>
            public string sid { get; set; }
            /// <summary>
            /// 短信計費的條數
            /// </summary>
            public int fee { get; set; }
            /// <summary>
            /// ToString()
            /// </summary>
            /// <returns></returns>
            public override string ToString()
            {
                return string.Format(
                        "\tDetail result {0} errmsg {1} mobile {2} nationcode {3} sid {4} fee {5}",
                        result, errmsg, mobile, nationcode, sid, fee);
            }
        }

        public int result;
        public string errmsg = "";
        public string ext = "";
        public IList<Detail> detail;

        public override string ToString()
        {
            if (null != detail)
            {
                return String.Format(
                        "SmsMultiSenderResult\nresult {0}\nerrmsg {1}\next {2}\ndetail:\n{3}",
                        result, errmsg, ext, String.Join("\n", detail));
            }
            else
            {
                return String.Format(
                     "SmsMultiSenderResult\nresult {0}\nerrmsg {1}\next {2}\n",
                     result, errmsg, ext);
            }
        }
    }
    #endregion

    #region 公共類
    /// <summary>
    /// 公共類
    /// </summary>
    class SmsSenderUtil
    {
        /// <summary>
        /// 國家碼
        /// </summary>
        public static string nationCode = "86";
        /// <summary>
        /// 隨機數生成器
        /// </summary>
        private Random random = new Random();

        #region GetPostHttpConn
        /// <summary>
        /// GetPostHttpConn
        /// </summary>
        /// <param name="url"></param>
        /// <returns></returns>
        public HttpWebRequest GetPostHttpConn(string url)
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
            request.Method = "POST";
            request.ContentType = "application/x-www-form-urlencoded";
            return request;
        }
        #endregion

        #region 生成隨機數
        /// <summary>
        /// 生成隨機數
        /// </summary>
        /// <returns></returns>
        public long GetRandom()
        {
            return random.Next(999999) % 900000 + 100000;
        }
        #endregion

        #region 獲取請求發起時間
        /// <summary>
        /// 獲取請求發起時間，
        /// unix 時間戳（單位：秒），如果和系統時間相差超過 10 分鍾則會返回失敗
        /// </summary>
        /// <returns></returns>
        public long GetCurTime()
        {
            Int32 unixTimestamp = (Int32)(DateTime.UtcNow.Subtract(new DateTime(1970, 1, 1))).TotalSeconds;
            return unixTimestamp;
        }
        #endregion

        #region 字符串轉SHA256
        /// <summary>
        /// 字符串轉SHA256
        /// </summary>
        /// <param name="str"></param>
        /// <returns></returns>
        public string StrToHash(string str)
        {
            SHA256 sha256 = SHA256Managed.Create();
            byte[] resultByteArray = sha256.ComputeHash(System.Text.Encoding.UTF8.GetBytes(str));
            return ByteArrayToHex(resultByteArray);
        }

        /// <summary>
        /// 將二進制的數值轉換為 16 進制字符串，如 "abc" => "616263"
        /// </summary>
        /// <param name="byteArray"></param>
        /// <returns></returns>
        private static string ByteArrayToHex(byte[] byteArray)
        {
            string returnStr = "";
            if (byteArray != null)
            {
                for (int i = 0; i < byteArray.Length; i++)
                {
                    returnStr += byteArray[i].ToString("x2");
                }
            }
            return returnStr;
        }
        #endregion

        #region 將單發回包解析成結果對象
        /// <summary>
        /// 將單發回包解析成結果對象
        /// </summary>
        /// <param name="str"></param>
        /// <returns></returns>
        public SmsSingleSenderResult ResponseStrToSingleSenderResult(string str)
        {
            SmsSingleSenderResult result = JsonConvert.DeserializeObject<SmsSingleSenderResult>(str);
            return result;
        }
        #endregion

        #region 將群發回包解析成結果對象
        /// <summary>
        /// 將群發回包解析成結果對象
        /// </summary>
        /// <param name="str"></param>
        /// <returns></returns>
        public SmsMultiSenderResult ResponseStrToMultiSenderResult(string str)
        {
            SmsMultiSenderResult result = JsonConvert.DeserializeObject<SmsMultiSenderResult>(str);
            return result;
        }
        #endregion

        #region List<string>轉JArray
        /// <summary>
        /// List<string>轉JArray
        /// </summary>
        /// <param name="templParams"></param>
        /// <returns></returns>
        public JArray SmsParamsToJSONArray(List<string> templParams)
        {
            JArray smsParams = new JArray();
            foreach (string templParamsElement in templParams)
            {
                smsParams.Add(templParamsElement);
            }
            return smsParams;
        }
        #endregion

        #region PhoneNumbersToJSONArray
        /// <summary>
        /// PhoneNumbersToJSONArray
        /// </summary>
        /// <param name="nationCode"></param>
        /// <param name="phoneNumbers"></param>
        /// <returns></returns>
        public JArray PhoneNumbersToJSONArray(string nationCode, List<string> phoneNumbers)
        {
            JArray tel = new JArray();
            int i = 0;
            do
            {
                JObject telElement = new JObject();
                telElement.Add("nationcode", nationCode);
                telElement.Add("mobile", phoneNumbers.ElementAt(i));
                tel.Add(telElement);
            } while (++i < phoneNumbers.Count);
            return tel;
        }
        #endregion

        #region 計算App憑證
        /*
         "sig" 字段根據公式 sha256（appkey=$appkey&random=$random&time=$time&mobile=$mobile）生成
         */
        public string CalculateSigForTempl(string appkey, long random, long curTime, List<string> phoneNumbers)
        {
            string phoneNumbersString = phoneNumbers.ElementAt(0);
            for (int i = 1; i < phoneNumbers.Count; i++)
            {
                phoneNumbersString += "," + phoneNumbers.ElementAt(i);
            }
            return StrToHash(String.Format(
                "appkey={0}&random={1}&time={2}&mobile={3}",
                appkey, random, curTime, phoneNumbersString));
        }

        public string CalculateSigForTempl(string appkey, long random, long curTime, string phoneNumber)
        {
            List<string> phoneNumbers = new List<string>();
            phoneNumbers.Add(phoneNumber);
            return CalculateSigForTempl(appkey, random, curTime, phoneNumbers);
        }

        public string CalculateSig(string appkey, long random, long curTime, List<string> phoneNumbers)
        {
            string phoneNumbersString = phoneNumbers.ElementAt(0);
            for (int i = 1; i < phoneNumbers.Count; i++)
            {
                phoneNumbersString += "," + phoneNumbers.ElementAt(i);
            }
            return StrToHash(String.Format(
                    "appkey={0}&random={1}&time={2}&mobile={3}",
                    appkey, random, curTime, phoneNumbersString));
        }
        #endregion
    }
    #endregion
}

demo下載路徑為：https://files.cnblogs.com/files/LikeHeart/ConsoleTest.zip