WeChat.Work (wechat v0.6.0)

企业微信

use WeChat.Work,
  corp_id: "corp_id",
  agents: [
    contacts_agent(secret: "your_contacts_secret"),
    %WeChat.Work.Agent{name: :agent_name, id: 10000, secret: "your_secret"},
    ...
  ]

Link to this section Summary

Types

access_token 是企业后台去企业微信的后台获取信息时的重要票据 - 官方文档

每个应用都有唯一的 agentid - 官方文档

每个企业都拥有唯一的 corpid - 官方文档

参数

secret 是企业应用里面用于保障数据安全的“钥匙” - 官方文档

Link to this section Types

Link to this type

access_token()

Specs

access_token() :: String.t()

access_token 是企业后台去企业微信的后台获取信息时的重要票据 - 官方文档

corpidsecret 产生。所有接口在通信时都需要携带此信息用于验证接口的访问权限

Specs

agent() :: agent_name() | agent_id()

Specs

agent_id() :: WeChat.Work.Agent.agent_id()

每个应用都有唯一的 agentid - 官方文档

在管理后台->“应用与小程序”->“应用”,点进某个应用,即可看到 agentid

Link to this type

agent_name()

Specs

agent_name() :: WeChat.Work.Agent.agent_name()

Specs

agents() :: [WeChat.Work.Agent.t(), ...]

Specs

client() :: module()

Specs

corp_id() :: String.t()

每个企业都拥有唯一的 corpid - 官方文档

获取此信息可在管理后台“我的企业”-“企业信息”下查看“企业ID”(需要有管理员权限)

Specs

options() :: [
  corp_id: corp_id(),
  agents: agents(),
  server_role: WeChat.server_role(),
  storage: WeChat.Storage.Adapter.t(),
  requester: module()
]

参数

参数说明

默认参数:

Specs

secret() :: WeChat.Work.Agent.secret()

secret 是企业应用里面用于保障数据安全的“钥匙” - 官方文档

每一个应用都有一个独立的访问密钥,为了保证数据的安全,secret务必不能泄漏。 目前 secret 有:

  • 自建应用 secret 在管理后台->“应用与小程序”->“应用”->“自建”,点进某个应用,即可看到。
  • 基础应用 secret 某些基础应用(如“审批”“打卡”应用),支持通过API进行操作。在管理后台->“应用与小程序”->“应用->”“基础”,点进某个应用,点开“API”小按钮,即可看到。
  • 通讯录管理 secret 在“管理工具”-“通讯录同步”里面查看(需开启“API接口同步”);
  • 外部联系人管理 secret 在“客户联系”栏,点开“API”小按钮,即可看到。

Link to this section Functions

Link to this function

build_client(client, options)

Specs

build_client(client(), options()) :: {:ok, client()}

动态构建 client

Link to this function

get_access_token(client, agent)

Specs

get_access_token(client(), agent()) :: WeChat.response()

获取 access_token - 官方文档