net core WebApi——尝试企业微信内部应用

目录

  • 前言
  • 企业微信
  • 开始
  • 测试
  • 小结

@

前言

这几天忙活着别的东西,耽误了很长时间,从文件操作完了之后就在考虑着下一步鼓捣点儿啥,因为最开始的业务开发就是企业微信相关的,这刚好来做个内部应用的小例子玩玩。

企业微信

前身是企业号,当时微信主推的还是公众号与服务号,后续战略考虑到企业的OA了(当然还是跟某个抢市场),企业号应该是在16年还是具体啥时候出的,刚出的时候也是问题不断一直在修复更新,最近这两年基本上没咋关注企业微信了,也都是偶尔上去看看有没有新东西啊什么的,不过不得不说,在这几年的成长中已经修复逐渐成为一个不错的产品了(大厂的效率还是有的),相对于公众号的开发,为什么我选这个作为例子呢,因为企业微信我可以通过个人来使用(注册的早,现在不清楚注册流程,主要看是否需要企业认证),个人开发者在不论啥时候啥平台都或多或少有些不友好(当然,认证了说明你是个好人,为了信息安全,都懂)。

开始

注册企业微信的流程我就不多说了,直接说注册完成之后,我们来看下这个界面,标注的就是我们需要的关键参数。

记好这个东西之后,我们转到应用管理

这个创建就是你添张图片打个名字而已,不多说,创建完成之后我们来看下图的标记。

记好这两个参数,OK,下来我们就来看API吧,这里我只是介绍下消息推送。
微信等相关的第三方开发大致流程都类似,如下:

  1. 注册账号(这不废话么)
  2. 账号认证(为了权限,当然企业微信内部应用不需要)
  3. 服务域名确定好
  4. AppID、Secret等等的配置(为了accesstoken)
  5. 几乎所有的接口都是先获取accesstoken,相当于你在微信的登录
  6. 根据接口文档来传参啊获取回调啊获取事件等等
  7. 根据返回值来看看错误信息

我这里不做服务端,只是写个示例,需要服务端什么的开发之类的可以给我联系,互相学习。

首先,在我们的Util新建一个类QyThirdUtil(名字感觉起的好没水平,玩游戏止于起名字,别人都10级了,我还在想名字),先把我们需要的配置信息搞了。

        private static string _CorpID = string.Empty;
        private static string _Secret = string.Empty;
        private static string _AgentID = string.Empty;
        /// <summary>
        /// 企业微信id
        /// </summary>
        public static string CorpID
        {
            get
            {
                if (string.IsNullOrEmpty(_CorpID))
                {
                    _CorpID = AprilConfig.Configuration["QyThird:CorpID"];
                }
                return _CorpID;
            }
        }
        /// <summary>
        /// 企业微信应用秘钥
        /// </summary>
        public static string Secret
        {
            get
            {
                if (string.IsNullOrEmpty(_Secret))
                {
                    _Secret = AprilConfig.Configuration["QyThird:Secret"];
                }
                return _Secret;
            }
        }
        /// <summary>
        /// 企业微信应用id
        /// </summary>
        public static string AgentID
        {
            get
            {
                if (string.IsNullOrEmpty(_Secret))
                {
                    _AgentID = AprilConfig.Configuration["QyThird:AgentID"];
                }
                return _AgentID;
            }
        }

然后我们来划分下方法,我们需要获取accesstoken,需要执行发送消息的方法。

        /// <summary>
        /// 获取AccessToken
        /// </summary>
        /// <returns></returns>
        public static string GetAccessToken()
        {
            QyAccessToken accessToken = null;
            bool isGet = false;
            if (CacheUtil.Exists("QyAccessToken"))
            {
                accessToken = CacheUtil.Get<QyAccessToken>("QyAccessToken");
                if (accessToken.Expire_Time >= DateTime.Now.AddMinutes(1))
                {
                    isGet = true;
                }
            }
            if (!isGet)
            {
                string url = $"https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid={CorpID}&corpsecret={Secret}";
                //请求获取
                string res = RequestUtil.HttpGet(url);
                accessToken = JsonConvert.DeserializeObject<QyAccessToken>(res);
                if (accessToken != null && accessToken.ErrCode == 0)
                {
                    accessToken.Expire_Time = DateTime.Now.AddSeconds(accessToken.Expires_In);
                    CacheUtil.Set("QyAccessToken", accessToken, new TimeSpan(2, 0, 0));
                }
                else
                {
                    LogUtil.Error($"获取accesstoken失败——{accessToken.ErrCode},{accessToken.ErrMsg}");
                }
            }

            return accessToken.Access_Token;
        }

这里用到了两个地方,一个是微信端回调的对象实例QyAccessToken,需要的朋友可以在源码里cv,我这里就不贴出来了。

另一个是HttpClient的简单封装请求方法RequestUtil,看了有些博客说HttpClient的生命周期之类的,有推荐直接实例化一个私有静态的,也有做工厂模式创建的,没细究,这块儿要多注意下。

    public class RequestUtil
    {

        /// <summary>
        /// 发起POST同步请求
        /// </summary>
        /// <param name="url">请求地址</param>
        /// <param name="postData">请求数据</param>
        /// <param name="contentType">数据类型</param>
        /// <param name="timeOut">超时时间</param>
        /// <returns></returns>
        public static string HttpPost(string url, string postData = null, string contentType = null, int timeOut = 30)
        {
            if (string.IsNullOrEmpty(postData))
            {
                postData = "";
            }
            using (HttpClient client = new HttpClient())
            {
                client.Timeout = new TimeSpan(0, 0, timeOut);
                using (HttpContent httpContent = new StringContent(postData, Encoding.UTF8))
                {
                    if (contentType != null)
                        httpContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(contentType);

                    HttpResponseMessage response = client.PostAsync(url, httpContent).Result;
                    return response.Content.ReadAsStringAsync().Result;
                }
            }
        }

        /// <summary>
        /// 发起POST异步请求
        /// </summary>
        /// <param name="url">请求地址</param>
        /// <param name="postData">请求数据</param>
        /// <param name="contentType">数据类型</param>
        /// <param name="timeOut">超时时间</param>
        /// <returns></returns>
        public static async Task<string> HttpPostAsync(string url, string postData = null, string contentType = null, int timeOut = 30)
        {
            if (string.IsNullOrEmpty(postData))
            {
                postData = "";
            }
            using (HttpClient client = new HttpClient())
            {
                client.Timeout = new TimeSpan(0, 0, timeOut);
                using (HttpContent httpContent = new StringContent(postData, Encoding.UTF8))
                {
                    if (contentType != null)
                        httpContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(contentType);

                    HttpResponseMessage response = await client.PostAsync(url, httpContent);
                    return await response.Content.ReadAsStringAsync();
                }
            }
        }

        /// <summary>
        /// 发起GET同步请求
        /// </summary>
        /// <param name="url">请求地址</param>
        /// <returns></returns>
        public static string HttpGet(string url)
        {
            using (HttpClient client = new HttpClient())
            {
                return client.GetStringAsync(url).Result;
            }
        }

        /// <summary>
        /// 发起GET异步请求
        /// </summary>
        /// <param name="url">请求地址</param>
        /// <returns></returns>
        public static async Task<string> HttpGetAsync(string url)
        {
            using (HttpClient client = new HttpClient())
            {
                HttpResponseMessage response = await client.GetAsync(url);
                return await response.Content.ReadAsStringAsync();
            }
        }
    }

然后我们来写个发送消息的方法SendMessage,这里我只写了下普通文本推送。

        /// <summary>
        /// 消息推送
        /// </summary>
        /// <param name="content">文本内容</param>
        /// <param name="range">推送范围</param>
        /// <param name="messageType">消息类型</param>
        /// <returns></returns>
        public static bool SendMessage(string content, MessageRange range, AprilEnums.MessageType messageType)
        {
            bool isSend = false;
            if (string.IsNullOrEmpty(content) || content.Length > 2048 || range==null)
            {
                return false;
            }
            string accessToken = GetAccessToken();
            if (string.IsNullOrEmpty(accessToken))
            {
                return false;
            }
            string url = $"https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token={accessToken}";
            StringBuilder data = new StringBuilder();
            bool isVaildRange = false;
            if (range.IsAll)
            {
                data.Append($"\"touser\":\"@all\"");
                isVaildRange = true;
            }
            else
            {
                if (range.Users != null && range.Users.Count > 0)
                {
                    data.AppendFormat("\"touser\" : {0}", GetRangeValue(range.Users));
                    isVaildRange = true;
                }

                if (range.Tags != null && range.Tags.Count > 0)
                {
                    if (data.Length > 0)
                    {
                        data.Append(",");
                    }
                    data.AppendFormat("\"totag\" : {0}", GetRangeValue(range.Tags));
                    isVaildRange = true;
                }

                if (range.Departments != null && range.Departments.Count > 0)
                {
                    if (data.Length > 0)
                    {
                        data.Append(",");
                    }
                    data.AppendFormat("\"totag\" : {0}", GetRangeValue(range.Departments));
                    isVaildRange = true;
                }
            }
            if (!isVaildRange)
            {
                //没有发送范围
                return false;
            }
            data.AppendFormat(",\"msgtype\":\"{0}\"", GetMessageType(messageType));
            data.AppendFormat(",\"agentid\":\"{0}\"", AgentID);
            data.Append(",\"text\": {");
            data.AppendFormat("\"content\":\"{0}\"", content);
            data.Insert(0, "{");
            data.Append("}}");
            LogUtil.Debug($"获取到发送消息请求:{data.ToString()}");
            string res = RequestUtil.HttpPost(url, data.ToString(), "application/json");
            LogUtil.Debug($"获取到发送消息回调:{res}");

            return false;
        }

简单说下消息推送,第一个就是你的推送类型,是普通文本还是啥(文档都有,我这净扯淡),然后就是你的范围,再然后就是你的推送内容了,当然根据不同的推送类型你的内容参数也不同,需要进一步封装的朋友可以去看下API。

测试

我们在控制器中(不再说Values了)加上消息推送的测试,这里的范围可以在你自己的通讯录中查看。

        [HttpGet]
        public ActionResult<IEnumerable<string>> Get()
        {
            //…
            MessageRange range = new MessageRange();
            range.Users = new List<string>();
            range.Users.Add("10001");
            QyThridUtil.SendMessage("我就是来测试", range, AprilEnums.MessageType.Text);
            //…
        }

小结

写到这里基本上都结束了,为什么我特意拿出来企业微信的内部应用来写这篇呢,其实是做下这个消息推送,以后的自己的工程就可以写个这个然后做异常警告之类的东西,这样想想这篇就不是废话了,编程的奇淫技巧(咳咳,乐趣,乐趣)就在于此,代码自己敲,东西自己组,全在于你自己怎么玩了。

原文地址:https://www.cnblogs.com/AprilBlank/p/11447390.html

时间: 2024-10-09 13:31:15

net core WebApi——尝试企业微信内部应用的相关文章

Asp.net Core WebApi 使用Swagger做帮助文档,并且自定义Swagger的UI

WebApi写好之后,在线帮助文档以及能够在线调试的工具是专业化的表现,而Swagger毫无疑问是做Docs的最佳工具,自动生成每个Controller的接口说明,自动将参数解析成json,并且能够在线调试. 那么要讲Swagger应用到Asp.net Core中需要哪些步骤,填多少坑呢? 安装Swagger到项目 { "dependencies": { "Swashbuckle": "6.0.0-beta902", ........ 或者直接通

ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者的心情.或者详细点,或者简单点.那么有没有一种快速有效的方法来构建api说明文档呢?答案是肯定的, Swagger就是最受欢迎的REST APIs文档生成工具之一! 为什么使用Swagger作为REST APIs文档生成工具 Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学

ASP.NET Core WebApi使用Swagger生成api

引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者的心情.或者详细点,或者简单点.那么有没有一种快速有效的方法来构建api说明文档呢?答案是肯定的, Swagger就是最受欢迎的REST APIs文档生成工具之一! 为什么使用Swagger作为REST APIs文档生成工具 Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学

下个小风口?企业微信3.0新版初体验

12月23日,企业微信2019年度发布会在广州举行,发布了企业微信3.0版,相比之前的企业微信更新,这次更新的企业微信是一个非常牛的版本发布. 这一天,关于企业微信的新闻络绎不绝,有人围观热闹,有人撰写稿子,有人研究功能,有人拿来做营销. 其实企业微信很多年前就有了,但一直不温不火.卢松松早在2016年便注册了企业微信,但由于各种限制太多,功能完善方面和钉钉比太差,和个人微信互联互通不好,基本上很多人注册后就没再使用,搁置了. (如图所示,卢松松在2016年便申请了,同时也是服务商) 而这几年随

Asp.Net Core WebApi学习笔记(四)-- Middleware

Asp.Net Core WebApi学习笔记(四)-- Middleware 本文记录了Asp.Net管道模型和Asp.Net Core的Middleware模型的对比,并在上一篇的基础上增加Middleware功能支持. 在演示Middleware功能之前,先要了解一下Asp.Net管道模型发生了什么样的变化. 第一部分:管道模型 1. Asp.Net管道 在之前的Asp.Net里,主要的管道模型流程如下图所示: 请求进入Asp.Net工作进程后,由进程创建HttpWorkRequest对象

如何用php开启企业微信开发的回调模式

猜想: 懵逼 实践: 微信公众号开发的手册中甚至给出了只需要修改几个参数就能使用的范例.企业微信开发中在一个很不显眼的地方放了一个sample. https://work.weixin.qq.com/api/doc#10128 看似很好理解(并不,背后封装了不算简单的加密方法) 获取参数->解密->输出解密后的参数 然而却因为一个函数引用传参知识点的缺失而困扰了许久 public function VerifyURL($sMsgSignature, $sTimeStamp, $sNonce,

钉钉、企业微信等9款协同办公产品互相厮杀,你赌谁赢?

O2O企业的倒闭潮助长了企业服务的发展,在2C市场的短暂失意后,投资人将眼光聚焦在了慢工出细活的2B领域.云服务.大数据成为创业者口中的香饽饽,这样仿佛便可以显得自己更加高级. 其中,在复杂庞大的企业服务市场,基于SaaS的企业不断诞生,将行业变得更加细分与多样化.协同办公是SaaS创业的一大热点,目前该领域已经杀入了不少玩家,不乏BAT.硅谷背景的优秀创业者. 日前,纷享逍客拿到最新一轮融资,并宣布将转型协同办公的消息,令该领域国内的创业者再次沸腾.虽然看好看衰之声参差不齐,但也足以令协同办公

体验了一天企业微信,你的工作以后可能离不开它

你每天看多少次微信?有多少次是为了工作? 微信几乎是今天所有中国人的办公工具,从中小企业到大国企,甚至已经配备了 Skype.Sharepoint 之类办公工具的外企,都将越来越多的日常沟通.公告甚至文件传输放在微信上完成. 而现在的问题是,微信什么都有,而什么时候都得看,你也不知道是工作还是一个无关的推送,这让我们本来就很有限的时间更加零碎了. 最近浮出水面的企业微信,就是一个试图将你工作和生活分开的微信工具.<好奇心日报>拿到内测,我们使用这个工具工作了一天. 来看看未来用微信工作将会是什

一秒教会你破解企业微信虚拟定位位置修改 让你在哪都可以打卡上下班

一秒教会你破解企业微信虚拟定位位置修改  让你在哪都可以打卡上下班 一秒教会你破解企业微信虚拟定位位置修改  让你在哪都可以打卡上下班 一秒教会你破解企业微信虚拟定位位置修改  让你在哪都可以打卡上下班 企业微信除了具有类似微信的聊天功能,另外添加了公费电话和邮件功能.腾讯方面表示,企业微信将免费使用.在OA功能方面,结合了公告.考勤.请假.报销.此外,企业微信添加了如回执消息.休息一下等办公场景功能.企业微信原来是想成为企业内部通信工具,对标钉钉,然而现在很多企业还是在用微信做内部沟通.这一次