腾讯乐享接口文档

# 标签管理

# 创建标签

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/create?access_token=ACCESS_TOKEN

请求包体：

{
    "id": "123",
    "name": "标签"
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 否 标签id，大于0小于100000的整数字符串，不指定时系统自动生成32位随机字符串
name 是 标签名称，名称长度为1-32个字，可由汉字、英文字母、数字或—()（）_-/[]【】<>符号组成

返回结果：

{
    "msg": "success",
    "code": 0,
    "data": {
        "id": "3e64cd98ff0511eb97d0623bfcb7341c"
    }
}

参数说明：

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 返回数据
id 标签id

错误码说明（请求包体参数错误）：

CODE 说明
20011 标签已经存在
20018 标签id已经存在
30011 标签id只能为正整数并且大于0小于100000的字符串
30012 名称长度为1-32个字，可由汉字、英文字母、数字或—()（）_-/[]【】<>符号组成

# 更新标签

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/update?access_token=ACCESS_TOKEN

请求包体（如果非必须的字段未指定，则不更新该字段）：

{
    "id": "3e64cd98ff0511eb97d0623bfcb7341c",
    "name": "标签test"
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 是 标签id
name 否 标签名称，名称长度为1-32个字，可由汉字、英文字母、数字或—()（）_-/[]【】<>符号组成

返回结果：

{
    "msg": "success",
    "code": 0,
    "data": {
        "id": "3e64cd98ff0511eb97d0623bfcb7341c"
    }
}

参数说明：

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 响应数据

错误码说明（请求包体参数错误）：

CODE 说明
20010 标签不存在
20011 标签名对应的标签已经存在
20012 非乐享标签不支持修改
30012 名称长度为1-32个字，可由汉字、英文字母、数字或—()（）_-/[]【】<>符号组成

# 删除标签

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/delete?access_token=ACCESS_TOKEN

请求包体（如果非必须的字段未指定，则不更新该字段）：

{
    "id": "3e64cd98ff0511eb97d0623bfcb7341c"
}

参数说明：

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

返回结果：

{
    "msg": "success",
    "code": 0,
    "data": null
}

参数说明：

参数 说明
code 返回码
msg 对返回码的文本描述内容

错误码说明（请求包体参数错误）：

CODE 说明
20010 标签id不存在
20013 非乐享标签不支持删除

# 增加标签成员

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/add-users?access_token=ACCESS_TOKEN

请求包体：

{
    "id": "572c2858fe6f11ebb1d2a67595a2469f", 
    "user_list": ["zhangsan", "lisi"],
    "department_list": ["1", "2"]
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 是 标签id
user_list 否 用户id列表， 长度限制为1000
department_list 否 部门id列表，长度限制为1000

返回结果：

{
    "data": {
        "invalid_user_list": []
    },
    "msg": "success",
    "code": 0
}

参数说明：

参数 说明
invalid_user_list 无效成员列表
code 返回码
msg 对返回码的文本描述内容

错误码说明（请求包体参数错误）：

CODE 说明
20011 参数错误（id为空）
20010 标签不存在
20014 非乐享标签不支持增加标签成员
30012 标签名称只能是中文和英文字符，且长度不能超过32
30013 用户id列表只能为数组且长度不能超过1000
30014 部门id列表只能为数组且长度不能超过1000

# 删除标签成员

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/del-users?access_token=ACCESS_TOKEN

请求包体：

{
    "id": "572c2858fe6f11ebb1d2a67595a2469f", 
    "user_list": ["zhangsan", "lisi"],
    "department_list": ["1", "2"]
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 是 标签id
user_list 否 用户id列表
department_list 否 部门id列表

返回结果：

{
    "msg": "success",
    "code": 0,
    "data": null
}

参数说明：

参数 说明
code 返回码
msg 对返回码的文本描述内容

错误码说明（请求包体参数错误）：

CODE 说明
20010 标签不存在
20015 非乐享标签不支持删除标签成员

# 获取标签成员

请求方式：GET（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/users?access_token=ACCESS_TOKEN&tag_id={tag_id}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
tag_id 是 标签id
page 否 当前页数
per_page 否 每页返回的数量 1~1000，当需要使用分页page参数时，此参数需要传入

返回结果：

{
  "data": {
    "id": "533e394a570511ec97796ae7e46f4585", 
    "name": "121", 
    "user_list": [
      "zhangsan", 
      "lisi", 
      "wangwu"
    ], 
    "department_list": [
      23, 
      24, 
      25
    ]
  }, 
  "msg": "success", 
  "code": 0
}

参数说明：

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 返回内容

错误码说明（请求入参错误）：

CODE 说明
20010 标签不存在，参数错误：缺少tag_id , per page 必须在1 和 1000 之间

# 获取所有标签

请求方式：GET（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/all?access_token=ACCESS_TOKEN

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
offset 是 偏移量, 默认0
limit 是 数目, 默认20

返回结果：

{
    "msg": "success",
    "code": 0,
    "data": {
        "total": 2,
        "list": [
            {
                "name": "标签A",
                "id": "572c2858fe6f11ebb1d2a67595a2469f"
            },
            {
                "name": "标签B",
                "id": "954b52c0fe7011eb9f34d229e73ba5ca"
            }
        ]
    }
}

参数说明：

参数 说明
code 返回码
msg 对返回码的文本描述内容
data 返回内容

← 通用说明 →