乐享知识库接口文档

# 平台集成

# 概述

乐享知识库可集成到企业微信、钉钉、飞书等平台中使用。

平台集成接口是为解决乐享成员如何映射到不同平台用户，以满足平台OAuth授权登录以及从平台接收乐享推送消息的需求。

# 概念说明

平台：指企业微信、钉钉、飞书

数据源：平台下的一个企业/租户/组织。

# 映射规则说明

  • 一个乐享成员可以同时映射到不同数据源的用户，但不能同时映射到同一数据源的不同用户

示例：乐享用户"张三"可以同时映射企业微信3个不同企业以及飞书1个企业的用户，但不能同时映射到企业微信一个企业下的a和b两个用户

  • 一个数据源的用户不能映射给乐享中多个成员

示例：企微的"张三"不能同时映射乐享的a和b

# 添加映射关系

请求URL

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

请求头

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

其他说明

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

请求参数

{
  "mapping_list": [
    {
      "source_id": "xxxx",
      "target_id": "zhangsan",
      "platform": "privatelark",
      "company_corp_id": "lark_cli_a67ba81c6xx"
    },
    {
      "source_id": "xxxx",
      "target_id": "lisi",
      "platform": "wecom",
      "company_corp_id": "wp-psUDwAAp7JgmZWxxxx"
    }
  ]
}

请求参数说明

参数 是否必须 默认值 说明
mapping_list 是 无 映射对象数组，单次最多传入100条记录
mapping_list[].source_id 是 无 数据源用户id
mapping_list[].target_id 是 无 乐享成员帐号，staff_id
mapping_list[].platform 是 无 平台类型
wecom表示企业微信第三方应用
privatewechat表示企业微信自建应用
privatelark表示飞书自建应用
privatedingtalk表示钉钉自建应用
mapping_list[].company_corp_id 是 无 平台租户ID

响应

200 Ok 状态码

{
  "data": {
    "added_count": 2,
    "invalid_list": []
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容
data.added_count 成功添加条数
data.invalid_list 无效用户列表

错误码说明

错误码 说明
1001 插入条数为空
1002 插入条数超过最大100条限制

# 删除映射关系

请求URL

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

请求头

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

其他说明

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

请求参数

[
  {
    "source_id": "xxxx",
    "target_id": "zhangsan",
    "platform": "privatelark",
    "company_corp_id": "lark_cli_a67ba81xxx"
  },
  {
    "source_id": "xxxx",
    "target_id": "lisi",
    "platform": "wecom",
    "company_corp_id": "wp-psUDwAAp7JgmZWKcLsoxxx"
  }
]

请求参数说明

参数 是否必须 默认值 说明
source_id 是 无 数据源用户id
target_id 是 无 乐享成员帐号，staff_id
platform 是 无 平台类型
wecom表示企业微信第三方应用
privatewechat表示企业微信自建应用
privatelark表示飞书自建应用
privatedingtalk表示钉钉自建应用
company_corp_id 是 无 平台租户ID

响应

200 Ok 状态码

{
  "data": [
    {
      "source_id": "xxxx",
      "target_id": "sandxu3",
      "platform": "privatelark",
      "company_corp_id": "lark_cli_a67ba81xxx",
      "deleted": true
    },
    {
      "source_id": "xxxx",
      "target_id": "sandxu3",
      "platform": "wecom",
      "company_corp_id": "wp-psUDwAAp7JgmZWKcLxxx",
      "deleted": true
    }
  ],
  "msg": "success",
  "code": 0
}

响应参数说明

参数 说明
code 错误码
msg 对错误码的文本描述内容
data[].deleted 删除成功：true ；删除失败：false

错误码说明

错误码 说明
1001 删除数据参数为空
1002 删除条数超过最大100条限制

# 查询映射关系

请求URL

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

请求头

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

其他说明

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

请求参数说明

参数 是否必须 默认值 说明
source_id 是 无 指定要查询的数据源用户id
target_id 是 无 指定要查询的乐享成员帐号
platform 是 无 指定要查询的平台类型
wecom表示企业微信第三方应用
privatewechat表示企业微信自建应用
privatelark表示飞书自建应用
privatedingtalk表示钉钉自建应用
company_corp_id 是 无 指定要查询的平台租户ID
page 否 1 页码
per_page 否 10 每页返回条数，最大100

响应

200 Ok 状态码

{
  "data": {
    "mapping_list": [
      {
        "source_id": "xxxx",
        "target_id": "zhangsan",
        "platform": "wecom",
        "company_corp_id": "wp-psUDwAAiO3lH0k6xxx"
      },
      {
        "source_id": "xxx",
        "target_id": "lsi",
        "platform": "privatelark",
        "company_corp_id": "lark_cli_a67ba81xxx"
      }
    ],
    "has_more": true
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数 说明
code 错误码
msg 对错误码的文本描述内容
has_more 为true表示返回数据不全，可继续拉取下一页
mapping_list 映射列表对象
mapping_list[].source_id 数据源用户id
mapping_list[].target_id 乐享成员帐号，staff_id
mapping_list[].platform 平台类型
wecom表示企业微信第三方应用
privatewechat表示企业微信自建应用
privatelark表示飞书自建应用
privatedingtalk表示钉钉自建应用
mapping_list[].company_corp_id 平台租户ID

← 获取团队列表 →