通訊錄

<?php
$config = [
    // 企業(yè)微信后臺(tái)的 企業(yè) ID
    'corpId' => 'xxxxxxxxxxxxxxxxx',

    // 通訊錄的 secret
    'corpSecret' => 'xxxxxxxxxxxxxxxxx',

    // ...
];

// 企業(yè)微信
$work = \EasySwoole\WeChat\Factory::work($config);

成員管理

創(chuàng)建成員

<?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');
// 或者刪除多個(gè)
$work->user->delete(['easyswoole', 'zhangsan', 'wangwu']);

獲取部門(mén)成員

<?php
$work->user->getDepartmentUsers($departmentId);
// 遞歸獲取子部門(mén)下面的成員
$work->user->getDepartmentUsers($departmentId, true);

獲取部門(mén)成員詳情

<?php
$work->user->getDetailedDepartmentUsers($departmentId);
// 遞歸獲取子部門(mén)下面的成員
$work->user->getDetailedDepartmentUsers($departmentId, true);

用戶(hù) ID 轉(zhuǎn)為 openid

<?php
$work->user->userIdToOpenid($userId);
// 或者指定應(yīng)用 ID
$work->user->userIdToOpenid($userId, $agentId);

openid 轉(zhuǎn)為用戶(hù) ID

$work->user->openidToUserId($openid);

手機(jī)號(hào)轉(zhuǎn)為用戶(hù) ID

$work->user->mobileToUserId($mobile);

二次驗(yàn)證

企業(yè)在成員驗(yàn)證成功后，調(diào)用如下接口即可讓成員加入成功

$work->user->accept($userId);

邀請(qǐng)成員

企業(yè)可通過(guò)接口批量邀請(qǐng)成員使用企業(yè)微信，邀請(qǐng)后將通過(guò)短信或郵件下發(fā)通知。

<?php
$params = [
    // 成員ID列表, 最多支持1000個(gè)
    'user' => ['UserID1', 'UserID2', 'UserID3'],

    // 部門(mén)ID列表，最多支持100個(gè)
    'party' => ['PartyID1', 'PartyID2'],

    // 標(biāo)簽ID列表，最多支持100個(gè)
    'tag' => ['TagID1', 'TagID2']
];

$work->user->invite($params);

user、party、tag 三者不能同時(shí)為空

獲取邀請(qǐng)二維碼

<?php
// qrcode尺寸類(lèi)型，1: 171 x 171; 2: 399 x 399; 3: 741 x 741; 4: 2052 x 2052
$sizeType = 1; 

$work->user->getInvitationQrCode($sizeType);

部門(mén)管理

創(chuàng)建部門(mén)

<?php
$work->department->create([
    'name' => '廣州研發(fā)中心',
    'parentid' => 1,
    'order' => 1,
    'id' => 2,
]);

更新部門(mén)

<?php
$work->department->update($id, [
    'name' => '廣州研發(fā)中心',
    'parentid' => 1,
    'order' => 1,
]);

刪除部門(mén)

<?php
$work->department->delete($id);

獲取部門(mén)列表

<?php
$work->department->list();
// 獲取指定部門(mén)及其下的子部門(mén)
$work->department->list($id);

標(biāo)簽管理

創(chuàng)建標(biāo)簽

$work->user->tag->create($tagName, $tagId);

更新標(biāo)簽名字

$work->user->tag->update($tagId, $tagName);

刪除標(biāo)簽

$work->user->tag->delete($tagId);

獲取標(biāo)簽列表

$work->user->tag->list();

獲取標(biāo)簽成員(標(biāo)簽詳情)

$work->user->tag->get($tagId);

增加標(biāo)簽成員

<?php
$work->user->tag->tagUsers($tagId, [$userId1, $userId2, ...]);
// 指定部門(mén)
$work->user->tag->tagDepartments($tagId, [$departmentId1, $departmentId2, ...]);

刪除標(biāo)簽成員

<?php
$work->user->tag->untagUsers($tagId, [$userId1, $userId2, ...]);
// 指定部門(mén)
$work->user->tag->untagDepartments($tagId, [$departmentId1, $departmentId2, ...]);

異步批量接口

增量更新成員

<?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);

全量覆蓋部門(mén)

<?php
$params = [
    'media_id' => 'mediaId',
    'callback' => [
        'url' => 'xxx',
        'token' => 'xxx',
        'encodingaeskey' => 'xxx'
    ]
];

$work->user->batchJobs->batchReplaceDepartments(array $params);

獲取異步任務(wù)結(jié)果

<?php
$jobId = '2322232';

$work->user->batchJobs->getJobStatus(array $jobId);

互聯(lián)企業(yè)

獲取應(yīng)用的可見(jiàn)范圍

$work->user->linkedCorp->getAgentPermissions();

獲取互聯(lián)企業(yè)成員詳細(xì)信息

<?php
$userId = 'corpId/userId';

$work->user->linkedCorp->getUser(string $userId);

獲取互聯(lián)企業(yè)部門(mén)成員

<?php
$departmentId = 'linkedId/departmentId';
$fetchChild = true;

$work->user->linkedCorp->getUsers(string $departmentId, bool $fetchChild = true);

獲取互聯(lián)企業(yè)部門(mén)成員詳情

<?php
$departmentId = 'linkedId/departmentId';
$fetchChild = true;

$work->user->linkedCorp->getDetailedUsers(string $departmentId, bool $fetchChild = true);

獲取互聯(lián)企業(yè)部門(mén)列表

<?php
$departmentId = 'linkedId/departmentId';

$work->user->linkedCorp->getDepartments(string $departmentId);