企业微信
在接入企业微信之前,建议先根据 快速开始 中的内容了解程序运行和配置的基础流程,企业微信只能使用 docker部署 或 服务器Python部署 两种方式。
一、准备
本项目的企微渠道接入是使用 企业微信应用 的方式,企业微信应用支持企业内部人员单聊使用,无法在群聊中使用或对外使用。企业用户如有企业微信账号(群聊)的使用场景,可查看 LinkAI应用接入。
需要的资源如下:
- 一台服务器 (海外服务器,有国内代理接口的话可使用国内服务器)
- 注册一个企业微信,个人也可以注册,只是无法认证
- 如果是认证的企业微信,还需要一个对应主体备案的域名
二、创建企业微信应用
首先在 企业微信管理后台,点击 "我的企业" 菜单,在最下方可以看到 "企业ID",保存这个id,后续需要填写在配置的 wechatcom_corp_id
字段中。
接下来,切换到 "应用管理" 菜单,点击创建应用:
进入到应用创建页面,记录下页面上显示的 agentld
和 secret
信息:
点击 "设置API接收" 配置应用接口:
- 其中 url 的格式为
http://ip:port/wxcomapp
,如果是认证企业则需要填写备案域名 - 随机获取
Token
和EncodingAESKey
并保存下来,后续需要填写在配置文件中。
此时保存 API接收配置 是无法成功的,因为我们的python程序还没有启动起来,等项目运行后再回来保存。
三、配置和运行程序
企业微信相比个人微信需要增加一些配置,打开 config.json
配置文件,除了 配置说明 中必填的配置外,还需要添加或修改以下配置。各配置项和企业微信后台各参数的对应关系已经在上述截图中说明。
{
"channel_type": "wechatcom_app",
"single_chat_prefix": [""],
"wechatcom_corp_id": "",
"wechatcomapp_token": "",
"wechatcomapp_secret": "",
"wechatcomapp_agent_id": "",
"wechatcomapp_aes_key": "",
"wechatcomapp_port": 9898
}
配置完成后,按 快速开始 中选择的方式启动程序。当后台日志显示 http://0.0.0.0:9898/
的时候就说明程序已经运行成功,监听9898端口了,此时需要将该端口对外开放,比如在云服务器的安全组中放开该端口。
程序启动后就可以回到 企业微信后台 保存 "消息服务器配置" 了,保存成功后还需要将服务器的ip添加到 "企业可信IP" 中,否则是无法收发消息的。
如遇到企业微信后台url设置显示回调不通过或者配置失败,参考下面的解决方案:
- 确保 服务器防火墙关闭 且 安全组放行监听的端口
- 仔细检查token,secret key等参数配置是否一致,后台 url格式配置是否正确
- 对于认证的企业微信需要配置与主体一致的备案域名
四、运行效果
接下来就可以在企业微信中搜索我们刚刚创建的应用名称,直接和应用对话了。如果将项目复制多份,分别监听不同端口,还可以创建多个企微应用,效果如下:
另外,如果想让外部个人微信用户使用,可以在 "我的企业 - 微信插件",分享邀请关注二维码。个人微信扫码点击关注,验证手机号后就可以加入到该公司,并与上面创建的应用对话。