PHPackages                             workwexin/wecom - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. workwexin/wecom

ActiveLibrary[API Development](/categories/api)

workwexin/wecom
===============

WeCom (Enterprise WeChat) PHP SDK for message and contacts

20PHP

Since Jan 12Pushed 4mo agoCompare

[ Source](https://github.com/cping6/work_wexin)[ Packagist](https://packagist.org/packages/workwexin/wecom)[ RSS](/packages/workwexin-wecom/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

WorkWeXin WeCom SDK
===================

[](#workwexin-wecom-sdk)

面向企业微信的 PHP SDK（当前包含：应用消息 + 通讯录 + 身份与登录 + 回调事件 + 客户联系 + OA/审批 + 小程序 + 支付）。

安装
--

[](#安装)

```
composer require workwexin/wecom
```

配置说明
----

[](#配置说明)

```
$config = [
    "corps" => [
        "default" => [
            "corp_id" => "wx123",
            "apps" => [
                "default" => [
                    "agent_id" => 1000002,
                    "secret" => "app_secret"
                ]
            ]
        ]
    ],
    "cache" => [
        "path" => __DIR__ . "/runtime/cache",
        "ttl" => 7200
    ],
    "http" => [
        "timeout" => 5.0,
        "base_uri" => "https://qyapi.weixin.qq.com"
    ]
];
```

字段说明：

- `corps`：多企业配置，key 为企业别名
- `corps.{corp}.corp_id`：企业 ID
- `corps.{corp}.apps`：企业下的多个应用
- `corps.{corp}.apps.{app}.agent_id`：应用 AgentId
- `corps.{corp}.apps.{app}.secret`：应用 Secret
- `cache.path`：文件缓存目录（access\_token 缓存）
- `cache.ttl`：默认缓存时间（秒）
- `cache.instance`：自定义缓存（需实现 `Psr\SimpleCache\CacheInterface`）
- `http.timeout`：HTTP 超时时间
- `http.base_uri`：企业微信 API 根地址
- `http.client`：自定义 HTTP 客户端（需实现 `Psr\Http\Client\ClientInterface`）
- `http.retry.max_retries`：最大重试次数（默认 0）
- `http.retry.retry_delay_ms`：重试间隔毫秒（默认 200）
- `http.retry.retry_on_status`：重试的 HTTP 状态码（默认 500/502/503/504）
- `http.retry.retry_on_timeout`：是否对超时重试（默认 true）
- `http.retry.methods`：允许重试的 HTTP 方法（默认 `["GET"]`）
- `logger`：自定义日志（需实现 `Psr\Log\LoggerInterface`）
- `corps.{corp}.callback.token`：回调 Token
- `corps.{corp}.callback.encoding_aes_key`：回调 EncodingAESKey

快速开始
----

[](#快速开始)

```
use WorkWeXin\WeCom;

$wecom = new WeCom($config, "default", "default");

$wecom->message()->send([
    "touser" => "userid1|userid2",
    "msgtype" => "text",
    "text" => ["content" => "Hello"]
]);
```

说明：`agentid` 如果未传，会从配置里的 `agent_id` 自动注入。

应用消息示例
------

[](#应用消息示例)

```
$wecom->message()->sendText("你好", ["touser" => "userid1"]);
$wecom->message()->sendMarkdown("**加粗**内容", ["touser" => "userid1"]);
$wecom->message()->sendTextCard("标题", "描述", "https://example.com", ["touser" => "userid1"]);
```

任务卡片更新示例：

```
$wecom->message()->updateTaskCard("userid1|userid2", "task_id_xxx", "已完成");
```

通讯录 API
-------

[](#通讯录-api)

```
$wecom->contacts()->getUser("userid1");
$wecom->contacts()->listUsers(1, true);
$wecom->contacts()->createUser([
    "userid" => "userid1",
    "name" => "张三",
    "department" => [1]
]);
$wecom->contacts()->updateUser([
    "userid" => "userid1",
    "name" => "李四"
]);
$wecom->contacts()->deleteUser("userid1");

$wecom->contacts()->listDepartments();
$wecom->contacts()->createDepartment([
    "name" => "研发部",
    "parentid" => 1
]);
$wecom->contacts()->updateDepartment([
    "id" => 2,
    "name" => "技术部"
]);
$wecom->contacts()->deleteDepartment(2);
```

可用方法与字段说明
---------

[](#可用方法与字段说明)

说明：以下为当前 SDK 可用方法（MVP：应用消息 + 通讯录）。

小程序：

方法说明主要字段（必填/可选）`miniProgram()->getSession(string $jsCode): array`小程序登录（jscode2session）必填：`jsCode``miniProgram()->getCode(array $data): array`获取小程序码必填：`path``miniProgram()->getQrCode(array $data): array`获取小程序二维码必填：`path``miniProgram()->getJsapiTicket(string $type = "agent_config"): array`获取 JSAPI ticket可选：`type``miniProgram()->createJsapiConfig(string $url, string $ticket, ?string $nonceStr = null, ?int $timestamp = null): array`生成 JSAPI 签名配置必填：`url`、`ticket`支付：

方法说明主要字段（必填/可选）`payment()->unifiedOrder(array $data): array`统一下单必填：`data``payment()->queryOrder(array $data): array`订单查询必填：`data``payment()->refund(array $data): array`退款必填：`data``payment()->transferToUser(array $data): array`企业付款到个人必填：`data``payment()->sendRedPack(array $data): array`企业红包必填：`data``payment()->downloadBill(array $query): string`下载账单必填：`query``payment()->sign(array $data, string $apiKey, string $signType = "HMAC-SHA256"): string`支付签名必填：`data`、`apiKey``payment()->verifySignature(array $data, string $apiKey, string $signField = "sign", string $signTypeField = "sign_type"): bool`校验支付签名必填：`data`、`apiKey`客户联系：

方法说明主要字段（必填/可选）`customerContact()->listFollowUsers(): array`获取配置了客户联系功能的成员列表-`customerContact()->listExternalContacts(string $userId): array`获取客户列表必填：`userId``customerContact()->getExternalContact(string $externalUserId, ?string $cursor = null): array`获取客户详情必填：`externalUserId`。可选：`cursor``customerContact()->batchGetByUser(string $userId, ?string $cursor = null, int $limit = 100): array`批量获取客户详情必填：`userId`、`limit`。可选：`cursor``customerContact()->listGroupChats(int $statusFilter = 0, array $ownerFilter = [], ?string $cursor = null, int $limit = 1000): array`获取客户群列表可选：`statusFilter`、`ownerFilter`、`cursor`、`limit``customerContact()->getGroupChat(string $chatId, int $needName = 1): array`获取客户群详情必填：`chatId`。可选：`needName``customerContact()->updateRemark(array $data): array`更新客户备注必填：`userid`、`external_userid``customerContact()->addContactWay(array $data): array`添加联系我必填：`type`、`scene``customerContact()->getContactWay(string $configId): array`获取联系我配置必填：`configId``customerContact()->updateContactWay(array $data): array`更新联系我配置必填：`config_id``customerContact()->deleteContactWay(string $configId): array`删除联系我配置必填：`configId``customerContact()->closeTempChat(string $userId, string $externalUserId): array`结束临时会话必填：`userId`、`externalUserId``customerContact()->sendWelcome(array $data): array`发送新客户欢迎语必填：`welcome_code``customerContact()->getCorpTagList(array $tagIds = [], array $groupIds = []): array`获取客户标签可选：`tagIds`、`groupIds``customerContact()->addCorpTag(array $data): array`添加客户标签必填：`group_name`、`tag``customerContact()->editCorpTag(array $data): array`更新客户标签必填：`id``customerContact()->deleteCorpTag(array $tagIds = [], array $groupIds = []): array`删除客户标签必填：`tagIds`/`groupIds``customerContact()->markTag(array $data): array`为客户打标签必填：`userid`、`external_userid`，`add_tag`/`remove_tag` 至少一项`customerContact()->getUnassignedList(int $pageId = 0, int $pageSize = 1000): array`获取待分配客户必填：`pageSize``customerContact()->transferCustomer(array $data): array`分配客户给新成员必填：`handover_userid`、`takeover_userid`、`external_userid``customerContact()->transferGroupChat(array $data): array`分配客户群必填：`chat_id_list`、`new_owner``customerContact()->getGroupChatStatistic(int $startTime, int $endTime, array $ownerFilter = [], ?string $cursor = null, int $limit = 1000): array`获取客户群统计必填：`startTime`、`endTime`、`limit``customerContact()->getUserBehaviorData(int $startTime, int $endTime, array $userIdList): array`获取客户联系统计必填：`startTime`、`endTime`、`userIdList``customerContact()->getGroupChatMembers(string $chatId, int $needName = 1): array`获取客户群成员详情必填：`chatId`。可选：`needName``customerContact()->addGroupWelcomeTemplate(array $data): array`添加客户群欢迎语必填：`chat_id``customerContact()->editGroupWelcomeTemplate(array $data): array`更新客户群欢迎语必填：`template_id``customerContact()->getGroupWelcomeTemplate(string $templateId): array`获取客户群欢迎语必填：`templateId``customerContact()->deleteGroupWelcomeTemplate(string $templateId): array`删除客户群欢迎语必填：`templateId`OA 与审批：

方法说明主要字段（必填/可选）`approval()->listTemplates(array $query = []): array`获取审批模板列表可选：`query``approval()->getTemplateDetail(string $templateId): array`获取审批模板详情必填：`templateId``approval()->getApprovalDetail(string $spNo): array`获取审批详情必填：`spNo``approval()->createApproval(array $data): array`发起审批必填：`creator_userid`、`template_id`、`apply_data``oa()->getCheckinData(int $startTime, int $endTime, array $userIdList): array`获取打卡数据必填：`startTime`、`endTime`、`userIdList``oa()->getCheckinDayData(int $startTime, int $endTime, array $userIdList): array`获取打卡日报数据必填：`startTime`、`endTime`、`userIdList``oa()->getCheckinOption(int $datetime, array $userIdList): array`获取打卡规则必填：`datetime`、`userIdList``oa()->getJournalRecordList(int $startTime, int $endTime, array $userIdList): array`获取日报列表必填：`startTime`、`endTime`、`userIdList``oa()->getJournalRecordDetail(string $journalUuid): array`获取日报详情必填：`journalUuid``approval()->addTemplate(array $data): array`?????????`template_name`?`template_content``approval()->updateTemplate(array $data): array`?????????`template_id`?`template_content``approval()->deleteTemplate(string $templateId): array`?????????`templateId``approval()->getApprovalInfo(array $data): array`???????????`starttime`?`endtime``approval()->getApprovalInfoAdvanced(int $startTime, int $endTime, array $filters = [], ?string $cursor = null, int $size = 100): array`???????????????`startTime`?`endTime`?`size``approval()->buildApprovalFilters(array $conditions): array`???????????`conditions``approval()->getApprovalInfoByConditions(int $startTime, int $endTime, array $conditions, ?string $cursor = null, int $size = 100): array`???????????????`startTime`?`endTime`?`conditions`?`size``approval()->enableTemplate(string $templateId, array $templateContent): array`?????????`templateId`?`templateContent``approval()->disableTemplate(string $templateId, array $templateContent): array`?????????`templateId`?`templateContent``oa()->addSchedule(array $data): array`???????`schedule``oa()->updateSchedule(array $data): array`???????`schedule_id`?`schedule``oa()->deleteSchedule(string $scheduleId): array`???????`scheduleId``oa()->getSchedule(string $scheduleId): array`?????????`scheduleId``oa()->getScheduleByDate(int $startTime, int $endTime, array $userIdList): array`???????????`startTime`?`endTime`?`userIdList``oa()->shareSchedule(array $data): array`???????`schedule_id`?`share_to``oa()->shareScheduleWithPermission(string $scheduleId, array $shareTo, int $permission): array`?????????????`scheduleId`?`shareTo`?`permission``oa()->cancelShareSchedule(array $data): array`?????????`schedule_id`?`share_to``oa()->setScheduleReminder(string $scheduleId, int $remindTime, ?int $remindType = null): array`?????????`scheduleId`?`remindTime``oa()->setScheduleAttachments(string $scheduleId, array $attachments): array`?????????`scheduleId`?`attachments``oa()->addScheduleAttendees(array $data): array`??????????`schedule_id`?`attendees``oa()->deleteScheduleAttendees(array $data): array`??????????`schedule_id`?`attendees``oa()->listMeetingRooms(array $query = []): array`??????????`query``oa()->listMeetingRoomsByEquipment(array $equipmentIds, array $query = []): array`???????????`equipmentIds``oa()->getMeetingRoom(string $meetingroomId): array`??????????`meetingroomId``oa()->getMeetingRoomEquipment(string $meetingroomId): array`????????????`meetingroomId``oa()->getMeetingRoomLocation(string $meetingroomId): array`????????????`meetingroomId``oa()->addMeetingRoom(array $data): array`????????`name`?`capacity``oa()->updateMeetingRoom(array $data): array`????????`meetingroom_id``oa()->deleteMeetingRoom(string $meetingroomId): array`????????`meetingroomId``oa()->bookMeetingRoom(array $data): array`????????`meetingroom_id`?`start_time`?`end_time``oa()->cancelMeetingRoom(string $bookingId): array`??????????`bookingId``oa()->getMeetingRoomBooking(string $bookingId): array`????????????`bookingId``oa()->getMeetingRoomAvailability(array $data): array`????????????`meetingroom_id`?`start_time`?`end_time``oa()->addTodo(array $data): array`???????`data``oa()->batchAddTodo(array $todos): array`?????????`todos``oa()->batchUpdateTodo(array $todos): array`?????????`todos``oa()->batchDeleteTodo(array $todoIds): array`?????????`todoIds``oa()->markTodo(array $data): array`?????????`todo_id`?`status``oa()->setTodoReminder(string $todoId, int $remindTime): array`?????????`todoId`?`remindTime``oa()->setTodoCc(string $todoId, array $ccUserIds): array`?????????`todoId`?`ccUserIds``oa()->updateTodo(array $data): array`???????`todo_id``oa()->deleteTodo(string $todoId): array`???????`todoId``oa()->getTodo(string $todoId): array`?????????`todoId``oa()->listTodo(array $query = []): array`?????????`query`身份与登录：

方法说明主要字段（必填/可选）`auth()->getAuthorizeUrl(string $redirectUri, string $state = "STATE", string $scope = "snsapi_base", ?string $agentId = null): string`生成网页授权 URL必填：`redirectUri`。可选：`state`、`scope`（`snsapi_base`/`snsapi_userinfo`）、`agentId``auth()->getQrConnectUrl(string $redirectUri, string $state = "STATE", ?string $agentId = null): string`生成扫码登录 URL必填：`redirectUri`。可选：`state`、`agentId``auth()->getUserInfo(string $code): array`通过 code 获取用户身份必填：`code``auth()->getUserDetail(string $userTicket): array`通过 user\_ticket 获取用户详情必填：`userTicket`应用消息：

方法说明主要字段（必填/可选）`message()->send(array $payload): array`发送应用消息必填：`msgtype`、`agentid`（可省略自动注入）、`touser`/`toparty`/`totag` 至少一项。可选：`safe`、`enable_duplicate_check`、`duplicate_check_interval`。按消息类型补充字段见下表。`message()->sendText(string $content, array $to = []): array`发送文本必填：`content`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendImage(string $mediaId, array $to = []): array`发送图片必填：`mediaId`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendVoice(string $mediaId, array $to = []): array`发送语音必填：`mediaId`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendVideo(string $mediaId, string $title, string $description, array $to = []): array`发送视频必填：`mediaId`、`title`、`description`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendFile(string $mediaId, array $to = []): array`发送文件必填：`mediaId`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendMarkdown(string $content, array $to = []): array`发送 Markdown必填：`content`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendNews(array $articles, array $to = []): array`发送图文必填：`articles`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendMpNews(array $articles, array $to = []): array`发送图文（mpnews）必填：`articles`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendTextCard(string $title, string $description, string $url, array $to = []): array`发送文本卡片必填：`title`、`description`、`url`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendTaskCard(string $title, string $description, string $url, string $taskId, array $btn, array $to = []): array`发送任务卡片必填：`title`、`description`、`url`、`taskId`、`btn`。可选：`to` 内的 `touser`/`toparty`/`totag``message()->sendTemplateCard(array $card, array $to = []): array`发送模板卡片必填：`card`（含 `card_type`）。可选：`to` 内的 `touser`/`toparty`/`totag``message()->updateTaskCard(string $userIds, string $taskId, string $replaceName): array`更新任务卡片必填：`userIds`、`taskId`、`replaceName`消息类型字段说明：

msgtype必填字段说明`text``text.content`文本内容`image``image.media_id`图片素材 media\_id`voice``voice.media_id`语音素材 media\_id`video``video.media_id`、`video.title`、`video.description`视频素材与标题描述`file``file.media_id`文件素材 media\_id`markdown``markdown.content`Markdown 内容`news``news.articles`图文数组，元素需含 `title`、`description`、`url`、`picurl``mpnews``mpnews.articles`图文数组，元素需含 `title`、`thumb_media_id`、`content``textcard``textcard.title`、`textcard.description`、`textcard.url`文本卡片`taskcard``taskcard.title`、`taskcard.description`、`taskcard.url`、`taskcard.task_id`、`taskcard.btn`任务卡片`template_card``template_card.card_type`模板卡片（结构按官方卡片类型）模板卡片字段说明：

通用字段：

字段说明备注`template_card.card_type`卡片类型必填，`text_notice`/`news_notice`/`button_interaction`/`vote_interaction`/`multiple_interaction``template_card.source`来源信息对象可选，见下表`template_card.main_title`主标题对象多数卡片必填，见下表`template_card.card_action`卡片整体跳转多数卡片必填，见下表`template_card.quote_area`引用区域对象可选，见下表`template_card.emphasis_content`强调内容对象可选，见下表`template_card.sub_title_text`副标题文本可选`template_card.horizontal_content_list`横向内容列表可选，元素结构见下表`template_card.jump_list`跳转列表可选，元素结构见下表`template_card.card_image`图片对象可选，见下表`template_card.button_selection`选择按钮对象交互卡片可用，见下表`template_card.button_list`按钮数组交互卡片可用，元素结构见下表`template_card.submit_button`提交按钮对象交互卡片可用，见下表对象字段：

对象字段说明`source``icon_url`来源图标 URL`source``desc`来源描述`source``desc_color`描述颜色`main_title``title`主标题`main_title``desc`主标题描述`quote_area``type`引用类型`quote_area``url`引用跳转 URL`quote_area``title`引用标题`quote_area``quote_text`引用文本`quote_area``image_url`引用图片 URL`emphasis_content``title`强调标题`emphasis_content``desc`强调描述`horizontal_content_list``keyname`名称`horizontal_content_list``value`值`horizontal_content_list``type`类型`horizontal_content_list``url`跳转 URL`horizontal_content_list``media_id`素材 ID`jump_list``type`跳转类型`jump_list``title`文案`jump_list``url`跳转 URL`jump_list``appid`小程序 appid`jump_list``pagepath`小程序路径`card_image``url`图片 URL`card_image``aspect_ratio`图片比例`card_action``type`跳转类型`card_action``url`跳转 URL`card_action``appid`小程序 appid`card_action``pagepath`小程序路径`button_selection``question_key`选择题 key`button_selection``title`选择题标题`button_selection``option_list`选项数组（含 `id`、`text`）`button_selection``selected_id`已选项 ID`button_list``text`按钮文案`button_list``style`按钮样式`button_list``key`按钮 key`button_list``url`按钮跳转 URL`button_list``appid`小程序 appid`button_list``pagepath`小程序路径`submit_button``text`提交按钮文案`submit_button``style`提交按钮样式`submit_button``key`提交按钮 key说明：不同 `card_type` 对字段组合有要求，具体必填规则请以企业微信官方文档为准。 通讯录（成员）：

方法说明主要字段（必填/可选）`contacts()->getUser(string $userId): array`获取成员详情必填：`userId``contacts()->listUsers(int $departmentId = 1, bool $fetchChild = true, ?int $status = null): array`获取部门成员可选：`departmentId`（默认 1）、`fetchChild`（是否递归子部门）、`status``contacts()->listSimpleUsers(int $departmentId = 1, bool $fetchChild = true, ?int $status = null): array`获取部门成员（精简）可选：`departmentId`、`fetchChild`、`status``contacts()->createUser(array $data): array`创建成员必填：`userid`、`name`、`department`。可选：`mobile`、`email`、`position`、`gender`、`enable` 等`contacts()->updateUser(array $data): array`更新成员必填：`userid`。可选：其余需要更新的字段`contacts()->deleteUser(string $userId): array`删除成员必填：`userId`通讯录（部门）：

方法说明主要字段（必填/可选）`contacts()->listDepartments(?int $departmentId = null): array`获取部门列表可选：`departmentId`（不传返回全部）`contacts()->createDepartment(array $data): array`创建部门必填：`name`、`parentid`。可选：`order`、`id``contacts()->updateDepartment(array $data): array`更新部门必填：`id`。可选：`name`、`parentid`、`order``contacts()->deleteDepartment(int $departmentId): array`删除部门必填：`departmentId`多企业/多应用
-------

[](#多企业多应用)

```
$wecom = new WeCom($config, "corp_a", "app1");
$wecomB = $wecom->forCorpApp("corp_b", "app2");
```

高级配置示例
------

[](#高级配置示例)

```
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use WorkWeXin\WeCom;

$logger = new Logger("wecom");
$logger->pushHandler(new StreamHandler(__DIR__ . "/runtime/wecom.log"));

$config["logger"] = $logger;
$config["http"]["retry"] = [
    "max_retries" => 2,
    "retry_delay_ms" => 300,
    "retry_on_status" => [500, 502, 503, 504],
    "retry_on_timeout" => true
];

$wecom = new WeCom($config, "default", "default");
```

错误处理
----

[](#错误处理)

SDK 会在接口返回 `errcode != 0` 时抛出异常：

```
use WorkWeXin\Exception\WeComException;

try {
    $wecom->message()->send([...]);
} catch (WeComException $e) {
    // $e->getErrCode() 获取 errcode
    // $e->getMessage() 获取 errmsg
}
```

通讯录扩展接口
-------

[](#通讯录扩展接口)

批量/异步接口：

方法说明主要字段`contacts()->batchDeleteUsers(array $userIds): array`批量删除成员`userIds``contacts()->inviteUsers(array $userIds = [], array $partyIds = [], array $tagIds = []): array`批量邀请`userIds`/`partyIds`/`tagIds` 至少一项`contacts()->batchSyncUsers(array $data): array`批量同步成员`media_id``contacts()->batchReplaceUsers(array $data): array`批量更新成员`media_id``contacts()->batchReplaceDepartments(array $data): array`批量替换部门`media_id``contacts()->getBatchResult(string $jobId): array`获取异步结果`jobId`标签管理：

方法说明主要字段`contacts()->listTags(): array`获取标签列表-`contacts()->getTag(int $tagId): array`获取标签成员`tagId``contacts()->createTag(string $name, ?int $tagId = null): array`创建标签`name``contacts()->updateTag(int $tagId, string $tagName): array`更新标签`tagId`、`tagName``contacts()->deleteTag(int $tagId): array`删除标签`tagId``contacts()->addTagUsers(int $tagId, array $userList = [], array $partyList = []): array`标签增加成员`tagId`、`userList`/`partyList``contacts()->deleteTagUsers(int $tagId, array $userList = [], array $partyList = []): array`标签删除成员`tagId`、`userList`/`partyList`通讯录回调与变更同步
----------

[](#通讯录回调与变更同步)

回调配置：

```
$config["corps"]["default"]["callback"] = [
    "token" => "your_token",
    "encoding_aes_key" => "your_encoding_aes_key_43_chars"
];
```

使用示例：

```
$crypto = $wecom->callback();
$plain = $crypto->verifyUrl($msgSignature, $timestamp, $nonce, $echoStr);
$event = $crypto->decryptMessage($msgSignature, $timestamp, $nonce, $postData);
```

回调事件分发示例：

```
$events = $wecom->callbackEvents();

$events->onEvent("change_contact", function (array $event, $service) {
    // 例如：成员/部门变更
    return null;
});

$events->onMessage("text", function (array $event, $service) {
    // 这里返回明文 XML，SDK 会自动加密
    return $service->buildTextReply($event, "已收到");
});

$reply = $events->dispatch($msgSignature, $timestamp, $nonce, $postData);
// echo $reply;
```

常见回调类型（示例）：

- Event: `change_contact`
    - ChangeType: `create_user`/`update_user`/`delete_user`/`create_party`/`update_party`/`delete_party`
- Event: `change_external_contact`
    - ChangeType: `add_external_contact`/`edit_external_contact`/`del_external_contact`/`add_half_external_contact`/`del_half_external_contact`
- Event: `sys_approval_change`
    - ChangeType: `approve`/`reject`/`cancel`

示例
--

[](#示例)

参考 `examples/basic.php`、`examples/callback.php`、`examples/customer_contact.php`、`examples/approval_oa.php`、`examples/miniprogram.php`、`examples/payment.php`。

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance52

Moderate activity, may be stable

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/ce2f6eeaefc7077f2e238b6a2f1ad390d2fdaebf7acefe513f4f80936cc85eb3?d=identicon)[chenchangping1987](/maintainers/chenchangping1987)

---

Top Contributors

[![cping6](https://avatars.githubusercontent.com/u/20664106?v=4)](https://github.com/cping6 "cping6 (1 commits)")

### Embed Badge

![Health badge](/badges/workwexin-wecom/health.svg)

```
[![Health](https://phpackages.com/badges/workwexin-wecom/health.svg)](https://phpackages.com/packages/workwexin-wecom)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)