业务 API

JSSDK 更新于 2026-08-28 阅读 10

选择人员

chooseContacts

蓝信版本: ios: >6.6.85 android: >6.6.88 windows: >6.6.110 mac: >6.6.202

示例代码

lx.biz.chooseContacts({
  title: '选择人员', // 选择窗体标题
  multiple: true, // 是否允许多选
  type: ['friend', 'staff', 'sector'], // 选择人员窗体tab选项卡类型，friend 好友，staff 组织人员， sector 组织部门
  canChooseExternal: false, // 是否可以选择跨组织的外部人员
  max: 10, // 可选最大数量，当允许多选时生效，默认根据当前组织云控配置
  maxTip: '最多选择10人' //选择数量超出最大限制提示
  existentStaffs: [],  // 已选择的人员staffId列表
  existentSectors: [],  // 已选择的部门sectorId列表
  requiredStaffs: [],  // 默认选中的人员staffId列表，不可取消选中
  requiredSectors: [], // 默认选中的部门sectorId列表，不可取消选中
  selectGroupMembers: false, //是否默认选中群成员，仅在群入口生效，默认false
  success: function(res){
    /**
    {
      //已选择人员列表，列表中每个对象包含name（人员姓名）、avatar（人员头像）、staffId（人员staffId）
      staffs: [
        {"name":"","avatar":"","staffId":""}
      ],
      //已选择部门列表，列表中每个对象包含name（部门姓名）、count（部门包含的人数）、sectorId（部门sectorId）
      sectors: [
        {"name":"","count":1,"sectorId":""}
      ],
    }
    */
  },
  fail: function(err){
  }
})

参数说明

字段	类型	必填	说明
title	String	否	选择人员窗体标题
multiple	Boolean	否	是否允许多选，默认 true
type	Array[String]	否	选择人员窗体 tab 选项卡类型，friend 好友、staff 组织人员、sector 组织部门，默认为：['friend', 'staff']
canChooseExternal	Boolean	否	是否可以选择跨组织的外部人员，默认 false
max	Number	否	可选最大数量，当允许多选时生效
maxTip	String	否	选择数量超出最大限制提示
existentStaffs	Array[String]	否	已选择的人员 staffId 列表
existentSectors	Array[String]	否	已选择的部门 sectorId 列表
requiredStaffs	Array[String]	否	默认选中的人员 staffId 列表，不可取消选中
requiredSectors	Array[String]	否	默认选中的分支 sectorId 列表，不可取消选中
selectGroupMembers	Boolean	否	是否默认选中群成员，仅在群入口生效，默认 false

SUCCESS 返回值说明

字段	类型	说明
staffs	Array	已选择人员列表，列表中每个对象包含 name（人员姓名）、avatar（人员头像）、staffId（人员 staffId）
sectors	Array	已选择部门列表，列表中每个对象包含 name（部门姓名）、count（部门包含的人数）、sectorId（部门 sectorId）

staffs 结构说明

字段	类型	说明
name	String	人员姓名
avatar	String	人员头像 Url
staffId	String	人员 staffId

sectors 结构说明

字段	类型	说明
name	String	部门姓名
count	String	部门包含的人数
sectorId	String	部门 sectorId

errorCode 说明

code 值	message 值	说明
-7	CANCEL	取消选择人员操作

选择人员和手机通讯录

chooseContactsAndPhoneContacts

蓝信版本: ios: >6.6.85 android: >6.6.88 windows: 不支持 mac: 不支持

示例代码

lx.biz.chooseContactsAndPhoneContacts({
  title: '选择人员', // 选择窗体标题
  multiple: true, // 是否允许多选
  max: 10, // 可选最大数量，当允许多选时生效
  maxTip: '最多选择10人' // 选择数量超出最大限制提示
  existentContacts: [],  // 已选择的人员列表
  existentPhoneContacts: [],  // 已选择的通讯录列表
  requiredContacts: [], // 默认选中的人员staffId列表，不可取消选中
  requiredPhoneContacts: [] // 默认选中的人员staffId列表，不可取消选中
  selectGroupMembers: false, // 是否默认选中群成员，仅在群入口生效，默认false
  success: function(res){
    /**
    {
      //已选择人员列表，列表中每个对象包含name（人员姓名）、avatar（人员头像）、staffId（人员staffId）
      contacts: [
        {"name":"","avatar":"","staffId":""}
      ],
      //已选择人员列表，列表中每个对象包含name（姓名）、phoneNumber（手机号）
      phoneContacts: [
        {"name":"","phoneNumber":""}
      ]
    }
    */
  },
  fail: function(err){
  }
})

参数说明

字段	类型	必填	说明
title	String	否	选择人员窗体标题
multiple	Boolean	否	是否允许多选，默认 true
max	Number	否	可选最大数量，当允许多选时生效
maxTip	String	否	选择数量超出最大限制提示
existentContacts	Array[String]	否	已选择的人员 staffId 列表
existentPhoneContacts	Array[String]	否	已选择的手机通讯录 phoneNumber 列表
requiredStaffs	Array[String]	否	默认选中的人员 staffId 列表，不可取消选中
requiredPhoneContacts	Array[String]	否	默认选中的手机通讯录 phoneNumber 列表，不可取消选中
selectGroupMembers	Boolean	否	是否默认选中群成员，仅在群入口生效，默认 false

SUCCESS 返回值说明

字段	类型	说明
contacts	Array	已选择人员列表
phoneContacts	Array	选择的手机通讯录列表

contacts 结构说明

字段	类型	说明
name	String	人员姓名
avatar	String	人员头像 Url
staffId	String	人员 staffId

phoneContacts 结构说明

字段	类型	说明
name	String	姓名
phoneNumber	Number	手机号码

errorCode 说明

code 值	message 值	说明
-7	CANCEL	取消选择操作

打开人员蓝名片

openContactsCard

蓝信版本: ios: >6.6.85 android: >6.6.88 windows: >6.6.110 mac: >6.6.202

示例代码

lx.biz.openContactsCard({
  staffId: "String",
});

参数说明

字段	类型	必填	说明
staffId	String	是	联系人 staffId

添加联系人

addContact

蓝信版本: ios: >7.9.30 android: >7.9.30 windows: 不支持 mac: 不支持

示例代码

lx.biz.addContact({
  phone: "String",
  name: "String",
});

参数说明

字段	类型	必填	说明
phone	String	是	联系人手机号
name	String	是	联系人名称

选择部门

chooseDepartments

蓝信版本: ios: >7.6.15 android: >7.6.15 windows: 不支持 mac: 不支持

示例代码

lx.biz.chooseDepartments({
  title: '选择部门', // 选择窗体标题
  multiple: true, // 是否允许多选
  max: 10, // 可选最大数量，当允许多选时生效，默认根据当前组织云控配置
  maxTip: '最多选择10人' //选择数量超出最大限制提示
  existentSectors: [],  // 已经选择的部门列表
  requiredSectors: [],  // 默认选中的部门列表，不可取消
  success: function(res){
    /**
    {
      //选择的部门列表，列表中每个对象包含name（部门名称）、count（部门人数）、sectorId（部门sectorId）
      sectors: [{"name":"","count":"10","sectorId":""}]
    }
    */
  },
  fail: function(err){
  }
})

参数说明

字段	类型	必填	说明
title	String	否	选择部门窗体标题
multiple	Boolean	否	是否允许多选，默认 true
max	Number	否	可选最大数量，当允许多选时生效
maxTip	String	否	选择数量超出最大限制提示
existentSectors	Array[String]	否	已经选择的部门 sectorId 列表
requiredSectors	Array[String]	否	默认选中的部门列表，不可取消

SUCCESS 返回值说明

字段	类型	说明
sectors	Array	选择的部门列表，列表中每个对象包含 name（部门名称）、count（部门人数）、sectorId（部门 sectorId）

sectors 结构说明

字段	类型	说明
name	String	部门名称
count	String	部门人数
sectorId	String	部门 sectorId

errorCode 说明

code 值	message 值	说明
-7	CANCEL	取消选择部门操作

创建群会话

createGroupChat

蓝信版本: ios: >7.7.15 android: >7.7.15 windows: >=7.31.30 mac: >=7.31.30

示例代码

lx.biz.createGroupChat({
  name: "String",
  requiredStaffs: [], // 默认选中的人员 id 列表，不可取消选中
  requiredSectors: [], // 默认选中的分支 id 列表，不可取消选中
});

参数说明

字段	类型	必填	说明
name	String	否	群会话名称，不填写则为前几位成员名称拼接
requiredStaffs	Array[String]	否	默认选中的人员 id 列表，不可取消选中，须大于等于 3 人
requiredSectors	Array[String]	否	默认选中的分支 id 列表，不可取消选中

SUCCESS 返回值说明

字段	类型	说明
name	String	群会话名称
groupId	String	群会话 id

errorCode 说明

code 值	message 值	说明
-3	SERVER_INTERNAL_ERROR	服务端内部错误
-6	CLIENT_INTERNAL_ERROR	客户端内部错误
-7	CANCEL	用户取消操作
141	LIMITED_NUMBER_OF_PERSON	群会话人数受限，须大于等于 3 人

打开群会话

openGroupChat

蓝信版本: ios: >6.6.85 android: >6.6.88 windows: >6.6.110 mac: >6.6.202

示例代码

lx.biz.openGroupChat({
  groupId: "String",
});

参数说明

字段	类型	必填	说明
groupId	String	是	群会话 id

errorCode 说明

code 值	message 值	说明
-8	NOT_EXIST	打开的群不存在

选择会话

chooseChat

蓝信版本: ios: >6.6.85 android: >6.6.88 windows: >6.6.110 mac: >6.6.202

示例代码

lx.biz.chooseChat({
  title: '选择会话',
  allowCreate: true,
  max: 10，
  type: [1,2],
  success: function (res) {
    console.log(res);
  },
  fail: function (err) {},
});

参数说明

字段	类型	必填	默认值	说明
title	String	否		自定义选会话标题，最多 10 个字
allowCreate	Boolean	否	true	是否允许创建聊天
max	Number	否	9	可选会话数量，非 0 整数，最大支持 100
type	Array	否	[1,2]	选会话组件模式：1 只选择群聊；2.只选择单聊

返回示例

{
  chatList: [{
    chatId: ''
  }],
},

SUCCESS 返回值说明

字段	类型	说明
chatList	Array	已选择会话列表

chatList 结构说明

字段	类型	说明
chatId	String	会话 id

选择本地文件

chooseLocalFile

蓝信版本: ios: >=8.1.0 android: >7.21.15 windows: >7.6.15 mac: >7.6.15

示例代码

lx.biz.chooseLocalFile({
  multiple: true, // 是否允许多选，默认为true
  max: 3, // 可选最大数量，当允许多选时生效，最小为1
  maxTip: '当前选择文件数量已超出最大限制' //选择数量超出最大限制提示
  maxSize: 1024 //最大文件大小，单位：Byte
  types: ['pdf', 'jpg', 'doc'], // 需要选择的文件类型(文件名后缀)，不传则可以选择全部文件
  success: function(res){
    /**
    {
      fileList: [{
        localId: 'xxxx',
        name:'我的文档.doc',
        size: 1000,
        type: 'doc'
      }]，//已选择文件列表，列表中每个对象包含name（文件名称）、localId（文件id）、size（文件大小）、type（文件类型）
    }
    */
  },
  fail: function(err){
  }
})

参数说明

字段	类型	必填	说明	备注
multiple	Boolean	否	是否允许多选，默认 true
max	Number	否	可选最大数量，当允许多选时生效，默认最大为 9	Android 不支持
maxTip	String	否	选择数量超出最大限制提示	Android 不支持
maxSize	Number	否	最大文件大小，单位：Byte	Android 不支持
types	Array[String]	否	需要选择的文件类型(文件名后缀)，不传则可以选择全部文件	Android 不支持

SUCCESS 返回值说明

字段	类型	说明
fileList	Array	已选择文件列表

fileList 结构说明

字段	类型	说明
localId	String	文件的资源 id
name	String	文件名称
size	String	文件大小，单位：Byte
type	String	文件类型(文件名后缀)

errorCode 说明

code 值	message 值	说明
-3	SERVER_INTERNAL_ERROR	内部错误等

选择云盘文件

chooseCloudFile

蓝信版本: ios: >6.6.85 android: >6.6.86 windows: 不支持 mac: >6.6.202

示例代码

lx.biz.chooseCloudFile({
  multiple: true,
  max: 9,
  maxTip: "当前选择文件数量已超出最大限制",
  existent: [],
  types: ["pdf", "jpg", "doc"],
  success: function (res) {
    /**
    {
      fileList: [{"mediaId":"","name":"","size":"", "type": ""}]，//已选择文件列表，列表中每个对象包含name（文件名称）、mediaId（文件id）、size（文件大小）、type（文件类型）
    }
    */
  },
  fail: function (err) {},
});

参数说明

字段	类型	必填	说明
multiple	Boolean	否	是否允许多选，默认 true
max	Number	否	可选最大数量，当允许多选时生效，默认最大为 9
maxTip	String	否	选择数量超出最大限制提示
existent	Array[String]	否	已经选择的文件 mediaId 列表
types	Array[String]	否	需要选择的文件类型(文件名后缀)，不传则可以选择全部文件

SUCCESS 返回值说明

字段	类型	说明
fileList	Array	已选择文件列表

fileList 结构说明

字段	类型	说明
mediaId	String	文件的资源 id，通过服务端接口可获取相关文件
name	String	文件名称
size	String	文件大小，单位：Byte
type	String	文件类型(文件名后缀)

errorCode 说明

code 值	message 值	说明
-3	SERVER_INTERNAL_ERROR	内部错误等

获取分支下所有人员

getSectorMembers

蓝信版本: ios: >7.0.75 android: >7.0.75 windows: 不支持 mac: 不支持

示例代码

lx.biz.getSectorMembers({
  sectors: [], // 部门sectorId列表
});

参数说明

字段	类型	必填	说明
sectors	Array[String]	是	部门 sectorId 列表

返回示例

[
  {
    name: "张三", // 姓名
    avatar: "", // 头像url
    staffId: "1001", // 人员ID
  },
];

SUCCESS 返回值说明

字段	类型	说明
name	String	人员姓名
avatar	String	人员头像 Url
staffId	String	人员 staffId

errorCode 说明

code 值	message 值	说明
-1	INVALID_REQUEST	请求参数不合法, 如缺少必要字段等
-3	SERVER_INTERNAL_ERROR	请求失败

打开会话

openChat

蓝信版本: ios: >=8.0.0 android: >=8.0.0 windows: >=7.30.30 mac: >=7.30.30

示例代码

lx.biz.openChat({
  chatId: "xxx", // 会话的openId
  success: function () {},
  fail: function (error) {},
});

参数说明

字段	类型	必填	说明
chatId	String	是	会话的 openId

获取微信发票

getWxInvoice

蓝信版本: ios: >=8.1.0 android: >=8.1.0 windows: 不支持 mac: 不支持

示例代码

lx.biz.getWxInvoice({
  success: function (res) {
    // 具体 res 可参考 https://developers.weixin.qq.com/doc/offiaccount/WeChat_Invoice/E_Invoice/Reimburser_API_List.html#5
  },
  fail: function (error) {},
});

SUCCESS 返回值说明

字段	类型	说明
card_id	String	微信发票信息的 json 字符串
begin_time	Number	发票有效起止日期
end_time	Number	发票的有效期截止时间
openid	String	用户标识
type	String	发票的类型，如广东增值税普通发票
payee	String	发票的收款方
detail	String	发票详情
user_info	Object	用户可在发票票面看到的主要信息

设置剪切板

setClipboardData

设置剪切板内容，只支持文本内容

蓝信版本: ios: >=8.1.0 android: >=8.1.0 windows: 不支持 mac: 不支持

示例代码

lx.biz.setClipboardData({
  content: "lanxin",
  success: function () {},
  fail: function (error) {},
});

参数说明

字段	类型	必填	说明
content	String	是	向剪切板中设置的内容

获取剪切板内容

getClipboardData

获取剪切板内容,只支持文本内容,如果剪切板没有内容返回空字符串

蓝信版本: ios: >=8.1.0 android: >=8.1.0 windows: 不支持 mac: 不支持

示例代码

lx.biz.getClipboardData({
  success: function () {},
  fail: function (error) {},
});

SUCCESS 返回值说明

字段	类型	说明
content	String	剪切板内容

创建会话

createSingleChat

创建会话，目前支持私聊和智能机器人

蓝信版本: ios: >=8.5.0 android: >=8.5.0 windows: >=7.35.30 mac: >=7.35.30

示例代码

lx.biz.createSingleChat({
  type: "normal",
  id: '123-345'
  success: function () {},
  fail: function (error) {},
});

参数说明

字段	类型	必填	默认值	说明
type	String	否	normal	会话类型，normal - 普通私聊; bot - 智能机器人(目前仅支持应用机器人)
id	String	是	-	人员或者应用机器人对应应用的 appId

SUCCESS 返回值说明

字段	类型	说明
chatId	String	会话 id

errorCode 说明

code 值	message 值	说明
-1	INVALID_REQUEST	参数错误，id 或 type 错误等

💬 即时通讯

🤝 业务协同

📦 AI产品

📦 其他产品

openplatform

业务 API

选择人员

选择人员和手机通讯录

打开人员蓝名片

添加联系人

选择部门

创建群会话

打开群会话

选择会话

选择本地文件

选择云盘文件

获取分支下所有人员

打开会话

获取微信发票

设置剪切板

获取剪切板内容

创建会话