View Source WeChat.Work.Customer.GroupChat (wechat v0.16.0)

客户群管理

Summary

Types

客户群ID

是否需要返回群成员的名字 group_chat.member_list.name

Functions

获取客户群列表 - 官方文档

获取「群聊数据统计」数据(按群主聚合的方式) - 官方文档

获取「群聊数据统计」数据(按自然日聚合的方式) - 官方文档

Types

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

客户群ID

@type chat_id_list() :: [chat_id()]
@type need_name() :: 0 | 1

是否需要返回群成员的名字 group_chat.member_list.name

  • 0 不返回
  • 1 返回

默认不返回

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

Functions

Link to this function

get(client, agent, chat_id, need_name \\ 0)

View Source

获取客户群详情 - 官方文档

通过客户群ID,获取详情。包括群名、群成员列表、群成员入群时间、入群方式。 (客户群是由具有客户群使用权限的成员创建的外部群)

需注意的是,如果发生群信息变动,会立即收到群变更事件, 但是部分信息是异步处理,可能需要等一段时间调此接口才能得到最新结果。

Link to this function

list(client, agent, body)

View Source
@spec list(WeChat.Work.client(), WeChat.Work.agent(), body :: map()) ::
  WeChat.response()

获取客户群列表 - 官方文档

该接口用于获取配置过客户群管理的客户群列表。

Link to this function

open_gid2chat_id(client, agent, open_gid)

View Source
@spec open_gid2chat_id(WeChat.Work.client(), WeChat.Work.agent(), open_gid()) ::
  WeChat.response()

客户群opengid转换 - 官方文档

用户在微信里的客户群里打开小程序时,某些场景下可以获取到群的opengid, 如果该群是企业微信的客户群,则企业或第三方可以调用此接口将一个opengid转换为客户群chat_id

Link to this function

resigned_transfer(client, agent, chat_id_list, new_owner)

View Source

分配离职成员的客户群 - 官方文档

企业可通过此接口,将已离职成员为群主的群,分配给另一个客服成员。

Link to this function

statistic(client, agent, body)

View Source
@spec statistic(WeChat.Work.client(), WeChat.Work.agent(), body :: map()) ::
  WeChat.response()

获取「群聊数据统计」数据(按群主聚合的方式) - 官方文档

获取指定日期的统计数据。注意,企业微信仅存储180天的数据。

Link to this function

statistic_by_day(client, agent, body)

View Source
@spec statistic_by_day(WeChat.Work.client(), WeChat.Work.agent(), body :: map()) ::
  WeChat.response()

获取「群聊数据统计」数据(按自然日聚合的方式) - 官方文档

获取指定日期的统计数据。注意,企业微信仅存储180天的数据。