通訊錄
<?php
$config = [
// 企業微信后臺的 企業 ID
'corpId' => 'xxxxxxxxxxxxxxxxx',
// 通訊錄的 secret
'corpSecret' => 'xxxxxxxxxxxxxxxxx',
// ...
];
// 企業微信
$work = \EasySwoole\WeChat\Factory::work($config);
成員管理
創建成員
<?php
$data = [
"userid" => "easyswoole",
"name" => "EasySwoole",
"english_name" => "easyswoole",
"mobile" => "12345678910",
];
$work->user->create($data);
讀取成員
$work->user->get('easyswoole');
更新成員
<?php
$work->user->update('easyswoole', [
"isleader" => 0,
'position' => 'PHP 工程師',
// ...
]);
刪除成員
<?php
$work->user->delete('easyswoole');
// 或者刪除多個
$work->user->delete(['easyswoole', 'zhangsan', 'wangwu']);
獲取部門成員
<?php
$work->user->getDepartmentUsers($departmentId);
// 遞歸獲取子部門下面的成員
$work->user->getDepartmentUsers($departmentId, true);
獲取部門成員詳情
<?php
$work->user->getDetailedDepartmentUsers($departmentId);
// 遞歸獲取子部門下面的成員
$work->user->getDetailedDepartmentUsers($departmentId, true);
用戶 ID 轉為 openid
<?php
$work->user->userIdToOpenid($userId);
// 或者指定應用 ID
$work->user->userIdToOpenid($userId, $agentId);
openid 轉為用戶 ID
$work->user->openidToUserId($openid);
手機號轉為用戶 ID
$work->user->mobileToUserId($mobile);
二次驗證
企業在成員驗證成功后,調用如下接口即可讓成員加入成功
$work->user->accept($userId);
邀請成員
企業可通過接口批量邀請成員使用企業微信,邀請后將通過短信或郵件下發通知。
<?php
$params = [
// 成員ID列表, 最多支持1000個
'user' => ['UserID1', 'UserID2', 'UserID3'],
// 部門ID列表,最多支持100個
'party' => ['PartyID1', 'PartyID2'],
// 標簽ID列表,最多支持100個
'tag' => ['TagID1', 'TagID2']
];
$work->user->invite($params);
user、party、tag
三者不能同時為空
獲取邀請二維碼
<?php
// qrcode尺寸類型,1: 171 x 171; 2: 399 x 399; 3: 741 x 741; 4: 2052 x 2052
$sizeType = 1;
$work->user->getInvitationQrCode($sizeType);
部門管理
創建部門
<?php
$work->department->create([
'name' => '廣州研發中心',
'parentid' => 1,
'order' => 1,
'id' => 2,
]);
更新部門
<?php
$work->department->update($id, [
'name' => '廣州研發中心',
'parentid' => 1,
'order' => 1,
]);
刪除部門
<?php
$work->department->delete($id);
獲取部門列表
<?php
$work->department->list();
// 獲取指定部門及其下的子部門
$work->department->list($id);
標簽管理
創建標簽
$work->user->tag->create($tagName, $tagId);
更新標簽名字
$work->user->tag->update($tagId, $tagName);
刪除標簽
$work->user->tag->delete($tagId);
獲取標簽列表
$work->user->tag->list();
獲取標簽成員(標簽詳情)
$work->user->tag->get($tagId);
增加標簽成員
<?php
$work->user->tag->tagUsers($tagId, [$userId1, $userId2, ...]);
// 指定部門
$work->user->tag->tagDepartments($tagId, [$departmentId1, $departmentId2, ...]);
刪除標簽成員
<?php
$work->user->tag->untagUsers($tagId, [$userId1, $userId2, ...]);
// 指定部門
$work->user->tag->untagDepartments($tagId, [$departmentId1, $departmentId2, ...]);
異步批量接口
注意: 【異步批量接口】需要使用 ”通訊錄同步” secret
所獲取的 accesstoken
來調用。 傳送門: https://work.weixin.qq.com/wework_admin/frame#apps/contactsApi
增量更新成員
<?php
$params = [
'media_id' => 'mediaId',
'to_invite' => true,
'callback' => [
'url' => 'xxx',
'token' => 'xxx',
'encodingaeskey' => 'xxx'
]
];
$work->user->batchJobs->batchUpdateUsers(array $params);
全量覆蓋成員
<?php
$params = [
'media_id' => 'mediaId',
'to_invite' => true,
'callback' => [
'url' => 'xxx',
'token' => 'xxx',
'encodingaeskey' => 'xxx'
]
];
$work->user->batchJobs->batchReplaceUsers(array $params);
全量覆蓋部門
<?php
$params = [
'media_id' => 'mediaId',
'callback' => [
'url' => 'xxx',
'token' => 'xxx',
'encodingaeskey' => 'xxx'
]
];
$work->user->batchJobs->batchReplaceDepartments(array $params);
獲取異步任務結果
<?php
$jobId = '2322232';
$work->user->batchJobs->getJobStatus(array $jobId);
互聯企業
獲取應用的可見范圍
$work->user->linkedCorp->getAgentPermissions();
獲取互聯企業成員詳細信息
<?php
$userId = 'corpId/userId';
$work->user->linkedCorp->getUser(string $userId);
獲取互聯企業部門成員
<?php
$departmentId = 'linkedId/departmentId';
$fetchChild = true;
$work->user->linkedCorp->getUsers(string $departmentId, bool $fetchChild = true);
獲取互聯企業部門成員詳情
<?php
$departmentId = 'linkedId/departmentId';
$fetchChild = true;
$work->user->linkedCorp->getDetailedUsers(string $departmentId, bool $fetchChild = true);
獲取互聯企業部門列表
<?php
$departmentId = 'linkedId/departmentId';
$work->user->linkedCorp->getDepartments(string $departmentId);