乐享知识库接口文档

# 标签管理

# 创建标签

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/create

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数

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

请求参数说明

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

响应

200 Ok 状态码

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

响应参数说明

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

错误码说明

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

# 更新标签

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/update

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数

如果非必须的字段未指定，则不更新该字段

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

请求参数说明

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

响应

200 Ok 状态码

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

响应参数说明

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

错误码说明

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

# 删除标签

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/delete

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数

{
  "id": "3e64cd98ff0511eb97d0623bfcb7341c"
}

请求参数说明

参数 必须 说明
id 是 标签id

响应

200 Ok 状态码

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

响应参数说明

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

错误码说明

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

# 增加标签成员

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/add-users

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数

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

请求参数说明

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

响应

200 Ok 状态码

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

响应参数说明

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

错误码说明

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

# 删除标签成员

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/del-users

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数

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

请求参数说明

参数 必须 说明
id 是 标签id
user_list 否 用户id列表
department_list 否 部门id列表

响应

200 Ok 状态码

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

响应参数说明

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

错误码说明

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

# 获取标签成员

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/users

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数说明

参数 必须 默认值 说明
tag_id 是 无 标签id
page 否 无 当前页数。page 与 per_page 必须同时传入才会启用分页；任意一个未传则不分页，返回标签下全部成员且响应中无 total 字段
per_page 否 无 每页返回的数量，范围 1~1000。需要与 page 同时传入

响应

200 Ok 状态码

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

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容
data 返回数据
data.total 标签下成员总数。仅当同时传入 page 和 per_page 时返回；不分页时无此字段
data.id 标签id
data.name 标签名称
data.user_list 标签下的用户id列表
data.department_list 标签下的部门id列表

错误码说明

错误码 说明
20010 标签不存在；或参数错误：缺少 tag_id；或 per_page 必须在 1~1000 之间

# 获取所有标签

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/tag/all

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数说明

参数 必须 默认值 说明
offset 是 0 偏移量
limit 是 20 数目

响应

200 Ok 状态码

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

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容
data 返回数据
data.total 标签总数
data.list 标签列表
data.list[].id 标签id
data.list[].name 标签名称

← 平台集成 →