纷享销客开发者手册 纷享销客开发者手册
  • APL开发手册
  • PWC开发手册
  • OpenAPI 文档
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门

  • API授权流程

  • API基础说明

  • OpenAPI

  • 免登集成方案

  • 客户端开发

    • 接入指南

    • JavaScript

      • 容器
      • 设备
      • 启动器
      • Webview
      • 弹层
      • 纷享服务
        • 媒体
        • 通用
      • UI

    • 常见问题

    目录

    纷享服务

    # 通讯录

    接口名 接口描述
    service.contact.select 选择员工和部门
    service.contact.selectDepartment 选择部门
    service.contact.selectUser 选择员工
    service.contact.getMembers 获取成员列表
    service.contact.getUsersInfo 获取员工信息
    service.contact.setMark 关注员工或取消关注
    service.contact.getServiceChannelsInfo 获取服务号信息

    使用FSOpen.util.open接口可跳转到“个人资料页”或“部门工作页”,参考通用。

    # 从通讯录选择人员,部门和群组

    代码样例

    // 从人员列表、部门列表和群组列表选择
    FSOpen.service.contact.select({
        title: '选择数据',
        selectedUsers: ['FSUID_571AA7C41A11BE3D9BA25BDD397AC86E'],
        selectedDepartments: [1001],
        excludedUsers: ['FSUID_643539016707F16000E85ADCC967D12C'],
        excludedDepartments: [1000],
        hasEmail: true,
        hasPhone: true,
        showRecent: true,
        showGroupTab: true,
        showCompanyAll: true,
        onSuccess: function(resp) {
            console.assert(resp.users != null);
            console.assert(resp.departments != null);
            console.assert(resp.groups != null);
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    
    // 自定义用户和部门列表
    FSOpen.service.contact.select({
        scope: 'custom',
        users: [
            'FSUID_571AA7C41A11BE3D9BA25BDD397AC86E',
            'FSUID_643539016707F16000E85ADCC967D12C'
        ],
        departments: [
            1000,
            1001
        ],
        title: '选择数据',
        onSuccess: function(resp) {
            console.assert(resp.users != null);
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.contact.select JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 选择控件的显示标题,默认为空
    scope String 否 指定控件的可选范围,只有两个情况:company或custom。当为company时,数据源为全公司数据列表;当为custom时,可通过users和departments两个参数来指定可选范围。默认为company。
    users Array[String] 否 当scope为custom时使用,指定用户可选范围
    departments Array[Number] 否 当scope为custom时使用,指定部门可选范围
    selectedUsers Array[String] 否 已选中状态的用户ID列表
    selectedDepartments Array[Number] 否 已选中状态的部门ID列表
    selectedGroups Array[String] 否 已选中状态的群组ID列表
    selectedCompanyAll Boolean 否 是否已选中“全公司”,只在showCompanyAll为true时有效
    showRecent Boolean 否 是否显示最近,默认为true
    showGroupTab Boolean 否 是否显示群组标签页,默认为true
    showCompanyAll Boolean 否 是否显示全公司选项,默认为true
    excludedUsers Array[String] 否 过滤器,需要从当前设定范围(参考scope)排除掉的用户ID列表。js 2.0.0暂未实现。
    excludedDepartments Array[Number] 否 过滤器,需要从当前设定范围(参考scope)排除掉的部门ID列表。js 2.0.0暂未实现。
    hasEmail Boolean 否 过滤器,为true代表仅显示有Email的用户数据。不指定则全部显示。
    hasPhone Boolean 否 过滤器,为true代表仅显示有电话号码的用户数据。不指定则全部显示。

    返回说明:

    参数 类型 说明
    users Array[Object] 选择的用户user列表
    departments Array[Object] 选择的部门department列表
    groups Array[Object] 选择的群组group列表
    selectedSum Array[Object] 所有选中的人的总数。如果选中了部门,则部门的人去重后计入总数。
    selectedCompanyAll String 是否选中了全公司

    user字段说明:

    参数 类型 说明
    userId String 用户ID
    nickname String 用户昵称
    email String 用户电子邮箱
    avatarUrl String 用户头像
    position String 用户职位信息

    department字段说明:

    参数 类型 说明
    departmentId Number 部门ID
    name String 部门名称
    parentId String 父部门ID

    group字段说明:

    参数 类型 说明
    sessionId String 群组(会话)ID
    name String 群组(会话)名称

    # 从通讯录选择部门

    代码样例

    FSOpen.service.contact.selectDepartment({
        title: '选择数据',
        selectedDepartments: [1001],
        excludedDepartments: [1000],
        onSuccess: function(resp) {
            console.assert(resp.departments != null);
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.contact.selectDepartment JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 选择控件的显示标题,默认为空
    scope String 否 指定控件的可选范围,只有两个情况:company或custom。当为company时,数据源为全公司数据列表;当为custom时,可通过departments参数来指定可选范围。默认为company。
    departments Array[Number] 否 当scope为custom时使用,指定部门可选范围
    selectedDepartments Array[Number] 否 已选中状态的部门ID列表
    max Number 否 最大选择上限,当max=1时为单选。默认不限制
    excludedDepartments Array[Number] 否 过滤器,需要从当前设定范围(参考scope)排除掉的部门ID列表

    返回说明:

    参数 类型 说明
    departments Array[Object] 选择的部门department列表
    selectedSum Array[Object] 所有选中的人的总数

    department字段说明:

    参数 类型 说明
    departmentId Number 部门ID
    name String 部门名称
    parentId String 父部门ID

    # 从通讯录选择人员

    代码样例

    FSOpen.service.contact.selectUser({
        title: '选择数据',
        selectedUsers: ['FSUID_571AA7C41A11BE3D9BA25BDD397AC86E'],
        excludedUsers: ['FSUID_643539016707F16000E85ADCC967D12C'],
        hasEmail: true,
        hasPhone: true,
        onSuccess: function(resp) {
            console.assert(resp.users != null);
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.contact.selectUser JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 选择控件的显示标题,默认为空
    scope String 否 指定控件的可选范围,只有两个情况:company或custom。当为company时,数据源为全公司数据列表;当为custom时,可通过users参数来指定可选范围。默认为company。
    users Array[String] 否 当scope为custom时使用,指定用户可选范围
    selectedUsers Array[String] 否 已选中状态的用户ID列表
    max Number 否 最大选择上限,当max=1时为单选。默认不限制
    excludedUsers Array[String] 否 过滤器,需要从当前设定范围(参考scope)排除掉的用户Id列表
    hasEmail Boolean 否 过滤器,为true代表仅显示有Email的用户数据。不指定则全部显示。
    hasPhone Boolean 否 过滤器,为true代表仅显示有电话号码的用户数据。不指定则全部显示。

    返回说明:

    参数 类型 说明
    users Array[Object] 选择的用户user列表
    selectedSum Array[Object] 所有选中的人的总数

    user字段说明:

    参数 类型 说明
    userId String 用户ID
    nickname String 用户昵称
    email String 用户电子邮箱
    avatarUrl String 用户头像
    position String 用户职位信息

    # 获取成员列表

    代码样例

    请注意样例中的参数'departmentId'需要替换成一个有效值,该Id可能来自于另外一个接口selectDepartment的返回。

    FSOpen.service.contact.getMembers({
        departmentId: 1000,
        sessionId: 'f6b22ba707bd4447855567291c27476f',
        onSuccess: function(resp) {
            console.assert(resp.userIds.length != undefined);
            FSOpen.service.contact.getUsersInfo({
                userIds: resp.userIds
            });
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.contact.getMembers JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    departmentId Number 是 如果查询对象是一个部门,则需传入部门ID。
    sessionId String 是 如果查询对象是一个部门,则需传入群组(会话)ID。如果传入了一个有效的departmentId,接口后会忽略sessionId传参。

    成功回调返回参数:

    参数 类型 说明
    userIds Array[String] 用户ID列表

    # 获取用户信息

    代码样例

    FSOpen.service.contact.getUsersInfo({
        userIds: [
            'FSUID_571AA7C41A11BE3D9BA25BDD397AC86E',
            'FSUID_643539016707F16000E85ADCC967D12C'
        ],
        onSuccess: function(resp) {
            console.assert(resp.users != null);
            var users = resp.users, key;
            // 遍历搜索到的用户
            for (key in users) {
                // {userId:'',nickname:'',email:'',avatarUrl:'',position:'',marked:true}
                console.log(users[key]);
            }
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.contact.getUsersInfo JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    userIds Array[String] 是 用户ID列表

    成功回调返回参数:

    参数 类型 说明
    users Object 用户user关联数组,比如:{'FSUID_XXX': {userId:'',nickname:'',email:'',avatarUrl:'',position:'',marked:true}},如果用户没找到,对应的值为空

    user字段说明:

    参数 类型 说明
    userId String 用户ID
    nickname String 用户昵称
    email String 用户电子邮箱
    avatarUrl String 用户头像
    position String 用户职位信息
    marked Boolean 是否关注了此用户

    # 关注员工或取消关注

    代码样例

    FSOpen.service.contact.setMark({
        userId: 'FSUID_5174F22D77B81347E278CBD353748547',
        value: true,
        onSuccess: function(resp) {
            alert(JSON.stringify(resp));
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.contact.setMark JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    userId String 是 纷享用户的ID
    value Boolean 是 是否关注

    # 获取服务号信息

    代码样例

    FSOpen.service.contact.getServiceChannelsInfo({
        serviceChannelIds: ['FSAID_1313eef'],
        onSuccess: function(resp) {
            // do sth
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.contact.getServiceChannelsInfo JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    serviceChannelIds Array[String] 是 服务号ID列表

    成功回调返回参数:

    参数 类型 说明
    serviceChannels Object 用户serviceChannel关联数组,比如:{'FSAID_13135e9': {serviceChannelId:'',name:'',imgUrl:''}},如果用户没找到,对应的值为空

    serviceChannel字段说明:

    参数 类型 说明
    serviceChannelId String 服务号ID
    name String 服务号名称
    imgUrl String 服务号Logo地址

    # 企信会话

    接口名 接口描述
    service.conversation.setupFSCall 发起1对1纷享电话
    service.conversation.setupFSConference 发起多人纷享电话会议

    使用FSOpen.util.open接口可跳转到“企信会话窗口”,参考Util (opens new window)。

    # 发起1对1纷享电话

    代码样例

    FSOpen.service.conversation.setupFSCall({
        userId: ['FSUID_571AA7C41A11BE3D9BA25BDD397AC86E']
    });
    

    方法名:FSOpen.service.conversation.setupFSCall JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    userId String 是 用户ID

    # 发起多人纷享电话会议

    代码样例

    FSOpen.service.conversation.setupFSConference({
        userIds: ['FSUID_571AA7C41A11BE3D9BA25BDD397AC86E']
    });
    

    方法名:FSOpen.service.conversation.setupFSConference JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    userIds Array[String] 是 用户ID列表

    # 收藏

    接口名 接口描述
    service.favorite.add 添加收藏

    使用FSOpen.util.open接口可跳转到“我的收藏”,参考Util (opens new window)。

    # 添加收藏

    代码样例

    FSOpen.service.favorite.add({
        title: '纷享开放平台JSAPI',
        desc: '纷享开放平台JSAPI',
        link: location.href,
        imgUrl: '',
        tagList: ['纷享', 'JSAPI'],
        onSuccess: function(resp) {
            alert('收藏成功');
        },
        onFail: function(error) {
            if (error.errorCode === 40050) {
                alert('用户取消收藏');
                return;
            }
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.favorite.add JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 是 收藏标题
    desc String 否 收藏描述
    link String 否 收藏链接,默认为当前页面链接
    imgUrl String 否 收藏内容的缩略图
    tagList Array[String] 否 收藏内容的标签列表

    # 位置

    接口名 接口描述
    service.geo.getLocation 获取当前地理位置
    service.geo.selectPOI 选择兴趣点

    # 获取当前地理位置

    代码样例

    FSOpen.service.geo.getLocation({
        onSuccess: function(resp) {
            alert('位置信息:' + JSON.stringify(resp));
        },
        onFail: function(error) {
            alert('操作失败:' + JSON.stringify(error));
        }
    });
    

    方法名:FSOpen.service.geo.getLocation JS版本:2.0.0 客户端支持版本:5.4.0及以上

    返回说明:

    参数 类型 说明
    accuracy Number 实际的定位精度半径(单位米)
    address String 格式化后的地址,如:深圳市南山区大冲商务中心
    country String 国家
    province String 省份,如:广东省
    city String 城市,如:深圳市。直辖市会返回空
    district String 行政区,如:南山区
    street String 街道,如:铜鼓路10000号

    # 选择兴趣点

    代码样例

    FSOpen.service.geo.selectPOI({
        latitude: 39.903578,
        longitude: 116.473565,
        onSuccess: function(resp) {
            alert('位置信息:' + JSON.stringify(resp));
        },
        onFail: function(error) {
            alert('操作失败:' + JSON.stringify(error));
        }
    });
    

    方法名:FSOpen.service.geo.selectPOI JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    latitude Number 否 标准维度,默认当前位置
    longitude Number 否 标准经度,默认当前位置

    返回说明:

    参数 类型 说明
    latitude Number POI的标准维度
    longitude Number POI的标准经度
    title String POI的名称
    province String POI所在省,可能为空
    provinceCode String POI所在省编码,可能为空
    city String POI所在城市,可能为空
    cityCode String POI所在城市的编码,可能为空
    district String POI所在区,可能为空
    districtCode String POI所在区的编码,可能为空
    postcode String POI的邮编,可能为空
    street String POI的街道地址,可能为空

    # 分享

    此类接口对应纷享菜单里的分享接口,可独立使用。

    接口名 接口描述
    service.share.toConversation 转发到企信
    service.share.toFeed 转发到工作
    service.share.toCRMContact 转发到CRM联系人
    service.share.toWXFriend 转发给微信朋友
    service.share.toWXMoments 分享到微信朋友圈
    service.share.toQQFriend 转发给QQ朋友
    service.share.viaSMS 通过短信转发
    service.share.viaEmail 通过邮件转发

    # 转发到企信

    代码样例

    FSOpen.service.share.toConversation({
        title: '纷享逍客',
        desc: '移动办公 自在纷享',
        link: 'http://www.fxiaoke.com',
        imgUrl: 'https://www.fxiaoke.com/static/img/index/logo.png?v=5.1.5',
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.toConversation JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    type String 否 分享的资源类型,目前支持text-文字,link-链接,image-图片,file-文件。当link参数为空时,默认text类型,否则默认为link类型。
    title String 否 资源类型为link时使用,表示分享标题,默认当前页面标题
    desc String 否 资源类型为link时使用,表示分享摘要描述,默认当前页面描述(<meta name="description" content="网页摘要内容在这里填写">标签中的内容),取不到则显示页面URL。
    link String 否 资源类型为link时使用,表示分享链接地址,默认当前页面链接
    imgUrl String 否 资源类型为link时使用,表示分享缩略图地址,默认为纷享预置图标
    name String 否 资源类型为image或file时使用,表示资源名
    size String 否 资源类型为image或file时使用,表示资源大小
    npath String 否 资源类型为image或file时使用,表示资源存储地址。资源需是存储在纷享平台上,采用N-Path地址引用,如N_201512_08_101239c8308f4ea7325f69df4fba386f1.pptx。
    content String 否 资源类型为text时使用,表示文件内容

    # 转发到工作流

    代码样例

    FSOpen.service.share.toFeed({
        title: '纷享逍客',
        desc: '移动办公 自在纷享',
        link: 'http://www.fxiaoke.com',
        imgUrl: 'https://www.fxiaoke.com/static/img/index/logo.png?v=5.1.5',
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.toFeed JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    type String 否 分享的资源类型,目前支持text-文字,link-链接,image-图片,file-文件。当link参数为空时,默认text类型,否则默认为link类型。
    title String 否 资源类型为link时使用,表示分享标题,默认当前页面标题
    desc String 否 资源类型为link时使用,表示分享摘要描述,默认当前页面描述(<meta name="description" content="网页摘要内容在这里填写">标签中的内容),取不到则显示页面URL。
    link String 否 资源类型为link时使用,表示分享链接地址,默认当前页面链接
    imgUrl String 否 资源类型为link时使用,表示分享缩略图地址,默认为纷享预置图标
    name String 否 资源类型为image或file时使用,表示资源名
    size String 否 资源类型为image或file时使用,表示资源大小 ,单位为kb。
    npath String 否 资源类型为image或file时使用,表示资源存储地址。资源需是存储在纷享平台上,采用N-Path地址引用,如N_201512_08_101239c8308f4ea7325f69df4fba386f1.pptx。
    content String 否 资源类型为text时使用,表示文件内容

    # 转发给CRM联系人

    代码样例

    FSOpen.service.share.toCRMContact({
        link: location.href,
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.toCRMContact JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    link String 否 要转发的页面链接

    # 分享给微信好友

    代码样例

    FSOpen.service.share.toWXFriend({
        title: '纷享逍客',
        link: 'http://www.fxiaoke.com',
        imgUrl: 'https://www.fxiaoke.com/static/img/index/logo.png?v=5.1.5',
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.toWXFriend JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 分享标题,默认当前页面标题
    link String 否 分享链接地址,默认当前页面链接
    imgUrl String 否 分享缩略图地址,默认为纷享预置图标

    # 分享到微信朋友圈

    代码样例

    FSOpen.service.share.toWXMoments({
        title: '纷享逍客',
        link: 'http://www.fxiaoke.com',
        imgUrl: 'https://www.fxiaoke.com/static/img/index/logo.png?v=5.1.5',
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.toWXMoments JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 分享标题,默认当前页面标题
    link String 否 分享链接地址,默认当前页面链接
    imgUrl String 否 分享缩略图地址,默认为纷享预置图标

    # 分享给QQ好友

    代码样例

    FSOpen.service.share.toQQFriend({
        title: '纷享逍客',
        desc: '移动办公 自在纷享',
        link: 'http://www.fxiaoke.com',
        imgUrl: 'https://www.fxiaoke.com/static/img/index/logo.png?v=5.1.5',
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.toQQFriend JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 分享标题,默认当前页面标题
    desc String 否 分享摘要描述,默认当前页面描述(<meta name="description" content="网页摘要内容在这里填写">标签中的内容),取不到则显示页面URL。
    link String 否 分享链接地址,默认当前页面链接
    imgUrl String 否 分享缩略图地址,默认为纷享预置图标

    # 通过短信转发

    代码样例

    FSOpen.service.share.viaSMS({
        content: '移动办公,自在纷享 {url}',
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.viaSMS JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    content String 否 转发内容,最多140字,可使用{url}替换符来表示当前页面的url

    # 通过邮件转发

    代码样例

    FSOpen.service.share.viaMail({
        title: '纷享逍客',
        content: '移动办公,自在纷享 {url}',
        onSuccess: function(resp) {
            // 可以在这里做些分享数据统计
            alert('分享成功');
        },
        onFail: function(error) {
            if (error.errorCode == 40050) {
                alert('用户取消分享');
                return;
            }
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.share.viaMail JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 转发邮件标题
    content String 否 转发邮件内容,可使用{url}(5个字符)来表示当前页面的URL,后台会在最终内容中替换。

    # 日历

    接口名 接口描述
    service.calendar.createEvent 创建日程

    使用FSOpen.util.open接口可跳转到“日历”,参考Util (opens new window)。

    # 创建日程提醒

    代码样例

    FSOpen.service.calendar.createEvent({
        content: '今天原来要上班',
        onSuccess: function(resp) {
            alert('创建成功');
        },
        onFail: function(error) {
            alert('创建失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.calendar.createEvent JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    content String 否 日程提醒内容

    # 工作流

    接口名 接口描述
    service.feed.create 创建一条工作

    使用FSOpen.util.open接口可跳转到“工作详情”,参考Util (opens new window)。

    # 创建一条工作

    代码样例

    FSOpen.service.feed.create({
        type: 'share',
        content: '周五要上线',
        onSuccess: function(resp) {
            alert('创建成功');
        },
        onFail: function(error) {
            alert('创建失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.feed.create JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    type String 否 工作类型:share-分享,diary-日志,approval-审批,task-任务,schedule-日程,order-指令,不指定则由用户自行选择
    content String 否 工作文本内容,除任务外,均默认赋值到各类型工作的第一个字段,比如日报填入到“今日工作”;任务则填入到第二个字段“备注”

    # 网盘

    接口名 接口描述
    service.disk.addFile 文件保存到网盘
    service.disk.selectFile 从网盘中选取文件

    # 将文件保存到网盘

    FSOpen.service.disk.addFile({
        fileName: '纷享逍客培训.pptx',
        fileNPath: 'N_201606_29_f13bbed15ba14413bc0aef29be255817.pptx',
        onSuccess: function(resp) {
            alert('保存成功');
        },
        onFail: function(error) {
            alert('保存失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.disk.addFile JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    fileName String 是 存储文件名称,需要带上文件后缀
    fileNPath String 是 文件地址。资源需是存储在纷享平台上,采用N-Path地址引用,如N_201512_08_101239c8308f4ea7325f69df4fba386f1.pptx。

    # 从网盘选择文件

    代码样例

    FSOpen.service.disk.selectFile({
        onSuccess: function(resp) {
            alert('文件信息:' + JSON.stringify(resp));
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.service.disk.selectFile JS版本:2.0.0 客户端支持版本:5.4.0及以上

    成功回调返回参数:

    参数 类型 说明
    file Object 文件信息

    file字段说明:

    参数 类型 说明
    id String 文件ID信息
    fileName String 文件名
    fileNPath String 文件地址。资源需是存储在纷享平台上,采用N-Path地址引用,如N_201512_08_101239c8308f4ea7325f69df4fba386f1.pptx。
    size Number 文件大小,以字节为单位
    url String 可通过HTTP连接访问的文件地址
    弹层
    媒体

    ← 弹层 媒体 →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式