ExWechat

Elixir/Phoenix wechat api wraper, (documentation).

From v0.1.7, we have change the main module from ExWechat to Wechat.

Installation

1. Add ex_wechat to your list of dependencies in mix.exs:

    def deps do
      [{:ex_wechat, "~> 0.1.8"}]
    end

2. Ensure ex_wechat is started before your application:

  def application do
    [extra_applications: [:ex_wechat]]
  end

Usage

Single Wechat api usage

1. Add config data(you can use direnv to set your ENV):

    config :ex_wechat, Wechat,
      appid: System.get_env("WECHAT_APPID") || "your appid",
      secret: System.get_env("WECHAT_APPSECRET") || "your app secret",
      token: System.get_env("WECHAT_TOKEN") || "your token",
      aes: Sestem.get_env("WECHAT_AES") || "your aes_key"

2. Use the methods in Wechat module, you can get all the method name from doc or from the definition files in lib/apis.

    Wechat.get_user_list
    Wechat.get_menu
   
    Wechat.Message.send_custom(openid, msgtype: "text", content: "Hello!")

Multi-account apis usage

1. Add your own module:

    defmodule Wechat.User do
      use Wechat.Api, appid: "", secret: "", token: "", aes: ""
    end
   
    defmodule Wechat.Doctor do
      use Wechat.Api, appid: "", secret: "", token: "", aes: ""
    end

2. Use the methods in Wechat with the module you define:

    Wechat.User.get_user_list
    Wechat.Doctor.get_user_list
   
    Wechat.Message.send_custom(Wechat.User, openid, msgtype: "text", content: "Hello!")
    Wechat.Message.send_custom(Wechat.Doctor, openid, msgtype: "text", content: "Hello!")

Phoenix Plugs

1. Example usage with server verify and message responder:

    defmodule Wechat.Router do
      use Wechat.Web, :router
   
      pipeline :api do
        plug :accepts, ["json"]
      end
   
      pipeline :customer do
        # single wechat app don't need to add api
        plug Wechat.Plugs.WechatSignatureResponder
        plug Wechat.Plugs.WechatMessageParser
   
        # you can add your own api module(for multi-accounts support)
        plug Wechat.Plugs.WechatSignatureResponder, api: Wechat.Customer
        plug Wechat.Plugs.WechatMessageParser, api: Wechat.Customer
      end
   
      scope "/customer_wechat", Wechat do
        pipe_through [:api, :customer]
        get "/", CustomerWechatController, :index
        post "/", CustomerWechatController, :create
      end
    end
   
    defmodule Wechat.CustomerWechatController do
      use Wechat.Web, :controller
      use Wechat.Responder
    end

2. In your controller you can use the helper methods in Wechat.Responder to respond with user:

    def on_text_responder(conn),         do: conn
    def on_image_responder(conn),        do: conn
    def on_voice_responder(conn),        do: conn
    def on_video_responder(conn),        do: conn
    def on_shortvideo_responder(conn),   do: conn
    def on_location_responder(conn),     do: conn
    def on_link_responder(conn),         do: conn
    def on_event_responder(conn),        do: conn

    defmodule Wechat.CustomerWechatController do
      use Wechat.Web, :controller
      use Wechat.Responder
   
      import Wechat.Message
   
      defp on_text_responder(conn) do
        message = conn.assigns[:message]
        case message do
          %{content: "我要图"} ->
            reply_with(conn, generate_passive(message, msgtype: "news",
              articles: [
                %{ title: "sjsjssjsj", description: "xxxxlaldsaldskl",
                   picurl: "picurl", url: "http://baidu.com" },
                %{ title: "sjsjssjsj", description: "xxxxlaldsaldskl",
                   picurl: "picurl", url: "http://baidu.com" }
                ]))
          %{content: content} ->
            reply_with(conn, generate_passive(message, msgtype: "text",
               content: String.reverse(content)))
          _ ->
            conn
        end
      end
    end

3. Example usage with wechat site plug (get wechat user info):

    defmodule Wechat.Router do
      use Wechat.Web, :router
   
      pipeline :browser do
        plug :accepts, ["html"]
        plug :fetch_session
        plug :fetch_flash
        plug :protect_from_forgery
        plug :put_secure_browser_headers
      end
   
      pipeline :wechat_website do
        # use the api you define, set the scope, the state module
        # and set the redirect url you want to.
        plug Wechat.Plugs.WechatWebsite, api: Wechat.Customer,
          host: "http://wechat.one-picture.com", scope: "snsapi_userinfo",
          state: Wechat.PageController
   
        # use the Wechat(default), scope is snsapi_base(default)
        plug Wechat.Plugs.WechatWebsite,
          host: "http://wechat.one-picture.com"
      end
   
      scope "/", Wechat do
        pipe_through [:browser, :wechat_website]
   
        get "/", PageController, :index
        get "/about", PageController, :about
      end
    end

    defmodule Wechat.PageController do
      use Wechat.Web, :controller
   
      def index(conn, _params) do
        # get the openid from session
        openid = conn |> get_session(:openid)
        # get the wechat authorize data from assins
        # include the access_token and other info,
        # you can use this info to get the user's infos.
        wechat_result = conn.assigns[:wechat_result]
        render conn, "index.html"
      end
   
      def about(conn, _params) do
        render(conn, "about.html")
      end
   
      def state do
        # you can set the state you want.
        'your_state'
      end
    end

License

MIT license