Client.php
8.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<?php
/*
* This file is part of the overtrue/wechat.
*
* (c) overtrue <i@overtrue.me>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace EasyWeChat\Work\ExternalContact;
use EasyWeChat\Kernel\BaseClient;
/**
* Class Client.
*
* @author mingyoung <mingyoungcheung@gmail.com>
*/
class Client extends BaseClient
{
/**
* 获取配置了客户联系功能的成员列表.
*
* @see https://work.weixin.qq.com/api/doc#90000/90135/91554
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function getFollowUsers()
{
return $this->httpGet('cgi-bin/externalcontact/get_follow_user_list');
}
/**
* 获取外部联系人列表.
*
* @see https://work.weixin.qq.com/api/doc#90000/90135/91555
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function list(string $userId)
{
return $this->httpGet('cgi-bin/externalcontact/list', [
'userid' => $userId,
]);
}
/**
* 获取外部联系人详情.
*
* @see https://work.weixin.qq.com/api/doc#90000/90135/91556
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function get(string $externalUserId)
{
return $this->httpGet('cgi-bin/externalcontact/get', [
'external_userid' => $externalUserId,
]);
}
/**
* 批量获取外部联系人详情.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92994
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function batchGetUsers(array $data)
{
return $this->httpPostJson(
'cgi-bin/externalcontact/batch/get_by_user',
$data
);
}
/**
* 修改客户备注信息.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92115
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function remark(array $data)
{
return $this->httpPostJson(
'cgi-bin/externalcontact/remark',
$data
);
}
/**
* 获取离职成员的客户列表.
*
* @see https://work.weixin.qq.com/api/doc#90000/90135/91563
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function getUnassigned(int $pageId = 0, int $pageSize = 1000)
{
return $this->httpPostJson('cgi-bin/externalcontact/get_unassigned_list', [
'page_id' => $pageId,
'page_size' => $pageSize,
]);
}
/**
* 离职成员的外部联系人再分配.
*
* @see https://work.weixin.qq.com/api/doc#90000/90135/91564
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function transfer(string $externalUserId, string $handoverUserId, string $takeoverUserId)
{
$params = [
'external_userid' => $externalUserId,
'handover_userid' => $handoverUserId,
'takeover_userid' => $takeoverUserId,
];
return $this->httpPostJson('cgi-bin/externalcontact/transfer', $params);
}
/**
* 获取客户群列表.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92120
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function getGroupChats(array $params)
{
return $this->httpPostJson('cgi-bin/externalcontact/groupchat/list', $params);
}
/**
* 获取客户群详情.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92122
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function getGroupChat(string $chatId, int $needName = 0)
{
$params = [
'chat_id' => $chatId,
'need_name' => $needName,
];
return $this->httpPostJson('cgi-bin/externalcontact/groupchat/get', $params);
}
/**
* 获取企业标签库.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92117#获取企业标签库
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function getCorpTags(array $tagIds = [])
{
$params = [
'tag_id' => $tagIds,
];
return $this->httpPostJson('cgi-bin/externalcontact/get_corp_tag_list', $params);
}
/**
* 添加企业客户标签.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92117#添加企业客户标签
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function addCorpTag(array $params)
{
return $this->httpPostJson('cgi-bin/externalcontact/add_corp_tag', $params);
}
/**
* 编辑企业客户标签.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92117#编辑企业客户标签
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function updateCorpTag(string $id, string $name, int $order = 1)
{
$params = [
'id' => $id,
'name' => $name,
'order' => $order,
];
return $this->httpPostJson('cgi-bin/externalcontact/edit_corp_tag', $params);
}
/**
* 删除企业客户标签.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92117#删除企业客户标签
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function deleteCorpTag(array $tagId, array $groupId)
{
$params = [
'tag_id' => $tagId,
'group_id' => $groupId,
];
return $this->httpPostJson('cgi-bin/externalcontact/del_corp_tag', $params);
}
/**
* 编辑客户企业标签.
*
* @see https://work.weixin.qq.com/api/doc/90000/90135/92118
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function markTags(array $params)
{
return $this->httpPostJson('cgi-bin/externalcontact/mark_tag', $params);
}
}