职贝云数AI新零售门户

标题: 企微机器人运用及内容配置文档 [打印本页]
作者: A6Qua4jMtW    时间: 2023-2-9 12:37
标题: 企微机器人运用及内容配置文档
如何运用群机器人
在终端某个群组添加机器人之后，创建者可以在机器人概况页看的该机器人特有的webhookurl。开发者可以按以下阐明a向这个地址发起HTTP POST 央求，即可完成给该群组发送音讯。下面举个简单的例子.
假设webhook是：https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693a91f6-6xxx-4bc4-97a0-0ec2sifa5aaa
特别特别要留意：一定要保护好机器人的webhook地址，避免走漏！不要分享到github、博客等可被公开查阅的地方，否则坏人就可以用你的机器人来发渣滓音讯了。
以下是用curl工具往群组推送文本音讯的示例（留意要将url交换成你的机器人webhook地址，content必须是utf8编码）：
  1. curl'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693axxx6-7aoc-4bc4-97a0-0ec2sifa5aaa'\-H'Content-Type: application/json'\-d'
  2.    {
  3.         "msgtype": "text",
  4.         "text": {
  5.             "content": "hello world"
  6.         }
  7.    }'
复制代码
当前自定义机器人支持文本（text）、markdown（markdown）、图片（image）、图文（news）四种音讯类型。
机器人的text/markdown类型音讯支持在content中运用<@userid>扩展语法来@群成员
音讯类型及数据格式

1、文本类型
  1. {"msgtype":"text","text":{"content":"广州昔日天气：29度，大部分多云，降雨概率：60%","mentioned_list":["wangqing","@all"],"mentioned_mobile_list":["13800001111","@all"]}}
复制代码
aa
a
参数能否必填阐明
msgtype是音讯类型，此时固定为text
content是文本内容，最长不超过2048个字节，必须是utf8编码
mentioned_list否userid的列表，提示群中的指定成员(@某个成员)，@all表示提示一切人，假如开发者获取不到userid，可以运用mentioned_mobile_list
mentioned_mobile_list否手机号列表，提示手机号对应的群成员(@某个成员)，@all表示提示一切人

2、markdown类型
  1. {"msgtype":"markdown","markdown":{"content": "实时新增用户反馈<font color="warning">132例</font>，请相关同事留意。\n
  2.          >类型:<font color="comment">用户反馈</font>>普通用户反馈:<font color="comment">117例</font>>VIP用户反馈:<font color="comment">15例</font>"}}
复制代码
参数能否必填阐明
msgtype是音讯类型，此时固定为markdown
content是markdown内容，最长不超过4096个字节，必须是utf8编码
目前支持的markdown语法是如下的子集：
  1. 标题 （支持1至6级标题，留意#与文字中间要有空格）
  2. # 标题一
  3. ## 标题二
  4. ### 标题三
  5. #### 标题四
  6. ##### 标题五
  7. ###### 标题六
  8. 加粗
  9. **bold**
  10. 链接
  11. [这是一个链接](http://work.weixin.qq.com/api/doc)
  12. 行内代码段（暂不支持跨行）
  13. `code`
  14. 援用
  15. > 援用文字
  16. 字体颜色(只支持3种内置颜色)
  17. <font color="info">绿色</font>
  18. <font color="comment">灰色</font>
  19. <font color="warning">橙红色</font>
复制代码
3、图片类型
  1. {"msgtype":"image","image":{"base64":"DATA","md5":"MD5"}}
复制代码
参数能否必填阐明
msgtype是音讯类型，此时固定为image
base64是图片内容的base64编码
md5是图片内容（base64编码前）的md5值；纯二进制编码为base64的结果，不携带头部信息（data:image/jpeg;base64,***）
注：图片（base64编码前）最大不能超过2M，支持JPG,PNG格式

4、图文类型
  1. {"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格式，较好的效果为大图 1068455，小图150150。

5、文件类型
  1. {"msgtype":"file","file":{"media_id":"3a8asd892asd8asd"}}
复制代码
参数能否必填阐明
msgtype是音讯类型，此时固定为file
media_id是文件id，经过下文的文件上传接口获取

6、模版卡片类型

文本告诉模版卡片

(, 下载次数: 1)

  1. {"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时选填
图文展现模版卡片

(, 下载次数: 1)

  1. {"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时选填音讯发送频率限制
每个机器人发送的音讯不能超过20条/分钟。
7、文件上传接口

素材上传得到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发音讯时，展现的文件名由该字段控制
央求示例：
  1. POST https://qyapi.weixin.qq.com/cgi-bin/webhook/upload_media?key=693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa&type=file HTTP/1.1
  2. Content-Type: multipart/form-data;boundary=-------------------------acebdf13572468
  3. Content-Length: 220
  4. ---------------------------acebdf13572468
  5. Content-Disposition: form-data;name="media";filename="wework.txt";filelength=6
  6. Content-Type: application/octet-stream
  7. mytext
  8. ---------------------------acebdf13572468--
复制代码
前往数据：
  1. {"errcode":0,"errmsg":"ok","type":"file","media_id":"1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0","created_at":"1380000000"}
复制代码
参数阐明：
参数阐明
type媒体文件类型，分别有图片（image）、语音（voice）、视频（video），普通文件(file)
media_id媒体文件上传后获取的独一标识，3天内有效
created_at媒体文件上传工夫戳
上传的文件限制：要求文件大小在5B~20M之间



欢迎光临 职贝云数AI新零售门户 (https://www.taojin168.com/cloud/) Powered by Discuz! X3.5