Skip to content

企业微信

请仔细阅读并理解:企业微信 API - 企业内部开发

实例化

php
<?php
use EasyWeChat\Work\Application;

$config = [
  'corp_id' => 'wx3cf0f39249eb0exx',
  'secret' => 'f1c242f4f28f735d4687abb469072axx',
  'token' => 'easywechat',
  'aes_key' => '35d4687abb469072a29f1c242xxxxxx',

  /**
   * 接口请求相关配置,超时时间等,具体可用参数请参考:
   * https://github.com/symfony/symfony/blob/5.3/src/Symfony/Contracts/HttpClient/HttpClientInterface.php
   */
  'http' => [
      'throw'  => true, // 状态码非 200、300 时是否抛出异常,默认为开启
      'timeout' => 5.0,
      // 'base_uri' => 'https://qyapi.weixin.qq.com/', // 如果你在国外想要覆盖默认的 url 的时候才使用,根据不同的模块配置不同的 uri

      'retry' => true, // 使用默认重试配置
      //  'retry' => [
      //      // 仅以下状态码重试
      //      'status_codes' => [429, 500]
      //       // 最大重试次数
      //      'max_retries' => 3,
      //      // 请求间隔 (毫秒)
      //      'delay' => 1000,
      //      // 如果设置,每次重试的等待时间都会增加这个系数
      //      // (例如. 首次:1000ms; 第二次: 3 * 1000ms; etc.)
      //      'multiplier' => 3
      //  ],
  ],
];

$app = new Application($config);

API

Application 就是一个工厂类,所有的模块都是从 $app 中访问,并且几乎都提供了协议和 setter 可自定义修改。

服务端

服务端模块封装了服务端相关的便捷操作,隐藏了部分复杂的细节,基于中间件模式可以更方便的处理消息推送和服务端验证。

php
$app->getServer();

📖 更多说明请参阅:服务端使用文档

API Client

封装了多种模式的 API 调用类,你可以选择自己喜欢的方式调用开放平台任意 API,默认自动处理了 access_token 相关的逻辑。

php
$app->getClient();

📖 更多说明请参阅:API 调用

配置

php
$config = $app->getConfig();

你可以轻松使用 $config->get($key, $default) 读取配置,或使用 $config->set($key, $value) 在调用前修改配置项。

getAccessToken

access_token 是 API 调用的必备条件,如果你想获取它的值,你可以通过以下方式拿到当前的 access_token:

php
$accessToken = $app->getAccessToken();
$accessToken->getToken(); // string

当然你也可以使用自己的 getAccessToken 类:

php
$accessToken = new MyCustomAccessToken();
$app->getAccessToken($accessToken)

企业账户

企业账号类,提供一系列 API 获取企业的基本信息:

php
$account = $app->getAccount();

$account->getCorpId();
$account->getSecret();
$account->getToken();
$account->getAesKey();

企业网页授权

点此查看官方文档

php
$oauth = $app->getOAuth();

📖 详情请参考:网页授权

Released under the MIT License.