企业微信机器人配置说明

1. 如何使用群机器人

  • 在终端某个群组添加机器人之后,创建者可以在机器人详情页看的该机器人特有的webhookurl。开发者可以按以下说明a向这个地址发起HTTP POST 请求,即可实现给该群组发送消息。下面举个简单的例子.
    假设webhook是:https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=

特别特别要注意:一定要保护好机器人的webhook地址,避免泄漏!不要分享到github、博客等可被公开查阅的地方,否则坏人就可以用你的机器人来发垃圾消息了。

以下是用curl工具往群组推送文本消息的示例(注意要将url替换成你的机器人webhook地址,content必须是utf8编码):

curl 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=' \
   -H 'Content-Type: application/json' \
   -d '
   {
        "msgtype": "text",
        "text": {
            "content": "hello world"
        }
   }'

  • 当前自定义机器人支持文本(text)、markdown(markdown)、图片(image)、图文(news)四种消息类型。
  • 机器人的text/markdown类型消息支持在content中使用<@userid>扩展语法来@群成员

2. 消息类型及数据格式

 1)文本类型
{
    "msgtype": "text",
    "text": {
        "content": "广州今日天气:29度,大部分多云,降雨概率:60%",
        "mentioned_list":["wangqing","@all"],
        "mentioned_mobile_list":["13800001111","@all"]
    }
}
参数是否必填说明
msgtype消息类型,此时固定为text
content文本内容,最长不超过2048个字节,必须是utf8编码
mentioned_listuserid的列表,提醒群中的指定成员(@某个成员),@all表示提醒所有人,如果开发者获取不到userid,可以使用mentioned_mobile_list
mentioned_mobile_list手机号列表,提醒手机号对应的群成员(@某个成员),@all表示提醒所有人

2) markdown类型
{
    "msgtype": "markdown",
    "markdown": {
        "content": "实时新增用户反馈<font color=\"warning\">132例</font>,请相关同事注意。\n
         >类型:<font color=\"comment\">用户反馈</font>
         >普通用户反馈:<font color=\"comment\">117例</font>
         >VIP用户反馈:<font color=\"comment\">15例</font>"
    }
}
参数是否必填说明
msgtype消息类型,此时固定为markdown
contentmarkdown内容,最长不超过4096个字节,必须是utf8编码

 

 3) 目前支持的markdown语法是如下的子集:

a. 标题 (支持1至6级标题,注意#与文字中间要有空格)

  1. # 标题一
  2. ## 标题二
  3. ### 标题三
  4. #### 标题四
  5. ##### 标题五
  6. ###### 标题六

b. 加粗

**bold**

 c. 链接

[这是一个链接](http://work.weixin.qq.com/api/doc)

d. 行内代码段(暂不支持跨行)

 `code`

e. 引用

> 引用文字 

f. 字体颜色(只支持3种内置颜色

<font color="info">绿色</font>

<font color="comment">灰色</font>

<font color="warning">橙红色</font> 

4) 图片类型
{
    "msgtype": "image",
    "image": {
        "base64": "DATA",
        "md5": "MD5"
    }
}
参数是否必填说明
msgtype消息类型,此时固定为image
base64图片内容的base64编码
md5图片内容(base64编码前)的md5值

注:图片(base64编码前)最大不能超过2M,支持JPG,PNG格式 

 5) 图文类型
{
    "msgtype": "news",
    "news": {
       "articles" : [
           {
               "title" : "中秋节礼品领取",
               "description" : "今年中秋节公司有豪礼相送",
               "url" : "www.qq.com",
               "picurl" : "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"
           }
        ]
    }
}
参数是否必填说明
msgtype消息类型,此时固定为news
articles图文消息,一个图文消息支持1到8条图文
title标题,不超过128个字节,超过会自动截断
description描述,不超过512个字节,超过会自动截断
url点击后跳转的链接。
picurl图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图 1068*455,小图150*150。

 6) 文件类型
{
    "msgtype": "file",
    "file": {
         "media_id": "3a8asd892asd8asd"
    }
}

参数是否必填说明
msgtype消息类型,此时固定为file
media_id文件id,通过下文的文件上传接口获取

 7) 模版卡片类型
a. 文本通知模版卡片

{
    "msgtype":"template_card",
    "template_card":{
        "card_type":"text_notice",
        "source":{
            "icon_url":"https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0",
            "desc":"企业微信",
            "desc_color":0
        },
        "main_title":{
            "title":"欢迎使用企业微信",
            "desc":"您的好友正在邀请您加入企业微信"
        },
        "emphasis_content":{
            "title":"100",
            "desc":"数据含义"
        },
        "quote_area":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH",
            "title":"引用文本标题",
            "quote_text":"Jack:企业微信真的很好用~\nBalian:超级好的一款软件!"
        },
        "sub_title_text":"下载企业微信还能抢红包!",
        "horizontal_content_list":[
            {
                "keyname":"邀请人",
                "value":"张三"
            },
            {
                "keyname":"企微官网",
                "value":"点击访问",
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi"
            },
            {
                "keyname":"企微下载",
                "value":"企业微信.apk",
                "type":2,
                "media_id":"MEDIAID"
            }
        ],
        "jump_list":[
            {
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi",
                "title":"企业微信官网"
            },
            {
                "type":2,
                "appid":"APPID",
                "pagepath":"PAGEPATH",
                "title":"跳转小程序"
            }
        ],
        "card_action":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH"
        }
    }
}

请求参数

参数类型必须说明
msgtypeString消息类型,此时的消息类型固定为template_card
template_cardObject具体的模版卡片参数

template_card的参数说明

参数类型必须说明
card_typeString模版卡片的模版类型,文本通知模版卡片的类型为text_notice
sourceObject卡片来源样式信息,不需要来源样式可不填写
source.icon_urlString来源图片的url
source.descString来源图片的描述,建议不超过13个字
source.desc_colorInt来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
main_titleObject模版卡片的主要内容,包括一级标题和标题辅助信息
main_title.titleString一级标题,建议不超过26个字。模版卡片主要内容的一级标题main_title.title和二级普通文本sub_title_text必须有一项填写
main_title.descString标题辅助信息,建议不超过30个字
emphasis_contentObject关键数据样式
emphasis_content.titleString关键数据样式的数据内容,建议不超过10个字
emphasis_content.descString关键数据样式的数据描述内容,建议不超过15个字
quote_areaObject引用文献样式,建议不与关键数据共用
quote_area.typeInt引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.urlString点击跳转的url,quote_area.type是1时必填
quote_area.appidString点击跳转的小程序的appid,quote_area.type是2时必填
quote_area.pagepathString点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.titleString引用文献样式的标题
quote_area.quote_textString引用文献样式的引用文案
sub_title_textString二级普通文本,建议不超过112个字。模版卡片主要内容的一级标题main_title.title和二级普通文本sub_title_text必须有一项填写
horizontal_content_listObject[]二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.typeInt链接类型,0或不填代表是普通文本,1 代表跳转url,2 代表下载附件,3 代表@员工
horizontal_content_list.keynameString二级标题,建议不超过5个字
horizontal_content_list.valueString二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过26个字
horizontal_content_list.urlString链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_idString附件的media_id,horizontal_content_list.type是2时必填
horizontal_content_list.useridString被@的成员的userid,horizontal_content_list.type是3时必填
jump_listObject[]跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
jump_list.typeInt跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
jump_list.titleString跳转链接样式的文案内容,建议不超过13个字
jump_list.urlString跳转链接的url,jump_list.type是1时必填
jump_list.appidString跳转链接的小程序的appid,jump_list.type是2时必填
jump_list.pagepathString跳转链接的小程序的pagepath,jump_list.type是2时选填
card_actionObject整体卡片的点击跳转事件,text_notice模版卡片中该字段为必填项
card_action.typeInt卡片跳转类型,1 代表跳转url,2 代表打开小程序。text_notice模版卡片中该字段取值范围为[1,2]
card_action.urlString跳转事件的url,card_action.type是1时必填
card_action.appidString跳转事件的小程序的appid,card_action.type是2时必填
card_action.pagepathString跳转事件的小程序的pagepath,card_action.type是2时选填
 b. 图文展示模版卡片

{
    "msgtype":"template_card",
    "template_card":{
        "card_type":"news_notice",
        "source":{
            "icon_url":"https://wework.qpic.cn/wwpic/252813_jOfDHtcISzuodLa_1629280209/0",
            "desc":"企业微信",
            "desc_color":0
        },
        "main_title":{
            "title":"欢迎使用企业微信",
            "desc":"您的好友正在邀请您加入企业微信"
        },
        "card_image":{
            "url":"https://wework.qpic.cn/wwpic/354393_4zpkKXd7SrGMvfg_1629280616/0",
            "aspect_ratio":2.25
        },
        "image_text_area":{
            "type":1,
            "url":"https://work.weixin.qq.com",
            "title":"欢迎使用企业微信",
            "desc":"您的好友正在邀请您加入企业微信",
            "image_url":"https://wework.qpic.cn/wwpic/354393_4zpkKXd7SrGMvfg_1629280616/0"
        },
        "quote_area":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH",
            "title":"引用文本标题",
            "quote_text":"Jack:企业微信真的很好用~\nBalian:超级好的一款软件!"
        },
        "vertical_content_list":[
            {
                "title":"惊喜红包等你来拿",
                "desc":"下载企业微信还能抢红包!"
            }
        ],
        "horizontal_content_list":[
            {
                "keyname":"邀请人",
                "value":"张三"
            },
            {
                "keyname":"企微官网",
                "value":"点击访问",
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi"
            },
            {
                "keyname":"企微下载",
                "value":"企业微信.apk",
                "type":2,
                "media_id":"MEDIAID"
            }
        ],
        "jump_list":[
            {
                "type":1,
                "url":"https://work.weixin.qq.com/?from=openApi",
                "title":"企业微信官网"
            },
            {
                "type":2,
                "appid":"APPID",
                "pagepath":"PAGEPATH",
                "title":"跳转小程序"
            }
        ],
        "card_action":{
            "type":1,
            "url":"https://work.weixin.qq.com/?from=openApi",
            "appid":"APPID",
            "pagepath":"PAGEPATH"
        }
    }
}

请求参数

参数类型必须说明
msgtypeString模版卡片的消息类型为template_card
template_cardObject具体的模版卡片参数

template_card的参数说明

参数类型必须说明
card_typeString模版卡片的模版类型,图文展示模版卡片的类型为news_notice
sourceObject卡片来源样式信息,不需要来源样式可不填写
source.icon_urlString来源图片的url
source.descString来源图片的描述,建议不超过13个字
source.desc_colorInt来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
main_titleObject模版卡片的主要内容,包括一级标题和标题辅助信息
main_title.titleString一级标题,建议不超过26个字
main_title.descString标题辅助信息,建议不超过30个字
card_imageObject图片样式
card_image.urlString图片的url
card_image.aspect_ratioFloat图片的宽高比,宽高比要小于2.25,大于1.3,不填该参数默认1.3
image_text_areaObject左图右文样式
image_text_area.typeInt左图右文样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
image_text_area.urlString点击跳转的url,image_text_area.type是1时必填
image_text_area.appidString点击跳转的小程序的appid,必须是与当前应用关联的小程序,image_text_area.type是2时必填
image_text_area.pagepathString点击跳转的小程序的pagepath,image_text_area.type是2时选填
image_text_area.titleString左图右文样式的标题
image_text_area.descString左图右文样式的描述
image_text_area.image_urlString左图右文样式的图片url
quote_areaObject引用文献样式,建议不与关键数据共用
quote_area.typeInt引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
quote_area.urlString点击跳转的url,quote_area.type是1时必填
quote_area.appidString点击跳转的小程序的appid,quote_area.type是2时必填
quote_area.pagepathString点击跳转的小程序的pagepath,quote_area.type是2时选填
quote_area.titleString引用文献样式的标题
quote_area.quote_textString引用文献样式的引用文案
vertical_content_listObject[]卡片二级垂直内容,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过4
vertical_content_list.titleString卡片二级标题,建议不超过26个字
vertical_content_list.descString二级普通文本,建议不超过112个字
horizontal_content_listObject[]二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
horizontal_content_list.typeInt模版卡片的二级标题信息内容支持的类型,1是url,2是文件附件
horizontal_content_list.keynameString二级标题,建议不超过5个字
horizontal_content_list.valueString二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过26个字
horizontal_content_list.urlString链接跳转的url,horizontal_content_list.type是1时必填
horizontal_content_list.media_idString附件的media_id,horizontal_content_list.type是2时必填
jump_listObject[]跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
jump_list.typeInt跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
jump_list.titleString跳转链接样式的文案内容,建议不超过13个字
jump_list.urlString跳转链接的url,jump_list.type是1时必填
jump_list.appidString跳转链接的小程序的appid,jump_list.type是2时必填
jump_list.pagepathString跳转链接的小程序的pagepath,jump_list.type是2时选填
card_actionObject整体卡片的点击跳转事件,news_notice模版卡片中该字段为必填项
card_action.typeInt卡片跳转类型,1 代表跳转url,2 代表打开小程序。news_notice模版卡片中该字段取值范围为[1,2]
card_action.urlString跳转事件的url,card_action.type是1时必填
card_action.appidString跳转事件的小程序的appid,card_action.type是2时必填
card_action.pagepathString跳转事件的小程序的pagepath,card_action.type是2时选填

 3. 消息发送频率限制

每个机器人发送的消息不能超过20条/分钟。

 4 文件上传接口

素材上传得到media_id,该media_id仅三天内有效
media_id只能是对应上传文件的机器人可以使用

请求方式:POST(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/webhook/upload_media?key=KEY&type=TYPE

使用multipart/form-data POST上传文件, 文件标识名为”media”
参数说明:

参数必须说明
key调用接口凭证, 机器人webhookurl中的key参数
type固定传file

POST的请求包中,form-data中媒体文件标识,应包含有 filename、filelength、content-type等信息

filename标识文件展示的名称。比如,使用该media_id发消息时,展示的文件名由该字段控制 

请求示例:

POST https://qyapi.weixin.qq.com/cgi-bin/webhook/upload_media?key=693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa&type=file HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------------------acebdf13572468
Content-Length: 220
---------------------------acebdf13572468
Content-Disposition: form-data; name="media";filename="wework.txt"; filelength=6
Content-Type: application/octet-stream
mytext
---------------------------acebdf13572468--

 返回数据:

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

参数说明:

参数说明
type媒体文件类型,分别有图片(image)、语音(voice)、视频(video),普通文件(file)
media_id媒体文件上传后获取的唯一标识,3天内有效
created_at媒体文件上传时间戳

 5. 上传的文件限制:

要求文件大小在5B~20M之间

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
环境要求 PHP >= 7.0 PHP fileinfo 拓展 储存文件需要用到 PHP gd 拓展 控制台显示二维码 PHP posix 拓展 控制台显示二维码(linux) PHP 系统命令 拓展 执行clear命令 PHP SimpleXML 拓展 解析XML 安装 请确保已经会使用composer! 运行微信账号的语言设置务必设置为简体中文!!否则可能出现未知的错误! 1、git git clone https://github.com/HanSon/vbot.git cd vbot composer install 2、composer composer require hanson/vbot 运行 正常运行 php example/index.php 带session运行 php example/index.php --session yoursession 关于session : 带session运行会自动寻找设定session指定的cookies,如不存在则新建一个文件夹位于 /tmp/session 中,当下次修改代码时再执行就会免扫码自动登录。 如果不设置,vbot会自动设置一个6位的字符的session值,下次登录也可以直接设定此值进行面扫码登录。 PS:运行后二维码将保存于设置的缓存目录,命名为qr.png,控制台也会显示二维码,扫描即可(linux用户请确保已经打开ANSI COLOR) 警告!执行前请先查看index.php的代码,注释掉你认为不需要的代码,避免对其他人好友造成困扰 请在terminal运行!请在terminal运行!请在terminal运行! 目录结构 vbot demo (vbot 当前在运行的代码,也欢迎大家提供自己的一些实战例子) example (较为初级的实例) src (源码) tmp (假设缓存目录设置在此) session hanson (设定值 php index.php --session hanson) 523eb1 (随机值) users 23534234345 (微信账号的UIN值) file (文件) gif (表情) jpg (图片) mp3 (语音) mp4 (视频) contact.json (联系人 debug模式下存在) group.json (群组 debug模式下存在) member.json (所有群的所有成员 debug模式下存在) official.json (公众号 debug模式下存在) special.json (特殊账号 debug模式下存在) message.json (消息) 体验 扫码后,验证输入“echo”即可自动加为好友并且拉入vbot群。 vbot并非24小时执行,有时会因为开发调试等原因暂停功能。如果碰巧遇到关闭情况,可加Q群 492548647 了解开放时间。执行后发送“拉我”即可自动邀请进群。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值