WeChat

Module Version Hex Docs Total Download License Last Updated

WeChat SDK for Elixir

  • 目前 Elixir 中支持最完善的微信SDK
  • 已支持:
    • 公众号
    • 小程序
    • 第三方应用
    • 企业微信
    • 微信支付
  • WIP: 企业微信服务商

在线文档

Installation

You can use wechat in your projects by adding it to your mix.exs dependencies:

def deps do
  [
    {:wechat, "~> 0.8", hex: :wechat_sdk}
  ]
end

Usage

定义 Client 模块

公众号(默认)

  defmodule YourApp.WeChatAppCodeName do
    @moduledoc "CodeName"
    use WeChat,
      appid: "wx-appid",
      appsecret: "appsecret"
  end

小程序

  defmodule YourApp.WeChatAppCodeName do
    @moduledoc "CodeName"
    use WeChat,
      app_type: :mini_program,
      appid: "wx-appid",
      appsecret: "appsecret"
  end

第三方应用

  defmodule YourApp.WeChatAppCodeName do
    @moduledoc "CodeName"
    use WeChat,
      by_component?: true,
      app_type: :official_account | :mini_program, # 默认为 :official_account
      appid: "wx-appid",
      component_appid: "wx-third-appid", # 第三方 appid
  end

企业微信

  defmodule YourApp.WeChatAppCodeName do
    @moduledoc "CodeName"
    use WeChat.Work,
      corp_id: "corp_id",
      agents: [
        contacts_agent(secret: "contacts_secret"),
        customer_agent(secret: "customer_secret"),
        agent(10000, name: :agent_name, secret: "agent_secret"),
        ...
      ]
  end

自动刷新 token

config.exs 中设置:

config :wechat, :refresh_settings, [ClientA, ClientB, ClientC]

手动添加 client:

WeChat.Refresher.Default.add(YourApp.WeChatAppCodeName)

调用接口

所有类型的 client,都同时支持以下两种形式调用:

YourApp.WeChatAppCodeName.Material.batch_get_material(:image, 2)

# or

WeChat.Material.batch_get_material(YourApp.WeChatAppCodeName, :image, 2)

更多详情请见:WeChat模块

快速测试

微信提供申请测试号,用于快速测试

Contributing

如果有接口未覆盖到,欢迎提交 PR,感谢。

Copyright (c) 2021 feng19

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.