目次

1. タグ作成
2. タグ名変更
3. タグ削除
4. タグの所属ユーザ取得
5. タグの所属ユーザ追加
6. タグの所属ユーザ削除
7. タグ一覧の取得

タグ作成

リクエスト説明

HTTPSリクエストメソッド：POST
https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN

リクエストボディ

{
   "tagname": "UI",
   "tagid": id
}

パラメータ説明

パラメータ	必須	説明
access_token	Y	Access Token
tagname	Y	タグ名。最大64文字。重複禁止
tagid	N	タグID。整数。パラメータで指定すれば任意の値を指定可能。未指定の場合は最大値。

権限説明

作成したタグは管理グループ配下属し、デフォルトはロック状態。ロック状態の場合は、管理グループ内のみユーザの増減が可能。アンロック状態では、その他の管理グループのユーザ増減が可能。

レスポンス結果

{
   "errcode": 0,
   "errmsg": "created"
   "tagid": "1"
}

タグ名変更

リクエスト説明

HTTPSリクエストメソッド：POST
https://qyapi.weixin.qq.com/cgi-bin/tag/update?access_token=ACCESS_TOKEN

リクエストボディ

{
   "tagname": "UI",
   "tagid": id
}

パラメータ説明

パラメータ	必須	説明
access_token	Y	Access Token
tagname	Y	タグ名。最大64文字。重複禁止
tagid	N	タグID

権限説明

指定したタグの作成者である事

レスポンス結果

{
   "errcode": 0,
   "errmsg": "updated"
}

タグ削除

リクエスト説明

HTTPSリクエストメソッド：GET
https://qyapi.weixin.qq.com/cgi-bin/tag/delete?access_token=ACCESS_TOKEN&tagid=TAGID

パラメータ説明

パラメータ	必須	説明
access_token	Y	Access Token
tagid	N	タグID

権限説明

指定したタグの作成者である事。かつ所属ユーザが存在しない事

レスポンス結果

{
   "errcode": 0,
   "errmsg": "deleted"
}

タグの所属ユーザ取得

リクエスト説明

HTTPSリクエストメソッド：GET
https://qyapi.weixin.qq.com/cgi-bin/tag/get?access_token=ACCESS_TOKEN&tagid=TAGID

パラメータ説明

パラメータ	必須	説明
access_token	Y	Access Token
tagid	Y	タグID

権限説明

制限無し。ただし、結果一覧は管理グループの管轄している範囲内のユーザのみ出力。

レスポンス結果

{
   "errcode": 0,
   "errmsg": "ok",
   "userlist": [
         {
             "userid": "zhangsan",
             "name": "李四"
         }
     ],
   "partylist": [2]
}

パラメータ	必須	説明
errcode	結果コード
errmsg	エラーメッセージ
userlist	ユーザ配列
userid	ユーザID。管理コンソール上の帐号。
name	ユーザ名称
partylist	部門ID配列。

タグの所属ユーザ追加

リクエスト説明

HTTPSリクエストメソッド：POST
https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers?access_token=ACCESS_TOKEN

リクエストボディ

{
   "tagid": "1",
   "userlist":[ "user1","user2"],
   "partylist": [4]
}

パラメータ説明

パラメータ	必須	説明
access_token	Y	Access Token
tagid	Y	タグID
userlist	N	ユーザID配列。注意：userlist、partylistどちらか必須。最大配列数1000。
partylist	N	部門ID配列。注意：userlist、partylistどちらか必須。最大配列数100。

権限説明

タグを作成した管理グループ。またはアンロックの場合は、管理グループの管轄の内ユーザ

レスポンス結果

a)正常結果

{
   "errcode": 0,
   "errmsg": "ok"
}

b)userid,partylistの一部が無効の場合

{
   "errcode": 0,
   "errmsg": "错误消息",
   "invalidlist"："usr1|usr2|usr",
   "invalidparty"：[2,4]
}

具体的に発生するその他のエラー分類
invalid userlist and partylist faild
invalid userlist faild
invalid partylist faild

c)userid, partylist全てが無効の場合

{
   "errcode": 40070,
   "errmsg": "all list invalid "
}

パラメータ	必須	説明
errcode	エラーコード
errmsg	エラーメッセージ
invalidlist	権限範囲外のユーザID配列。“\|”区切り
invalidparty	N	権限範囲外の部門ID配列。

タグの所属ユーザ削除

リクエスト説明

HTTPSリクエストメソッド：POST
https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers?access_token=ACCESS_TOKEN