# lanxin-sdk

**Repository Path**: zhangwen800/lanxin-sdk

## Basic Information

- **Project Name**: lanxin-sdk
- **Description**: 蓝信开放平台 sdk java版（非官方）
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 0
- **Created**: 2021-09-07
- **Last Updated**: 2025-08-28

## Categories & Tags

**Categories**: web-dev-toolkits

**Tags**: None

## README

## 蓝信开放平台 sdk java 版

### 概述

为了方便 java 开发者更快速的接入蓝信开放平台 https://developer.lanxin.cn/official/article?id=646eca933d4e4adb7039c0e1&module=back-end-api
，使用蓝信开放平台接口。个人分享提供此开发sdk。  
目前仅提供 <b>认证授权</b>、<b>通讯录</b>、<b>消息通知</b> 中的重要接口实现。其余接口根据使用情况逐步开放。  
如此 sdk 无法满足业务需要，请直接使用官方 REST API 或联系本 sdk 开发者（微信号 Z2013111158）开放需的其他接口。

### 运行环境

java版本 ≥ 1.8

### 使用方法

#### 1. 添加依赖

maven 方式

    <dependency>
        <groupId>com.nmgolden</groupId>
        <artifactId>lanxin-sdk</artifactId>
        <version>0.13.1</version>
    </dependency>

gradle 方式

    implementation 'com.nmgolden:lanxin-sdk:0.13.1'

#### 2.初始化 LanxinService 对象

    // 初始化蓝信配置对象
    LanxinAppConfig config = new LanxinAppConfig();
    config.setAppId(appId);
    config.setAppSecret(appSecret);
    config.setApiGateway(apiGateway);
    
    // 创建服务对象
    LanxinService lanxinService = new DefaultLanxinService(config);

appId、appSecret、apiGateway 请到蓝信开放平台中查看。

#### 3.使用 LanxinService 对象进行接口调用

    // 获取蓝信用户 staffId , code:免登陆授权码
    String staffId = lanxinService.getStaffIdByCode(code);

    // 根据 staffId 获取用户详细信息
    UserDetail userDetail = lanxinService.getUserDetail(staffId);

    // 发送文本消息
    mLanxinService.sendTextMessage("1572864-JWuRLcnaBGVjC5ab5IggKvC20b2a", "测试文本内容");

    // 发送 oa 卡片消息
    List<MsgDataField> fields = new ArrayList<>();
    fields.add(new MsgDataField("标签1", "标签值1"));
    fields.add(new MsgDataField("标签2", "标签值2"));
    lanXinService.sendOaCardMessage(staffId,
            "您有一条新消息",
            "副标题",
            fields,
            "https://example.com");

## 版本记录

### 0.19.0

发布时间：2025/08/18

- 新增-emcCookieDomain 配置

### 0.18.0

发布时间：2025/06/24

- 新增- 发送应用消息数方法

### 0.17.0

发布时间：2025/05/08

- 新增- 通过 shareId 下载文件

### 0.16.0

发布时间：2025/02/25

- 新增- 通过 shareId 下载文件

### 0.15.4

发布时间：2025/02/06

- 修改- 取消禁用连接池配置，新增自动清理闲置链接

### 0.15.3

发布时间：2025/02/05

- 修改- 新增禁用链接复用配置

### 0.15.2

发布时间：2025/01/26

- 新增- 默认的请求超时时间，默认连接失效时间

### 0.15.1

发布时间：2024/05/28

- 新增- 移除无用包
  

### 0.15.0

发布时间：2024/05/18

- 新增- 补全人员管理和分支管理剩余接口
  整理代码结构

### 0.14.0

发布时间：2024/05/16

- 新增- 获取配置接口

### 0.13.2

发布时间：2024/04/30

- 修复- 请求蓝信服务的 httpClient 最大连接数默认为2 可能导致新请求被阻塞的问题

### 0.13.1

发布时间：2024/02/21

- 修复- revokeMessage 方法错误

### 0.13.0

发布时间：2024/02/02

- 新增-getDepartmentAncestors4User 方法


### 0.12.0

发布时间：2024/01/23

- 新增-上传、下载媒体文件方法以及获取媒体文件下载路径方法。
- 新增-发送链接消息支持区分手机端和 pc 端


### 0.11.0

发布时间：2023/12/21

- 新增-sendLinkCardMessage重载方法

### 0.10.0

发布时间：2023/12/18

- 变更-异常类code类型变更为int

### 0.9.0

发布时间：2023/12/09

- 变更-用户详情对象修改：新增extraFieldSet字段。

### 0.8.0

发布时间：2023/12/08

- 新增-获取通讯录拓展字段列表方法

### 0.7.0

发布时间：2023/11/08

- 新增-webhook机器人发送群消息重载方法(使用消息体详情发送)
- 新增-webhook机器人发送群消息重载方法(使用加签方式校验消息合法性）

### 0.6.0

发布时间：2023/10/31

- 新增-发送appCard类型应用消息、更新appCard应用消息
- 新增-webhook机器人发送群消息方法
- 新增-发送文本消息时可以指定人员id数据

### 0.5.0

发布时间：2023/09/05

- 新增-获取分支时可获取分支下人员数量

### 0.4.0

发布时间：2023/08/24

- 新增-获取应用运营者
- 新增-发送应用通知，更新通知消息会话状态

### 0.3.0

发布时间：2022/04/04

- 变更 - 更新用户方法参数变更为 Map

### 0.2.0

发布时间：2022/06/01

- 新增 - getStaffIdByCode 方法
- 新增 - 获取 OrgId 方法
- 新增 - 撤回消息方法
- 修复 - 多实例 token 冲突问题

### 0.1.0

发布时间：2022/05/13

- 解决了一些问题
- 使用 httpClient 进行网络请求

### 0.0.1

发布时间：2020

基本功能