Name

QQ::exmail::tag

DESCRIPTION

通讯录管理->管理标签

FUNCTION

create(access_token, hash);

创建标签

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10050

请求说明:

请求包结构体为:

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

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
tagname	        是	标签名称,长度限制为32个字以内(汉字或英文字母),标签名不可与其他标签重名。
tagid	        否	标签id,非负整型,指定此参数时新增的标签会生成对应的标签id,不指定时则以目前最大的id自增。

注意

标签总数不能超过3000个。

RETURN 返回结果

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

RETURN 参数说明

参数	    说明
errcode	返回码
errmsg	对返回码的文本描述内容
tagid	标签id

update(access_token, hash);

更新标签名字

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10051

请求说明:

请求包结构体为:

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

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
tagid	        是	标签ID
tagname	        是	标签名称,长度限制为32个字(汉字或英文字母),标签不可与其他标签重名。

RETURN 返回结果

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

RETURN 参数说明

参数	    说明
errcode	返回码
errmsg	对返回码的文本描述内容

delete(access_token, tagid);

删除标签

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10052

请求说明:

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
tagid	        是	标签ID

RETURN 返回结果

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

RETURN 参数说明

参数	    说明
errcode	返回码
errmsg	对返回码的文本描述内容

get(access_token, tagid);

获取标签成员

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10053

请求说明:

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
tagid	        是	标签ID

RETURN 返回结果

{
   "errcode": 0,
   "errmsg": "ok",
   "tagname": "乒乓球协会",
   "userlist": [
        {
            "userid": "zhangsan@gz.com",
            "name": "李四"
        }
     ],
   "partylist": [2]
}

RETURN 参数说明

参数	        说明
errcode	    返回码
errmsg	    对返回码的文本描述内容
tagname	    标签名
userlist	标签中包含的成员列表
userid	    成员UserID。企业邮帐号名,邮箱格式
name	    成员名
partylist	标签中包含的部门id列表

addtagusers(access_token, hash);

增加标签成员

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10054

请求说明:

请求包结构体为:

{
    "tagid": 12,
    "userlist":[ "user1@gz.com","user2@gz.com"],
    "partylist": [4]
}

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
tagid	        是	标签ID
userlist    	否	企业成员ID列表,邮箱格式,注意:userlist、partylist不能同时为空,单次请求长度不超过1000
partylist	    否	企业部门ID列表,注意:userlist、partylist不能同时为空,单次请求长度不超过100

注意

每个标签下部门、人员总数不能超过3万个。

RETURN 返回结果

a)正确时返回

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

b)若部分userid、partylist非法,则返回

{
    "errcode": 0,
    "errmsg": "ok",
    "invalidlist":"usr1@gz.com|usr2@gz.com|usr@gz.com",
    "invalidparty":[2,4]
}

c)当包含userid、partylist全部非法时返回

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

RETURN 参数说明

参数	            说明
errcode	        返回码
errmsg	        对返回码的文本描述内容
invalidlist	    非法的成员帐号列表
invalidparty	非法的部门id列表

deltagusers(access_token, hash);

删除标签成员

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10055

请求说明:

请求包结构体为:

{
    "tagid": 12,
    "userlist":[ "user1@gz.com","user2@gz.com"],
    "partylist": [2,4]
}

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
tagid	        是	标签ID
userlist	    否	企业成员ID列表,邮箱格式,注意:userlist、partylist不能同时为空
partylist	    否	企业部门ID列表,注意:userlist、partylist不能同时为空

RETURN 返回结果

a)正确时返回

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

b)若部分userid、partylist非法,则返回

{
    "errcode": 0,
    "errmsg": "deleted",
    "invalidlist":"usr1@gz.com|usr2@gz.com|usr@gz.com",
    "invalidparty":[2,4]
}

c)当包含userid、partylist全部非法时返回

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

RETURN 参数说明

参数	            说明
errcode	        返回码
errmsg	        对返回码的文本描述内容
invalidlist	    非法的成员帐号列表
invalidparty	非法的部门id列表

list(access_token);

获取标签列表

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10056

请求说明:

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证

RETURN 返回结果

{
   "errcode": 0,
   "errmsg": "ok",
   "taglist":[
      {"tagid":1,"tagname":"a"},
      {"tagid":2,"tagname":"b"}
   ]
}

RETURN 参数说明 参数 说明 errcode 返回码 errmsg 对返回码的文本描述内容 taglist 标签列表 tagid 标签id tagname 标签名