View Source WeChat.Work.ChatRobot (wechat v0.16.0)

群机器人

在终端某个群组添加机器人之后,创建者可以在机器人详情页看的该机器人特有的webhookurl。 开发者可以按以下说明a向这个地址发起HTTP POST 请求,即可实现给该群组发送消息。

当前自定义机器人支持文本(text)、markdown(markdown)、图片(image)、图文(news)四种消息类型。

机器人的text/markdown类型消息支持在content中使用<@userid>扩展语法来@群成员

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

Summary

Types

调用接口凭证, 机器人webhookurl中的key参数

文件id,通过文件上传接口获取

消息类型

Types

@type content() :: String.t()
@type key() :: String.t()

调用接口凭证, 机器人webhookurl中的key参数

@type media_id() :: String.t()

文件id,通过文件上传接口获取

@type msg() :: map()
@type msg_type() :: String.t()

消息类型

  • text: 文本消息
  • image: 图片消息
  • file: 文件消息
  • news: 图文消息
  • markdown: markdown消息
  • template_card: 模板卡片消息
@type opts() :: Enumerable.t()
@type webhook_url() :: String.t()

Functions

Link to this function

send(webhook_url, msg_type, msg)

View Source
@spec send(webhook_url(), msg_type(), msg()) :: Tesla.Env.result()

发送消息 - 官方文档

Link to this function

send_file(webhook_url, media_id)

View Source
@spec send_file(webhook_url(), Material.media_id()) :: WeChat.response()

发送文件消息 - 官方文档

Link to this function

send_image(webhook_url, image_data)

View Source
@spec send_image(webhook_url(), image_data :: binary()) :: WeChat.response()
Link to this function

send_image(webhook_url, base64, md5)

View Source
@spec send_image(webhook_url(), base64 :: String.t(), md5 :: String.t()) ::
  WeChat.response()

发送图片消息 - 官方文档

  • base64: 图片内容的 base64 编码
  • md5: 图片内容(base64编码前)的 md5

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

Link to this function

send_markdown(webhook_url, content)

View Source
@spec send_markdown(webhook_url(), content()) :: WeChat.response()

发送markdown消息 - 官方文档

Link to this function

send_news(webhook_url, msg)

View Source
@spec send_news(webhook_url(), msg()) :: WeChat.response()

发送图文消息 - 官方文档

Link to this function

send_template_card(webhook_url, msg)

View Source
@spec send_template_card(webhook_url(), msg()) :: WeChat.response()

发送模板卡片消息 - 官方文档

Link to this function

send_text(webhook_url, content, opts \\ [])

View Source
@spec send_text(webhook_url(), content(), opts()) :: WeChat.response()

发送文本消息 - 官方文档

Link to this function

upload_file(key, file_path)

View Source
@spec upload_file(key(), file_path()) :: Tesla.Env.result()

文件上传接口 - 官方文档

Link to this function

upload_file(key, filename, file_data)

View Source
@spec upload_file(key(), filename(), file_data()) :: Tesla.Env.result()

文件上传接口 - 官方文档