企業微信開發之發放企業紅包(C#)

1、企業微信API

地址:http://work.weixin.qq.com/api/doc#11543node

2、參數說明

一、發送企業紅包

請求方式:POST(HTTPS)
請求地址:https://api.mch.weixin.qq.com/mmpaymkttransfers/sendworkwxredpack
是否須要證書:是
數據格式:xmlgit

具體參數說明請參見API接口文檔github

二、具體實現代碼

WxPayData data = new WxPayData();
data.SetValue("nonce_str", WxPayApi.GenerateNonceStr());                                //隨機字符串
data.SetValue("mch_billno", WxPayApi.GenerateOutTradeNo());                  //商戶訂單號
data.SetValue("mch_id", WxPayConfig.MCHID);                           //商戶號
data.SetValue("wxappid", WxPayConfig.APPID);                          //公衆帳號ID
data.SetValue("sender_name", "ly");                                  //發送者名稱
data.SetValue("sender_header_media_id", "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0"); //發送者頭像,此id爲微信默認的頭像(若是想自定義頭像,請參見第三部分)
string openid = ConvertToOpenidByUserId(_accessToken,"13212345678");  
var openInfo =  JsonConvert.DeserializeObject<U_OpenInfo>(openid);
data.SetValue("re_openid", openInfo.openid);                            //用戶openid   
data.SetValue("total_amount", 100);                                     //付款金額,單位分  最低一元錢
data.SetValue("wishing", "七夕情人節快樂!");                             //紅包祝福語
data.SetValue("act_name", "XX活動");                                    //活動名稱
data.SetValue("remark", "快來搶");                                    //備註
data.SetValue("scene_id", "PRODUCT_4");                                 //場景(金額大於200元時必填)
data.SetValue("workwx_sign", data.MakeWorkWxSign("redPacket"));                 //企業微信簽名
data.SetValue("sign", data.MakeSign());                                         //微信支付簽名
string xml = data.ToXml();
const string postUrl = "https://api.mch.weixin.qq.com/mmpaymkttransfers/sendworkwxredpack";  //發送企業紅包接口地址
string response = PostWebRequest(postUrl, xml, Encoding.UTF8, true);                         //調用HTTP通訊接口提交數據到API
WxPayData result = new WxPayData();
result.FromXml(response);
 
public class WxPayData
{
    //採用排序的Dictionary的好處是方便對數據包進行簽名,不用再簽名以前再作一次排序
    private SortedDictionary<string, object> m_values = new SortedDictionary<string, object>();

    /// <summary>
    /// 設置某個字段的值
    /// </summary>
    /// <param name="key">字段名</param>
    /// <param name="value">字段值</param>
    public void SetValue(string key, object value)
    {
        m_values[key] = value;
    }

    /// <summary>
    /// 根據字段名獲取某個字段的值
    /// </summary>
    /// <param name="key">字段名</param>
    /// <returns>對應的字段值</returns>
    public object GetValue(string key)
    {
        object o = null;
        m_values.TryGetValue(key, out o);
        return o;
    }

    /// <summary>
    /// 判斷某個字段是否已設置
    /// </summary>
    /// <param name="key">字段名</param>
    /// <returns>若字段key已被設置,則返回true,不然返回false</returns>
    public bool IsSet(string key)
    {
        object o = null;
        m_values.TryGetValue(key, out o);
        if (null != o)
            return true;
        else
            return false;
    }
    /// <summary>
    /// 將Dictionary轉成xml
    /// </summary>
    /// <returns>經轉換獲得的xml串</returns>
    public string ToXml()
    {
        //數據爲空時不能轉化爲xml格式
        if (0 == m_values.Count)
        {
            LogHelper.LogHelper.WriteLog("WxPayData數據爲空!");
            throw new WxPayException("WxPayData數據爲空!");
        }

        string xml = "<xml>";
        foreach (KeyValuePair<string, object> pair in m_values)
        {
            //字段值不能爲null,會影響後續流程
            if (pair.Value == null)
            {
                LogHelper.LogHelper.WriteLog("WxPayData內部含有值爲null的字段!" + pair.Key + ":" + pair.Value);
                throw new WxPayException("WxPayData內部含有值爲null的字段!");
            }

            if (pair.Value is int)
            {
                xml += "<" + pair.Key + ">" + pair.Value + "</" + pair.Key + ">";
            }
            else if (pair.Value is string)
            {
                xml += "<" + pair.Key + ">" + "<![CDATA[" + pair.Value + "]]></" + pair.Key + ">";
            }
            else//除了string和int類型不能含有其餘數據類型
            {
                LogHelper.LogHelper.WriteLog("WxPayData字段數據類型錯誤!");
                throw new WxPayException("WxPayData字段數據類型錯誤!");
            }
        }
        xml += "</xml>";
        return xml;
    }

    /// <summary>
    /// 將xml轉爲WxPayData對象並返回對象內部的數據
    /// </summary>
    /// <param name="xml">待轉換的xml串</param>
    /// <returns>經轉換獲得的Dictionary</returns>
    public SortedDictionary<string, object> FromXml(string xml)
    {
        if (string.IsNullOrEmpty(xml))
        {
            LogHelper.LogHelper.WriteLog("將空的xml串轉換爲WxPayData不合法!");
            throw new WxPayException("將空的xml串轉換爲WxPayData不合法!");
        }

        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.LoadXml(xml);
        XmlNode xmlNode = xmlDoc.FirstChild;//獲取到根節點<xml>
        XmlNodeList nodes = xmlNode.ChildNodes;
        foreach (XmlNode xn in nodes)
        {
            XmlElement xe = (XmlElement)xn;
            m_values[xe.Name] = xe.InnerText;//獲取xml的鍵值對到WxPayData內部的數據中
        }

        try
        {
            //2015-06-29 錯誤是沒有簽名
            if (m_values["return_code"].ToString() != "SUCCESS")
            {
                return m_values;
            }
            CheckSign();//驗證簽名,不經過會拋異常
        }
        catch (WxPayException ex)
        {
            throw new WxPayException(ex.Message);
        }

        return m_values;
    }

    /// <summary>
    /// 將xml轉爲WxPayData對象並返回對象內部的數據
    /// </summary>
    /// <param name="xml">待轉換的xml串</param>
    /// <returns>經轉換獲得的Dictionary</returns>
    public SortedDictionary<string, object> XmlToEntity(string xml)
    {
        if (string.IsNullOrEmpty(xml))
        {
            LogHelper.LogHelper.WriteLog("將空的xml串轉換爲WxPayData不合法!");
            throw new WxPayException("將空的xml串轉換爲WxPayData不合法!");
        }

        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.LoadXml(xml);
        XmlNode xmlNode = xmlDoc.FirstChild;//獲取到根節點<xml>
        XmlNodeList nodes = xmlNode.ChildNodes;
        foreach (XmlNode xn in nodes)
        {
            XmlElement xe = (XmlElement)xn;
            m_values[xe.Name] = xe.InnerText;//獲取xml的鍵值對到WxPayData內部的數據中
        }

        try
        {
            //2015-06-29 錯誤是沒有簽名
            if (m_values["return_code"].ToString() != "SUCCESS")
            {
                return m_values;
            }
            // CheckSign();//驗證簽名,不經過會拋異常
        }
        catch (WxPayException ex)
        {
            throw new WxPayException(ex.Message);
        }

        return m_values;
    }

    /// <summary>
    /// Dictionary格式轉化成url參數格式
    /// </summary>
    /// <returns>url格式串, 該串不包含sign字段值</returns>
    public string ToUrl()
    {
        string buff = "";
        foreach (KeyValuePair<string, object> pair in m_values)
        {
            if (pair.Value == null)
            {
                LogHelper.LogHelper.WriteLog("WxPayData內部含有值爲null的字段!" + pair.Key + ":" + pair.Value);
                throw new WxPayException("WxPayData內部含有值爲null的字段!");
            }

            if (pair.Key != "sign" && pair.Value.ToString() != "")
            {
                buff += pair.Key + "=" + pair.Value + "&";
            }
        }
        buff = buff.Trim('&');
        return buff;
    }

    /// <summary>
    /// 生成簽名,詳見簽名生成算法
    /// </summary>
    /// <returns>簽名, sign字段不參加簽名</returns>
    public string MakeSign()
    {
        //轉url格式
        string str = ToUrl();
        //在string後加入API KEY
        str += "&key=" + WxPayConfig.KEY;
        //MD5加密
        var md5 = MD5.Create();
        var bs = md5.ComputeHash(Encoding.UTF8.GetBytes(str));
        var sb = new StringBuilder();
        foreach (byte b in bs)
        {
            sb.Append(b.ToString("x2"));
        }
        //全部字符轉爲大寫
        return sb.ToString().ToUpper();
    }

    /// <summary>
    /// 檢測簽名是否正確
    /// </summary>
    /// <returns>正確返回true,錯誤拋異常</returns>
    public bool CheckSign()
    {
        //若是沒有設置簽名,則跳過檢測
        if (!IsSet("sign"))
        {
            LogHelper.LogHelper.WriteLog("WxPayData簽名存在但不合法!");
            throw new WxPayException("WxPayData簽名存在但不合法!");
        }
        //若是設置了簽名可是簽名爲空,則拋異常
        else if (GetValue("sign") == null || GetValue("sign").ToString() == "")
        {
            LogHelper.LogHelper.WriteLog("WxPayData簽名存在但不合法!");
            throw new WxPayException("WxPayData簽名存在但不合法!");
        }

        //獲取接收到的簽名
        string return_sign = GetValue("sign").ToString();

        //在本地計算新的簽名
        string cal_sign = MakeSign();

        if (cal_sign == return_sign)
        {
            return true;
        }

        LogHelper.LogHelper.WriteLog("WxPayData簽名驗證錯誤!");
        throw new WxPayException("WxPayData簽名驗證錯誤!");
    }

    /// <summary>
    /// 獲取Dictionary
    /// </summary>
    /// <returns></returns>
    public SortedDictionary<string, object> GetValues()
    {
        return m_values;
    }
}
WxPayData類

 

public class WxPayException:Exception
{
    public WxPayException(string msg)
        : base(msg)
    {

    }
}
WxPayException類

 

public class WxPayApi
{
    protected Hashtable Parameters = new Hashtable();
    /// <summary>
    /// 根據當前系統時間加隨機序列來生成訂單號
    /// </summary>
    /// <returns>@return 訂單號</returns>
    public static string GenerateOutTradeNo()
    {
        var ran = new Random();
        return string.Format("{0}{1:yyyyMMddHHmmss}{2}", WxPayConfig.MCHID, DateTime.Now, ran.Next(999));
    }


    /// <summary>
    /// 生成時間戳,標準北京時間,時區爲東八區,自1970年1月1日 0點0分0秒以來的秒數
    /// </summary>
    /// <returns>@return 時間戳</returns>
    public static string GenerateTimeStamp()
    {
        TimeSpan ts = DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0);
        return Convert.ToInt64(ts.TotalSeconds).ToString();
    }

    /// <summary>
    /// 生成隨機串,隨機串包含字母或數字
    /// </summary>
    /// <returns> @return 隨機串</returns>
    public static string GenerateNonceStr()
    {
        //Random random = new Random();
        //return GetMD5(random.Next(1000).ToString(), "GBK");
         return Guid.NewGuid().ToString().Replace("-", "");
    }
    /// <summary>
    /// 獲取md5加密字符串
    /// </summary>
    /// <param name="encypStr"></param>
    /// <param name="charset"></param>
    /// <returns></returns>
    protected static string GetMD5(string encypStr, string charset)
    {
        byte[] bytes;
        //建立md5對象
        MD5CryptoServiceProvider provider = new MD5CryptoServiceProvider();
        //使用GB2312編碼方式把字符串轉化爲字節數組.
        try
        {
            bytes = Encoding.GetEncoding(charset).GetBytes(encypStr);
        }
        catch (Exception)
        {
            bytes = Encoding.GetEncoding("GB2312").GetBytes(encypStr);
        }
        return BitConverter.ToString(provider.ComputeHash(bytes)).Replace("-", "").ToUpper();
    }
  
 protected void SetParameter(string parameter, string parameterValue)
        {
            if (!string.IsNullOrEmpty(parameter))
            {
                if (this.Parameters.Contains(parameter))
                {
                    this.Parameters.Remove(parameter);
                }
                this.Parameters.Add(parameter, parameterValue);
            }
        }

}
WxPayApi類

 

public class WxPayConfig
 {

        //=======【基本信息設置】=====================================
        /* 微信公衆號信息配置
        * APPID:綁定支付的APPID(必須配置)
        * MCHID:商戶號(必須配置)
        * KEY:商戶支付密鑰,參考開戶郵件設置(必須配置)
        * APPSECRET:公衆賬號secert(僅JSAPI支付的時候須要配置)
        */
        public static readonly string APPID = "111111111111";  //所有寫你本身的

        public static readonly string APPSECRET = "111111";

        public static readonly string PAYMENTSECRET ="111111";

        public static readonly string MCHID = "111111";    //商戶id號

        public static readonly string KEY = "111111111111";


        //=======【證書路徑設置】===================================== 
        /* 證書路徑,注意應該填寫絕對路徑(僅退款、撤銷訂單時須要)
        */
        public static readonly string SSLCERT_PATH = "cert/apiclient_cert.p12";
        public static readonly string SSLCERT_PASSWORD =MCHID ;
  
}
WxPayConfig類

三、注意事項

(1)計算企業微信簽名算法

字符串最後拼的secret是企業微信管理端支付應用頁面的secret(見下圖)c#

而不是企業微信的secret。(以下圖)切記!!!api

(2)仍是計算企業微信簽名數組

發紅包ap有且僅有以下幾個字段參與簽名(這點代碼裏有體現):
  act_name
  mch_billno
  mch_id
  nonce_str
  re_openid
  total_amount
  wxappid微信

不要將參數所有參與計算簽名,不然會返回微信簽名錯誤!app

3、上傳臨時素材

一、在發紅包的API接口中有一個參數爲"sender_header_media_id"即發送者頭像,能夠經過企業微信開放上傳素材接口獲取

請求方式:POST(HTTPS)
請求地址:https://qyapi.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPEdom

使用http multipart/form-data上傳文件, 文件標識名爲」media」.
參數說明:

參數 必須 說明
access_token 調用接口憑證
type 媒體文件類型,分別有圖片(image)、語音(voice)、視頻(video),普通文件(file)
media form-data中媒體文件標識,有filename、filelength、content-type等信息

權限說明:徹底公開,media_id在同一企業內應用之間能夠共享。

返回數據:

{
   "errcode": 0,
   "errmsg": """type": "image",
   "media_id": "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0",
   "created_at": "1380000000"
}

二、具體實現

/// <summary>
/// 上傳臨時素材
/// </summary>
/// <param name="filePath"></param>
/// <returns></returns>
public string UploadTempResource(string filePath)
{
    const string url = "https://qyapi.weixin.qq.com/cgi-bin/media/upload?access_token={0}&type=image";
    var uploadUrl = string.Format(url, _accessToken);
    var mediaId = "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0";
    using (var client = new WebClient())
    {
        var cm = CacheManager<string>.GetInstance();
        if (cm.Get("media_id") == null)
        {
            byte[] resource = client.UploadFile(new Uri(uploadUrl), filePath);
            string retdata = Encoding.UTF8.GetString(resource);
            var data = JsonConvert.DeserializeObject(retdata) as JObject;
            if (data != null)
            {
                mediaId = data["media_id"].ToString();
                cm.Add("media_id", mediaId, 3 * 24 * 3600);
            }
        }
        return mediaId;
    }
}

4、實現效果

 

有須要的能夠下載源碼

相關文章
相關標籤/搜索